Skip to main content
cURL
curl --request GET \
  --url https://test.deribit.com/api/v2/private/cancel_all_by_currency_pair \
  --header 'Content-Type: application/json' \
  --data '
{
  "jsonrpc": "2.0",
  "id": 5663,
  "method": "private/cancel_all_by_currency_pair",
  "params": {
    "currency_pair": "BTC_USD",
    "kind": "option"
  }
}
'
{
  "jsonrpc": "2.0",
  "id": 47,
  "result": 4
}

Query Parameters

​
currency_pair
enum<string>
required

The currency pair symbol Index identifier, matches (base) cryptocurrency with quote currency

Available options:
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,
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
​
kind
enum<string>

Instrument kind, "combo" for any combo or "any" for all. If not provided instruments of all kinds are considered Instrument kind: "future", "option", "spot", "future_combo", "option_combo", "combo" for any combo or "any" for all

Available options:
future,
option,
spot,
future_combo,
option_combo,
combo,
any
​
type
enum<string>

Order type - limit, stop, take, trigger_all or all, default - all Order type: "all", "limit", "stop", "take", "trailing_stop", "trailing_take"

Available options:
all,
limit,
trigger_all,
stop,
take,
trailing_stop
​
detailed
boolean

When detailed is set to true output format is changed. See description. Default: false

​
freeze_quotes
boolean

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

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