Skip to main content
GET
GET /orderbook

Description

Returns the current order book for a single pair, split into bids 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=100 returns up to 50 bids and 50 asks
  • depth=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).
  • price is the bid price in target currency
  • quantity is the order size in base currency
array
required
Array of [price, quantity] tuples sorted by price ascending (best ask first).
  • price is the ask price in target currency
  • quantity is 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_trades may 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 quantity is the remaining order size at that price level after partial fills.

Errors