Skip to main content

Reality Orderbook Segmented Channel

Reality Orderbook Segmented Channel

Description​

Subscribe to real-time segmented depth data of a specified Reality (US stock) trading pair (up to 50 levels). Each price level reports onshore (internal) and offshore (external) quantities separately.

Every push is a full snapshot (snapshot). The depth copy is pushed every 500ms when it has changed, or every 10s when unchanged.

For the merged (onshore + offshore) depth, see Reality Orderbook Channel.

Access requirements
  • This channel requires API Key authentication. You must contact your Business Development (BD) representative in advance to apply for whitelist access.
Request
{
"op": "subscribe",
"args": [
{
"instType": "UTA",
"topic": "reality-orderbook-segmented",
"symbol": "RAAPLUSDT"
}
]
}

Request Parameters​

ParametersTypeRequiredDescription
opStringYesOperation
subscribe Subscribe
unsubscribe Unsubscribe
argsList<Object>YesSubscribed channel
> instTypeStringYesProduct type
Fixed to UTA
> topicStringYesTopic
Fixed to reality-orderbook-segmented
> symbolStringYesSymbol name
e.g., RAAPLUSDT
Response
{
"event": "subscribe",
"arg": {
"instType": "UTA",
"topic": "reality-orderbook-segmented",
"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-segmented
> symbolStringSymbol name
codeStringError code
msgStringError message
Push
{
"arg": {
"instType": "UTA",
"topic": "reality-orderbook-segmented",
"symbol": "RAAPLUSDT"
},
"action": "snapshot",
"ts": 1740000000000,
"data": {
"a": [
["227.55", "60", "20"],
["227.60", "200", "100"]
],
"b": [
["227.50", "80", "20"],
["227.45", "250", "0"]
]
}
}

Push Parameters​

Return FieldParameter TypeDescription
argObjectSubscribed channel
> instTypeStringProduct type
Fixed to UTA
> topicStringTopic
Fixed to reality-orderbook-segmented
> 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, onshore qty, offshore qty], sorted by price in ascending order
> > a[0]StringSell price
> > a[1]StringSell onshore (internal) quantity
> > a[2]StringSell offshore (external) quantity
> bList<Array>Buy bids. Each item is [price, onshore qty, offshore qty], sorted by price in descending order
> > b[0]StringBuy price
> > b[1]StringBuy onshore (internal) quantity
> > b[2]StringBuy offshore (external) quantity

How was your Reading Experience with us?

★
★
★
★
â˜