Class WebsocketStreamsConnection

The Aggregate Trade Streams push market trade information that is aggregated for fills with same price and taking side every 100 milliseconds.

Update Speed: 100ms

Pushes any update to the best bid or ask's price or quantity in real-time for all symbols.

Update Speed: Real-time

The All Liquidation Order Snapshot Streams push force liquidation order information for all symbols in the market. For each symbol，only the latest one liquidation order within 1000ms will be pushed as the snapshot. If no liquidation happens in the interval of 1000ms, no stream will be pushed.

Update Speed: 1000ms

24hr rolling window mini-ticker statistics for all symbols. These are NOT the statistics of the UTC day, but a 24hr rolling window from requestTime to 24hrs before. Note that only tickers that have changed will be present in the array.

Update Speed: 1000ms

24hr rolling window ticker statistics for all symbols. These are NOT the statistics of the UTC day, but a 24hr rolling window from requestTime to 24hrs before. Note that only tickers that have changed will be present in the array.

Update Speed: 1000ms

Kline update every second

Update Speed: 250ms

ContractInfo stream pushes when contract info updates(listing/settlement/contract bracket update). bks field only shows up when bracket gets updated.

Update Speed: Real-time

Bids and asks, pushed every 250 milliseconds, 500 milliseconds, or 100 milliseconds

Update Speed: 250ms or 500ms or 100ms

Disconnects from the WebSocket server. If there is no active connection, a warning is logged. Otherwise, all connections in the connection pool are closed gracefully, and a message is logged indicating that the connection has been disconnected.

Index Kline/Candlestick Streams

Update Speed: 250ms

Index Price Stream

Update Speed: 3000ms OR 1000ms

Pushes any update to the best bid or ask's price or quantity in real-time for a specified symbol.

Update Speed: Real-time

24hr rolling window mini-ticker statistics for a single symbol. These are NOT the statistics of the UTC day, but a 24hr rolling window from requestTime to 24hrs before.

Update Speed: 500ms

24hr rolling window ticker statistics for a single symbol. These are NOT the statistics of the UTC day, but a 24hr rolling window from requestTime to 24hrs before.

Update Speed: 500ms

Checks if the WebSocket connection is currently open.

Checks if the WebSocket connection is subscribed to the specified stream.

The Kline/Candlestick Stream push updates to the current klines/candlestick every 250 milliseconds (if existing).

Update Speed: 250ms

The Liquidation Order Snapshot Streams push force liquidation order information for specific symbol.

For each symbol，only the latest one liquidation order within 1000ms will be pushed as the snapshot. If no liquidation happens in the interval of 1000ms, no stream will be pushed.

Update Speed: 1000ms

Mark Price Kline/Candlestick Streams

Update Speed: 250ms

Mark Price of All Symbols of a Pair

Update Speed: 3000ms OR 1000ms

Mark price update stream

Update Speed: 3000ms OR 1000ms

Removes an event listener for the specified WebSocket event.

Adds an event listener for the specified WebSocket event.

Top <levels> bids and asks, Valid <levels> are 5, 10, or 20.

Update Speed: 250ms, 500ms or 100ms

Sends a ping message to all connected Websocket servers in the pool. If no connections are ready, a warning is logged. For each active connection, the ping message is sent, and debug logs provide details.

Subscribes to one or multiple WebSocket streams Handles both single and pool modes

Unsubscribes from one or multiple WebSocket streams Handles both single and pool modes

Subscribes to the user data WebSocket stream using the provided listen key.