Enum DeribitWsChannel 

pub enum DeribitWsChannel {
    Trades,
    Book,
    Ticker,
    Quote,
    PriceIndex,
    PriceRanking,
    VolatilityIndex,
    EstimatedExpirationPrice,
    Perpetual,
    MarkPriceOptions,
    PlatformState,
    Announcements,
    ChartTrades,
    InstrumentState,
    UserOrders,
    UserTrades,
    UserPortfolio,
    UserChanges,
    UserAccessLog,
}

Deribit WebSocket public data channels.

Channels follow the format: {channel_type}.{instrument_or_currency}.{interval}

Variants

Trades

Raw trade stream: trades.{instrument}.raw

Book

Order book updates: book.{instrument}.{group}.{depth}.{interval}

Ticker

Ticker updates: ticker.{instrument}.{interval}

Quote

Quote updates (best bid/ask): quote.{instrument}

PriceIndex

Index price: deribit_price_index.{currency}

PriceRanking

Price ranking: deribit_price_ranking.{currency}

VolatilityIndex

Volatility index: deribit_volatility_index.{currency}

EstimatedExpirationPrice

Estimated expiration price: estimated_expiration_price.{currency}

Perpetual

Perpetual interest rate: perpetual.{instrument}.{interval}

MarkPriceOptions

Mark price options: markprice.options.{currency}

PlatformState

Platform state: platform_state

Announcements

Announcements: announcements

ChartTrades

Chart trades: chart.trades.{instrument}.{resolution}

InstrumentState

Instrument state changes: instrument.state.{kind}.{currency} Used for instrument lifecycle notifications (created, started, settled, closed, terminated)

UserOrders

User orders: user.orders.{instrument}.{interval}

UserTrades

User trades/fills: user.trades.{instrument}.{interval}

UserPortfolio

User portfolio: user.portfolio.{currency}

UserChanges

User changes (combined orders/trades/positions): user.changes.{instrument}.{interval}

UserAccessLog

User access log: user.access_log

Implementations

impl DeribitWsChannel

pub fn format_channel( &self, instrument_or_currency: &str, interval: Option<DeribitUpdateInterval>, ) -> String

Formats the channel name for subscription with the given instrument or currency.

Returns the full channel string for Deribit subscription.

Arguments

• instrument_or_currency - The instrument name (e.g., “BTC-PERPETUAL”) or currency (e.g., “BTC”)
• interval - Optional update interval. Defaults to Ms100 (100ms) if not specified.

Panics

Panics if called on InstrumentState variant. Use format_instrument_state_channel() instead.

Note

Raw subscriptions require authentication. Use Ms100 for public/unauthenticated access.

pub fn format_instrument_state_channel(kind: &str, currency: &str) -> String

Formats the instrument status channel for subscription.

Returns the full channel string: instrument.state.{kind}.{currency}

Arguments

• kind - Instrument kind: “future”, “option”, “spot”, “future_combo”, “option_combo”, or “any”
• currency - Currency: “BTC”, “ETH”, “USDC”, “USDT”, “EURR”, or “any”

pub fn from_channel_string(channel: &str) -> Option<Self>

Parses a channel string to extract the channel type.

Returns the channel enum variant if recognized.

pub const fn is_private(&self) -> bool

Returns whether this is a private (authenticated) channel.

pub fn requires_auth(channel: &str) -> bool

Returns whether a channel string requires authentication.

This includes private user.* channels and any channel with a .raw interval (book, trades, ticker) which Deribit gates behind auth.

Trait Implementations

impl AsRef<str> for DeribitWsChannel

fn as_ref(&self) -> &str

Converts this type into a shared reference of the (usually inferred) input type.

impl Clone for DeribitWsChannel

fn clone(&self) -> DeribitWsChannel

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Copy for DeribitWsChannel

impl Debug for DeribitWsChannel

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for DeribitWsChannel

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for DeribitWsChannel

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl Eq for DeribitWsChannel

impl FromStr for DeribitWsChannel

type Err = ParseError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<DeribitWsChannel, <Self as FromStr>::Err>

Parses a string s to return a value of this type.

impl Hash for DeribitWsChannel

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl IntoEnumIterator for DeribitWsChannel

type Iterator = DeribitWsChannelIter

fn iter() -> DeribitWsChannelIter

impl PartialEq for DeribitWsChannel

fn eq(&self, other: &DeribitWsChannel) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl Serialize for DeribitWsChannel

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for DeribitWsChannel

impl TryFrom<&str> for DeribitWsChannel

type Error = ParseError

The type returned in the event of a conversion error.

fn try_from(s: &str) -> Result<DeribitWsChannel, <Self as TryFrom<&str>>::Error>

Performs the conversion.