Enum SubscriptionChannel 

pub enum SubscriptionChannel {
    Ticker(String),
    OrderBook(String),
    Trades(String),
    ChartTrades {
        instrument: String,
        resolution: String,
    },
    UserOrders,
    UserTrades,
    UserPortfolio,
    UserChanges {
        instrument: String,
        interval: String,
    },
    PriceIndex(String),
    EstimatedExpirationPrice(String),
    MarkPrice(String),
    Funding(String),
    Perpetual {
        instrument: String,
        interval: String,
    },
    Quote(String),
    PlatformState,
    PlatformStatePublicMethods,
    InstrumentState {
        kind: String,
        currency: String,
    },
    GroupedOrderBook {
        instrument: String,
        group: String,
        depth: String,
        interval: String,
    },
    IncrementalTicker(String),
    TradesByKind {
        kind: String,
        currency: String,
        interval: String,
    },
    PriceRanking(String),
    PriceStatistics(String),
    VolatilityIndex(String),
    BlockRfqTrades(String),
    BlockTradeConfirmations,
    BlockTradeConfirmationsByCurrency(String),
    UserMmpTrigger(String),
    UserAccessLog,
    UserLock,
    Unknown(String),
}

WebSocket subscription channel types

Variants

Ticker(String)

Ticker data for a specific instrument

OrderBook(String)

Order book data for a specific instrument

Trades(String)

Trade data for a specific instrument

ChartTrades

Chart trade data for a specific instrument with resolution

Fields

instrument: String

The trading instrument (e.g., “BTC-PERPETUAL”)

resolution: String

Chart resolution (e.g., “1”, “5”, “15”, “60” for minutes)

UserOrders

User’s order updates

UserTrades

User’s trade updates

UserPortfolio

User’s portfolio updates

UserChanges

User’s position changes for a specific instrument with interval

Fields

instrument: String

The trading instrument (e.g., “BTC-PERPETUAL”)

interval: String

Update interval (e.g., “raw”, “100ms”)

PriceIndex(String)

Price index updates

EstimatedExpirationPrice(String)

Estimated delivery price

MarkPrice(String)

Mark price updates

Funding(String)

Funding rate updates

Perpetual

Perpetual updates with configurable interval

Fields

instrument: String

The trading instrument (e.g., “BTC-PERPETUAL”)

interval: String

Update interval (e.g., “raw”, “100ms”)

Quote(String)

Quote updates

PlatformState

Platform state updates

PlatformStatePublicMethods

Platform state public methods state updates

InstrumentState

Instrument state changes for a specific kind and currency

Fields

kind: String

Instrument kind (e.g., “future”, “option”, “spot”)

currency: String

Currency (e.g., “BTC”, “ETH”)

GroupedOrderBook

Grouped order book with configurable depth and interval

Fields

instrument: String

The trading instrument (e.g., “BTC-PERPETUAL”)

group: String

Grouping level for aggregation

depth: String

Order book depth (e.g., “1”, “10”, “20”)

interval: String

Update interval (e.g., “100ms”, “agg2”)

IncrementalTicker(String)

Incremental ticker updates for a specific instrument

TradesByKind

Trades by instrument kind (e.g., future, option) and currency

Fields

kind: String

Instrument kind (e.g., “future”, “option”, “spot”, “any”)

currency: String

Currency (e.g., “BTC”, “ETH”, “any”)

interval: String

Update interval (e.g., “raw”, “100ms”)

PriceRanking(String)

Price ranking data for an index

PriceStatistics(String)

Price statistics for an index

VolatilityIndex(String)

Volatility index data

BlockRfqTrades(String)

Block RFQ trades for a specific currency

BlockTradeConfirmations

Block trade confirmations (all currencies)

BlockTradeConfirmationsByCurrency(String)

Block trade confirmations for a specific currency

UserMmpTrigger(String)

User MMP (Market Maker Protection) trigger for a specific index

UserAccessLog

User API access log

UserLock

User account lock status

Unknown(String)

Unknown or unrecognized channel

Implementations

impl SubscriptionChannel

pub fn channel_name(&self) -> String

Convert subscription channel to channel name

pub fn from_string(s: &str) -> Self

Parse subscription channel from string

Returns the appropriate SubscriptionChannel variant for recognized channel patterns, or Unknown(String) for unrecognized patterns.

pub fn is_unknown(&self) -> bool

Check if this channel is unknown/unrecognized

Trait Implementations

impl Clone for SubscriptionChannel

fn clone(&self) -> SubscriptionChannel

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SubscriptionChannel

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for SubscriptionChannel

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for SubscriptionChannel

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

Formats the value using the given formatter.

impl Hash for SubscriptionChannel

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 PartialEq for SubscriptionChannel

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for SubscriptionChannel

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for SubscriptionChannel

impl StructuralPartialEq for SubscriptionChannel