cancel action removes resting orders from the order book using the exchange-assigned order IDs returned in the resting.oid field when you originally placed them. You can cancel up to 10 orders in a single signed request, mixing contracts freely within the batch.
Endpoint
Request Body
Action Fields
string
required
Fixed value:
"cancel".array
required
Array of cancel objects. Maximum 10 per request. Each entry must identify the contract and the exchange order ID to cancel.
Cancel Object Fields
int32
required
asset — The integer contract ID for the order you want to cancel. Must match the contract the order was placed on.
int64
required
orderId — The exchange-assigned order ID from the
resting.oid field returned when the order was placed.Responses
The response contains one status entry per cancel object in the same index order as your request.- Success
- Order Not Found
All cancellations were accepted. Each successful entry is the plain string
"success".Response Fields
array
One entry per cancel object in request order. Each entry is either:
- The string
"success"— the order was found and removed from the book. - An object
{"error": "<reason>"}— the cancellation failed; the reason string explains why.
A top-level
"status": "ok" does not mean every individual cancellation succeeded. Always inspect each element of statuses to detect per-order failures.