Skip to main content
This stream provides real-time order book updates for a specified market. Upon subscription to this stream, you will receive publicOrderBookDelta messages whenever the order book changes: 
{
    "resultType": "publicOrderBookDelta",
    "data": {
        "orders": [
            {
                "orderType": "sell",
                "price": "3181.41",
                "quantity": "38.92"
            },
            {
                "orderType": "buy",
                "price": "3181.39",
                "quantity": "38.98"
            }
        ],
        "statusCode": 200
    }
}
FieldTypeRequiredDescription
resultTypestringYespublicOrderBookDelta
data.ordersarrayYesIncremental order book changes
data.orders[].orderTypestringYesOrder side: Order side: buy or sell
data.orders[].pricestringYesPrice level
data.orders[].quantitystringYesNew total quantity at this price level
data.statusCodenumberYes200

​
Order Book Snapshot Request

There is one request called emitPublicOrderBook that returns a full order book snapshot with publicOrderBook response messages. This request is useful for:
  • Bootstrap order book state when first subscribing to the stream
  • Recover after temporary data loss or connection issues
  • Synchronize local book models with the current market state
  • Get the complete order book picture before processing delta updates

​
Request

{
  "message":"emitPublicOrderBook",
  "content": {
    "clientRequestId": "4cc68b60-ed2d-42aa-a21e-cb5486f8fd1a"
  }
}
FieldTypeRequiredDescription
messagestringYesemitPublicOrderBook
content.clientRequestIdstringNoClient-generated UUID for correlation

​
Response

{
    "resultType": "publicOrderBook",
    "data": {
        "clientRequestId": "4cc68b60-ed2d-42aa-a21e-cb5486f8fd1a",
        "orders": [
            {
                "orderType": "buy",
                "price": "3181.39",
                "quantity": "38.98"
            },
            {
                "orderType": "sell",
                "price": "3181.41",
                "quantity": "38.92"
            }
        ],
        "statusCode": 200
    }
}
FieldTypeRequiredDescription
resultTypestringYespublicOrderBook
data.clientRequestIdstringNoClient-generated UUID for correlation
data.ordersarrayYesFull order book entries
data.orders[].orderTypestringYesOrder side: Order side: buy or sell
data.orders[].pricestringYesPrice level
data.orders[].quantitystringYesTotal quantity at this price level
data.statusCodenumberYes200