mzoe/ritmex-bot
1
0
Fork 0
mirror of https://github.com/discountry/ritmex-bot.git synced 2026-09-10 16:58:08 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
fb906be27c83d07f3475effa313c4b9b8cc4e5ad
ritmex-bot/docs/binance/binance-spot/faqs_sbe_faq.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

159 lines
12 KiB
Markdown
Raw Blame History

This file contains invisible Unicode characters
This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
---
title: "SBE FAQ | Binance Open Platform"
source: "https://developers.binance.com/docs/binance-spot-api-docs/faqs/sbe_faq"
fetched_at: "2026-02-26T10:38:07.910Z"
---
# Simple Binary Encoding (SBE) FAQ
The goal of this document is to explain:
- How to receive SBE responses in the SPOT API.
- How to decode SBE responses.
SBE is a serialization format used for low-latency.
This implementation is based on the FIX SBE specification.
- [GitHub repository](https://github.com/FIXTradingCommunity/fix-simple-binary-encoding)
- [HTML document](https://www.fixtrading.org/standards/sbe-online)
### How to get an SBE response[​](https://developers.binance.com/docs/binance-spot-api-docs/faqs/sbe_faq)
#### REST API[​](https://developers.binance.com/docs/binance-spot-api-docs/faqs/sbe_faq)
- The `Accept` header must include `application/sbe`.
- Provide the schema ID and version in the `X-MBX-SBE` header as `<ID>:<VERSION>`.
Sample request (REST):
```
curl -sX GET -H "Accept: application/sbe" -H "X-MBX-SBE: 1:0" 'https://api.binance.com/api/v3/exchangeInfo?symbol=BTCUSDT'
```
**Notes:**
- If you provide only `application/sbe` in the Accept header:
- If SBE is not enabled in the exchange, you will receive an HTTP **406 Not Acceptable**.
- If the `<ID>:<VERSION>` provided in the `X-MBX-SBE` header is malformed or invalid, the response will be an SBE-encoded error.
- If the `X-MBX-SBE` header is missing, the response will be an SBE-encoded error.
- If you provide both `application/sbe` and `application/json` in the Accept header:
- If SBE is not enabled in the exchange, the response will fall back to JSON.
- If the `<ID>:<VERSION>` provided in the `X-MBX-SBE` header is malformed or invalid, the response will fall back to JSON.
- If the `X-MBX-SBE` header is missing, the response will fall back to JSON.
#### WebSocket API[​](https://developers.binance.com/docs/binance-spot-api-docs/faqs/sbe_faq)
- In the connection URL, add `responseFormat=sbe`.
- Provide the schema ID and version in the parameters `sbeSchemaId=<SCHEMA_ID>` and `sbeSchemaVersion=<SCHEMA_VERSION>` respectively.
Sample request (WebSocket):
```
id=$(date +%s%3N)method="exchangeInfo"params='{"symbol":"BTCUSDT"}'request=$( jq -n \ --arg id "$id" \ --arg method "$method" \ --argjson params "$params" \ '{id: $id, method: $method, params: $params}' )response=$(echo $request | websocat -n1 'wss://ws-api.binance.com:443/ws-api/v3?responseFormat=sbe&sbeSchemaId=1&sbeSchemaVersion=0')
```
**Notes:**
- If you provide only `responseFormat=sbe` in the connection URL:
- If SBE is not enabled in the exchange, the response will be HTTP 400.
- If the `sbeSchemaId=<SCHEMA_ID>` or `sbeSchemaVersion=<SCHEMA_VERSION>` are malformed or invalid, the response will be HTTP 400.
- If you provide both `responseFormat=sbe` and `responseFormat=json`, the response will be HTTP 400.
- All error responses during the HTTP handshake are encoded as JSON with the `Content-Type` header set to `application/json;charset=UTF-8`.
- Once a WebSocket session has been successfully established with SBE enabled, all method responses within that session are encoded in SBE, even in the event SBE becomes disabled.
- This means that if SBE is disabled while your WebSocket connection is active, you will receive an SBE-encoded "SBE is not enabled" error in response to any subsequent request.
- As of writing, we do not recommend using `websocat` to send any request as we have observed issues in how it decodes binary frames. The sample above is only used for reference to show the URL to get an SBE response.
#### FIX API[​](https://developers.binance.com/docs/binance-spot-api-docs/faqs/sbe_faq)
See FIX API's [SBE section](https://developers.binance.com/docs/binance-spot-api-docs/fix-api) for detailed information.
Please continue reading below also.
### Supported APIs[​](https://developers.binance.com/docs/binance-spot-api-docs/faqs/sbe_faq)
REST API, WebSocket API and FIX API for SPOT support SBE.
### SBE Schema[​](https://developers.binance.com/docs/binance-spot-api-docs/faqs/sbe_faq)
- The schema to use both for the live exchange and SPOT Testnet will be saved in this repository [here](https://github.com/binance/binance-spot-api-docs/tree/master/sbe/schemas).
- Any updates to the schema will be noted in the [CHANGELOG](https://developers.binance.com/docs/binance-spot-api-docs/CHANGELOG).
### Regarding Legacy support[​](https://developers.binance.com/docs/binance-spot-api-docs/faqs/sbe_faq)
- SBE schemas are versioned via two XML attributes, `id` and `version`.
- `id` is incremented when a breaking change is introduced. When this occurs, `version` is reset to 0.
- `version` is incremented when a non-breaking change is introduced. When this occurs, `id` is not modified.
- When a new schema is live the old schema becomes deprecated. **Deprecation occurs even when the new schema only introduces non-breaking changes.**
- A deprecated schema will be supported **for at least 6 months after deprecation**.
For example given this hypothetical timeline:
- January 3024: Schema id 1 version 0 is released. This is the first version so this is usable once SBE is enabled in the exchange.
- March 3024: Schema id 1 version 1 is released. This schema introduces a non-breaking change.
- Schema id 1 version 0 is deprecated, but can still be used for at least another 6 months.
- August 3024: Schema id 2 version 0 is released. This schema introduces a breaking change.
- Schema id 1 version 0 is deprecated, but can still be used for at least another 1 month.
- Schema id 1 version 1 is deprecated, but can still be used for at least another 6 months.
- September 3024: 6 months have passed since the release of Schema id 1 version 1.
- Schema id 1 version 0 is retired.
- February 3025: Schema id 2 version 1 is released. This schema introduces a non-breaking change.
- Schema id 1 version 1 is retired.
- Schema id 2 version 0 is deprecated, but can still be used for at least another 6 months.
- For REST API requests specifying a deprecated `<ID>:<VERSION>` in their `X-MBX-SBE` header:
- the HTTP responses will contain a `X-MBX-SBE-DEPRECATED` header
- the SBE responses will be encoded in the highest compatible schema
- For example, as of 2025-08-27, requests for `X-MBX-SBE: 3:0` will receive responses encoded in schema `3:1`. An SBE decoder for schema `3:0` is expected to decode schema `3:1` gracefully as detailed in the [FIX SBE Specification](https://www.fixtrading.org/standards/sbe-online).
- For WebSocket API connections specifying a deprecated `sbeSchemaId` and `sbeSchemaVersion` in their connection URL:
- the field `sbeSchemaIdVersionDeprecated` will be set to `true` in all `WebSocketResponse` SBE messages
- all SBE responses will be encoded in the highest compatible schema
- For example, as of 2025-08-27, requests for `sbeSchemaId=3&sbeSchemaVersion=0` will receive responses encoded in schema `3:1`. An SBE decoder for schema `3:0` is expected to decode schema `3:1` gracefully as detailed in the [FIX SBE Specification](https://www.fixtrading.org/standards/sbe-online).
- For FIX API, when an SBE request message header specifies a deprecated `schemaId` and `version`:
- the field `sbeSchemaIdVersionDeprecated` will be set to `true` in the `LogonAck` message
- all SBE response messages will be encoded using the highest schema version for the provided `schemaId`
- Requests specifying a retired schemaId/version will fail with HTTP 400 (REST & WebSocket) or reject message (FIX API) .
- In SBE Schema [3:0](https://github.com/binance/binance-spot-api-docs/blob/master/sbe/schemas/spot_3_0.xml), a `validValue` named `NonRepresentable` was added to each `enum`. Receipt of this value indicates that additional data is available when using the latest schema.
- In SBE Schema [3:1](https://github.com/binance/binance-spot-api-docs/blob/master/sbe/schemas/spot_3_1.xml), a message named `NonRepresentableMessage` was added. Receipt of this message indicates that additional data is available when using the latest schema. This message may be received as a top-level message or embedded in a `data` field when the `data` field's `type` is `messageData`, `messageData8`, `messageData16`, `optionalMessageData`, or `optionalMessageData16`.
- JSON file regarding the schema life-cycle with the dates of the latest, deprecated, and retired schemas for both the live exchange and SPOT Testnet will be saved in this repository [here](https://github.com/binance/binance-spot-api-docs/tree/master/sbe/schemas).
Below is an example JSON based on the hypothetical timeline above:
```
{ "environment": "PROD", "latestSchema": { "id": 2, "version": 1, "releaseDate": "3025-02-01" }, "deprecatedSchemas": [ { "id": 2, "version": 0, "releaseDate": "3024-08-01", "deprecatedDate": "3025-02-01" } ], "retiredSchemas": [ { "id": 1, "version": 1, "releaseDate": "3024-03-01", "deprecatedDate": "3024-08-01", "retiredDate": "3025-02-01" }, { "id": 1, "version": 0, "releaseDate": "3024-01-01", "deprecatedDate": "3024-03-01", "retiredDate": "3024-09-01" } ]}
```
### Generate SBE decoders:[​](https://developers.binance.com/docs/binance-spot-api-docs/faqs/sbe_faq)
1. Download the schema:
- REST/WebSocket API:
- [`spot_prod_latest.xml`](https://github.com/binance/binance-spot-api-docs/blob/master/sbe/schemas/spot_prod_latest.xml) for the live exchange.
- [`spot_testnet_latest.xml`](https://github.com/binance/binance-spot-api-docs/blob/master/sbe/schemas/spot_testnet_latest.xml) for [SPOT Testnet](https://testnet.binance.vision/).
- FIX API:
- [`spot_fix_prod_latest.xml`](https://github.com/binance/binance-spot-api-docs/blob/master/sbe/schemas/spot_fix_prod_latest.xml) for the live exchange.
- [`spot_fix_testnet_latest.xml`](https://github.com/binance/binance-spot-api-docs/blob/master/sbe/schemas/spot_fix_testnet_latest.xml) for [SPOT Testnet](https://testnet.binance.vision/).
2. Clone and build [`simple-binary-encoding`](https://github.com/real-logic/simple-binary-encoding):
```
$ git clone https://github.com/real-logic/simple-binary-encoding.git $ cd simple-binary-encoding $ ./gradlew
```
3. Run the SbeTool code generator. (Here are samples for [Java](https://github.com/binance/binance-sbe-java-sample-app), [C++](https://github.com/binance/binance-sbe-cpp-sample-app) and [Rust](https://github.com/binance/binance-sbe-rust-sample-app) decoding the payload from Exchange Information.)
#### Decimal field encoding[​](https://developers.binance.com/docs/binance-spot-api-docs/faqs/sbe_faq)
Unlike the FIX SBE specification, decimal fields have their mantissa and exponent fields encoded separately as primitive fields in order to minimize payload size and the number of encoded fields within messages.
#### Timestamp field encoding[​](https://developers.binance.com/docs/binance-spot-api-docs/faqs/sbe_faq)
Timestamps in SBE responses are in microseconds. This differs from JSON responses, which contain millisecond timestamps by default.
#### Custom field attributes in the schema file[​](https://developers.binance.com/docs/binance-spot-api-docs/faqs/sbe_faq)
A few field attributes prefixed with `mbx:` were added to the schema file for documentation purposes:
- `mbx:exponent`: Points to the exponent field corresponding to the mantissa field
- `mbx:jsonPath`: Contains the name of the equivalent field in the JSON response
- `mbx:jsonValue`: Contains the name of the equivalent ENUM value in the JSON response
- [How to get an SBE response](https://developers.binance.com/docs/binance-spot-api-docs/faqs/sbe_faq)
- [Supported APIs](https://developers.binance.com/docs/binance-spot-api-docs/faqs/sbe_faq)
- [SBE Schema](https://developers.binance.com/docs/binance-spot-api-docs/faqs/sbe_faq)
- [Regarding Legacy support](https://developers.binance.com/docs/binance-spot-api-docs/faqs/sbe_faq)
- [Generate SBE decoders:](https://developers.binance.com/docs/binance-spot-api-docs/faqs/sbe_faq)
Reference in New Issue View Git Blame Copy Permalink