Orderbook

Description

The system will push the orderbook data.

If there is no change in the market, data will not be pushed.

For depth: 1(BBO), 5 or depth: 50, clients can directly use the received snapshots without maintaining a local order book.

For depth: increment, clients must maintain a local order book by combining a REST API snapshot with WebSocket delta updates, following the calibration procedure below.

Push frequency:

Level	SPOT	FUTURES
Best1(BBO)	Real time	Real time
Best 5	100ms	100ms
Best 50	100ms	100ms
increment	Real time	Real time

{
  "id": "1545910660739",
  "action": "SUBSCRIBE",  // or UNSUBSCRIBE
  "channel":"obu",
  "tradeType": "SPOT",    // SPOT / FUTURES
  "symbol": "BTC-USDT",
  "depth": "5",           // 1 / 5 / 50 / increment
  "rpiFilter": 0          // 0：Only NoneRPI orders [Default]  1(Only Support Futures)：NoneRPI+ RPI Orders. When rpiFilter=1, "depth" only supports 5/50.
}

Response

Data Schema

orderbook

Note:
O and C represent the starting sequence number and the ending sequence number of the data contained in the current push.
1.
For Snapshot pushes, the order book data reflects the state at a single sequence point, so the values of O and C are always the same.
2.
For Incremental pushes, a single push may aggregate multiple order book changes, reflected as multiple price level updates in the bid (b) and ask (a) arrays. Therefore, the values of O and C may differ.

Example

//SPOT-bbo  
{
    "T": "obu.SPOT",
    "dp": "1",
    "t": "snapshot",
    "P": 1768217874990007701,
    "d": {
        "C": 25984468414,
        "M": 1768217874986000000,
        "O": 25984468414,
        "a": [
            [
                "90701.2",
                "0.5771583"
            ]
        ],
        "b": [
            [
                "90701.1",
                "0.13918404"
            ]
        ],
        "s": "BTC-USDT"
    }
}
      
//SPOT-increment
{
    "T": "obu.SPOT",
    "dp": "increment",
    "t": "delta",
    "P": 1768217909684719896,
    "d": {
        "C": 25984544840,
        "M": 1768217909683000000,
        "O": 25984544839,
        "a": [],
        "b": [
            [
                "1",
                "12996.24994153"
            ]
        ],
        "s": "BTC-USDT"
    }
}

//FUTURES-bbo
{
    "T": "obu.FUTURES",
    "dp": "1",
    "t": "snapshot",
    "P": 1768217994549513415,
    "d": {
        "a": [
            [
                "90629.2",
                "2236"
            ]
        ],
        "b": [
            [
                "90629.1",
                "301"
            ]
        ],
        "s": "XBTUSDTM",
        "C": 1732420529826,
        "M": 1768217994548000000,
        "O": 1732420529826
    }
}
      
//FUTURES-increment
{
    "T": "obu.FUTURES",
    "dp": "increment",
    "t": "delta",
    "P": 1768218044321756061,
    "d": {
        "a": [
            [
                "90601.5",
                "0"
            ]
        ],
        "b": [],
        "C": 1732420557695,
        "s": "XBTUSDTM",
        "M": 1768218044321000000,
        "O": 1732420557695
    }
}
      
//FUTURES-RPI    
{
  "t" : "snapshot",
  "T" : "obu.FUTURES",
  "d" : {
    "O" : 1731931329201,
    "b" : [
      [
        "88862.4",
        "891",
        "0"
      ]
    ],
    "M" : 1767323800296000000,
    "s" : "XBTUSDTM",
    "a" : [
      [
        "88862.5",
        "1645",
        "0"
      ]
    ],
    "C" : 1731931329201
  },
  "P" : 1767323800305802104,
  "dp" : "5"
}

Calibration procedure：

To maintain an accurate local order book, follow these steps:

Cache WebSocket Data:

Subscribe to the WebSocket Level 2 data feed for the desired trading pair and depth (e.g., obu.spot, dp: increment).

