Skip to main content

Cancel Order

REQUEST
wss://ws-auth.kraken.com/v2
cancel_orderAuthentication Required

The cancel_order request cancels one or more open orders in a single request. The orders to be cancelled can be identified by a range of client or Kraken identifiers. Note, the details of the individual cancelled orders will also be streamed on the executions channel.

Request​

MESSAGE BODY

method string required
Value: cancel_order
params object
order_id array of string
A list of Kraken order_id identifiers.
cl_ord_id array of string
A list of client cl_ord_id identifiers.
order_userref array of integer
A list of client order_userref identifiers.
token string required
This is a authenticated channel, a session token is required. See guides on how to generate a token via REST.
req_id integer
Optional client originated request identifier sent as acknowledgment in the response.

Response​

When cancelling multiple orders, there will be a stream of individual order responses.

MESSAGE BODY

method string
Value: cancel_order
result object conditional
Condition: On successful requests only
order_id string
Kraken identifier of the cancelled order.
cl_ord_id string
Optional client identifier of the cancelled order.
warnings array of strings
An advisory message, highlighting deprecated fields or upcoming changes to the request.
error string conditional
Condition: On unsuccessful requests only
The error message for a rejected request.
success boolean
Possible values: [true, false]
Indicates if the request was successfully processed by the engine.
req_id integer
Optional client originated request identifier sent as acknowledgment in the response.
time_in string
Format: RFC3339
Example: 2022-12-25T09:30:59.123456Z
The timestamp when the request was received on the wire, just prior to parsing data.
time_out string
Format: RFC3339
Example: 2022-12-25T09:30:59.123456Z
The timestamp when the response was sent on the wire, just prior to transmitting data.