kncsolutions / dhelm-gfeed-java-client

This is a java client for websocket APIs provided by Global Financial Datafeeds LLP

No more support will be provided on this package from MAY 01, 2020.

Dhelm-gfeed-java-client is a java client library to access and integrate stock market data from
Global Financial Datafeeds LLP with your application.

To use this library you must subscribe to web socket api with Global Financial Datafeeds LLP and get your API key and web socket endpoint URL. Programmatic access to data obviously provides better control over your algorithm. You access the raw data from your data provider, then feed into your own application and do whatever analysis you want.

If java is your favorite language for stock market data analysis, then using Dhelm-gfeed-client you can plug data from web socket api into your application directly.

For detailed integration and usage guidelines, please read through the wiki.

Required Java version

Java 1.8 or higher is required.

How to run the test file

Clone the repository to your computer.Navigate to the dhelm-gfeed-client/dhelm-gfeed-client-test/target folder. From the command line run the following command:
java -jar dhelm-gfeedtest-1.0.0-launcher.jar <WEB_SOCKET_URL> <API_KEY>
where you should replace
<WEB_SOCKET_URL> with the web socket url
and
<API_KEY> with the api key which you have got at the time of subscription.

How to integrate with your project

If you use MAVEN as build tool you can directly integrate the library in your project. Add the following dependency:

<dependency>
  <groupId>in.kncsolutions.dhelm.gfeed</groupId>
  <artifactId>dhelm-gfeed-client</artifactId>
  <version>1.0.0</version>
</dependency>

Alternatively you can download the jar from here and integrate it in your classpath.

Changelog

For smoother streaming of real time data certain changes have been made in version 1.0.1-SNAPSHOT. To integrate that version, add the following dependency

<dependency>
  <groupId>in.kncsolutions.dhelm.gfeed</groupId>
  <artifactId>dhelm-gfeed-client</artifactId>
  <version>1.0.1-SNAPSHOT</version>
</dependency>

For the souce code clone the snapshot branch.

Changes

1. In version 1.0.1-SNAPSHOT, to stream real time data streamRealTimeData(...) has been introduced. The getRealTimeData(..) method has been phased out. See the usage guide here.
2. To stream snapshot data streamRealTimeSnapshotData(..) has been introduced. The getRealTimeSnapshotData() method has been phased out.See the usage guide here.

To run the corresponding test file, clone the snapshot branch of the repository to your computer.Navigate to the dhelm-gfeed-client/dhelm-gfeed-client-test/target folder. From the command line run the following command:
java -jar dhelm-gfeedtest-1.0.1-launcher.jar <WEB_SOCKET_URL> <API_KEY>
where you should replace
<WEB_SOCKET_URL> with the web socket url
and
<API_KEY> with the api key which you have got at the time of subscription.

[NB: v1.0.1-SNAPSHOT is still under testing phase.]
If you have any query raise an issue or email at [email protected]. To know about dhelm project visit our project website at https://dhelm.kncsolutions.in