Sign in

v2

OpenAPI 3.0.02026-07-311824171.4 MB
Trading
Matching Engine
Private

Cancels all open orders for a specific currency pair. This is useful for quickly clearing all orders across instruments in a currency pair.

Orders can be optionally filtered by instrument kind (future, option, etc.) and/or order type (limit, market, stop, etc.). Use the detailed parameter to receive a list of all cancelled orders.

Scope: trade:read_write

Try in API console

get/private/cancel_all_by_currency_pair

Query parameters

currency_pair'btc_usd' | 'eth_usd' | 'ada_usdc' | 'algo_usdc' | 'avax_usdc' | 'bch_usdc' | 'bnb_usdc' | 'btc_usdc' | 'btcdvol_usdc' | 'buidl_usdc' | 'doge_usdc' | 'dot_usdc' | 'eurr_usdc' | 'eth_usdc' | 'ethdvol_usdc' | 'hype_usdc' | 'link_usdc' | 'ltc_usdc' | 'near_usdc' | 'paxg_usdc' | 'shib_usdc' | 'sol_usdc' | 'steth_usdc' | 'ton_usdc' | 'trump_usdc' | 'trx_usdc' | 'uni_usdc' | 'usde_usdc' | 'usyc_usdc' | 'xrp_usdc' | 'btc_usdt' | 'eth_usdt' | 'eurr_usdt' | 'sol_usdt' | 'steth_usdt' | 'usdc_usdt' | 'usde_usdt' | 'btc_eurr' | 'btc_usde' | 'btc_usyc' | 'eth_btc' | 'eth_eurr' | 'eth_usde' | 'eth_usyc' | 'steth_eth' | 'paxg_btc' | 'drbfix-btc_usdc' | 'drbfix-eth_usdc' required

Index identifier, matches (base) cryptocurrency with quote currency

The currency pair symbol

kind'future' | 'option' | 'spot' | 'future_combo' | 'option_combo' | 'combo' | 'any'

Instrument kind: "future", "option", "spot", "future_combo", "option_combo", "combo" for any combo or "any" for all

Instrument kind, "combo" for any combo or "any" for all. If not provided instruments of all kinds are considered

type'all' | 'limit' | 'trigger_all' | 'stop' | 'take' | 'trailing_stop'

Order type: "all", "limit", "stop", "take", "trailing_stop", "trailing_take"

Order type - limit, stop, take, trigger_all or all, default - all

detailedboolean

When detailed is set to true, the output format is changed to include a list of all cancelled orders.

📖 Related Article: Detailed Response for Cancel Methods

Default: false

freeze_quotesboolean

Whether or not to reject incoming quotes for 1 second after cancelling (false by default). Related to private/mass_quote request.

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
}