Skip to main content
GET
/
v1
/
complex-orders
/
{complex_order_id}
Get Complex Order
curl --request GET \
  --url https://api.rivermarkets.com/v1/complex-orders/{complex_order_id} \
  --header 'X-River-Key-Id: <api-key>' \
  --header 'X-River-Signature: <api-key>' \
  --header 'X-River-Timestamp: <api-key>'
{
  "complex_order_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "complex_order_type": "<string>",
  "subaccount_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "status": "<string>",
  "created_at": "<string>",
  "updated_at": "<string>",
  "complex_order_subtype": "<string>",
  "river_id": 123,
  "generic_asset_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "conditional_order": {
    "parent_river_order_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "parent_complex_order_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "conditional_order_type": "<string>",
    "stop_order_price": 123,
    "trigger_stop_order_price": 123,
    "trigger_order_type": "<string>",
    "trigger_order_qty": 123,
    "trigger_order_limit_price": 123,
    "trigger_order_buy_flag": true,
    "trigger_river_order_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "trigger_complex_order_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  },
  "iceberg_order": {
    "buy_flag": true,
    "total_qty": 123,
    "displayed_qty": 123,
    "limit_price": 123,
    "post_only": true,
    "reload_delay_s": 1800,
    "executed_qty": 123,
    "remaining_qty": 123,
    "expiry_ts_utc": "2023-11-07T05:31:56Z",
    "reject_reason": "<string>"
  },
  "peg_order": {
    "buy_flag": true,
    "total_qty": 123,
    "limit_price": 123,
    "post_only": true,
    "executed_qty": 123,
    "remaining_qty": 123,
    "expiry_ts_utc": "2023-11-07T05:31:56Z",
    "peg_min_stay_time_s": 123,
    "reject_reason": "<string>"
  }
}

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.

Path Parameters

​
complex_order_id
string<uuid>
required

Response

Successful Response

Schema for a complex order response (unified across all complex order types).

​
complex_order_id
string<uuid>
required

Unique complex order identifier

​
complex_order_type
string
required

Complex order type: CONDITIONAL, TWAP, etc.

​
subaccount_id
string<uuid>
required

Subaccount the order belongs to

​
status
string
required

Order status (interpretation depends on complex_order_type)

​
created_at
string
required

Creation timestamp (UTC)

​
updated_at
string
required

Last update timestamp (UTC)

​
complex_order_subtype
string | null

Complex order subtype: TP, SL, STOP, etc.

​
river_id
integer | null

Instrument ID

​
generic_asset_id
string<uuid> | null

Generic asset basket ID

​
conditional_order
ConditionalOrderResponse · object

Conditional order detail

​
iceberg_order
IcebergOrderResponse · object

Iceberg order detail

​
peg_order
PegOrderResponse · object

Peg order detail