{
  "message": "cancelOrder",
  "content": {
    "clientRequestId": "0835bf3e-4a20-41f0-908d-8213f2b7a285",
    "price": "1788.00",
    "orderType": "buy",
    "tradeType": "limit",
    "cancelBy": "price"
  }
}

// Orders deleted successfully
{
  "resultType": "cancelOrder",
  "data": {
    "statusCode": 200,
    "body": "order cancelled",
    "order": {
        "orderId": "01HZ5JPAH8DMWCAHK96A90GGHF",
        "market": "ETH-USD",
        "orderType": "buy",
        "tradeType": "limit",
        "orderStatus": "cancelled",
        "price": "3600",
        "quantity": "1",
        "filledQuantity": "0",
        "leverage": "1",
        "updatedAt": 1746642612190,
        "createdAt": 1746640906441,
        "reduceOnly": false,
        "postOnly": false
    },
    "clientRequestId": "0835bf3e-4a20-41f0-908d-8213f2b7a285#0"
  },
  "connectionId": "KNal9ekeCYcCIBA="
}

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.

Note that in the order object, quantity represents the remaining quantity and filledQuantity represents the cumulative filled quantity. The two values will add up to the original order quantity.

When you get 409 status code, it means that the order was in the process of being filled at the time of cancellation. Please retry the cancellation request if you get this status code.

Cancelling order by price may delete multiple orders. Each deleted order will be returned in a separate response. If a client request ID was provided, all these responses will contain the same client request ID plus a suffix. For example, if the client request ID is 0835bf3e-4a20-41f0-908d-8213f2b7a285 and there are two orders of the same price, the two responses will contain 0835bf3e-4a20-41f0-908d-8213f2b7a285#0 and 0835bf3e-4a20-41f0-908d-8213f2b7a285#1 respectively in no particular order.

​
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",
    "price": "1788.00",
    "orderType": "buy",
    "tradeType": "limit",
    "cancelBy": "price"
  }
}

// Orders deleted successfully
{
  "resultType": "cancelOrder",
  "data": {
    "statusCode": 200,
    "body": "order cancelled",
    "order": {
        "orderId": "01HZ5JPAH8DMWCAHK96A90GGHF",
        "market": "ETH-USD",
        "orderType": "buy",
        "tradeType": "limit",
        "orderStatus": "cancelled",
        "price": "3600",
        "quantity": "1",
        "filledQuantity": "0",
        "leverage": "1",
        "updatedAt": 1746642612190,
        "createdAt": 1746640906441,
        "reduceOnly": false,
        "postOnly": false
    },
    "clientRequestId": "0835bf3e-4a20-41f0-908d-8213f2b7a285#0"
  },
  "connectionId": "KNal9ekeCYcCIBA="
}