Bitget APIBitget API
UTAClassic
Legacy Doc
  • Overview
  • API Documentation
  • WebSocket
  • Agent Hub
  • SDK
  • Changelog
Copied to clipboard
Websocket
Public
Private
Reality
    Public
      Reality Orderbook ChannelReality Orderbook Segmented Channel
SBE
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
{ "op": "subscribe", "args": [ { "instType": "UTA", "topic": "reality-orderbook", "symbol": "RAAPLUSDT" } ] }

Request Parameters

ParametersTypeRequiredDescription
opStringYesOperation
subscribe Subscribe
unsubscribe Unsubscribe
argsList<Object>YesSubscribed channel
> instTypeStringYesProduct type
Fixed to UTA
> topicStringYesTopic
Fixed to reality-orderbook
> symbolStringYesSymbol name
e.g., RAAPLUSDT
Code
{ "event": "subscribe", "arg": { "instType": "UTA", "topic": "reality-orderbook", "symbol": "RAAPLUSDT" } }

Response Parameters

ParametersTypeDescription
eventStringEvent
subscribe Subscribe
unsubscribe Unsubscribe
error Parameter error
argObjectSubscribed channel
> instTypeStringProduct type
Fixed to UTA
> topicStringTopic
Fixed to reality-orderbook
> symbolStringSymbol name
codeStringError code
msgStringError message
Code
{ "arg": { "instType": "UTA", "topic": "reality-orderbook", "symbol": "RAAPLUSDT" }, "action": "snapshot", "ts": 1740000000000, "data": { "a": [ ["227.55", "80"], ["227.60", "300"] ], "b": [ ["227.50", "100"], ["227.45", "250"] ] } }

Push Parameters

Return FieldParameter TypeDescription
argObjectSubscribed channel
> instTypeStringProduct type
Fixed to UTA
> topicStringTopic
Fixed to reality-orderbook
> symbolStringSymbol name
actionStringData push action
snapshot Full push
tsStringData push timestamp
A Unix timestamp in milliseconds
dataObjectSubscribed data
> aList<Array>Sell asks. Each item is [price, size], sorted by price in ascending order
> > a[0]StringSell price
> > a[1]StringSell quantity
> bList<Array>Buy bids. Each item is [price, size], sorted by price in descending order
> > b[0]StringBuy price
> > b[1]StringBuy quantity
Strategy Order ChannelReality Orderbook Segmented Channel
JSON
JSON
JSON