Cancel Order

Cancel one or more open orders via WebSocket

WSSws-auth.kraken.com/v2cancel_order

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

method · string · required

Value: cancel_order

params · object · required

Hide properties

order_id · array of string

A list of Kraken order_id identifiers. Cannot be combined with cl_ord_id or order_userref in the same request.

cl_ord_id · array of string

A list of client cl_ord_id identifiers. Cannot be combined with order_id or order_userref in the same request.

order_userref · array of integer

A list of client order_userref identifiers. Cannot be combined with order_id or cl_ord_id in the same request.

token · string · required

Authentication token. See authentication guide for details.

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.

method · string

Value: cancel_order

result · object

Hide properties

order_id · string

Kraken identifier of the cancelled order.

cl_ord_id · string

Optional client identifier of the cancelled order.

warnings · array of string

Non-fatal warnings about the cancellation, if any.

error · string

Error message. Condition: if success is false.

success · boolean

Indicates if the request was successfully processed by the engine. One of: true, false

req_id · integer

Optional client originated request identifier sent as acknowledgment in the response.

time_in · string

The timestamp when the request was received on the wire, just prior to parsing data. Format: RFC3339. Example: 2022-12-25T09:30:59.123456Z

time_out · string

The timestamp when the response was sent on the wire, just prior to transmitting data. Format: RFC3339. Example: 2022-12-25T09:30:59.123456Z