v2

latestOpenAPI 3.1.0Proprietary2026-08-054985119.4 KB
complex-orders

List Complex Orders

List complex orders (conditional and iceberg) with optional filters.

Returns a dict keyed by complex order type (conditional_orders, iceberg_orders). Use complex_order_type to restrict to one type.

get/v1/complex-orders

Query parameters

complex_order_typestring nullable

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

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

statusstring[] nullable

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.

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_idinteger nullable

Filter by instrument ID

Filter by instrument ID

generic_asset_idstring uuid nullable

Filter by generic asset basket ID

Filter by generic asset basket ID

subaccount_idstring uuid nullable

Filter to a specific subaccount

Filter to a specific subaccount

complex_order_idsstring[] nullable

Filter by complex order IDs

Filter by complex order IDs

parent_river_order_idstring uuid nullable

Filter by parent order ID

Filter by parent order ID

unparented_onlyboolean

When true, only return conditional orders with no parent_river_order_id (standalone stops). Ignored for non-conditional types.

When true, only return conditional orders with no parent_river_order_id (standalone stops). Ignored for non-conditional types.

limitinteger

Results per page (max 1000)

Results per page (max 1000)

offsetinteger

Pagination offset

Pagination offset

Response

Successful Response

complex_ordersobject required

List of complex orders matching the query

countinteger required

Total count of matching complex orders (for pagination)