Public
Reality Orderbook Channel
Description
Subscribe to real-time depth data of a specified Reality (US stock) trading pair.
Every push is a full snapshot (snapshot). The depth data returned is raw (unaggregated) depth.
Complete depth data is available during both trading sessions and non-trading sessions. The depth copy is pushed every 500ms when it has changed, or every 10s when unchanged.
This is the merged (onshore + offshore) depth. See also Reality Orderbook Segmented Channel, which breaks down onshore and offshore quantities separately.
Access requirements
This channel requires API Key authentication. You must contact your Business Development (BD) representative in advance to apply for whitelist access.
Code
Request Parameters
| Parameters | Type | Required | Description |
|---|---|---|---|
| op | String | Yes | Operation subscribe Subscribe unsubscribe Unsubscribe |
| args | List<Object> | Yes | Subscribed channel |
| > instType | String | Yes | Product type Fixed to UTA |
| > topic | String | Yes | Topic Fixed to reality-orderbook |
| > symbol | String | Yes | Symbol name e.g., RAAPLUSDT |
Code
Response Parameters
| Parameters | Type | Description |
|---|---|---|
| event | String | Event subscribe Subscribe unsubscribe Unsubscribe error Parameter error |
| arg | Object | Subscribed channel |
| > instType | String | Product type Fixed to UTA |
| > topic | String | Topic Fixed to reality-orderbook |
| > symbol | String | Symbol name |
| code | String | Error code |
| msg | String | Error message |
Code
Push Parameters
| Return Field | Parameter Type | Description |
|---|---|---|
| arg | Object | Subscribed channel |
| > instType | String | Product type Fixed to UTA |
| > topic | String | Topic Fixed to reality-orderbook |
| > symbol | String | Symbol name |
| action | String | Data push action snapshot Full push |
| ts | String | Data push timestamp A Unix timestamp in milliseconds |
| data | Object | Subscribed data |
| > a | List<Array> | Sell asks. Each item is [price, size], sorted by price in ascending order |
| > > a[0] | String | Sell price |
| > > a[1] | String | Sell quantity |
| > b | List<Array> | Buy bids. Each item is [price, size], sorted by price in descending order |
| > > b[0] | String | Buy price |
| > > b[1] | String | Buy quantity |
