private/cancel_by_label

Cancels all orders (including trigger orders) that have a specific label. This is useful for managing groups of related orders that share the same label.

Orders can be cancelled across all currencies or filtered to a specific currency. When cancelling by currency, the currency queue is used for processing.

Rate Limits: When called without the currency parameter, this method is subject to cancel_all rate limits. Different rate limit values may apply for per-currency cancels versus calls without providing the currency parameter.

Scope: trade:read_write

Try in API console

cURL

cURL

curl --request GET \
  --url https://test.deribit.com/api/v2/private/cancel_by_label \
  --header 'Content-Type: application/json' \
  --data '
{
  "jsonrpc": "2.0",
  "id": 47,
  "method": "private/cancel_by_label",
  "params": {
    "label": "label"
  }
}
'

200

{
  "jsonrpc": "2.0",
  "id": 47,
  "result": 4
}

Query Parameters

label · string · required

user defined label for the order (maximum 64 characters)

currency · enum<string>

The currency symbol Currency, i.e "BTC", "ETH", "USDC"

Available options: BTC, ETH, USDC, USDT, EURR

Response

200 - application/json

Success response

jsonrpc · enum<string> · required

The JSON-RPC version (2.0)

Available options: 2.0

result · number · required

Total number of successfully cancelled orders

Example:

7

id · integer

The id that was sent in the request