Struct OkxWSClient 

pub struct OkxWSClient { /* private fields */ }

The WebSocket client for OKX.

OKX has Spot, Future, Swap and Option markets.

• API doc: https://www.okx.com/docs-v5/en/#websocket-api
• Trading at:
  • Spot https://www.okx.com/trade-spot
  • Future https://www.okx.com/trade-futures
  • Swap https://www.okx.com/trade-swap
  • Option https://www.okx.com/trade-option

Implementations

impl OkxWSClient

pub async fn new(tx: Sender<String>, url: Option<&str>) -> Self

Trait Implementations

impl WSClient for OkxWSClient

fn subscribe_trade<'life0, 'life1, 'async_trait>( &'life0 self, symbols: &'life1 [String], ) -> Pin<Box<dyn Future<Output = ()> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Subscribes to trade channels.

fn subscribe_orderbook<'life0, 'life1, 'async_trait>( &'life0 self, symbols: &'life1 [String], ) -> Pin<Box<dyn Future<Output = ()> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Subscribes to incremental level2 orderbook channels.

fn subscribe_orderbook_topk<'life0, 'life1, 'async_trait>( &'life0 self, symbols: &'life1 [String], ) -> Pin<Box<dyn Future<Output = ()> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Subscribes to level2 orderbook snapshot channels.

fn subscribe_l3_orderbook<'life0, 'life1, 'async_trait>( &'life0 self, symbols: &'life1 [String], ) -> Pin<Box<dyn Future<Output = ()> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Subscribes to level3 orderebook channels.

fn subscribe_ticker<'life0, 'life1, 'async_trait>( &'life0 self, symbols: &'life1 [String], ) -> Pin<Box<dyn Future<Output = ()> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Subscribes to ticker channels.

fn subscribe_bbo<'life0, 'life1, 'async_trait>( &'life0 self, symbols: &'life1 [String], ) -> Pin<Box<dyn Future<Output = ()> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Subscribes to BBO(best bid & offer) channels.

fn subscribe_candlestick<'life0, 'life1, 'async_trait>( &'life0 self, symbol_interval_list: &'life1 [(String, usize)], ) -> Pin<Box<dyn Future<Output = ()> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Subscribes to candlestick channels.

fn subscribe<'life0, 'life1, 'async_trait>( &'life0 self, topics: &'life1 [(String, String)], ) -> Pin<Box<dyn Future<Output = ()> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Subscribe to multiple topics.

fn unsubscribe<'life0, 'life1, 'async_trait>( &'life0 self, topics: &'life1 [(String, String)], ) -> Pin<Box<dyn Future<Output = ()> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Unsubscribes multiple topics.

fn send<'life0, 'life1, 'async_trait>( &'life0 self, commands: &'life1 [String], ) -> Pin<Box<dyn Future<Output = ()> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Send raw JSON commands.

fn run<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = ()> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Starts the infinite event loop.

fn close<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = ()> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Close the connection and break the loop in Run().