Orderbook - Increment

Topic:/market/level2:{symbol},{symbol}

Description

The system will return the increment change orderbook data(All depth)

A topic supports up to 100 symbols.

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

Push frequency: real-time

{
  "id": 1545910660739,
  "type": "subscribe",
  "topic": "/market/level2:BTC-USDT",
  "response": true
}

Response

Data Schema

orderbookIncrement

topic

string

required

type

string

required

subject

string

required

data

object

required

changes

object

required

sequenceEnd

integer <int64>

required

sequenceStart

integer <int64>

required

symbol

string

required

time

integer <int64>

required

milliseconds

Example

{
    "topic": "/market/level2:BTC-USDT",
    "type": "message",
    "subject": "trade.l2update",
    "data": {
        "changes": {
            "asks": [
                [
                    "67993.3", //price
                    "1.21427407", //size
                    "14701689783" //sequence
                ]
            ],
            "bids": []
        },
        "sequenceEnd": 14701689783,
        "sequenceStart": 14701689783,
        "symbol": "BTC-USDT",
        "time": 1729816425625 //milliseconds
    }
}

Calibration procedure：

After receiving the websocket Level 2 data flow, cache the data.

Initiate a Level 2 request to Get Full OrderBook

Playback the cached Level 2 data flow.

Apply the new Level 2 data flow to the local snapshot to ensure that sequenceStart(new) < = sequenceEnd+1(old) and sequenceEnd(new) > sequenceEnd(old). The sequence on each record in changes only represents the last modification of the corresponding sequence of the price, and does not serve as a basis for judging message continuity.

Update the level2 full data based on sequence according to the price and size. If the price is 0, ignore the messages and update the sequence. If the size=0, update the sequence and remove the price of which the size is 0 out of level 2. For other cases, please update the price.

The Change attribute of Level 2 is a string value of "price, size, sequence", namely: ["price", "quantity", "sequence"].

Please note: size refers to the latest size corresponding to price. When the size is 0, the corresponding price needs to be deleted from the order book.

Example

Take BTC/USDT as an example, suppose the current order book data in level 2 is as follows:

After subscribing to the channel, you would receive changes as follows:

...
"asks":[
["3988.59","3", "16"], // ignore it because sequence = 16
["3988.61","0", "19"], // Remove 3988.61
["3988.62","8", "15"], // ignore it because sequence < 16
]
"bids":[
["3988.50", "44", "18"] // Update size of 3988.50 to 44
]
"sequenceStart": 19,
"sequenceEnd": 15,
...

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 ["3988.50", "20", "17" "], ["3988.50", "44", "18"], at this time only the latest ["3988.50", "44", "18"] will be pushed

Get a snapshot of the order book through a REST request (Level 2) to build a local order book. Suppose that data we got is as follows:

...
"sequence": "16",
"asks":[
["3988.62","8"],//[Price, Size]
["3988.61","32"],
["3988.60","47"],
["3988.59","3"],
]
"bids":[
["3988.51","56"],
["3988.50","15"],
["3988.49","100"],
["3988.48","10"]
]
...

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

Price	Size	Side
3988.62	8	Sell
3988.61	32	Sell
3988.60	47	Sell
3988.59	3	Sell
3988.51	56	Buy
3988.50	15	Buy
3988.49	100	Buy
3988.48	10	Buy

In the beginning, the sequence of the order book is 16. Discard the feed data of sequence that is below or equals to 16, and apply playback the sequence [18,19] to update the snapshot of the order book. Now the sequence of your order book is 19 and your local order book is up-to-date.

Diff:

Update size of 3988.50 to 44 (Sequence 18)

Remove 3988.61 (Sequence 19)

Now your current order book is up-to-date and final data is as follows:

Price	Size	Side
3988.62	8	Sell
3988.60	47	Sell
3988.59	3	Sell
3988.51	56	Buy
3988.50	44	Buy
3988.49	100	Buy
3988.48	10	Buy

Request

Query Params

token

string

required

The token required to establish a websocket connection

Example:

2neAiuYvAU61ZDXANAGAsiL4-iAExhsBXZxftpOeh_55i3Ysy2q2LEsEWU64mdzUOPusi34M_wGoSf7iNyEWJ2gZJLp3fgqGGvpzdfennGL3R06_0gIS-diYB9J6i9GjsxUuhPw3Blq6rhZlGykT3Vp1phUafnulOOpts-MEmEF-3bpfetLOAjzQ04YZ_8fRJBvJHl5Vs9Y=.28mIdGU0xg5pJ6TpPYIhjg==

connectId

string

optional

Connection Id, a unique value taken from the client side. Both the id of the welcome message and the id of the error message are connectId.

Example:

121345

Orderbook - Increment

Topic:/market/level2:{symbol},{symbol}#

Subscribe Message#

Response#

Request

Topic:/market/level2:{symbol},{symbol}

Subscribe Message

Response