Skip to main content
GET
Get Orderbook

Authorizations

X-River-Key-Id
string
header
required

UUID of your API key (from Settings → API Keys).

X-River-Timestamp
string
header
required

Current unix seconds. Must be within 30s of server time.

X-River-Signature
string
header
required

Base64 Ed25519 signature over the canonical request: METHOD\nPATH\nSORTED_QUERY\nTIMESTAMP\nSHA256(body) hex. See /api-reference/authentication for the full recipe.

Path Parameters

river_id
integer
required

Query Parameters

levels
integer
default:10

Number of price levels to return

Required range: 1 <= x <= 10

Response

Successful Response

status
enum<string>
required
Available options:
ok,
pending,
not_found
orderbook
OrderbookData · object | null
message
string | null