Skip to main content
GET
/
v1
/
orders
List Orders
curl --request GET \
  --url https://api.rivermarkets.com/v1/orders \
  --header 'x-api-key: <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": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "complex_order_ids": {},
      "price": 123,
      "river_id": 123,
      "custom_asset_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "expiry_ts_utc": "2023-11-07T05:31:56Z",
      "traded_qty": 0,
      "average_price": 123,
      "fees_paid": 0,
      "reject_reason": "<string>"
    }
  ],
  "count": 123
}

Authorizations

​
x-api-key
string
header
required

API key for programmatic access. Generate one at app.rivermarkets.com under Settings → API Keys.

Query Parameters

​
status
enum<string> | null

Filter by order status

Available options:
PENDING_SUBMISSION,
RESTING,
EXECUTED,
CANCELLED,
REJECTED,
EXPIRED,
PARTIALLY_FILLED,
PROCESSING
​
river_id
integer | null

Filter by instrument ID

​
custom_asset_id
string<uuid> | null

Filter by custom asset ID

​
subaccount_id
string<uuid> | null

Filter to a specific subaccount

​
buy_flag
boolean | null

Filter by direction: true=buys, false=sells

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