Skip to main content
GET
List Orders

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.

Query Parameters

status
string | null

Filter by order status. Accepts a single OrderStatus name (e.g. 'RESTING') or the meta-value 'ACTIVE' which resolves to RESTING.

river_id
integer | null

Filter by instrument ID

generic_asset_id
string<uuid> | null

Filter by generic asset ID

subaccount_id
string<uuid> | null

Filter to a specific subaccount

parent_iceberg_order_id
string<uuid> | null

Filter to child tranches of a specific iceberg parent.

parent_peg_order_id
string<uuid> | null

Filter to child tranches of a specific peg parent.

parent_smart_taker_order_id
string<uuid> | null

Filter to IOC children of a specific smart-taker parent.

buy_flag
boolean | null

Filter by direction: true=buys, false=sells

search
string | null

Free-text search across the order's market: ticker/slug, the human-readable question (event title, market name, outcome) via full-text + substring match, plus the order's river_id / order id / generic asset id. Applied server-side over all matching orders, not just the current page.

show_tp_sl_active
boolean
default:false

When true, complex_order_ids only includes attached TP/SL orders with status PENDING or ACTIVE.

limit
integer
default:100

Results per page (max 1000)

Required range: 1 <= x <= 1000
offset
integer
default:0

Pagination offset

Required range: x >= 0

Response

Successful Response

Schema for list of orders.

orders
OrderResponse · object[]
required

List of orders matching the query

count
integer
required

Total count of matching orders (for pagination)