Enum WsMessage 

pub enum WsMessage {
    Subscribe {
        channel: String,
        symbols: Option<Vec<String>>,
        expiry: Option<String>,
        option_type: Option<String>,
    },
    Unsubscribe {
        channel: String,
        symbols: Option<Vec<String>>,
        expiry: Option<String>,
        option_type: Option<String>,
    },
    OrderUpdate(WsOrderMessage),
    OrderbookUpdate(WsOrderbookUpdate),
    Fill(WsFillUpdate),
    Trade(WsTradeUpdate),
    CandleUpdate(WsCandleUpdate),
    MarketUpdate(WsMarketUpdate),
    OptionsChainUpdate(WsOptionsChainUpdate),
    IndexPriceUpdate(WsIndexPriceUpdate),
    PortfolioUpdate(PortfolioUpdate),
    PositionExpired(WsPositionExpired),
    LiquidationStateChange(WsLiquidationStateChange),
    CompetitionUpdate(WsCompetitionUpdate),
    CompetitionPnlSummary(WsCompetitionPnlSummary),
    CompetitionFinalStats(WsCompetitionFinalStats),
    CompetitionRankChange(WsCompetitionRankChange),
    CompetitionGapUpdate(WsCompetitionGapUpdate),
    CompetitionFinalStanding(WsCompetitionFinalStanding),
    Authenticate {
        wallet: String,
    },
    Authenticated {
        wallet: String,
    },
    Error {
        message: String,
    },
    Subscribed {
        channel: String,
    },
    Unsubscribed {
        channel: String,
    },
    IndicativeMarketData(WsIndicativeMarketData),
    RfqQuotes(WsRfqQuotes),
    RfqStatusUpdate(WsRfqStatusUpdate),
    SubmitRfq {
        rfq_id: String,
        legs: Vec<WsRfqLegRequest>,
        wallet_address: String,
        nonce: u64,
        signature: String,
    },
    SubmitAutoExecuteRfq {
        rfq_id: String,
        legs: Vec<WsRfqLegRequest>,
        wallet_address: String,
        limit_price: String,
        nonce: u64,
        signature: String,
    },
    AcceptRfqQuote {
        rfq_id: String,
        quote_id: String,
        wallet_address: String,
        nonce: u64,
        signature: String,
    },
    RfqAcceptResult {
        rfq_id: String,
        quote_id: String,
        status: String,
        fill_id: Option<String>,
        taker_wallet: Option<WalletAddress>,
    },
    PlaceOrder {
        wallet: String,
        symbol: String,
        side: String,
        size: String,
        price: String,
        tif: Option<String>,
        client_id: Option<String>,
        nonce: u64,
        signature: String,
        mmp_enabled: Option<bool>,
        builder_code_address: Option<String>,
    },
    OrderResult(WsOrderResult),
    Other,
}

Variants

Subscribe

Subscribe to a data channel

Fields

channel: String

symbols: Option<Vec<String>>

expiry: Option<String>

option_type: Option<String>

Unsubscribe

Unsubscribe from a data channel

Fields

channel: String

symbols: Option<Vec<String>>

expiry: Option<String>

option_type: Option<String>

OrderUpdate(WsOrderMessage)

Order status update (authenticated)

OrderbookUpdate(WsOrderbookUpdate)

L2 orderbook snapshot/update

Fill(WsFillUpdate)

Fill notification (authenticated)

Trade(WsTradeUpdate)

Public trade event

CandleUpdate(WsCandleUpdate)

Underlying candle update

MarketUpdate(WsMarketUpdate)

Market listing change

OptionsChainUpdate(WsOptionsChainUpdate)

Incremental options chain update

IndexPriceUpdate(WsIndexPriceUpdate)

Real-time index/spot price update for all underlyings

PortfolioUpdate(PortfolioUpdate)

Portfolio update (authenticated)

PositionExpired(WsPositionExpired)

Position expiry notification (authenticated)

LiquidationStateChange(WsLiquidationStateChange)

Liquidation state change (authenticated)

CompetitionUpdate(WsCompetitionUpdate)

Competition leaderboard update for connected wallet (authenticated)

CompetitionPnlSummary(WsCompetitionPnlSummary)

Competition PnL summary for connected wallet (authenticated)

CompetitionFinalStats(WsCompetitionFinalStats)

Final competition stats notification for connected wallet (authenticated)

CompetitionRankChange(WsCompetitionRankChange)

Competition rank movement notification for connected wallet (authenticated)

CompetitionGapUpdate(WsCompetitionGapUpdate)

Competition gap-to-next notification for connected wallet (authenticated)

CompetitionFinalStanding(WsCompetitionFinalStanding)

Competition final standing notification for connected wallet (authenticated)

Authenticate

Identify the connection with a wallet address (replaces query-param ?wallet=).

Fields

wallet: String

Authenticated

Server confirms wallet identification

Fields

wallet: String

Error

Error message from server

Fields

message: String

Subscribed

Subscription confirmed

Fields

channel: String

Unsubscribed

Unsubscription confirmed

Fields

channel: String

IndicativeMarketData(WsIndicativeMarketData)

Indicative market data from aggregated QP quotes (public)

RfqQuotes(WsRfqQuotes)

RFQ quotes available for taker (authenticated)

RfqStatusUpdate(WsRfqStatusUpdate)

RFQ status update (authenticated)

SubmitRfq

Submit an RFQ request via WebSocket (authenticated)

Fields

rfq_id: String

legs: Vec<WsRfqLegRequest>

wallet_address: String

nonce: u64

signature: String

SubmitAutoExecuteRfq

Submit an RFQ with auto-execute via WebSocket (authenticated). The taker pre-authorizes execution with a directional limit_price.

Fields

rfq_id: String

legs: Vec<WsRfqLegRequest>

wallet_address: String

limit_price: String

Directional premium limit as a decimal string. Buy RFQs use this as a max debit. Sell RFQs use it as a min credit.

nonce: u64

signature: String

AcceptRfqQuote

Accept an RFQ quote via WebSocket (authenticated)

Fields

rfq_id: String

quote_id: String

wallet_address: String

nonce: u64

signature: String

RfqAcceptResult

RFQ accept result pushed back to the client

Fields

rfq_id: String

quote_id: String

status: String

fill_id: Option<String>

taker_wallet: Option<WalletAddress>

Used for wallet-based filtering in publish_to_channel so the result is only delivered to the taker, not all rfq subscribers. Excluded from the wire format.

PlaceOrder

Place an order via WebSocket (authenticated)

Fields

wallet: String

symbol: String

side: String

size: String

price: String

tif: Option<String>

client_id: Option<String>

nonce: u64

signature: String

mmp_enabled: Option<bool>

builder_code_address: Option<String>

OrderResult(WsOrderResult)

Order placement result pushed back to the client

Other

Implementations

impl WsMessage

pub fn asyncapi_message_names() -> Vec<&'static str>

Get AsyncAPI message names for this type

pub fn asyncapi_message_count() -> usize

Get the number of messages in this type

pub fn asyncapi_tag_field() -> Option<&'static str>

Get the serde tag field name if this is a tagged enum

pub fn asyncapi_messages() -> Vec<Message>

where Self: JsonSchema,

Generate AsyncAPI Message objects with JSON schemas

This method requires that the type implements schemars::JsonSchema.

Trait Implementations

impl Clone for WsMessage

fn clone(&self) -> WsMessage

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for WsMessage

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for WsMessage

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl JsonSchema for WsMessage

fn schema_name() -> Cow<'static, str>

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword.

impl Serialize for WsMessage

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

where __S: Serializer,

Serialize this value into the given Serde serializer.