repository·master·Indexed 26 days ago
https://github.com/binance/binance-spot-api-docsOfficial documentation for the Binance Spot API, providing technical specifications for REST, WebSocket, FIX, and SBE interfaces. Includes guides for core API modules, specialized APIs for Wallet and Sub Accounts, and official connectors for Python, Node.js, Ruby, DotNET C#, Java, Rust, PHP, Go, and TypeScript. Covers endpoints, parameters, payloads, error codes, and the SPOT Testnet environment.
The FIX (Financial Information eXchange) API is a high-performance interface available exclusively for the SPOT Exchange. It supports multiple session types including Order Entry, Drop Copy, and Market Data. The API can be implemented using NodeJS or custom TLS implementations in other languages.
Note: This API is restricted to the SPOT Exchange only.
Pegged orders (also known as Best Bid-Offer or BBO orders) are essentially Limit orders where the price is derived from the current order book rather than a fixed value.
They allow you to:
This mechanism helps market makers match prices with minimal latency and helps retail users achieve best execution with minimized slippage.
The API is asynchronous, and data retrieval latency varies depending on the data source. Sources are ordered from least to most potential for delay:
Some endpoints use multiple sources (e.g., Memory => Database), checking the first source and falling back to the next if the value is not found.
Binance APIs use different authentication types based on the required permissions. If no type is specified next to an endpoint name, the type is NONE.
| Authentication Type | Description |
|---|---|
NONE | Public market data |
TRADE | Trading on the exchange (placing and canceling orders) |
USER_DATA | Private account information (e.g., order status, trade history) |
USER_STREAM | Managing user data stream subscriptions |
All endpoints with an authentication type other than NONE are considered SIGNED requests and require a signature parameter. API keys can be configured to allow only specific permissions (e.g., a key with TRADE permission for trading and another with USER_DATA for monitoring).
The Binance Spot API documentation is organized into several core technical modules. Use the following guides to navigate the API surface:
/api): Main endpoints for trading and account management.enums.md, errors.md, and filters.md./sapi): Wallet and account management./sapi): Sub-account management.Each endpoint has a security type indicating required API key permissions. If unspecified, the security type is NONE.
| Security type | Description |
|---|---|
NONE | Public market data |
TRADE | Trading on the exchange, placing and canceling orders |
USER_DATA | Private account information, such as order status and your trading history |
USER_STREAM | Managing User Data Stream subscriptions |
Secure endpoints require a valid API key. API keys can be configured with specific permissions (e.g., a TRADE key for trading and a separate USER_DATA key for monitoring). By default, an API key cannot TRADE until enabled in API Management.
NONE (public).Smart Order Routing (SOR) allows you to access better liquidity by filling an order using liquidity from multiple order books that share the same base asset and have interchangeable quote assets (e.g., stablecoins with a 1:1 exchange rate).
Key Behaviors:
BTCUSDC), you will always receive the quote asset of the symbol you originally submitted (e.g., USDT).LIMIT IOC or MARKET orders: If the SOR cannot fully fill the order using available liquidity across all eligible books, the remaining quantity expires immediately.LIMIT GTC orders: If the SOR cannot fully fill the order, the remaining quantity is placed on the original order book you submitted the order to.Binance FIX API messages consist of a Header, a Body (containing message-specific tags), and a Trailer.
Note on Delimiters: In documentation examples, the | character represents the SOH (Start of Header) character used in actual FIX protocol messages.
Example Message:
8=FIX.4.4|9=113|35=A|34=1|49=SPOT|52=20240612-08:52:21.636837|56=5JQmUOsm|98=0|108=30|25037=4392a152-3481-4499-921a-6d42c50702e2|10=051|Because the API system is asynchronous, data latency is expected. Data sources are ranked by update speed (fastest to slowest):
Some endpoints may list multiple sources (e.g., Cache => Database), meaning the system checks the cache first and falls back to the database if no data is found.
The documentation is organized into several specialized modules for Spot trading and related services:
/api): Interface definitions for RESTful requests./fapi), Coin-M Futures (/dapi), Options (/eapi), and Portfolio Margin (/papi)./sapi endpoints.The Binance Spot API documentation provides definitions for interfaces, data streams, parameters, and responses.
Important Notes: