Struct OkxWs 

pub struct OkxWs { /* private fields */ }

OKX WebSocket client.

Provides real-time data streaming for OKX exchange.

Implementations

impl OkxWs

pub fn new(url: String) -> Self

Creates a new OKX WebSocket client.

Arguments

• url - WebSocket server URL

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

Connects to the WebSocket server.

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

Disconnects from the WebSocket server.

pub fn state(&self) -> WsConnectionState

Returns the current connection state.

pub fn is_connected(&self) -> bool

Checks if the WebSocket is connected.

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

Receives the next message from the WebSocket.

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

Subscribes to a ticker stream.

Arguments

• symbol - Trading pair symbol in OKX format (e.g., “BTC-USDT”)

pub async fn subscribe_tickers(&self, symbols: &[String]) -> Result<()>

Subscribes to multiple ticker streams.

Arguments

• symbols - List of trading pair symbols (e.g., ["BTC-USDT", "ETH-USDT"])

pub async fn watch_tickers( &self, symbols: &[String], ) -> Result<MessageStream<Vec<Ticker>>>

Watches ticker updates for multiple symbols.

Returns a stream of Vec<Ticker> updates for the specified symbols.

Arguments

• symbols - List of trading pair symbols (e.g., ["BTC-USDT", "ETH-USDT"])

Returns

A MessageStream<Vec<Ticker>> that yields ticker updates.

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

• depth - Orderbook depth (5, 50, or 400)

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

Subscribes to a trades stream.

Arguments

• symbol - Trading pair symbol in OKX format (e.g., “BTC-USDT”)

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

Subscribes to a kline/candlestick stream.

Arguments

• symbol - Trading pair symbol in OKX format (e.g., “BTC-USDT”)
• interval - Kline interval (e.g., “1m”, “5m”, “1H”, “1D”)

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

Unsubscribes from a stream.

Arguments

• stream_name - Stream identifier to unsubscribe from

pub async fn subscriptions(&self) -> Vec<String>

Returns the list of active subscriptions.

pub async fn watch_ticker( &self, symbol: &str, market: Option<Market>, ) -> Result<MessageStream<Ticker>>

Watches ticker updates for a symbol.

Returns a stream of Ticker updates for the specified symbol.

Arguments

• symbol - Trading pair symbol in OKX format (e.g., “BTC-USDT”)
• market - Optional market information for symbol resolution

Returns

A MessageStream<Ticker> that yields ticker updates.

pub async fn watch_order_book( &self, symbol: &str, limit: Option<u32>, ) -> Result<MessageStream<OrderBook>>

Watches order book updates for a symbol.

Returns a stream of OrderBook updates for the specified symbol.

Arguments

• symbol - Trading pair symbol in OKX format (e.g., “BTC-USDT”)
• limit - Optional depth limit (5, 50, or 400)

Returns

A MessageStream<OrderBook> that yields order book updates.

pub async fn watch_trades( &self, symbol: &str, market: Option<Market>, ) -> Result<MessageStream<Vec<Trade>>>

Watches trade updates for a symbol.

Returns a stream of Trade updates for the specified symbol.

Arguments

• symbol - Trading pair symbol in OKX format (e.g., “BTC-USDT”)
• market - Optional market information for symbol resolution

Returns

A MessageStream<Vec<Trade>> that yields trade updates.

pub async fn login(&self, auth: &OkxAuth) -> Result<()>

Sends a login message to authenticate the private WebSocket connection.

OKX WebSocket login format:

{
  "op": "login",
  "args": [{
    "apiKey": "...",
    "passphrase": "...",
    "timestamp": "...",
    "sign": "..."
  }]
}

The signature is: HMAC-SHA256(timestamp + “GET” + “/users/self/verify”, secret)

pub async fn subscribe_orders(&self, inst_type: Option<&str>) -> Result<()>

Subscribes to the orders channel (private).

Receives real-time order updates for all instrument types.

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

Subscribes to the account channel (private).

Receives real-time balance/account updates.

pub async fn watch_balance(&self) -> Result<MessageStream<Balance>>

Watches balance updates via the private WebSocket.

Requires prior authentication via login().

pub async fn watch_orders( &self, symbol_filter: Option<String>, ) -> Result<MessageStream<Order>>

Watches order updates via the private WebSocket.

Requires prior authentication via login().

pub async fn watch_my_trades( &self, symbol_filter: Option<String>, ) -> Result<MessageStream<Trade>>

Watches trade fills via the private WebSocket (orders channel).

Extracts trade information from order execution reports. Requires prior authentication via login().