public/get_instruments

Retrieves available trading instruments. This method can be used to see which instruments are available for trading, or which instruments have recently expired.

Note - This method has distinct API rate limiting requirements: Sustained rate: 1 request/second. To avoid rate limits, we recommend using either the REST requests for server-cached data or the WebSocket subscription to instrument_state.. for real-time updates. For more information, see Rate Limits.

Results can be filtered by currency and instrument kind (future, option, etc.). Set the expired parameter to true to retrieve recently expired instruments instead of active ones. Each instrument includes the underlying_type field indicating whether the underlying asset is equity, commodity, or crypto.

Try in API console

cURL

cURL

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

import requests

url = "https://test.deribit.com/api/v2/public/get_instruments"

payload = {
    "jsonrpc": "2.0",
    "id": 1,
    "method": "public/get_instruments",
    "params": {
        "currency": "BTC",
        "kind": "future"
    }
}
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: 1,
    method: 'public/get_instruments',
    params: {currency: 'BTC', kind: 'future'}
  })
};

fetch('https://test.deribit.com/api/v2/public/get_instruments', 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/public/get_instruments",
  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' => 1,
    'method' => 'public/get_instruments',
    'params' => [
        'currency' => 'BTC',
        'kind' => 'future'
    ]
  ]),
  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/public/get_instruments"

	payload := strings.NewReader("{\n  \"jsonrpc\": \"2.0\",\n  \"id\": 1,\n  \"method\": \"public/get_instruments\",\n  \"params\": {\n    \"currency\": \"BTC\",\n    \"kind\": \"future\"\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/public/get_instruments")
  .header("Content-Type", "application/json")
  .body("{\n  \"jsonrpc\": \"2.0\",\n  \"id\": 1,\n  \"method\": \"public/get_instruments\",\n  \"params\": {\n    \"currency\": \"BTC\",\n    \"kind\": \"future\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://test.deribit.com/api/v2/public/get_instruments")

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\": 1,\n  \"method\": \"public/get_instruments\",\n  \"params\": {\n    \"currency\": \"BTC\",\n    \"kind\": \"future\"\n  }\n}"

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

200

{
  "jsonrpc": "2.0",
  "id": 1,
  "result": [
    {
      "tick_size": 2.5,
      "tick_size_steps": [],
      "taker_commission": 0.0005,
      "settlement_period": "month",
      "settlement_currency": "BTC",
      "quote_currency": "USD",
      "price_index": "btc_usd",
      "min_trade_amount": 10,
      "max_liquidation_commission": 0.0075,
      "max_leverage": 50,
      "maker_commission": 0,
      "kind": "future",
      "is_active": true,
      "instrument_name": "BTC-29SEP23",
      "instrument_id": 138583,
      "instrument_type": "reversed",
      "expiration_timestamp": 1695974400000,
      "creation_timestamp": 1664524802000,
      "counter_currency": "USD",
      "contract_size": 10,
      "block_trade_tick_size": 0.01,
      "block_trade_min_trade_amount": 200000,
      "block_trade_commission": 0.00025,
      "base_currency": "BTC",
      "state": "open",
      "qty_tick_size": 10,
      "index_id": 1000001,
      "product_group": "BTC",
      "underlying_type": "crypto"
    },
    {
      "tick_size": 0.5,
      "tick_size_steps": [],
      "taker_commission": 0.0005,
      "settlement_period": "perpetual",
      "settlement_currency": "BTC",
      "quote_currency": "USD",
      "price_index": "btc_usd",
      "min_trade_amount": 10,
      "max_liquidation_commission": 0.0075,
      "max_leverage": 50,
      "maker_commission": 0,
      "kind": "future",
      "is_active": true,
      "instrument_name": "BTC-PERPETUAL",
      "instrument_id": 124972,
      "instrument_type": "reversed",
      "expiration_timestamp": 32503708800000,
      "creation_timestamp": 1534167754000,
      "counter_currency": "USD",
      "contract_size": 10,
      "block_trade_tick_size": 0.01,
      "block_trade_min_trade_amount": 200000,
      "block_trade_commission": 0.00025,
      "base_currency": "BTC",
      "state": "open",
      "qty_tick_size": 10,
      "index_id": 1000002,
      "product_group": "BTC",
      "underlying_type": "crypto"
    }
  ]
}

Query Parameters

currency · enum<string> · required

The currency symbol or "any" for all Currency name or "any" if don't care

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

kind · enum<string>

Instrument kind, if not provided instruments of all kinds are considered Instrument kind: "future", "option", "spot", "future_combo", "option_combo"

Available options: future, option, spot, future_combo, option_combo

expired · boolean · default: false

Set to true to show recently expired instruments instead of active ones.

Response

200 - application/json

Success response

jsonrpc · enum<string> · required

The JSON-RPC version (2.0)

Available options: 2.0

result · object[] · required

Hide child attributes

result. kind · enum<string> · required

Instrument kind: "future", "option", "spot", "future_combo", "option_combo"

