Skip to main content
POST
GetOrderBook

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

Connect-Protocol-Version
enum<number>
default:1
required

Define the version of the Connect protocol. If omitted, use 1.

Available options:
1
Connect-Timeout-Ms
number

Define the timeout, in ms

Body

application/json
market
market_id · object
required

Market to fetch the order book for, by market_id or market_symbol.

tickSize
number<float>

Price bucket size to group orders into levels. 0 disables bucketing. Otherwise must be a power-of-ten multiple of the market's minimum tick size (1 / 10^tickDecimals, from that market's config) — e.g. 0.01, 0.1, 1, 10. A value below the market's minimum tick is clamped up to that minimum rather than rejected. Any other value (not a power-of-ten step, or negative) returns INVALID_ARGUMENT.

sizeInUsd
boolean

Whether to express level sizes in USD notional (true) or the underlying asset's units (false).

levels
integer<int32>

Maximum number of price levels to return per side. 0 or omitted returns all levels.

limit
integer | null

Maximum number of underlying orders to aggregate before building levels. Defaults to 50.

offset
integer | null

Number of underlying orders to skip before aggregating.

totalOrderCount
integer | null

Accepted but currently ignored.

Response

200 - application/json

Success

orderBook
order_book · object

Aggregated order book for the requested market.