REST API›Trade›Order Book

GET

Get Level2 Order Book

Gets a snapshot of the order book for product

Path Params

  • accountId string required
    The ID of the account
  • product string required
    The name of the product

Query Params

  • includeCumulative boolean
    Include cumulative size in each price level, which is the running total of size from the top of that side through the level. When true, each level is [price, size, cumulativeSize] instead of [price, size].

    Defaults to false

Responses

200
A Level2OrderBookSnapshot

Response Body

object

  • time string date-time required
    The timestamp when the order book snapshot was generated
  • product string required
    Product name
  • bids array of array required
    An array of bid price levels. Each level is an array in the format [price, size], ordered from highest price to lowest price. price is the bid price in the quote currency and size is the quantity of the base asset at that price level. With includeCumulative=true, each level is [price, size, cumulativeSize] where cumulativeSize is the running total of size from the top of that side through the level.
  • asks array of array required
    An array of ask price levels. Each level is an array in the format [price, size], ordered from lowest price to highest price. price is the ask price in the quote currency and size is the quantity of the base asset at that price level. With includeCumulative=true, each level is [price, size, cumulativeSize] where cumulativeSize is the running total of size from the top of that side through the level.
default
unexpected error

Response Body

object

  • error string required
  • errorName string required
  • reqId string required
  • context object
    Optional structured metadata for REST validation failures. The schema is fixed for client contract stability.
    context object
    • errorName string required
      Same value as the top-level errorName.
    • field string
      Request field associated with the validation failure.
    • message string
      Human-readable field-level validation message.