Struct WebSocketClient

pub struct WebSocketClient {
    pub auth_key: String,
    /* private fields */
}

Fields

auth_key: String

Implementations

impl WebSocketClient

pub fn new(cluster: &str, auth_key: Option<&str>) -> Self

Returns a new WebSocket client.

The cluster parameter can be one of STOCKS_CLUSTER, FOREX_CLUSTER, or CRYPTO_CLUSTER.

The auth_key parameter optionally provides the API key to use for authentication. If None is provided, then the API key specified in the POLYGON_AUTH_KEY environment variable is used.

Panics

This function will panic if auth_key is None and the POLYGON_AUTH_KEY environment variable is not set.

pub fn subscribe(&mut self, params: &Vec<&str>)

Subscribes to one or more ticker.

pub fn unsubscribe(&mut self, params: &Vec<&str>)

Unscribes from one or more ticker.

pub fn receive(&mut self) -> Result<Message>

Receives a single message.