Ctrl+K

Get Level2 Order Book

get/api/prime/trading/v1/accounts/{accountId}/products/{product}/level2

Gets a snapshot of the order book for product

Path Parameters

  • accountIdstringRequired
    The ID of the account
  • productstringRequired
    The name of the product

Query Parameters

  • includeCumulativebooleanDefault: false
    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]`.

200 Response

time string <date-time>required
The timestamp when the order book snapshot was generated
Example: 2025-11-27T18:48:51.383577451Z
product string required
Product name
Example: BTC-USD
bids array[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.
string <decimal>
asks array[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.
string <decimal>

default Response

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.
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.