{
"jsonrpc": "2.0",
"method": "public/subscribe",
"id": 42,
"params": {
"channels": [
"instrument.state.(kind).(currency)"
]
}
}{
"data": {
"timestamp": 1553080940000,
"state": "open",
"instrument_name": "BTC-22MAR19"
}
}instrument.state.(kind).(currency)
Notifications about new or terminated instruments of a given kind in a given currency.
Use this channel to track instrument lifecycle events (new listings, expirations/terminations) without polling.
Note: Our system does not send notifications when currencies are locked. Users are advised to subscribe to the platform_state channel to monitor the state of currencies actively.
📖 Related Article: Options Data Collection Best Practices
{
"jsonrpc": "2.0",
"method": "public/subscribe",
"id": 42,
"params": {
"channels": [
"instrument.state.(kind).(currency)"
]
}
}{
"data": {
"timestamp": 1553080940000,
"state": "open",
"instrument_name": "BTC-22MAR19"
}
}Instrument kind
Allowed values: future, option, spot, future_combo, option_combo
future, option, spot, future_combo, option_comboCurrency code or any for all
Allowed values: BTC, ETH, USDC, USDT, EURR, any
BTC, ETH, USDC, USDT, EURR, anyClient sends subscription request to subscribe to notification channel. Please refer to Notification page for more information.
Server sends subscription notification data
The timestamp (milliseconds since the Unix epoch)
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 beopenif it was settlement, ordeliveredif 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 toexpired_instrumentsand itsinstrument_statewill 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 toexpired_instrumentstable, final state.
open, settlement, delivered, inactive, locked, halted, archivizedUnique instrument identifier
Related topics
Options Data CollectionSpot Trading: Deribit and Coinbase-Routed InstrumentsJSON-RPC API Changelogpublic/get_instrumentsNotificationsWas this page helpful?