Cancel order

Cancel existing order.

Rate limit: 10000 requests/10 sec.

• Modification by client_order_id takes priority over order_id.
• The request supports working only with order_id or only with client_order_id.
• Do not pass both values at the same time.

Error Codes

• 30 - default validation error code
• 31 - market validation failed

Errors

{
  "code": 30,
  "message": "Validation failed",
  "errors": {
    "market": ["Market field is required."],
    "order_id": ["OrderId field is required."]
  }
}

{
  "code": 30,
  "message": "Validation failed",
  "errors": {
    "market": ["Market is not available."]
  }
}

{
  "code": 31,
  "message": "Validation failed",
  "errors": {
    "market": ["Market is not available."]
  }
}

{
  "code": 30,
  "message": "Validation failed",
  "errors": {
    "order_id": ["OrderId field should be an integer."]
  }
}

{
  "code": 30,
  "message": "Validation failed",
  "errors": {
    "market": [
      "Market field should be a string.",
      "Market field format is invalid."
    ]
  }
}

{
  "code": 2,
  "message": "Inner validation failed",
  "errors": {
    "order_id": ["Unexecuted order was not found."]
  }
}

POST /api/v4/order/cancel

Cancel order

cURL

curl --request POST \
  --url https://whitebit.com/api/v4/order/cancel \
  --header 'Content-Type: application/json' \
  --header 'X-TXC-APIKEY: <api-key>' \
  --data '
{
  "market": "BTC_USDT",
  "request": "{{request}}",
  "nonce": "{{nonce}}",
  "order_id": 123456,
  "client_order_id": "customId11"
}
'

200

{
  "order_id": 4180284841,
  "client_order_id": "order1987111",
  "market": "BTC_USDT",
  "side": "buy",
  "type": "limit",
  "timestamp": 1595792396.165973,
  "deal_money": "0",
  "deal_stock": "0",
  "amount": "0.01",
  "left": "0.001",
  "deal_fee": "0",
  "price": "40000",
  "postOnly": false,
  "ioc": false,
  "status": "FILLED",
  "stp": "no",
  "positionSide": "LONG",
  "rpi": true
}

Authorizations

X-TXC-APIKEY · string · header · required

API Key authentication for private endpoints.

Required headers:

• X-TXC-APIKEY: API key
• X-TXC-PAYLOAD: Base64 encoded JSON payload
• X-TXC-SIGNATURE: HMAC SHA512 signature

Body

application/json

market · string · required

Available market. Example: BTC_USDT

Example:

"BTC_USDT"

request · string · required

Example:

"{{request}}"

nonce · string · required

Example:

"{{nonce}}"

order_id · integer

Order Id. Example: 4180284841. Required if client_order_id is not set.

Example:

123456

client_order_id · string

Custom client order id. Example: 'customId11'. Required if order_id is not set.

Example:

"customId11"

Response

200

application/json

Order cancelled successfully

order_id · integer

Order ID

Example:

4180284841

client_order_id · string

Custom client order ID; empty string if not specified

Example:

"order1987111"

market · string

Deal market

Example:

"BTC_USDT"

side · string

Order side

Example:

"buy"

type · string

Order type

Example:

"limit"

timestamp · number

Timestamp of order creation

Example:

1595792396.165973

deal_money · string

If order finished - amount in money currency that is finished

Example:

"0"

deal_stock · string

If order finished - amount in stock currency that is finished

Example:

"0"

amount · string

Amount

Example:

"0.01"

left · string

If order not finished - rest of the amount that must be finished

Example:

"0.001"

deal_fee · string

Fee in money currency when order is filled

Example:

"0"

price · string

Price

Example:

"40000"

postOnly · boolean

PostOnly flag

Example:

false

ioc · boolean

IOC flag

Example:

false

status · string

Order status

Example:

"FILLED"

stp · string

Self trade prevention mode

Example:

"no"

positionSide · string

Position side (for collateral orders)

Example:

"LONG"

rpi · boolean

Indicates Retail Price Improvement (RPI) mode for the order.

Example:

true