{
  "message": "cancelOrder",
  "content": {
    "clientRequestId": "0835bf3e-4a20-41f0-908d-8213f2b7a285",
    "orderId": "01HH0X2VD6R0CJE4X0P0D1NQ11",
    "cancelBy": "orderId"
  }
}

// Order deleted successfully
{
  "resultType": "cancelOrder",
  "data": {
    "clientRequestId": "0835bf3e-4a20-41f0-908d-8213f2b7a285",
    "statusCode": 200,
    "body": "order cancelled",
    "order": {
        "market": "ETH-USD",
        "orderId": "01HZ5J70FCBNJAS7TVPVB4GAAG",
        "orderType": "buy",
        "tradeType": "limit",
        "price": "3601",
        "quantity": "1",
        "leverage": "1",
        "createdAt": 1717100052972,
        "updatedAt": 1717100393492,
        "orderStatus": "active"
    }
  }
}

For the current WebSocket request, you can optionally include a unique client request ID in the request body. The same client request ID will be found in the response and is used to match the response to the request. The client request ID must be a UUID.

The quantity in the response is the remaining quantity of the order at the time of cancellation. It’s NOT the initial quantity of the order.

However, if you want to get the 100% accurate remaining quantity of the order at the time of cancellation, we recommend relying on the completed orders information that you can get from one of three different APIs:

The orderStatus in the response indicates the order’s status at the time it was cancelled. It could be active, pending and others depending on timing.

​
URL

This stream can be subscribed per market and you will need to pass in the market in the URL query. See below.

​
Query params

​
market
string
required

Example value: ETH-USD. To get all supported markets, call /api/v1/markets endpoint.

​
Headers

See Authorization section on how to retrieve authorization token. Once token is received, set Sec-WebSocket-Protocol headers in the WebSocket handshake request or on connect().

​
Sec-WebSocket-Protocol
string
required

Example value (authorization token) :

authorization#eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJzdGFnaW5nLmZ1bmdpYmxlLnh5eiIsInN1YiI6ImQxM2I1MzBmLWFmNzMtNDBmOS04ZjhlLWVkNzk1OTU3YTU3ZiIsImF1ZCI6WyJzdGFnaW5nLWFwcC5mdW5naWJsZS54eXoiXSwiZXhwIjoxNzAzMzA1NzQwLCJpYXQiOjE3MDMzMDM5NDB9.vsHe4G_yEkRfz8XNoTKcX83udA-LUysWD4q80wfCC8k

{
  "message": "cancelOrder",
  "content": {
    "clientRequestId": "0835bf3e-4a20-41f0-908d-8213f2b7a285",
    "orderId": "01HH0X2VD6R0CJE4X0P0D1NQ11",
    "cancelBy": "orderId"
  }
}

// Order deleted successfully
{
  "resultType": "cancelOrder",
  "data": {
    "clientRequestId": "0835bf3e-4a20-41f0-908d-8213f2b7a285",
    "statusCode": 200,
    "body": "order cancelled",
    "order": {
        "market": "ETH-USD",
        "orderId": "01HZ5J70FCBNJAS7TVPVB4GAAG",
        "orderType": "buy",
        "tradeType": "limit",
        "price": "3601",
        "quantity": "1",
        "leverage": "1",
        "createdAt": 1717100052972,
        "updatedAt": 1717100393492,
        "orderStatus": "active"
    }
  }
}