GET /orderbook
Aggregator Compatibility
GET /orderbook
Order book depth for a single trading pair.
GET
GET /orderbook
Description
Returns the current order book for a single pair, split intobids and asks arrays.
Parameters
string
required
Pair identifier in
{base}_{target} format, e.g. TRX_USDT. See ticker_id format.integer
Total order count across both sides. The response returns up to
floor(depth / 2) levels on each side.depth=100returns up to 50 bids and 50 asksdepth=0— or omitting the parameter — returns the full order book- Any positive integer is accepted; there is no fixed set of allowed values
Response
string
required
The requested pair identifier, echoed back.
integer
required
Last order book update time, Unix epoch in milliseconds.
array
required
Array of
[price, quantity] tuples sorted by price descending (best bid first).priceis the bid price in target currencyquantityis the order size in base currency
array
required
Array of
[price, quantity] tuples sorted by price ascending (best ask first).priceis the ask price in target currencyquantityis the order size in base currency
Example request
Example response
Computing spread
Notes
- Order book snapshots are eventually consistent — a trade you observe in
/historical_tradesmay take up to 1 second to be removed from the book. - For real-time order book streams, a WebSocket API is on the roadmap for v2.
- The
quantityis the remaining order size at that price level after partial fills.
