mirror of
https://github.com/discountry/ritmex-bot.git
synced 2026-09-09 08:18:07 +00:00
DisneyandGitHub
d6399b92aa
* 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.
256 lines
9.1 KiB
Markdown
256 lines
9.1 KiB
Markdown
---
|
||
title: "Readme | Binance Open Platform"
|
||
source: "https://developers.binance.com/docs/binance-spot-api-docs/README"
|
||
fetched_at: "2026-02-26T10:38:06.666Z"
|
||
---
|
||
# Official Documentation for the Binance APIs and Streams.
|
||
|
||
- Official Announcements regarding changes, downtime, etc. to the API and Streams will be reported here: **[https://t.me/binance\_api\_announcements](https://t.me/binance_api_announcements)**
|
||
- Streams, endpoints, parameters, payloads, etc. described in the documents in this repository are considered **official** and **supported**.
|
||
- The use of any other streams, endpoints, parameters, or payloads, etc. is **not supported**; **use them at your own risk and with no guarantees.**
|
||
|
||
Name
|
||
|
||
Description
|
||
|
||
[enums.md](https://developers.binance.com/docs/binance-spot-api-docs/enums)
|
||
|
||
Details on the enums used by REST and WebSocket API
|
||
|
||
[errors.md](https://developers.binance.com/docs/binance-spot-api-docs/errors)
|
||
|
||
Error codes and messages of Spot API
|
||
|
||
[filters.md](https://developers.binance.com/docs/binance-spot-api-docs/filters)
|
||
|
||
Details on the filters used by Spot API
|
||
|
||
[rest-api.md](https://developers.binance.com/docs/binance-spot-api-docs/rest-api)
|
||
|
||
Spot REST API (`/api`)
|
||
|
||
[web-socket-api.md](https://developers.binance.com/docs/binance-spot-api-docs/websocket-api)
|
||
|
||
Spot WebSocket API
|
||
|
||
[fix-api.md](https://developers.binance.com/docs/binance-spot-api-docs/fix-api)
|
||
|
||
FIX API
|
||
|
||
[web-socket-streams.md](https://developers.binance.com/docs/binance-spot-api-docs/web-socket-streams)
|
||
|
||
Spot Market Data WebSocket streams
|
||
|
||
[sbe-market-data-streams.md](https://developers.binance.com/docs/binance-spot-api-docs/sbe-market-data-streams)
|
||
|
||
SBE Market Data Streams
|
||
|
||
[user-data-stream.md](https://developers.binance.com/docs/binance-spot-api-docs/user-data-stream)
|
||
|
||
Spot User Data WebSocket streams
|
||
|
||
[sbe\_schemas](https://developers.binance.com/docs/binance-spot-api-docs/sbe/schemas)
|
||
|
||
Spot Simple Binary Encoding (SBE) schemas
|
||
|
||
[testnet](https://developers.binance.com/docs/binance-spot-api-docs/testnet)
|
||
|
||
API docs for features available only on SPOT Testnet
|
||
|
||
[demo-mode](https://developers.binance.com/docs/binance-spot-api-docs/demo-mode)
|
||
|
||
Page regarding Demo Mode
|
||
|
||
[Margin Trading](https://developers.binance.com/docs/margin_trading)
|
||
|
||
Details on Margin Trading
|
||
|
||
[Derivative UM Futures](https://developers.binance.com/docs/derivatives/usds-margined-futures/general-info)
|
||
|
||
Details on Derivative UM Futures (`/fapi`)
|
||
|
||
[Derivative CM Futures](https://developers.binance.com/docs/derivatives/coin-margined-futures/general-info)
|
||
|
||
Details on Derivative CM Futures (`/dapi`)
|
||
|
||
[Derivative Options](https://developers.binance.com/docs/derivatives/option/general-info)
|
||
|
||
Details on Derivative European Options (`/eapi`)
|
||
|
||
[Derivative Portfolio Margin](https://developers.binance.com/docs/derivatives/portfolio-margin/general-info)
|
||
|
||
Details on Derivative Portfolio Margin (`/papi`)
|
||
|
||
[Wallet](https://developers.binance.com/docs/wallet)
|
||
|
||
Details on Wallet endpoints (`/sapi`)
|
||
|
||
[Sub Account](https://developers.binance.com/docs/sub_account/general-info)
|
||
|
||
Details on Sub-Account requests (`/sapi`)
|
||
|
||
[Simple Earn](https://developers.binance.com/docs/simple_earn/general-info)
|
||
|
||
Details on Simple Earn
|
||
|
||
[Dual Investment](https://developers.binance.com/docs/dual_investment)
|
||
|
||
Details on Dual Investment
|
||
|
||
[Auto Invest](https://developers.binance.com/docs/auto_invest)
|
||
|
||
Details on Auto Invest
|
||
|
||
[Staking](https://developers.binance.com/docs/staking)
|
||
|
||
Details on Staking
|
||
|
||
[Mining](https://developers.binance.com/docs/mining)
|
||
|
||
Details on Mining
|
||
|
||
[Algo Trading](https://developers.binance.com/docs/algo)
|
||
|
||
Details on Algo Trading
|
||
|
||
[Copy Trading](https://developers.binance.com/docs/copy_trading)
|
||
|
||
Details on Copy Trading
|
||
|
||
[Portfolio Margin Pro](https://developers.binance.com/docs/derivatives/portfolio-margin-pro/general-info)
|
||
|
||
Details on Portfolio Margin Pro
|
||
|
||
[Fiat](https://developers.binance.com/docs/fiat)
|
||
|
||
Details on Fiat
|
||
|
||
[C2C](https://developers.binance.com/docs/c2c)
|
||
|
||
Details on C2C
|
||
|
||
[VIP Loan](https://developers.binance.com/docs/vip_loan)
|
||
|
||
Details on VIP Loan
|
||
|
||
[Crypto Loan](https://developers.binance.com/docs/crypto_loan)
|
||
|
||
Details on Crypto Loan
|
||
|
||
[Pay](https://developers.binance.com/docs/binance-pay)
|
||
|
||
Details on Binance Pay
|
||
|
||
[Convert](https://developers.binance.com/docs/convert)
|
||
|
||
Details on Convert API
|
||
|
||
[Rebate](https://developers.binance.com/docs/rebate)
|
||
|
||
Details on Spot Rebate
|
||
|
||
[NFT](https://developers.binance.com/docs/nft)
|
||
|
||
Details on NFT requests
|
||
|
||
[Gift Card](https://developers.binance.com/docs/gift_card)
|
||
|
||
Details on Gift Card API
|
||
|
||
### FAQ[](https://developers.binance.com/docs/binance-spot-api-docs/README)
|
||
|
||
Name
|
||
|
||
Description
|
||
|
||
[api\_key\_types](https://developers.binance.com/docs/binance-spot-api-docs/faqs/api_key_types)
|
||
|
||
API Key Types
|
||
|
||
[spot\_glossary](https://developers.binance.com/docs/binance-spot-api-docs/faqs/spot_glossary)
|
||
|
||
Definition of terms used in the API
|
||
|
||
[commission\_faq](https://developers.binance.com/docs/binance-spot-api-docs/faqs/commission_faq)
|
||
|
||
Explaining commission calculations on the API
|
||
|
||
[trailing-stop-faq](https://developers.binance.com/docs/binance-spot-api-docs/faqs/trailing-stop-faq)
|
||
|
||
Detailed Information on the behavior of Trailing Stops on the API
|
||
|
||
[stp\_faq](https://developers.binance.com/docs/binance-spot-api-docs/faqs/stp_faq)
|
||
|
||
Detailed Information on the behavior of Self Trade Prevention (aka STP) on the API
|
||
|
||
[market\_orders\_faq](https://developers.binance.com/docs/binance-spot-api-docs/faqs/market_orders_faq.md)
|
||
|
||
Detailed information on the behavior of Market Orders
|
||
|
||
[market-data-only](https://developers.binance.com/docs/binance-spot-api-docs/faqs/market_data_only)
|
||
|
||
Information on our market data only API and WebSocket streams.
|
||
|
||
[sor\_faq](https://developers.binance.com/docs/binance-spot-api-docs/faqs/sor_faq)
|
||
|
||
Smart Order Routing (SOR)
|
||
|
||
[order\_count\_decrement](https://developers.binance.com/docs/binance-spot-api-docs/faqs/order_count_decrement)
|
||
|
||
Updates to the Spot Order Count Limit Rules.
|
||
|
||
[order\_amend\_keep\_priority](https://developers.binance.com/docs/binance-spot-api-docs/faqs/order_amend_keep_priority)
|
||
|
||
Detailed Information on the behavior of Order Amend Keep Priority
|
||
|
||
[pegged\_orders](https://developers.binance.com/docs/binance-spot-api-docs/faqs/pegged_orders)
|
||
|
||
Detailed Information on Pegged Orders
|
||
|
||
[sbe\_faq](https://developers.binance.com/docs/binance-spot-api-docs/faqs/sbe_faq)
|
||
|
||
Information on the implementation of Simple Binary Encoding (SBE) on the API
|
||
|
||
### Change log[](https://developers.binance.com/docs/binance-spot-api-docs/README)
|
||
|
||
Please refer to [CHANGELOG](https://developers.binance.com/docs/binance-spot-api-docs/CHANGELOG) for latest changes on our APIs and Streamers.
|
||
|
||
### Useful Resources[](https://developers.binance.com/docs/binance-spot-api-docs/README)
|
||
|
||
- [Postman Collections](https://github.com/binance/binance-api-postman)
|
||
- Postman collections are available, and they are recommended for new users seeking a quick and easy start with the API.
|
||
- Connectors
|
||
- The following are lightweight libraries that work as connectors to the Binance public API, written in different languages:
|
||
- [Python](https://github.com/binance/binance-connector-python)
|
||
- [Node.js](https://github.com/binance/binance-connector-node)
|
||
- [Ruby](https://github.com/binance/binance-connector-ruby)
|
||
- [DotNET C#](https://github.com/binance/binance-connector-dotnet)
|
||
- [Java](https://github.com/binance/binance-connector-java)
|
||
- [Rust](https://github.com/binance/binance-spot-connector-rust)
|
||
- [PHP](https://github.com/binance/binance-connector-php)
|
||
- [Go](https://github.com/binance/binance-connector-go)
|
||
- [TypeScript](https://github.com/binance/binance-connector-typescript)
|
||
- FIX Connector - This provides access to the exchange using the FIX protocol.
|
||
- [Python](https://github.com/binance/binance-fix-connector-python)
|
||
- [Swagger](https://github.com/binance/binance-api-swagger)
|
||
- A YAML file with OpenAPI specification for the RESTful API is available, along with a Swagger UI page for reference.
|
||
- [Spot Testnet](https://testnet.binance.vision/)
|
||
- Users can use the SPOT Testnet to practice SPOT trading.
|
||
- Currently, this is only available via the API.
|
||
- Only endpoints starting with `/api/*` are supported, `/sapi/*` is not supported.
|
||
|
||
### Contact Us[](https://developers.binance.com/docs/binance-spot-api-docs/README)
|
||
|
||
- [Binance API Telegram Group](https://t.me/binance_api_english)
|
||
- For any questions regarding sudden drop in performance with the API and/or WebSockets.
|
||
- For any general questions about the API not covered in the documentation.
|
||
- [Binance Developers](https://dev.binance.vision/)
|
||
- For any questions/help regarding code implementation with API and/or WebSockets.
|
||
- [Binance Customer Support](https://www.binance.com/en/support-center)
|
||
- For cases such as missing funds, help with 2FA, etc.
|
||
|
||
- [FAQ](https://developers.binance.com/docs/binance-spot-api-docs/README)
|
||
- [Change log](https://developers.binance.com/docs/binance-spot-api-docs/README)
|
||
- [Useful Resources](https://developers.binance.com/docs/binance-spot-api-docs/README)
|
||
- [Contact Us](https://developers.binance.com/docs/binance-spot-api-docs/README)
|