Struct PolymarketWebSocketClient 

pub struct PolymarketWebSocketClient { /* private fields */ }

Provides a WebSocket client for the Polymarket CLOB API.

A single instance targets one channel (market or user). Use PolymarketWebSocketClient::new_market for public market data and PolymarketWebSocketClient::new_user for authenticated order/trade streams.

Implementations

impl PolymarketWebSocketClient

pub fn new_market( base_url: Option<String>, subscribe_new_markets: bool, transport_backend: TransportBackend, ) -> Self

Creates a new market-channel client (unauthenticated).

If base_url is None, the default production URL is used.

pub fn new_user( base_url: Option<String>, credential: Credential, transport_backend: TransportBackend, ) -> Self

Creates a new user-channel client (authenticated).

If base_url is None, the default production URL is used.

pub async fn connect(&mut self) -> Result<()>

Establishes the WebSocket connection and spawns the message handler.

Errors

pub async fn disconnect(&mut self) -> Result<()>

Disconnects the WebSocket connection.

pub fn is_active(&self) -> bool

Returns true if the WebSocket is actively connected.

pub fn url(&self) -> &str

Returns the URL this client connects to.

pub fn subscription_count(&self) -> usize

Returns the number of active market asset subscriptions (pending + confirmed).

pub fn is_authenticated(&self) -> bool

Returns true if the user channel has been authenticated.

pub async fn subscribe_market(&self, asset_ids: Vec<String>) -> Result<()>

Subscribe to market data for the given asset IDs.

Sends a subscribe message immediately if connected; the IDs are also retained so they are re-sent automatically on reconnect.

Errors

Returns an error if called on a user-channel client (incompatible channel).

pub async fn unsubscribe_market(&self, asset_ids: Vec<String>) -> Result<()>

Remove asset IDs from the active subscription set.

The IDs are dropped from the reconnect set so they will not be re-subscribed after a reconnect. No wire message is sent.

Errors

Returns an error if called on a user-channel client (incompatible channel).

pub async fn subscribe_user(&self) -> Result<()>

Authenticate and subscribe to the user channel.

Errors

Returns an error if called on a market-channel client (no credentials available).

pub fn clone_subscription_handle(&self) -> WsSubscriptionHandle

Returns a cloneable subscription handle for use in spawned tasks.

pub fn take_message_receiver( &mut self, ) -> Option<UnboundedReceiver<PolymarketWsMessage>>

Takes the message receiver, leaving None in its place.

This is useful when the data client needs to spawn its own handler task that reads messages independently of the WS client. Subscription methods (subscribe_market, etc.) remain usable on &self.

pub async fn next_message(&mut self) -> Option<PolymarketWsMessage>

Receives the next message from the WebSocket handler.

Returns None when the handler has disconnected or the receiver was not yet initialized (call connect first).

Trait Implementations

impl Debug for PolymarketWebSocketClient

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

Formats the value using the given formatter.