v2

OpenAPI 3.0.02026-07-311824171.4 MB
Trading
Matching Engine
Private

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

get/private/cancel_by_label

Query parameters

labelstring required

user defined label for the order (maximum 64 characters)

currency'BTC' | 'ETH' | 'USDC' | 'USDT' | 'EURR'

Currency, i.e "BTC", "ETH", "USDC"

The currency symbol

Response

Success response

jsonrpc'2.0' required

The JSON-RPC version (2.0)

idinteger

The id that was sent in the request

resultnumber required

Total number of successfully cancelled orders

Example response

{
  "result": 7
}