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-api-key: <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": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "complex_order_subtype": "<string>",
  "river_id": 123,
  "custom_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"
  }
}

Authorizations

​
x-api-key
string
header
required

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

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<date-time>
required

Creation timestamp (UTC)

​
updated_at
string<date-time>
required

Last update timestamp (UTC)

​
complex_order_subtype
string | null

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

​
river_id
integer | null

Instrument ID

​
custom_asset_id
string<uuid> | null

Custom asset basket ID

​
conditional_order
ConditionalOrderResponse · object

Conditional order