Skip to main content
POST
Create Complex Order

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.

Body

application/json

Request body for creating a complex order.

Provide exactly one of conditional_order_params (TP/SL/STOP) or iceberg_order_params (iceberg). The active param block determines the complex_order_type.

subaccount_id
string<uuid>
required

Subaccount to create the order under

river_id
integer | null

Instrument ID. Mutually exclusive with generic_asset_id.

generic_asset_id
string<uuid> | null

Generic asset basket ID. Mutually exclusive with river_id.

conditional_order_params
ConditionalOrderCreate · object | null

Conditional order parameters (TP/SL/STOP)

iceberg_order_params
IcebergOrderParams · object | null

Iceberg order parameters

peg_order_params
PegOrderParams · object | null

Peg order parameters

smart_taker_order_params
SmartTakerOrderParams · object | null

Smart-taker order parameters

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