Skip to main content
GET
Get the current order book

Authorizations

X-API-KEY
string
header
required

Per-user API key. Create and revoke keys from your SOAR account settings. A revoked key stops working within 60 seconds.

Path Parameters

market_id
string
required

The market's ticker or its event_market_id UUID. Tickers are case-insensitive.

Pattern: ^[A-Za-z0-9.](?:[A-Za-z0-9.-]*[A-Za-z0-9.])?$
Example:

"ANTHROPIC-VALUATION-26Q3-1.05T"

Response

The latest depth snapshot.

ticker
string
required
market_id
string<uuid>
required
as_of
string<date-time>
required

When this depth was captured — not when you asked for it.

Depth is captured on a short interval and published asynchronously, so this is a recent view rather than a live one. Size against it accordingly.

Watch this field. An as_of that stops advancing while trades keep printing means the depth feed is stale, not that the market has gone quiet — the two look identical if you read only the levels. A market that has never traded has no snapshot at all and reports the zero instant with empty sides.

bids
object[]
required

Best first. [] on a book with no bids — never null.

asks
object[]
required

Best first. [] on a book with no asks — never null.