Sign in

v2

latestOpenAPI 3.1.0Proprietary2026-08-054985119.4 KB
orders

List Orders

List orders with optional filters.

Returns a paginated list of orders across all accessible subaccounts, ordered by created_at descending.

Filters: All filters are optional and can be combined. If no subaccount_id is specified, returns orders from all subaccounts the user has access to.

Order Statuses:

  • PENDING_SUBMISSION: Order received, awaiting exchange submission.
  • PROCESSING: Being processed by the order consumer.
  • RESTING: Live on the exchange order book (may include partially-filled live orders).
  • EXECUTED: Terminal — fully filled.
  • PARTIALLY_FILLED: Terminal — cancelled with some quantity filled.
  • CANCELLED: Terminal — cancelled with no fills.
  • REJECTED: Rejected by exchange (see order details for reason).

Aggregated Fields: Each order includes traded_qty, average_price, and fees_paid computed from fills.

get/v1/orders

Query parameters

statusstring nullable

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

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

river_idinteger nullable

Filter by instrument ID

Filter by instrument ID

generic_asset_idstring uuid nullable

Filter by generic asset ID

Filter by generic asset ID

subaccount_idstring uuid nullable

Filter to a specific subaccount

Filter to a specific subaccount

parent_iceberg_order_idstring uuid nullable

Filter to child tranches of a specific iceberg parent.

Filter to child tranches of a specific iceberg parent.

parent_peg_order_idstring uuid nullable

Filter to child tranches of a specific peg parent.

Filter to child tranches of a specific peg parent.

parent_smart_taker_order_idstring uuid nullable

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

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

buy_flagboolean nullable

Filter by direction: true=buys, false=sells

Filter by direction: true=buys, false=sells

searchstring nullable

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.

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_activeboolean

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

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

limitinteger

Results per page (max 1000)

Results per page (max 1000)

offsetinteger

Pagination offset

Pagination offset

Response

Successful Response

countinteger required

Total count of matching orders (for pagination)