Interface: AdvTradeGlobalInstrument
Properties
| Property | Type | Description |
|---|---|---|
base_currency | string | The underlying currency being traded. |
base_currency_uuid? | string | Internal identifier for the base currency. Absent if the base currency does not have an assigned identifier. |
block_trade_commission? | number | Block Trade commission for instrument. |
block_trade_min_trade_amount? | number | Minimum amount for block trading. |
block_trade_tick_size? | number | Specifies minimal price change for block trading. |
contract_size | number | Contract size for the instrument, expressed in the same unit as the order amount. For inverse (reversed) futures and perpetuals this is USD - BTC-PERPETUAL has a contract size of 10 USD. For options, spots, and for linear futures and perpetuals it is the base currency coin - BTC_USDC-PERPETUAL has a contract size of 0.0001 BTC. Note that on an inverse instrument base_currency identifies the underlying and settlement coin and does not indicate the unit of contract_size. |
counter_currency? | string | Counter currency for the instrument. |
creation_timestamp | number | The time when the instrument was first created (milliseconds since the UNIX epoch). |
expiration_timestamp | number | The time when the instrument will expire (milliseconds since the UNIX epoch). |
future_type? | "linear" | "reversed" | Future type (only for futures)(field is deprecated and will be removed in the future, instrument_type should be used instead). |
index_id | number | Numeric identifier of the price index used by this instrument. Derived from the index currency pair, so all instruments sharing the same price_index also share the same index_id. |
instrument_id? | number | Instrument ID |
instrument_name | string | Unique instrument identifier |
instrument_type? | string | Type of the instrument. linear or reversed |
is_active | boolean | Indicates if the instrument can currently be traded. |
is_cbe_routed? | boolean | Optional (only for spot routed to Coinbase Exchange). Alias of is_csr added by public/get_instrument and public/get_instruments; other surfaces that return instrument metadata, such as the instrument.creation.{kind}.{currency} notification, carry is_csr only. When present it is always true and is omitted for every other instrument, so test for its presence rather than for a false value. |
is_csr? | boolean | Optional (only for spot routed to Coinbase Exchange). When present it is always true, meaning orders on this instrument are routed to Coinbase Exchange (CBE) for matching instead of the native Deribit matching engine. The field is omitted for every other instrument, so test for its presence rather than for a false value. |
kind | AdvTradeGlobalKind | Instrument kind: "future", "option", "spot", "future_combo", "option_combo" |
lot_size? | number | Lot size for instrument, used as the unit for fee lot counting. |
maker_commission? | number | Maker commission for instrument. |
max_leverage? | number | Maximal leverage for instrument (only for futures). |
max_liquidation_commission? | number | Maximal liquidation trade commission for instrument (only for futures). |
min_trade_amount | number | Minimum trade size. Use base-coin units for spot, options, and linear instruments, including linear perpetuals; use USD for inverse futures and inverse perpetuals. |
option_type? | "put" | "call" | The option type (only for options). |
price_index | string | Name of price index that is used for this instrument |
product_group | "BTC" | "ETH" | "TIER_2" | "TIER_3" | Product group classification of the instrument's base currency. Determines gateway and multicast channel assignment - see Underlying Tiers. |
qty_tick_size? | number | Minimum quantity change (step size) for order amounts on this instrument. |
quote_currency | string | The currency in which the instrument prices are quoted. |
quote_currency_uuid? | string | Internal identifier for the quote currency. Absent if the quote currency does not have an assigned identifier. |
settlement_currency? | string | Optional (not added for spot). Settlement currency for the instrument. |
settlement_period | "month" | "week" | "perpetual" | Optional (not added for spot). The settlement period. |
state? | AdvTradeGlobalBookState | 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. |
strike? | number | The strike value (only for options). |
taker_commission? | number | Taker commission for instrument. |
tick_size | number | Specifies minimal price change and, as follows, the number of decimal places for instrument prices. |
tick_size_steps? | AdvTradeGlobalTickSizeStep | - |
underlying_type | | "crypto" | "equity" | "commodity" | "preipo" | "equity_etf" | "crypto_index" | "adr" | "foreign_equity" | "equity_index" | "commodity_index" | "commodity_etf" | "otc" | The type of the underlying asset. |