Skip to main content
GET
Orderbook Snapshot

Path Parameters

tradingPairId
string
default:893d2add-2f36-4ee7-b660-893d2add2f36
required

Query Parameters

levels
integer<uint32>
default:20

Number of price levels (max 100)

Required range: 1 <= x <= 100
tradingMode
enum<string>

Trading mode

Available options:
SPOT,
MARGIN
Minimum string length: 1
magnitude
enum<string>

Price grouping magnitude

Available options:
0.0001,
0.001,
0.01,
0.1,
1,
10,
100,
1000,
10000
Minimum string length: 1
denomination
enum<string>

Price denomination

Available options:
base,
quote
Minimum string length: 1

Response

OK

Orderbook snapshot with token metadata and sequence number.

baseDecimals
integer<int32> | null

Base token decimal places

Example:

8

baseToken
string | null

Base token symbol

Example:

"BTC"

data
object
eventType
string | null

Event type identifier

Example:

"orderbook_snapshot"

symbol
string | null

Trading pair symbol

Example:

"BTC/USDC"

tradingPairId
string<uuid> | null

Trading pair UUID

Example:

"123e4567-e89b-12d3-a456-426614174000"

quoteDecimals
integer<int32> | null

Quote token decimal places

Example:

6

quoteToken
string | null

Quote token symbol

Example:

"USDC"

sequenceNumber
integer<uint32> | null

Orderbook sequence number

Example:

12345

timestamp
string | null

Snapshot timestamp

Example:

"2023-11-13T10:30:00Z"

tradingMode
string | null

Trading mode

Example:

"Spot"