Skip to main content
POST
Cancel All Complex Orders

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 cancelling all complex orders for a subaccount.

subaccount_id
string<uuid>
required

Subaccount to cancel all complex orders for

river_ids
integer[] | null

If set, only cancel cancellable complex orders for these instruments. Must be either omitted/null or a non-empty list.

Response

Successful Response

Schema for cancel order response What is returned when user cancels an order/ orders.

cancelled_complex_order_ids
string<uuid>[]
required

List of cancelled complex order identifiers

failed_cancelled_complex_order_ids
Failed Cancelled Complex Order Ids · object
required

Dictionary of failed to cancel complex order identifiers and reasons