> ## Documentation Index
> Fetch the complete documentation index at: https://docs.deribit.com/llms.txt
> Use this file to discover all available pages before exploring further.
# private/cancel_all_by_currency_pair
> 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](https://test.deribit.com/api_console?method=%2Fprivate%2Fcancel_all_by_currency_pair)
## OpenAPI
````yaml /specifications/deribit_openapi.json get /private/cancel_all_by_currency_pair
openapi: 3.0.0
info:
title: Deribit API
version: 2.1.1
servers:
- url: https://test.deribit.com/api/v2
security: []
tags:
- name: WebSocket Only
description: Can only be used over websockets.
- name: Public
description: Public methods can be used without authentication.
- name: Private
description: >-
Private methods require authentication. All requests must include a
valid OAuth2 token.
A token can be requested using the /public/auth method.
When using the websockets protocol, the token must be included as a
parameter access_token in the message. When using REST (HTTP
GET), the token may also be passed in the Authorization
header.
- name: Authentication
- name: Session Management
- name: Subscription Management
description: >-
Subscription works as [notifications](#notifications), so users will
automatically (after subscribing) receive messages from the server.
Overview for each channel response format is described in
[subscriptions](#subscriptions) section.
- name: Account Management
- name: Trading
- name: Market Data
- name: Wallet
- name: Chat
paths:
/private/cancel_all_by_currency_pair:
get:
tags:
- Trading
- Matching Engine
- Private
description: >+
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](https://test.deribit.com/api_console?method=%2Fprivate%2Fcancel_all_by_currency_pair)
parameters:
- name: currency_pair
required: true
in: query
schema:
$ref: '#/components/schemas/index_name'
description: The currency pair symbol
- name: kind
required: false
in: query
schema:
$ref: '#/components/schemas/kind_with_combo_all'
description: >-
Instrument kind, `"combo"` for any combo or `"any"` for all. If not
provided instruments of all kinds are considered
- name: type
required: false
in: query
schema:
$ref: '#/components/schemas/simple_order_type'
description: >-
Order type - `limit`, `stop`, `take`, `trigger_all` or `all`,
default - `all`
- name: detailed
required: false
in: query
schema:
type: boolean
description: >
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](https://docs.deribit.com/articles/json-rpc-overview#detailed-response-for-cancel-methods)
Default: `false`
- name: freeze_quotes
required: false
in: query
schema:
type: boolean
description: >-
Whether or not to reject incoming quotes for 1 second after
cancelling (`false` by default). Related to `private/mass_quote`
request.
requestBody:
content:
application/json:
examples:
request:
value:
jsonrpc: '2.0'
id: 5663
method: private/cancel_all_by_currency_pair
params:
currency_pair: BTC_USD
kind: option
description: JSON-RPC Request Example
description: JSON-RPC request body
responses:
'200':
$ref: '#/components/responses/PrivateCancelAllResponse'
components:
schemas:
index_name:
enum:
- 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
type: string
description: Index identifier, matches (base) cryptocurrency with quote currency
kind_with_combo_all:
enum:
- future
- option
- spot
- future_combo
- option_combo
- combo
- any
type: string
description: >-
Instrument kind: `"future"`, `"option"`, `"spot"`, `"future_combo"`,
`"option_combo"`, `"combo"` for any combo or `"any"` for all
simple_order_type:
enum:
- all
- limit
- trigger_all
- stop
- take
- trailing_stop
type: string
description: >-
Order type: `"all"`, `"limit"`, `"stop"`, `"take"`, `"trailing_stop"`,
`"trailing_take"`
PrivateCancelAllResponse:
properties:
jsonrpc:
type: string
enum:
- '2.0'
description: The JSON-RPC version (2.0)
id:
type: integer
description: The id that was sent in the request
result:
type: number
example: 7
description: Total number of successfully cancelled orders
required:
- jsonrpc
- result
type: object
responses:
PrivateCancelAllResponse:
content:
application/json:
schema:
$ref: '#/components/schemas/PrivateCancelAllResponse'
examples:
response:
value:
jsonrpc: '2.0'
id: 47
result: 4
description: Response example
description: Success response
````