Order Cancel Request

REQUEST
wss://wss.prime.kraken.com/ws/v1
order-cancel-requestAuthentication Required

Command used to cancel an open order. Results of this command will be visible in the Order and ExecutionReport streams.

Request

Request Schema

reqid number required

Request ID.

type string required

Value: OrderCancelRequest

Command type.

data array [ required

Cancel request data array.

Symbol string required

Symbol of the security to submit an order on.

ClOrdID string required

Unique Client Order ID for this request, usually a UUID.

OrigClOrdID string

Client Order ID of the order to cancel, one of OrderID, OrigClOrdID is required.

OrderID string

Order ID of the order to cancel, one of OrderID, OrigClOrdID is required.

TransactTime string required

An ISO-8601 UTC string of the form 2019-02-13T05:17:32.000000Z.

Timestamp string

Timestamp of the message.

]

Example

{
  "reqid": 13,
  "type": "OrderCancelRequest",
  "data": [
    {
      "Symbol": "BTC-USD",
      "ClOrdID": "c0be17e0-15da-11ec-b5e7-7f4881f01b7d",
      "OrderID": "16a55364-4248-4575-aa0b-dddd3f694ca3",
      "TransactTime": "2021-09-15T04:09:42.238000Z"
    }
  ]
}