private/cancel_all_by_currency

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

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

cURL

cURL

curl --request GET \
  --url https://test.deribit.com/api/v2/private/cancel_all_by_currency \
  --header 'Content-Type: application/json' \
  --data '
{
  "jsonrpc": "2.0",
  "id": 5663,
  "method": "private/cancel_all_by_currency",
  "params": {
    "currency": "BTC",
    "kind": "option"
  }
}
'

import requests

url = "https://test.deribit.com/api/v2/private/cancel_all_by_currency"

payload = {
    "jsonrpc": "2.0",
    "id": 5663,
    "method": "private/cancel_all_by_currency",
    "params": {
        "currency": "BTC",
        "kind": "option"
    }
}
headers = {"Content-Type": "application/json"}

response = requests.get(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'GET',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    jsonrpc: '2.0',
    id: 5663,
    method: 'private/cancel_all_by_currency',
    params: {currency: 'BTC', kind: 'option'}
  })
};

fetch('https://test.deribit.com/api/v2/private/cancel_all_by_currency', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://test.deribit.com/api/v2/private/cancel_all_by_currency",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_POSTFIELDS => json_encode([
    'jsonrpc' => '2.0',
    'id' => 5663,
    'method' => 'private/cancel_all_by_currency',
    'params' => [
        'currency' => 'BTC',
        'kind' => 'option'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://test.deribit.com/api/v2/private/cancel_all_by_currency"

	payload := strings.NewReader("{\n  \"jsonrpc\": \"2.0\",\n  \"id\": 5663,\n  \"method\": \"private/cancel_all_by_currency\",\n  \"params\": {\n    \"currency\": \"BTC\",\n    \"kind\": \"option\"\n  }\n}")

	req, _ := http.NewRequest("GET", url, payload)

	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://test.deribit.com/api/v2/private/cancel_all_by_currency")
  .header("Content-Type", "application/json")
  .body("{\n  \"jsonrpc\": \"2.0\",\n  \"id\": 5663,\n  \"method\": \"private/cancel_all_by_currency\",\n  \"params\": {\n    \"currency\": \"BTC\",\n    \"kind\": \"option\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://test.deribit.com/api/v2/private/cancel_all_by_currency")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"jsonrpc\": \"2.0\",\n  \"id\": 5663,\n  \"method\": \"private/cancel_all_by_currency\",\n  \"params\": {\n    \"currency\": \"BTC\",\n    \"kind\": \"option\"\n  }\n}"

response = http.request(request)
puts response.read_body

200

{
  "jsonrpc": "2.0",
  "id": 47,
  "result": 4
}

Query Parameters

currency · enum<string> · required

The currency symbol Currency, i.e "BTC", "ETH", "USDC"

Available options: BTC, ETH, USDC, USDT, EURR

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, the output format is changed to include a list of all cancelled orders.

📖 Related Article: Detailed Response for Cancel Methods

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