Skip to main content
GET
/
v1
/
complex-orders
List Complex Orders
curl --request GET \
  --url https://api.rivermarkets.com/v1/complex-orders \
  --header 'X-River-Key-Id: <api-key>' \
  --header 'X-River-Signature: <api-key>' \
  --header 'X-River-Timestamp: <api-key>'
{
  "complex_orders": {},
  "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

​
complex_order_type
string | null

Filter by complex order type: CONDITIONAL, TWAP, ICEBERG, PEG.

​
status
string[] | null

Filter by status name. Interpreted per complex_order_type (ConditionalOrderStatus for CONDITIONAL, IcebergOrderStatus for ICEBERG, PegOrderStatus for PEG). Unknown names for the active type are ignored.

​
river_id
integer | null

Filter by instrument ID

​
generic_asset_id
string<uuid> | null

Filter by generic asset basket ID

​
subaccount_id
string<uuid> | null

Filter to a specific subaccount

​
complex_order_ids
string<uuid>[] | null

Filter by complex order IDs

​
parent_river_order_id
string<uuid> | null

Filter by parent order ID

​
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 complex orders (all types).

​
complex_orders
Complex Orders · object
required

List of complex orders matching the query

​
count
integer
required

Total count of matching complex orders (for pagination)