Request parameters.
Rolling window ticker statistics for all market symbols, computed over multiple windows. Note that only tickers that have changed will be present in the array.
Request parameters.
24hr rolling window mini-ticker statistics for all symbols that changed in an array. These are NOT the statistics of the UTC day, but a 24hr rolling window for the previous 24hrs. Note that only tickers that have changed will be present in the array.
Request parameters.
24hr rolling window ticker statistics for all symbols that changed in an array. These are NOT the statistics of the UTC day, but a 24hr rolling window for the previous 24hrs. Note that only tickers that have changed will be present in the array.
Request parameters.
Average price streams push changes in the average price over a fixed time interval.
Request parameters.
Pushes any update to the best bid or ask's price or quantity in real-time for a specified symbol.
Multiple <symbol>@bookTicker
streams can be subscribed to over one connection.
Request parameters.
Order book price and quantity depth updates used to locally manage an order book.
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.
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 second in UTC+0
timezone
Request parameters.
The Kline/Candlestick Stream push updates to the current klines/candlestick every second in UTC+8
timezone
Request parameters.
24hr rolling window mini-ticker statistics. These are NOT the statistics of the UTC day, but a 24hr rolling window for the previous 24hrs.
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, pushed every second. Valid <levels> are 5, 10, or 20.
Request parameters.
Rolling window ticker statistics for a single symbol, computed over multiple windows.
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
24hr rolling window ticker statistics for a single symbol. These are NOT the statistics of the UTC day, but a 24hr rolling window for the previous 24hrs.
Request parameters.
The Trade Streams push raw trade information; each trade has a unique buyer and seller.
Request parameters.
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
The Aggregate Trade Streams push trade information that is aggregated for a single taker order.