mzoe/ritmex-bot
1
0
Fork 0
mirror of https://github.com/discountry/ritmex-bot.git synced 2026-09-09 08:18:07 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
9538ecf2658350636f35a54edb91fcb0146b3fc4
ritmex-bot/docs/binance/binance-spot/README.md
T
DisneyandGitHub d6399b92aa 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.
2026-02-27 11:37:44 +08:00

9.1 KiB
Raw Blame History

title, source, fetched_at
title source fetched_at
Readme | Binance Open Platform https://developers.binance.com/docs/binance-spot-api-docs/README 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
  • 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

Details on the enums used by REST and WebSocket API

errors.md

Error codes and messages of Spot API

filters.md

Details on the filters used by Spot API

rest-api.md

Spot REST API (/api)

web-socket-api.md

Spot WebSocket API

fix-api.md

FIX API

web-socket-streams.md

Spot Market Data WebSocket streams

sbe-market-data-streams.md

SBE Market Data Streams

user-data-stream.md

Spot User Data WebSocket streams

sbe_schemas

Spot Simple Binary Encoding (SBE) schemas

testnet

API docs for features available only on SPOT Testnet

demo-mode

Page regarding Demo Mode

Margin Trading

Details on Margin Trading

Derivative UM Futures

Details on Derivative UM Futures (/fapi)

Derivative CM Futures

Details on Derivative CM Futures (/dapi)

Derivative Options

Details on Derivative European Options (/eapi)

Derivative Portfolio Margin

Details on Derivative Portfolio Margin (/papi)

Wallet

Details on Wallet endpoints (/sapi)

Sub Account

Details on Sub-Account requests (/sapi)

Simple Earn

Details on Simple Earn

Dual Investment

Details on Dual Investment

Auto Invest

Details on Auto Invest

Staking

Details on Staking

Mining

Details on Mining

Algo Trading

Details on Algo Trading

Copy Trading

Details on Copy Trading

Portfolio Margin Pro

Details on Portfolio Margin Pro

Fiat

Details on Fiat

C2C

Details on C2C

VIP Loan

Details on VIP Loan

Crypto Loan

Details on Crypto Loan

Pay

Details on Binance Pay

Convert

Details on Convert API

Rebate

Details on Spot Rebate

NFT

Details on NFT requests

Gift Card

Details on Gift Card API

FAQ​

Name

Description

api_key_types

API Key Types

spot_glossary

Definition of terms used in the API

commission_faq

Explaining commission calculations on the API

trailing-stop-faq

Detailed Information on the behavior of Trailing Stops on the API

stp_faq

Detailed Information on the behavior of Self Trade Prevention (aka STP) on the API

market_orders_faq

Detailed information on the behavior of Market Orders

market-data-only

Information on our market data only API and WebSocket streams.

sor_faq

Smart Order Routing (SOR)

order_count_decrement

Updates to the Spot Order Count Limit Rules.

order_amend_keep_priority

Detailed Information on the behavior of Order Amend Keep Priority

pegged_orders

Detailed Information on Pegged Orders

sbe_faq

Information on the implementation of Simple Binary Encoding (SBE) on the API

Change log​

Please refer to CHANGELOG for latest changes on our APIs and Streamers.

Useful Resources​

  • Postman Collections
    • Postman collections are available, and they are recommended for new users seeking a quick and easy start with the API.
  • Connectors
  • FIX Connector - This provides access to the exchange using the FIX protocol.
  • Swagger
    • A YAML file with OpenAPI specification for the RESTful API is available, along with a Swagger UI page for reference.
  • Spot Testnet
    • 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​

Reference in New Issue View Git Blame Copy Permalink