Skip to main content
GET
GET /api/orderbook

Description

Returns up to 40 bid levels and 40 ask levels for one trading pair, as a flat array of order-book levels. Each level has an isBid flag indicating whether it is a bid (true) or ask (false).

Parameters

string
required
Pair code in {base}_{target} format, e.g. TRX_USDT.

Response

Array of order-book levels. Each level:
boolean
required
true for a bid, false for an ask.
decimal
required
Price level in target (quote) currency.
decimal
required
Available quantity at this level, denominated in base currency.
decimal
required
Equivalent value at this level in target (quote) currency. Equals price * amount.
decimal
deprecated
Deprecated alias of amount. Will be removed in a future release.
decimal
deprecated
Deprecated alias of quoteAmount. Will be removed in a future release.

Example request

Example response

Splitting bids and asks

Notes

  • Returns up to 40 levels per side. Less if the book is thin.
  • For deeper books or aggregator-spec format, see Aggregator Compatibility / orderbook.
  • currencyTo and currencyFrom are deprecated — prefer amount and quoteAmount.