Skip to main content
GET
Get markets orderbook
Returns the live protocol orderbook (every funded, available provider quote across corridors × tokens × networks) plus network-wide aggregate statistics. Use this endpoint to display live liquidity, rates, and protocol health without requiring authentication.
Public endpoint — no API key or HMAC signature required. CORS is open. Responses are cached for ~10 s and are per-IP rate limited.

Query parameters

Optional filters narrow data.book only. data.aggregates always remain network-wide (same values whether or not you filter the book). Empty or omitted params apply no filter on that dimension.

Response shape (data)

Book row fields

Each element of book is a single provider quote for one side on one network:
balance is a shared pool repeated across a provider’s networks for the same fiat (sell) or token (buy). De-duplicate by providerId + fiat (sell) or providerId + token (buy) when summing total depth to avoid double-counting.
Qualifying offer filters: is_available = true, funded (positive balance), enabled fiat/token, non-testnet network. All book rows are public regardless of a provider’s visibility setting—visibility only affects the narrower position benchmark pool on the Get Market Rate endpoint.

Aggregates fields

Windowed success and median fields are null for a window when no terminal orders exist in that period.

Example

Filtered example

Sell-side USDC offers on Base for NGN or KES. Aggregates in the response are still the full network-wide KPIs.

Errors

Query Parameters

side
enum<string>

Return only buy or sell book rows. Omit for both sides. Invalid values return 400.

Available options:
buy,
sell
fiat
string

Comma-separated fiat currency codes (e.g. NGN,KES). Case-sensitive as stored. Filters data.book only; omit for all fiats.

token
string

Comma-separated token symbols (e.g. USDC,USDT). Filters data.book only; omit for all tokens.

network
string

Comma-separated network identifiers (e.g. base,polygon). Filters data.book only; omit for all networks.

Response

Markets orderbook and aggregates

status
string
Example:

"success"

message
string
Example:

"Operation successful"

data
object

Public markets orderbook and network-wide aggregates.