GetOrderBook
Returns a simulated aggregated order-book depth for one market: bid and ask
price levels, each bucketed by tickSize and sorted toward the best
price. Resolved by market_id or market_symbol.
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Headers
Define the version of the Connect protocol. If omitted, use 1.
1 Define the timeout, in ms
Body
Market to fetch the order book for, by market_id or market_symbol.
- market_id
- market_symbol
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.
Whether to express level sizes in USD notional (true) or the underlying asset's units (false).
Maximum number of price levels to return per side. 0 or omitted returns all levels.
Maximum number of underlying orders to aggregate before building levels. Defaults to 50.
Number of underlying orders to skip before aggregating.
Accepted but currently ignored.
Response
Success
Aggregated order book for the requested market.