Skip to main content
kind
type:enum
required

Instrument kind or "any" for all

Available options: future, option, spot, future_combo, option_combo, any
currency
type:enum
required

The currency symbol or "any" for all.

📖 Related Article: Using the currency Parameter

Available options: BTC, ETH, USDC, USDT, EURR, any
Subscription Request
type:object

Client sends subscription request to subscribe to notification channel. Please refer to Notification page for more information.

jsonrpc
type:string
required

2.0

id
type:integer
required
method
type:enum
required
Available options: public/subscribe, private/subscribe
params
type:object
required
channels
type:array
required
item
type:string
Subscription Notification Data
type:object

Server sends subscription notification data

data
type:object
required
kind
type:enum
required

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

Available options: future, option, spot, future_combo, option_combo
settlement_currency
type:string

Optional (omitted for spot). Settlement currency for the instrument. For inverse (reversed) contracts this is the base coin (e.g. BTC); for linear contracts it is typically the quote currency (e.g. USDC).

counter_currency
type:string

Counter currency of the instrument's currency pair (e.g. USD or USDC).

base_currency
type:string
required

The underlying currency being traded. Not limited to BTC/ETH — altcoins, RWAs, and other listed bases are returned as their currency symbol.

quote_currency
type:string
required

The currency in which the instrument prices are quoted. Inverse options and futures are typically quoted in USD; linear and spot instruments are typically quoted in USDC or the quote coin.

min_trade_amount
type:number
required

Minimum amount for trading and the quantity increment (step size) for order amounts. For perpetual and inverse futures the amount is in USD units. For options and linear futures it is the underlying base currency coin.

This is the JSON-RPC name for the Starbase quantity increment (qty_tick_size on Starbase REST, SBE minOrderQuantity × 10^quantityExponent). JSON-RPC does not return a qty_tick_size field. Distinct from contract_size; do not assume the two values are equal.

instrument_name
type:string
required

Unique instrument identifier

instrument_id
type:integer

Instrument ID

is_active
type:boolean
required

true while the order book is visible (open, settlement, locked, or halted). false for delivered, inactive, and archivized.

This is not the same as tradable. Only state open accepts new orders; locked allows cancels only, and settlement / halted reject new orders even when is_active is true.

settlement_period
type:enum

Optional (omitted for spot). Calendar unit of the instrument's settlement/expiration period (minute, hour, day, week, month, or perpetual). Biweekly contracts still report week.

Available options: minute, hour, day, week, month, perpetual
creation_timestamp
type:integer
required

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

tick_size
type:number
required

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

tick_size_steps
type:object
above_price
type:number

The price from which the increased tick size applies

tick_size
type:number

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

expiration_timestamp
type:integer
required

The time when the instrument will expire (milliseconds since the UNIX epoch). Present for perpetuals as well (a far-future timestamp); do not treat a non-zero value as proof the instrument is dated.

strike
type:number

The strike value (only for options).

option_type
type:enum

The option type (only for options).

Available options: call, put
future_type
type:enum

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
instrument_type
type:string

Type of the instrument. linear or reversed. Present for options and spots as well as futures; do not assume it is futures-only.

contract_size
type:number
required

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.

Distinct from min_trade_amount. contract_size converts between amount and contracts. Starbase matching uses the quantity increment, which JSON-RPC exposes as min_trade_amount (Starbase REST name: qty_tick_size). The two values may currently coincide on some instruments, but that is not a guarantee.

lot_size
type:number

Lot size for instrument, used as the unit for fee lot counting. Omitted when the instrument has no configured lot size.

maker_commission
type:number

Maker commission for instrument.

taker_commission
type:number

Taker commission for instrument.

max_liquidation_commission
type:number

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

maker_max_commission
type:number

Optional. Maximum maker commission. Returned only when extended=true on public/get_instruments.

taker_max_commission
type:number

Optional. Maximum taker commission. Returned only when extended=true on public/get_instruments.

liquidation_max_commission
type:number

Optional. Maximum liquidation commission. Returned only when extended=true on public/get_instruments. Distinct from max_liquidation_commission, which is present on futures without extended.

settlement_max_commission
type:number

Optional. Maximum settlement commission. Returned only when extended=true on public/get_instruments.

trading_bandwidth_fraction
type:number

Optional (futures only). Trading bandwidth fraction used in mark-price logic. Returned only when extended=true on public/get_instruments.

perpetual_dempener
type:number

Optional (perpetual futures only). Perpetual funding dampener. Returned only when extended=true on public/get_instruments. The JSON field name is spelled dempener.

perpetual_max_funding
type:number

Optional (perpetual futures only). Maximum funding rate. Returned only when extended=true on public/get_instruments.

block_trade_commission
type:number

Block Trade commission for instrument. Omitted for spot routed to Coinbase Exchange (CSR), which does not support block trades.

block_trade_tick_size
type:number

Specifies minimal price change for block trading.

block_trade_min_trade_amount
type:number

Minimum amount for block trading.

max_leverage
type:integer

Maximal leverage for the default risk profile (futures). For spot, present only on cross pairs when spot margin loans are enabled: derived from the loan initial-margin rate for borrowable USDC-quoted pairs, otherwise 1. Omitted on other spots and options.

max_non_default_leverage
type:integer

Maximal leverage for the non-default risk profile (futures only). Omitted on options and spots.

price_index
type:string
required

Name of price index that is used for this instrument

underlying_type
type:enum
required

The type of the underlying asset.

Available options: crypto, equity, commodity, preipo, equity_etf, crypto_index, adr, foreign_equity, equity_index, commodity_index, commodity_etf, otc
state
type:enum

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
base_currency_uuid
type:string

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

quote_currency_uuid
type:string

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

index_id
type:integer
required

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.

product_group
type:enum
required

Product group classification of the instrument's base currency. Determines gateway and multicast channel assignment — see Underlying Tiers.

Available options: BTC, ETH, TIER_2, TIER_3, RWA
is_csr
type: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.

is_cbe_routed
type: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.

timestamp
type:integer
required

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