{"id":18349797,"url":"https://github.com/quedexnet/java-api","last_synced_at":"2025-04-06T09:32:17.062Z","repository":{"id":57737640,"uuid":"63944035","full_name":"quedexnet/java-api","owner":"quedexnet","description":"Trading API for Quedex Bitcoin Derivatives Exchange.","archived":false,"fork":false,"pushed_at":"2020-05-28T17:26:27.000Z","size":335,"stargazers_count":11,"open_issues_count":4,"forks_count":8,"subscribers_count":9,"default_branch":"master","last_synced_at":"2025-03-21T21:51:11.855Z","etag":null,"topics":["algo-trading","api","bitcoin","derivatives","exchange","java","market-maker","quedex"],"latest_commit_sha":null,"homepage":"https://quedex.net/","language":"Java","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/quedexnet.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2016-07-22T10:07:02.000Z","updated_at":"2022-10-16T18:21:20.000Z","dependencies_parsed_at":"2022-08-24T12:51:06.687Z","dependency_job_id":null,"html_url":"https://github.com/quedexnet/java-api","commit_stats":null,"previous_names":[],"tags_count":6,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/quedexnet%2Fjava-api","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/quedexnet%2Fjava-api/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/quedexnet%2Fjava-api/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/quedexnet%2Fjava-api/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/quedexnet","download_url":"https://codeload.github.com/quedexnet/java-api/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247463745,"owners_count":20942935,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["algo-trading","api","bitcoin","derivatives","exchange","java","market-maker","quedex"],"created_at":"2024-11-05T21:23:38.742Z","updated_at":"2025-04-06T09:32:16.747Z","avatar_url":"https://github.com/quedexnet.png","language":"Java","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Quedex Official Java API\n\n\u003e The best way to communicate with [Quedex Bitcoin Derivatives Exchange](https://quedex.net)\nusing Java.\n\n## Important!\n\n* Next to this documentation, please read the [general documentation](https://quedex.net/doc/api) of our WebSocket API.\n* Quedex Exchange uses an innovative [schedule of session states][faq-session-schedule]. Some\n  session states employ different order matching model - namely, [Auction][faq-what-is-auction].\n  Please consider this when placing orders.\n\n## Getting the API\n\nInclude in your project as a Maven dependency:\n\n```\n\u003cdependency\u003e\n    \u003cgroupId\u003enet.quedex\u003c/groupId\u003e\n    \u003cartifactId\u003ejava-api\u003c/artifactId\u003e\n    \u003cversion\u003e0.7.0\u003c/version\u003e\n\u003c/dependency\u003e\n\n```\n\n## Using the API:\n\nTo use the API you need to provide a configuration - the default way to do that is via a `.properties` file. An example\nmay be found in [qdxConfig.properties.example][example-config] - rename this file to `qdxConfig.propertie`, place on\nyour classpath and fill in the following (the rest of the properties is done):\n* `net.quedex.client.api.accountId`\n* `net.quedex.client.api.userPrivateKey`\n\nYou may find your account id and encrypted private key in our web application - on the trading dashboard select the\ndropdown menu with your email address in the upper right corner and go to User Profile (equivalent to visiting\nhttps://quedex.app/profile when logged in).\n\nNow you are ready to start hacking:\n\n```java\nchar[] pwd = ... // read private key passphrase\nConfig qdxConfig = Config.fromResource(pwd); // initialise the config from qdxConfig.properties using one of the factory methods\n\nMarketStream marketStream = new WebsocketMarketStream(qdxConfig);\nUserStream userStream = new WebsocketUserStream(qdxConfig);\n\n// register stream failure listeners\nmarketStream.registerStreamFailureListener(...);\nuserStream.registerStreamFailureListener(...)\n\n// start streams\nmarketStream.start();\nuserStream.start();\n\n// receive tradable instruments\nmarketStream.registerInstrumentsListener(instruments -\u003e {\n\n    // register and subscribe other market stream listeners\n    marketStream.registerQuotesListener(...).subscribe(instruments.keySet()); // to subscribe all instruments\n    marketStream.register*(...).subscribe(...);\n});\n\n// register user stream listeners\nuserStream.registerOpenPositionListener(...);\nuserStream.register*(...);\n\n// subscribe user stream listeners; see Javadoc for details\nuserStream.subscribeListeners();\n\n// play with the streams: receive events, place orders and so on\nuserStream.placeOrder(...);\nuserStream.batch()\n    .placeOrder(...)\n    ...\n    .send();\n...\n\n// once finished, stop the streams\nuserStream.stop();\nmarketStream.stop();\n```\n\n## Contributing Guide\n\nDefault channel for submitting **questions regarding the API** is [opening new issues][new-issue].\nIn cases when information disclosure is\u0026nbsp;not possible, you can contact us at support@quedex.net.\n\nIn case you need to add a feature to the API, please [submit an issue][new-issue]\ncontaining change proposal before submitting a PR.\n\nPull requests containing bugfixes are very welcome!\n\n## License\n\nCopyright \u0026copy; 2017-2019 Quedex Ltd. API is released under [Apache License Version 2.0](LICENSE).\n\n[inverse-notation-docs]: https://quedex.net/doc/inverse_notation\n[faq-session-schedule]: https://quedex.net/faq#session_schedule\n[faq-what-is-auction]: https://quedex.net/faq#what_is_auction\n[example-config]: src/main/resources/qdxConfig.properties.example\n[new-issue]: https://github.com/quedexnet/python-api/issues/new\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fquedexnet%2Fjava-api","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fquedexnet%2Fjava-api","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fquedexnet%2Fjava-api/lists"}