Batch Cancel

Cancel multiple orders in a single request

WSSws-auth.kraken.com/v2batch_cancel

The batch_cancel request enables multiple orders to be cancelled in a single request by a range of identifiers (minimum of 2 and maximum 50 in each batch).

Request

method · string · required

Value: batch_cancel

params · object

Hide properties

orders · string[] · required

A list containing either client order_userref or Kraken order_id identifiers.

cl_ord_id · string[]

A list of client cl_ord_id identifiers.

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

method · string

Value: batch_cancel

result · object

Condition: if success is true

Hide properties

count · integer

Number of orders cancelled.

warnings · array of string

Non-fatal warnings, 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