curl --request GET \
--url https://test.deribit.com/api/v2/public/get_instrument \
--header 'Content-Type: application/json' \
--data '
{
"jsonrpc": "2.0",
"id": 2,
"method": "public/get_instrument",
"params": {
"instrument_name": "BTC-13JAN23-16000-P"
}
}
'{
"jsonrpc": "2.0",
"id": 2,
"result": {
"tick_size": 0.0005,
"tick_size_steps": [
{
"above_price": 120,
"tick_size": 0.001
},
{
"above_price": 200,
"tick_size": 0.003
}
],
"taker_commission": 0.0003,
"strike": 16000,
"settlement_period": "week",
"settlement_currency": "BTC",
"quote_currency": "BTC",
"price_index": "btc_usd",
"option_type": "put",
"min_trade_amount": 0.1,
"maker_commission": 0.0003,
"kind": "option",
"is_active": true,
"instrument_name": "BTC-13JAN23-16000-P",
"instrument_id": 144613,
"expiration_timestamp": 1673596800000,
"creation_timestamp": 1671696002000,
"counter_currency": "USD",
"contract_size": 1,
"block_trade_tick_size": 0.0001,
"block_trade_min_trade_amount": 25,
"block_trade_commission": 0.00015,
"base_currency": "BTC",
"state": "open"
}
}Retrieves detailed information about a specific instrument, including instrument specifications, contract details, tick size, settlement currency, expiration date (for futures and options), strike price (for options), and other instrument parameters.
This method is useful for obtaining instrument metadata needed for trading operations and calculations.
curl --request GET \
--url https://test.deribit.com/api/v2/public/get_instrument \
--header 'Content-Type: application/json' \
--data '
{
"jsonrpc": "2.0",
"id": 2,
"method": "public/get_instrument",
"params": {
"instrument_name": "BTC-13JAN23-16000-P"
}
}
'{
"jsonrpc": "2.0",
"id": 2,
"result": {
"tick_size": 0.0005,
"tick_size_steps": [
{
"above_price": 120,
"tick_size": 0.001
},
{
"above_price": 200,
"tick_size": 0.003
}
],
"taker_commission": 0.0003,
"strike": 16000,
"settlement_period": "week",
"settlement_currency": "BTC",
"quote_currency": "BTC",
"price_index": "btc_usd",
"option_type": "put",
"min_trade_amount": 0.1,
"maker_commission": 0.0003,
"kind": "option",
"is_active": true,
"instrument_name": "BTC-13JAN23-16000-P",
"instrument_id": 144613,
"expiration_timestamp": 1673596800000,
"creation_timestamp": 1671696002000,
"counter_currency": "USD",
"contract_size": 1,
"block_trade_tick_size": 0.0001,
"block_trade_min_trade_amount": 25,
"block_trade_commission": 0.00015,
"base_currency": "BTC",
"state": "open"
}
}Instrument name Unique instrument identifier
"BTC-PERPETUAL"
Success response
The JSON-RPC version (2.0)
2.0 Hide child attributes
Instrument kind: "future", "option", "spot", "future_combo", "option_combo"
future, option, spot, future_combo, option_combo The underlying currency being traded.
BTC, ETH The currency in which the instrument prices are quoted.
USD 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.
0.1
Unique instrument identifier
"BTC-PERPETUAL"
Indicates if the instrument can currently be traded.
Optional (not added for spot). The settlement period.
month, week, perpetual The time when the instrument was first created (milliseconds since the UNIX epoch).
1536569522277
Specifies minimal price change and, as follows, the number of decimal places for instrument prices.
0.0001
The time when the instrument will expire (milliseconds since the UNIX epoch).
Contract size for instrument.
1
Name of price index that is used for this instrument
"btc_usdc"
Optional (not added for spot). Settlement currency for the instrument.
BTC, ETH Counter currency for the instrument.
USD, USDC Instrument ID
The strike value (only for options).
The option type (only for options).
call, put Future type (only for futures)(field is deprecated and will be removed in the future, instrument_type should be used instead).
linear, reversed Type of the instrument. linear or reversed
Maker commission for instrument.
0.0001
Taker commission for instrument.
0.0005
Maximal liquidation trade commission for instrument (only for futures).
0.001
Block Trade commission for instrument.
0.0005
Specifies minimal price change for block trading.
0.01
Minimum amount for block trading.
25
Maximal leverage for instrument (only for futures).
100
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.open, settlement, delivered, inactive, locked, halted, archivized The id that was sent in the request
Was this page helpful?