Skip to content

Interface: AdvTradeGlobalWSInstrumentCreated ​

The creation schema is open; its example contains instrument details and lifecycle fields.

Extends ​

Indexable ​

ts
[key: string]: unknown

Properties ​

PropertyTypeDescriptionOverridesInherited from
base_currency?stringThe underlying currency being traded.-AdvTradeGlobalInstrument.base_currency
base_currency_uuid?stringInternal identifier for the base currency. Absent if the base currency does not have an assigned identifier.-AdvTradeGlobalInstrument.base_currency_uuid
block_trade_commission?numberBlock Trade commission for instrument.-AdvTradeGlobalInstrument.block_trade_commission
block_trade_min_trade_amount?numberMinimum amount for block trading.-AdvTradeGlobalInstrument.block_trade_min_trade_amount
block_trade_tick_size?numberSpecifies minimal price change for block trading.-AdvTradeGlobalInstrument.block_trade_tick_size
contract_size?numberContract 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.-AdvTradeGlobalInstrument.contract_size
counter_currency?stringCounter currency for the instrument.-AdvTradeGlobalInstrument.counter_currency
creation_timestamp?numberThe time when the instrument was first created (milliseconds since the UNIX epoch).-AdvTradeGlobalInstrument.creation_timestamp
expiration_timestamp?numberThe time when the instrument will expire (milliseconds since the UNIX epoch).-AdvTradeGlobalInstrument.expiration_timestamp
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).-AdvTradeGlobalInstrument.future_type
index_id?numberNumeric 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.-AdvTradeGlobalInstrument.index_id
instrument_id?numberInstrument ID-AdvTradeGlobalInstrument.instrument_id
instrument_name?stringUnique instrument identifier-AdvTradeGlobalInstrument.instrument_name
instrument_type?stringType of the instrument. linear or reversed-AdvTradeGlobalInstrument.instrument_type
is_active?booleanIndicates if the instrument can currently be traded.-AdvTradeGlobalInstrument.is_active
is_cbe_routed?booleanOptional (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.-AdvTradeGlobalInstrument.is_cbe_routed
is_csr?booleanOptional (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.-AdvTradeGlobalInstrument.is_csr
kind?AdvTradeGlobalKindInstrument kind: "future", "option", "spot", "future_combo", "option_combo"-AdvTradeGlobalInstrument.kind
lot_size?numberLot size for instrument, used as the unit for fee lot counting.AdvTradeGlobalInstrument.lot_size-
maker_commission?numberMaker commission for instrument.-AdvTradeGlobalInstrument.maker_commission
max_leverage?numberMaximal leverage for instrument (only for futures).-AdvTradeGlobalInstrument.max_leverage
max_liquidation_commission?numberMaximal liquidation trade commission for instrument (only for futures).-AdvTradeGlobalInstrument.max_liquidation_commission
min_trade_amount?numberMinimum trade size. Use base-coin units for spot, options, and linear instruments, including linear perpetuals; use USD for inverse futures and inverse perpetuals.-AdvTradeGlobalInstrument.min_trade_amount
option_type?"put" | "call"The option type (only for options).-AdvTradeGlobalInstrument.option_type
price_index?stringName of price index that is used for this instrument-AdvTradeGlobalInstrument.price_index
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.-AdvTradeGlobalInstrument.product_group
qty_tick_size?numberMinimum quantity change (step size) for order amounts on this instrument.-AdvTradeGlobalInstrument.qty_tick_size
quote_currency?stringThe currency in which the instrument prices are quoted.-AdvTradeGlobalInstrument.quote_currency
quote_currency_uuid?stringInternal identifier for the quote currency. Absent if the quote currency does not have an assigned identifier.-AdvTradeGlobalInstrument.quote_currency_uuid
settlement_currency?stringOptional (not added for spot). Settlement currency for the instrument.-AdvTradeGlobalInstrument.settlement_currency
settlement_period?"month" | "week" | "perpetual"Optional (not added for spot). The settlement period.-AdvTradeGlobalInstrument.settlement_period
state?AdvTradeGlobalBookStateThe 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.AdvTradeGlobalInstrument.state-
strike?numberThe strike value (only for options).-AdvTradeGlobalInstrument.strike
taker_commission?numberTaker commission for instrument.-AdvTradeGlobalInstrument.taker_commission
tick_size?numberSpecifies minimal price change and, as follows, the number of decimal places for instrument prices.-AdvTradeGlobalInstrument.tick_size
tick_size_steps?AdvTradeGlobalTickSizeStep--AdvTradeGlobalInstrument.tick_size_steps
timestamp?number---
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.-AdvTradeGlobalInstrument.underlying_type

Built by Siebly. Open source SDKs for exchange APIs.