Struct BinanceWs 

pub struct BinanceWs { /* private fields */ }

Binance WebSocket client wrapper

Implementations

impl BinanceWs

pub fn new(url: String) -> Self

Creates a new Binance WebSocket client

Arguments

• url - WebSocket server URL

Returns

Initialized Binance WebSocket client

pub fn new_with_auth(url: String, binance: Arc<Binance>) -> Self

Creates a WebSocket client with a listen key manager

Arguments

• url - WebSocket server URL
• binance - Shared Binance instance

Returns

Binance WebSocket client configured with a listen key manager

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

Connects to the WebSocket server

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

Disconnects from the WebSocket server

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

Connects to the user data stream

Creates or retrieves a listen key, connects to the user data WebSocket, and starts auto-refresh

Returns

Result of the connection attempt

Errors

• Listen key manager is missing (requires new_with_auth constructor)
• Listen key creation failed
• WebSocket connection failed

Example

let binance = Arc::new(Binance::new(ExchangeConfig::default())?);
let ws = binance.create_authenticated_ws();
ws.connect_user_stream().await?;

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

Closes the user data stream

Stops auto-refresh and deletes the listen key

Returns

Result of the shutdown

pub async fn get_listen_key(&self) -> Option<String>

Returns the active listen key, when available

pub async fn subscribe_ticker(&self, symbol: &str) -> Result<()>

Subscribes to the ticker stream for a symbol

Arguments

• symbol - Trading pair (e.g. “btcusdt”)

Returns

Result of the subscription request

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

Subscribes to the 24-hour ticker stream for all symbols

pub async fn subscribe_trades(&self, symbol: &str) -> Result<()>

Subscribes to real-time trade executions for a symbol

Arguments

• symbol - Trading pair (e.g. “btcusdt”)

Returns

Result of the subscription request

pub async fn subscribe_agg_trades(&self, symbol: &str) -> Result<()>

Subscribes to the aggregated trade stream for a symbol

Arguments

• symbol - Trading pair (e.g. “btcusdt”)

Returns

Result of the subscription request

pub async fn subscribe_orderbook( &self, symbol: &str, levels: u32, update_speed: &str, ) -> Result<()>

Subscribes to the order book depth stream

Arguments

• symbol - Trading pair (e.g. “btcusdt”)
• levels - Depth levels (5, 10, 20)
• update_speed - Update frequency (“100ms” or “1000ms”)

Returns

Result of the subscription request

pub async fn subscribe_orderbook_diff( &self, symbol: &str, update_speed: Option<&str>, ) -> Result<()>

Subscribes to the diff order book stream

Arguments

• symbol - Trading pair (e.g. “btcusdt”)
• update_speed - Update frequency (“100ms” or “1000ms”)

Returns

Result of the subscription request

pub async fn subscribe_kline(&self, symbol: &str, interval: &str) -> Result<()>

Subscribes to Kline (candlestick) data for a symbol

Arguments

• symbol - Trading pair (e.g. “btcusdt”)
• interval - Kline interval (1m, 3m, 5m, 15m, 30m, 1h, 2h, 4h, 6h, 8h, 12h, 1d, 3d, 1w, 1M)

Returns

Result of the subscription request

pub async fn subscribe_mini_ticker(&self, symbol: &str) -> Result<()>

Subscribes to the mini ticker stream for a symbol

Arguments

• symbol - Trading pair (e.g. “btcusdt”)

Returns

Result of the subscription request

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

Subscribes to the mini ticker stream for all symbols

pub async fn unsubscribe(&self, stream: String) -> Result<()>

Cancels an existing subscription

Arguments

• stream - Stream identifier to unsubscribe from

Returns

Result of the unsubscribe request

pub async fn receive(&self) -> Option<Value>

Receives the next available message

Returns

Optional message payload when available

pub fn is_connected(&self) -> bool

Indicates whether the WebSocket connection is active

pub async fn get_cached_ticker(&self, symbol: &str) -> Option<Ticker>

Arguments

• symbol - Trading pair identifier

Returns

Ticker snapshot when available

pub async fn get_all_cached_tickers(&self) -> HashMap<String, Ticker>

Returns all cached ticker snapshots