Request parameters.
Pushes any update to the best bid or ask's price or quantity in real-time for all symbols.
Update Speed: 5s
Request parameters.
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
Request parameters.
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
Request parameters.
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
Request parameters.
Composite index information for index symbols pushed every second.
Update Speed: 1000ms
Request parameters.
Update Speed: 250ms
Request parameters.
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
Request parameters.
Bids and asks, pushed every 250 milliseconds, 500 milliseconds, 100 milliseconds (if existing)
Update Speed: 250ms, 500ms, 100ms
Request parameters.
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.
A Promise that resolves when all connections have been closed.
Pushes any update to the best bid or ask's price or quantity in real-time for a specified symbol.
Update Speed: Real-time
Request parameters.
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: 2s
Request parameters.
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: 2000ms
Request parameters.
Checks if the WebSocket connection is currently open.
true
if the connection is open, false
otherwise.
Checks if the WebSocket connection is subscribed to the specified stream.
The name of the WebSocket stream to check.
true
if the connection is subscribed to the stream, false
otherwise.
The Kline/Candlestick Stream push updates to the current klines/candlestick every 250 milliseconds (if existing).
Update Speed: 250ms
Request parameters.
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
Request parameters.
Mark price and funding rate for a single symbol pushed every 3 seconds or every second.
Update Speed: 3000ms or 1000ms
Request parameters.
Mark price and funding rate for all symbols pushed every 3 seconds or every second.
Update Speed: 3000ms or 1000ms
Request parameters.
Asset index for multi-assets mode user
Update Speed: 1s
Request parameters.
Removes an event listener for the specified WebSocket event.
The WebSocket event to stop listening for, such as 'open', 'message', 'error', 'close', 'ping', or 'pong'.
The callback function that was previously added as the event listener.
Adds an event listener for the specified WebSocket event.
The WebSocket event to listen for, such as 'open', 'message', 'error', 'close', 'ping', or 'pong'.
The callback function to be executed when the event is triggered. The function can accept any number of arguments.
Top <levels> bids and asks, Valid <levels> are 5, 10, or 20.
Update Speed: 250ms, 500ms or 100ms
Request parameters.
Subscribes to one or multiple WebSocket streams Handles both single and pool modes
Single stream name or array of stream names to subscribe to
Optional
id: stringOptional subscription ID
void
Unsubscribes from one or multiple WebSocket streams Handles both single and pool modes
Single stream name or array of stream names to unsubscribe from
Optional
id: stringOptional unsubscription ID
void
Subscribes to the user data WebSocket stream using the provided listen key.
The listen key for the user data WebSocket stream.
Optional
id: stringOptional user data stream ID
A WebSocket stream handler for the user data stream.
The Aggregate Trade Streams push market trade information that is aggregated for fills with same price and taking side every 100 milliseconds. Only market trades will be aggregated, which means the insurance fund trades and ADL trades won't be aggregated.
Update Speed: 100ms