Sign in

v3

latestOpenAPI 3.0.02026-07-311784111.3 MB
Trading
Matching Engine
Private

Cancels quotes (mass quote orders) based on various criteria. This method provides flexible options for cancelling quotes:

  • delta: Cancels quotes within a delta range defined by min_delta and max_delta
  • quote_set_id: Cancels quotes by a specific Quote Set identifier
  • instrument: Cancels all quotes associated with a particular instrument
  • kind: Cancels all quotes for a certain instrument kind
  • currency: Cancels all quotes in a specified currency
  • currency_pair: Cancels all quotes in a specified currency pair
  • all: Cancels all quotes

Use the detailed parameter to receive a list of all cancelled quotes.

Scope: trade:read_write

Try in API console

get/private/cancel_quotes

Query parameters

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.

cancel_type'delta' | 'quote_set_id' | 'instrument' | 'instrument_kind' | 'currency' | 'currency_pair' | 'all' required
Example:delta

Type of cancel criteria.

min_deltanumber
Example:0.4

Min delta to cancel by delta (for cancel_type: delta).

max_deltanumber
Example:0.6

Max delta to cancel by delta (for cancel_type: delta).

quote_set_idstring

Unique identifier for the Quote set.

instrument_namestring

Instrument name.

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

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

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

The currency symbol

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

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 quotes

Example response

{
  "result": 3
}