wss://trade.qfex.com?api_key=YOUR_API_KEY
order_id
or client_order_id
:
order_id
— always a UUID v4 and unique. Cancels exactly one order.client_order_id
— not guaranteed unique. Cancels all orders for that symbol that share this client order id.Use thecancel_order_id_type
field to specify which one you’re sending:"order_id"
or"client_order_id"
.
order_id
(single order)client_order_id
(may cancel multiple)Field | Type | Required | Description |
---|---|---|---|
order_id | string | Optional | UUID v4 of the order to cancel. Required if cancel_order_id_type = "order_id" . Cancels exactly one order. |
client_order_id | string | Optional | Client-specified ID to cancel orders. Required if cancel_order_id_type = "client_order_id" . May cancel multiple orders. |
symbol | string | ✅ | Market symbol of the order(s) (e.g. AAPL-USD ). |
cancel_order_id_type | enum | ✅ | Must be "order_id" or "client_order_id" . Tells the engine how to interpret the ID. |
⚠️ Notes:
- You must provide either
order_id
orclient_order_id
, depending oncancel_order_id_type
.order_id
is always unique (UUID v4).client_order_id
is not guaranteed unique and may cancel multiple orders for the same symbol.- Responses will include OrderStatus codes, e.g.
CANCELLED
,NO_SUCH_ORDER
, orREJECTED
.
ACK
. Cancelling it returns the same structure but with status CANCELLED
.