Available options: future, option, spot, future_combo, option_combo

result. base_currency · enum<string> · required

The underlying currency being traded.

Available options: BTC, ETH

result. quote_currency · enum<string> · required

The currency in which the instrument prices are quoted.

Available options: USD

result. min_trade_amount · number · required

Minimum amount for trading. For perpetual and inverse futures the amount is in USD units. For options and linear futures it is the underlying base currency coin.

Example:

0.1

result. instrument_name · string · required

Unique instrument identifier

Example:

"BTC-PERPETUAL"

result. is_active · boolean · required

Indicates if the instrument can currently be traded.

result. settlement_period · enum<string> · required

Optional (not added for spot). The settlement period.

Available options: month, week, perpetual

result. creation_timestamp · integer · required

The time when the instrument was first created (milliseconds since the UNIX epoch).

Example:

1536569522277

result. tick_size · number · required

Specifies minimal price change and, as follows, the number of decimal places for instrument prices.

Example:

0.0001

result. expiration_timestamp · integer · required

The time when the instrument will expire (milliseconds since the UNIX epoch).

result. contract_size · integer · required

Contract size for instrument.

Example:

1

result. price_index · string · required

Name of price index that is used for this instrument

Example:

"btc_usdc"

result. underlying_type · enum<string> · required

The type of the underlying asset.

Available options: equity, commodity, crypto

result. settlement_currency · enum<string>

Optional (not added for spot). Settlement currency for the instrument.

Available options: BTC, ETH

result. counter_currency · enum<string>

Counter currency for the instrument.

Available options: USD, USDC

result. instrument_id · integer

Instrument ID

result. tick_size_steps · object

Hide child attributes

result.tick_size_steps. above_price · number

The price from which the increased tick size applies

result.tick_size_steps. tick_size · number

Tick size to be used above the price. It must be multiple of the minimum tick size.

result. strike · number

The strike value (only for options).

result. option_type · enum<string>

The option type (only for options).

Available options: call, put

result. future_type · enum<string>

Future type (only for futures)(field is deprecated and will be removed in the future, instrument_type should be used instead).

Available options: linear, reversed

result. instrument_type · string

Type of the instrument. linear or reversed

result. maker_commission · number

Maker commission for instrument.

Example:

0.0001

result. taker_commission · number

Taker commission for instrument.

Example:

0.0005

result. max_liquidation_commission · number

Maximal liquidation trade commission for instrument (only for futures).

Example:

0.001

result. block_trade_commission · number

Block Trade commission for instrument.

Example:

0.0005

result. block_trade_tick_size · number

Specifies minimal price change for block trading.

Example:

0.01

result. block_trade_min_trade_amount · number

Minimum amount for block trading.

Example:

25

result. max_leverage · integer

Maximal leverage for instrument (only for futures).

Example:

100

result. state · enum<string>

The state of the order book. Represents the current lifecycle stage of the instrument.

State Lifecycle and Meanings:

• open: Default state for running books. In this state book is accepting new orders, edits, cancels; prices should be updated, trading is live.
• settlement: Books enters to this state during settlement/delivery. New orders, edits, cancels are not accepted. After this state normally next state should be open if it was settlement, or delivered if it was delivery. On enter to this state good till day orders in book are canceled.
• delivered: Final state of book that has been delivered. New orders, edits, cancels are not accepted. After some time book process will be terminated and, instrument moved to expired_instruments and its instrument_state will become archivized. On enter to this all open orders in book are canceled.
• inactive: After a book is deactivated, this state is set on book. New orders, edits, cancels are not accepted. On enter to this all open orders in book are canceled. Book in this state is not considered as open. This can be also final state for book.
• locked: New orders, edits, are not accepted, only cancels ARE accepted. In some cases when configured books can start as locked or it may become locked on admin request. Settlement is possible on locked books.
• halted: The state that books enter as a result of an error. Settlement is not possible when there is at least one book in this state.
• archivized: Set when instrument is moved to expired_instruments table, final state.

Available options: open, settlement, delivered, inactive, locked, halted, archivized

result. base_currency_uuid · string

Internal identifier for the base currency. Absent if the base currency does not have an assigned identifier.

Example:

"5b71fc48-3dd3-540c-809b-f8c94d0e68b5"

result. quote_currency_uuid · string

Internal identifier for the quote currency. Absent if the quote currency does not have an assigned identifier.

Example:

"2b92315d-eab7-5bef-84fa-089a131333f5"

result. qty_tick_size · number

Minimum quantity change (step size) for order amounts on this instrument.

Example:

1

result. index_id · integer

Internal numeric identifier for the price index associated with this instrument.

Example:

2000033

result. product_group · string

Product group classification for the instrument's base currency (e.g. BTC, ETH, TIER_2).

Example:

"ETH"

result. is_csr · boolean

Optional (only for spot). When true, orders on this instrument are routed to Coinbase Exchange (CBE) for matching instead of the native Deribit matching engine.

id · integer

The id that was sent in the request