{"id":18349791,"url":"https://github.com/quedexnet/python-api","last_synced_at":"2025-08-22T05:37:52.837Z","repository":{"id":22708504,"uuid":"97019823","full_name":"quedexnet/python-api","owner":"quedexnet","description":"Trading API for Quedex Bitcoin Derivatives Exchange.","archived":false,"fork":false,"pushed_at":"2022-12-02T03:19:12.000Z","size":325,"stargazers_count":20,"open_issues_count":9,"forks_count":11,"subscribers_count":10,"default_branch":"master","last_synced_at":"2025-07-16T15:05:36.675Z","etag":null,"topics":["algo-trading","api","autobahn","bitcoin","bitcoin-futures","bitcoin-options","derivatives","exchange","futures","market-maker","options","python","quedex","trading","twisted"],"latest_commit_sha":null,"homepage":"https://quedex.net/","language":"Python","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":"2017-07-12T14:51:10.000Z","updated_at":"2023-04-14T02:00:26.000Z","dependencies_parsed_at":"2022-08-28T06:33:24.740Z","dependency_job_id":null,"html_url":"https://github.com/quedexnet/python-api","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/quedexnet/python-api","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/quedexnet%2Fpython-api","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/quedexnet%2Fpython-api/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/quedexnet%2Fpython-api/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/quedexnet%2Fpython-api/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/quedexnet","download_url":"https://codeload.github.com/quedexnet/python-api/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/quedexnet%2Fpython-api/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":268157898,"owners_count":24204763,"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","status":"online","status_checked_at":"2025-08-01T02:00:08.611Z","response_time":67,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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","autobahn","bitcoin","bitcoin-futures","bitcoin-options","derivatives","exchange","futures","market-maker","options","python","quedex","trading","twisted"],"created_at":"2024-11-05T21:23:37.692Z","updated_at":"2025-08-01T02:17:27.596Z","avatar_url":"https://github.com/quedexnet.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Quedex Official Python API\n\n\u003ca href=\"https://travis-ci.org/quedexnet/python-api/\"\u003e\u003cimg src=\"https://travis-ci.org/quedexnet/python-api.svg?branch=master\" align=right\u003e\u003c/a\u003e\n\n\u003e The best way to communicate with [Quedex Bitcoin Derivatives Exchange](https://quedex.net)\nusing Python.\n\n## Show Me Some Code\n\nGo straight to our [Simple Trading Tutorial][simple_trading.py.md].\n\n## Why Is This Cool?\n\n * The API hides all technical concerns (transmission, encryption, serialization,\n   threading and connection) from the user so that all programming efforts may be\n   **concentrated on trading logic**.\n * We provide classes for easy integration with [Twisted][twisted] which is one of the best\n   frameworks for programming network communication in Python. Twisted uses asynchronuous\n   input/output which makes our API quite fast.\n * [Simple Trading Tutorial][simple_trading.py.md] is written in literate programming style\n   and translates to [simple_trading.py][simple_trading.py] script which is a\u0026nbsp;ready-to-run\n   example of using the API. The same file is also used in API's end-to-end test.\n * The API is fully compatible with Python 2 and 3.\n\n## Important!\n\n* Next to this documentation, please read the [general documentation](https://quedex.net/doc/api) \n  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\nTo use the API in your Python project include the following in your requirements file\n(when installing with `pip`):\n\n```\n-e git+https://github.com/quedexnet/python-api.git@8bdde08#egg=quedex_api\n```\n\n## Documentation\n\nThe fastest way of getting to know the API is by looking at the\n[Simple Trading Tutorial][simple_trading.py.md]. It shows how to set everything up using\n[Autobahn][autobahn] on top of [Twisted][twisted], listen for exchange events\nand how to send trading commands.\nIf you prefer working with bare code, you can take a look at\n[examples/simple_trading.py][simple_trading.py] (it is generated from the tutorial).\n\n**Documentation of the API** can be found in [the code][code] (mostly in\n[`MarketStream`][market_stream.py] and [`UserStream`][user_stream.py] classes).\nIntegration with Twisted is implemented in [`UserStreamClientProtocol`][user_stream_client.py]\nand [`MarketStreamClientProtocol`][market_stream_client.py] classes.\n\nThe API is designed to be flexible and may be used with various implementations of WebSockets\n(other than Twisted). To\u0026nbsp;this end, use [`MarketStream`][market_stream.py] and\n[`UserStream`][user_stream.py] with the WebSockets library of your choice.\n[`UserStreamClientProtocol`][user_stream_client.py] and [`MarketStreamClientProtocol`][\nmarket_stream_client.py] can be used as a reference on how to integrate [`MarketStream`][\nmarket_stream.py] and [`UserStream`][user_stream.py] classes with a WebSockets library.\n\n## Getting Credentials\n\nYou'll need to create an instance of `Trader` to use the API (for details see \n[Simple Trading Tutorial][simple_trading.py.md]). `Trader` needs to be provided with your account id\nand encrypted private key - you may find them in our web  application - on the trading dashboard \nselect the dropdown menu with your email address in the upper right corner and go to User Profile \n(equivalent to visiting https://quedex.net/webapp/profile when logged in).\n\nThe `Exchange` entity needs to be provided with the URL of our API, which is `wss://api.quedex.net`\nand our public key which for your convenience is bundled with the API - just import it like so\n`from quedex_api import quedex_public_key`.\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[autobahn]: https://github.com/crossbario/autobahn-python\n[twisted]: https://www.twistedmatrix.com/\n[simple_trading.py.md]: docs/tutorials/simple_trading.py.md\n[simple_trading.py]: examples/simple_trading.py\n[code]: quedex_api\n[user_stream.py]: quedex_api/user_stream.py\n[market_stream.py]: quedex_api/market_stream.py\n[user_stream_client.py]: quedex_api/user_stream.py\n[market_stream_client.py]: quedex_api/market_stream.py\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[new-issue]: https://github.com/quedexnet/python-api/issues/new\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fquedexnet%2Fpython-api","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fquedexnet%2Fpython-api","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fquedexnet%2Fpython-api/lists"}