Sign in

v1

latestOpenAPI 3.0.12026-07-2683220192.3 KB
Order Book

Get order book

Returns the current aggregated order book for a symbol

get/v1/orderbook/{symbol}

Path parameters

symbolstring required

Instrument symbol (e.g., "BTC-USD")

Query parameters

depthinteger

Number of price levels to return (default 3, max 10)

Response

A successful response.

symbolstring
state'INSTRUMENT_STATE_CLOSED' | 'INSTRUMENT_STATE_OPEN' | 'INSTRUMENT_STATE_PREOPEN' | 'INSTRUMENT_STATE_SUSPENDED' | 'INSTRUMENT_STATE_EXPIRED' | 'INSTRUMENT_STATE_TERMINATED' | 'INSTRUMENT_STATE_HALTED' | 'INSTRUMENT_STATE_MATCH_AND_CLOSE_AUCTION' | 'INSTRUMENT_STATE_PENDING'

PENDING: Initial state for a newly created instrument which has not yet begun trading.

CLOSED: No order entry, modification, cancellation, or matching. Day orders expired.

OPEN: Continuous order entry and matching.

PREOPEN: Orders accepted, no matching. Dutch Auction on transition to OPEN.

MATCH_AND_CLOSE_AUCTION: Like PREOPEN, matches on transition out.

SUSPENDED: Cancel only. No entry, modification, or matching.

HALTED: Like SUSPENDED, no cancels allowed.

EXPIRED: All resting orders expired, no new orders.

TERMINATED: Order book removed, all orders and positions closed.

transactTimestring date-time