Skip to main content

Reality Orderbook Channel

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.

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",
"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
Response
{
"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
Push
{
"arg": {
"instType": "UTA",
"topic": "reality-orderbook",
"symbol": "RAAPLUSDT"
},
"action": "snapshot",
"ts": 1740000000000,
"data": [
{
"symbol": "RAAPLUSDT",
"a": [
["227.55", "80"],
["227.60", "300"]
],
"b": [
["227.50", "100"],
["227.45", "250"]
],
"pseq": "0",
"seq": "0",
"ts": "0"
}
]
}

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
dataList<Object>Subscribed data
> symbolStringSymbol name
> 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
> pseqStringThe serial number of the previous push
> seqStringSerial number
> tsStringFixed to 0, not currently in use

How was your Reading Experience with us?

★
★
★
★
â˜