Skip to main content
GET
/
v1
/
orders
List Orders
curl --request GET \
  --url https://api.rivermarkets.com/v1/orders \
  --header 'X-River-Key-Id: <api-key>' \
  --header 'X-River-Signature: <api-key>' \
  --header 'X-River-Timestamp: <api-key>'
{
  "orders": [
    {
      "river_order_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "order_type": "<string>",
      "time_in_force": "<string>",
      "qty": 123,
      "buy_flag": true,
      "status": "<string>",
      "subaccount_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "created_at": "<string>",
      "updated_at": "<string>",
      "complex_order_ids": {},
      "price": 123,
      "post_only": false,
      "river_id": 123,
      "generic_asset_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "expiry_ts_utc": "<string>",
      "traded_qty": 0,
      "average_price": 123,
      "fees_paid": 0,
      "reject_reason": "<string>",
      "parent_iceberg_order_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "parent_peg_order_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    }
  ],
  "count": 123
}

Documentation Index

Fetch the complete documentation index at: https://docs.rivermarkets.com/llms.txt

Use this file to discover all available pages before exploring further.

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.

​
buy_flag
boolean | null

Filter by direction: true=buys, false=sells

​
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)