Skip to main content
Messages
kind
type:enum
required

Instrument kind

Allowed values: future, option, spot, future_combo, option_combo

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

Currency code or any for all

Allowed values: BTC, ETH, USDC, USDT, EURR, any

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.

Subscription Notification Data
type:object

Server sends subscription notification data

data
type:object
required
timestamp
type:integer

The timestamp (milliseconds since the Unix epoch)

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

Unique instrument identifier