mirror of
https://github.com/discountry/ritmex-bot.git
synced 2026-09-11 01:08:07 +00:00
Feat/support binance (#22)
* add docs * Add Binance exchange support - Updated the environment configuration to include Binance as a selectable exchange option. - Enhanced the README documentation to reflect the addition of Binance. - Implemented the Binance exchange adapter and integrated it into the existing exchange framework. - Modified the basis arbitrage strategy to support Binance alongside existing exchanges. - Added tests to ensure proper functionality and integration of Binance within the trading system. * Enhance README with detailed Binance exchange configuration - Added comprehensive instructions for setting up Binance as an exchange option. - Included environment variable specifications for API keys, market types, and trading symbols. - Provided examples for both perpetual and spot trading strategies. - Clarified the use of WebSocket and REST for the Binance adapter. * Enhance exchange support and testing framework - Added a new test suite for exchange contracts to ensure consistency and functionality across supported exchanges. - Refactored exchange ID handling to utilize a centralized list of supported exchanges, improving maintainability. - Updated CLI argument parsing and help documentation to reflect the new exchange structure. - Introduced utility functions for validating supported exchanges and their display names. - Enhanced the BasisApp and strategy runner to leverage the new exchange validation logic. - Added a new test command for running exchange-related tests. * Refactor exchange contract tests and update CLI commands - Removed the trailing supported exchanges set and simplified the logic for trailing stop support in the exchange contract tests. - Updated the test command for exchange contracts to exclude unnecessary tests, streamlining the testing process. - Enhanced test descriptions for clarity and improved understanding of the functionality being tested.
This commit is contained in:
@@ -0,0 +1,64 @@
|
||||
---
|
||||
title: "Quick Start | Binance Open Platform"
|
||||
source: "https://developers.binance.com/docs/derivatives/quick-start"
|
||||
fetched_at: "2026-01-27T05:28:24.271Z"
|
||||
---
|
||||
# Quick Start
|
||||
|
||||
## API Key Setup[](https://developers.binance.com/docs/derivatives/quick-start)
|
||||
|
||||
- Some endpoints will require an API Key. Please refer to [this page](https://www.binance.com/en/support/faq/how-to-create-api-keys-on-binance-360002502072) regarding API key creation.
|
||||
- Once API key is created, it is recommended to set IP restrictions on the key for security reasons.
|
||||
- **Never share your API key/secret key to ANYONE.**
|
||||
|
||||
## API Key Restrictions[](https://developers.binance.com/docs/derivatives/quick-start)
|
||||
|
||||
- After creating the API key, the default restrictions is `Enable Reading`.
|
||||
- To **enable withdrawals via the API**, the API key restriction needs to be modified through the Binance UI.
|
||||
|
||||
## Enabling Accounts[](https://developers.binance.com/docs/derivatives/quick-start)
|
||||
|
||||
### Account[](https://developers.binance.com/docs/derivatives/quick-start)
|
||||
|
||||
A `SPOT` account is provided by default upon creation of a Binance Account.
|
||||
|
||||
### Futures Account[](https://developers.binance.com/docs/derivatives/quick-start)
|
||||
|
||||
To enable a `FUTURES` account for Futures Trading, please refer to the [Futures Trading Guide](https://www.binance.com/en/support/faq/a-beginner-s-guide-to-futures-trading-website-360039304272)
|
||||
|
||||
### Futures Testnet[](https://developers.binance.com/docs/derivatives/quick-start)
|
||||
|
||||
Users can use the Futures Testnet to practice `FUTURES` trading.
|
||||
|
||||
Currently, this is only available via the API.
|
||||
|
||||
Please refer to the [Futures Testnet page](https://testnet.binancefuture.com/en/futures/BTCUSDT) for more information and how to set up the Testnet API key.
|
||||
|
||||
### Option Account[](https://developers.binance.com/docs/derivatives/quick-start)
|
||||
|
||||
To enable a `OPTION` account for Option Trading, please refer to the [Option Trading Guide](https://www.binance.com/en/support/faq/introduction-to-binance-options-374321c9317c473480243365298b8706)
|
||||
|
||||
## API Library[](https://developers.binance.com/docs/derivatives/quick-start)
|
||||
|
||||
### Python connector[](https://developers.binance.com/docs/derivatives/quick-start)
|
||||
|
||||
This is a lightweight library that works as a connector to Binance public API, written in Python.
|
||||
|
||||
[https://github.com/binance/binance-connector-python](https://github.com/binance/binance-connector-python)
|
||||
|
||||
### Java connector[](https://developers.binance.com/docs/derivatives/quick-start)
|
||||
|
||||
This is a lightweight library that works as a connector to Binance public API, written for Java users.
|
||||
|
||||
[https://github.com/binance/binance-connector-java](https://github.com/binance/binance-connector-java)
|
||||
|
||||
- [API Key Setup](https://developers.binance.com/docs/derivatives/quick-start)
|
||||
- [API Key Restrictions](https://developers.binance.com/docs/derivatives/quick-start)
|
||||
- [Enabling Accounts](https://developers.binance.com/docs/derivatives/quick-start)
|
||||
- [Account](https://developers.binance.com/docs/derivatives/quick-start)
|
||||
- [Futures Account](https://developers.binance.com/docs/derivatives/quick-start)
|
||||
- [Futures Testnet](https://developers.binance.com/docs/derivatives/quick-start)
|
||||
- [Option Account](https://developers.binance.com/docs/derivatives/quick-start)
|
||||
- [API Library](https://developers.binance.com/docs/derivatives/quick-start)
|
||||
- [Python connector](https://developers.binance.com/docs/derivatives/quick-start)
|
||||
- [Java connector](https://developers.binance.com/docs/derivatives/quick-start)
|
||||
Reference in New Issue
Block a user