Cache all incoming WebSocket messages (snapshots and deltas) for playback.

Fetch Initial Snapshot:

Make a REST API request to Get Full Order Book to retrieve a complete snapshot of the order book.

The snapshot provides the initial state with a sequence number, bids, and asks.

Playback Cached Data:

Replay cached WebSocket messages (deltas) in sequence order to update the local snapshot.

Ensure continuity by verifying that for each delta:


sequenceStart(new) <= sequenceEnd(old) + 1
sequenceEnd(new) > sequenceEnd(old)

The sequence number in each delta sequenceStart and sequenceEnd represents the range of updates. Only apply deltas with sequence numbers greater than the snapshot's sequence number.

Update the Order Book:

For each delta update in the b (bids) or a (asks) arrays:

If size is 0, remove the corresponding price from the order book.

If size is non-zero, update the price with the new size.

Update the local order book's sequence number to the sequenceEnd of the latest applied delta.

Tips

The sequence on each record in changes only represents the last modification of the corresponding sequence of the price, not as a basis for judging the continuity of the message; for example, when there are multiple updates at the same price, only the latest data will be pushed

Example

Suppose a REST API request to Get Full Order Book returns the following snapshot with sequence number 100001:

  "sequence": "100001",
  "asks": [
    ["115669", "0.1"],
    ["115553.5", "0.05"],
    ["115442", "0.2"]
  ],
  "bids": [
    ["115404", "0.5"],
    ["115403.5", "0.3"],
    ["115388.9", "0.1"]
  ]
}

The current data on the local order book is as follows:

Price	Size	Side
115669	0.1	Sell
115553.5	0.05	Sell
115442	0.2	Sell
115404	0.5	Buy
115403.5	0.3	Buy
115388.9	0.1	Buy

The order book’s sequence number is 100001.

Processing WebSocket Delta Updates

The following WebSocket delta updates are received

Sequence 100002:

{
  "T": "obu.spot",
  "t": "delta",
  "dp": "increment",
  "P": 1760324595709048090,
  "d": {
    "C": 100002,
    "M": 1760324595706000,
    "O": 100002,
    "a": [["115669", "0.0151843"]],
    "b": [],
    "s": "BTC-USDT"
  }
}

Verify Sequence Continuity:

Current order book sequence: 100001.

Delta’s sequenceStart (O): 100002.

Delta’s sequenceEnd (C): 100002.

Check: sequenceStart (100002) <= sequenceEnd(old) + 1 (100001 + 1 = 100002) and
sequenceEnd (100002) > sequenceEnd(old) (100001).

The delta is valid and can be applied.

Update:

Set ask size for price 115669 to 0.0151843.

Set the order book’s sequence number to sequenceEnd (C): 100002.

Sequence 100003:

{
  "T": "obu.spot",
  "t": "delta",
  "dp": "increment",
  "P": 1760324595709048090,
  "d": {
    "C": 100003,
    "M": 1760324595706000,
    "O": 100003,
    "a": [],
    "b": [["115404", "0"]],
    "s": "BTC-USDT"
  }
}

Verify Sequence Continuity:

Current order book sequence: 100002.

Delta’s sequenceStart (O): 100003.

Delta’s sequenceEnd (C): 100003.

Check: sequenceStart (100003) <= sequenceEnd(old) + 1 (100002 + 1 = 100003) and
sequenceEnd (100003) > sequenceEnd(old) (100002).

The delta is valid and can be applied.

Update:

Remove the price 115404 from the order book

Set the order book’s sequence number to sequenceEnd (C): 100003.

Final Order Book

Price	Size	Side
115669	0.0151843	Sell
115553.5	0.05	Sell
115442	0.2	Sell
115403.5	0.3	Buy
115388.9	0.1	Buy

Push frequency:#

Subscribe Message#

Response#

Request

Push frequency:

Subscribe Message

Response