Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/quedexnet/java-api
Trading API for Quedex Bitcoin Derivatives Exchange.
https://github.com/quedexnet/java-api
algo-trading api bitcoin derivatives exchange java market-maker quedex
Last synced: 2 months ago
JSON representation
Trading API for Quedex Bitcoin Derivatives Exchange.
- Host: GitHub
- URL: https://github.com/quedexnet/java-api
- Owner: quedexnet
- License: apache-2.0
- Created: 2016-07-22T10:07:02.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2020-05-28T17:26:27.000Z (over 4 years ago)
- Last Synced: 2024-04-17T22:55:59.795Z (9 months ago)
- Topics: algo-trading, api, bitcoin, derivatives, exchange, java, market-maker, quedex
- Language: Java
- Homepage: https://quedex.net/
- Size: 327 KB
- Stars: 11
- Watchers: 10
- Forks: 8
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Quedex Official Java API
> The best way to communicate with [Quedex Bitcoin Derivatives Exchange](https://quedex.net)
using Java.
## Important!
* Next to this documentation, please read the [general documentation](https://quedex.net/doc/api) of our WebSocket API.
* Quedex Exchange uses an innovative [schedule of session states][faq-session-schedule]. Some
session states employ different order matching model - namely, [Auction][faq-what-is-auction].
Please consider this when placing orders.
## Getting the API
Include in your project as a Maven dependency:
```
net.quedex
java-api
0.7.0
```
## Using the API:
To use the API you need to provide a configuration - the default way to do that is via a `.properties` file. An example
may be found in [qdxConfig.properties.example][example-config] - rename this file to `qdxConfig.propertie`, place on
your classpath and fill in the following (the rest of the properties is done):
* `net.quedex.client.api.accountId`
* `net.quedex.client.api.userPrivateKey`
You may find your account id and encrypted private key in our web application - on the trading dashboard select the
dropdown menu with your email address in the upper right corner and go to User Profile (equivalent to visiting
https://quedex.app/profile when logged in).
Now you are ready to start hacking:
```java
char[] pwd = ... // read private key passphrase
Config qdxConfig = Config.fromResource(pwd); // initialise the config from qdxConfig.properties using one of the factory methods
MarketStream marketStream = new WebsocketMarketStream(qdxConfig);
UserStream userStream = new WebsocketUserStream(qdxConfig);
// register stream failure listeners
marketStream.registerStreamFailureListener(...);
userStream.registerStreamFailureListener(...)
// start streams
marketStream.start();
userStream.start();
// receive tradable instruments
marketStream.registerInstrumentsListener(instruments -> {
// register and subscribe other market stream listeners
marketStream.registerQuotesListener(...).subscribe(instruments.keySet()); // to subscribe all instruments
marketStream.register*(...).subscribe(...);
});
// register user stream listeners
userStream.registerOpenPositionListener(...);
userStream.register*(...);
// subscribe user stream listeners; see Javadoc for details
userStream.subscribeListeners();
// play with the streams: receive events, place orders and so on
userStream.placeOrder(...);
userStream.batch()
.placeOrder(...)
...
.send();
...
// once finished, stop the streams
userStream.stop();
marketStream.stop();
```
## Contributing Guide
Default channel for submitting **questions regarding the API** is [opening new issues][new-issue].
In cases when information disclosure is not possible, you can contact us at [email protected].
In case you need to add a feature to the API, please [submit an issue][new-issue]
containing change proposal before submitting a PR.
Pull requests containing bugfixes are very welcome!
## License
Copyright © 2017-2019 Quedex Ltd. API is released under [Apache License Version 2.0](LICENSE).
[inverse-notation-docs]: https://quedex.net/doc/inverse_notation
[faq-session-schedule]: https://quedex.net/faq#session_schedule
[faq-what-is-auction]: https://quedex.net/faq#what_is_auction
[example-config]: src/main/resources/qdxConfig.properties.example
[new-issue]: https://github.com/quedexnet/python-api/issues/new