com.binance.connector.client.impl

Class WebSocketStreamClientImpl

java.lang.Object

com.binance.connector.client.impl.WebSocketStreamClientImpl

All Implemented Interfaces:

WebSocketStreamClient

public class WebSocketStreamClientImpl
extends Object
implements WebSocketStreamClient

WebSocket Streams

All stream endpoints under the WebSocket Market Streams and User Data Streams section of the API documentation will be implemented in this class.
Response will be returned as callback.

Constructor Summary

Constructors

Constructor and Description
WebSocketStreamClientImpl()
WebSocketStreamClientImpl(String baseUrl)

Method Summary

Modifier and Type	Method and Description
int	aggTradeStream(String symbol, com.binance.connector.client.utils.websocketcallback.WebSocketMessageCallback callback) The Aggregate Trade Streams push trade information that is aggregated for a single taker order.
int	aggTradeStream(String symbol, com.binance.connector.client.utils.websocketcallback.WebSocketOpenCallback onOpenCallback, com.binance.connector.client.utils.websocketcallback.WebSocketMessageCallback onMessageCallback, com.binance.connector.client.utils.websocketcallback.WebSocketClosingCallback onClosingCallback, com.binance.connector.client.utils.websocketcallback.WebSocketClosedCallback onClosedCallback, com.binance.connector.client.utils.websocketcallback.WebSocketFailureCallback onFailureCallback) Same as aggTradeStream(String, WebSocketMessageCallback) plus accepts callbacks for all major websocket connection events.
int	allMiniTickerStream(com.binance.connector.client.utils.websocketcallback.WebSocketMessageCallback callback) 24hr rolling window mini-ticker statistics for all symbols that changed in an array.
int	allMiniTickerStream(com.binance.connector.client.utils.websocketcallback.WebSocketOpenCallback onOpenCallback, com.binance.connector.client.utils.websocketcallback.WebSocketMessageCallback onMessageCallback, com.binance.connector.client.utils.websocketcallback.WebSocketClosingCallback onClosingCallback, com.binance.connector.client.utils.websocketcallback.WebSocketClosedCallback onClosedCallback, com.binance.connector.client.utils.websocketcallback.WebSocketFailureCallback onFailureCallback) Same as allMiniTickerStream(WebSocketMessageCallback) plus accepts callbacks for all major websocket connection events.
int	allRollingWindowTicker(String windowSize, com.binance.connector.client.utils.websocketcallback.WebSocketMessageCallback callback) Rolling window ticker statistics for all market symbols, computed over multiple windows.
int	allRollingWindowTicker(String windowSize, com.binance.connector.client.utils.websocketcallback.WebSocketOpenCallback onOpenCallback, com.binance.connector.client.utils.websocketcallback.WebSocketMessageCallback onMessageCallback, com.binance.connector.client.utils.websocketcallback.WebSocketClosingCallback onClosingCallback, com.binance.connector.client.utils.websocketcallback.WebSocketClosedCallback onClosedCallback, com.binance.connector.client.utils.websocketcallback.WebSocketFailureCallback onFailureCallback) Same as allRollingWindowTicker(String, WebSocketMessageCallback) plus accepts callbacks for all major websocket connection events.
int	allTickerStream(com.binance.connector.client.utils.websocketcallback.WebSocketMessageCallback callback) 24hr rolling window ticker statistics for all symbols that changed in an array.
int	allTickerStream(com.binance.connector.client.utils.websocketcallback.WebSocketOpenCallback onOpenCallback, com.binance.connector.client.utils.websocketcallback.WebSocketMessageCallback onMessageCallback, com.binance.connector.client.utils.websocketcallback.WebSocketClosingCallback onClosingCallback, com.binance.connector.client.utils.websocketcallback.WebSocketClosedCallback onClosedCallback, com.binance.connector.client.utils.websocketcallback.WebSocketFailureCallback onFailureCallback) Same as allTickerStream(WebSocketMessageCallback) plus accepts callbacks for all major websocket connection events.
int	bookTicker(String symbol, com.binance.connector.client.utils.websocketcallback.WebSocketMessageCallback callback) Pushes any update to the best bid or ask's price or quantity in real-time for a specified symbol.
int	bookTicker(String symbol, com.binance.connector.client.utils.websocketcallback.WebSocketOpenCallback onOpenCallback, com.binance.connector.client.utils.websocketcallback.WebSocketMessageCallback onMessageCallback, com.binance.connector.client.utils.websocketcallback.WebSocketClosingCallback onClosingCallback, com.binance.connector.client.utils.websocketcallback.WebSocketClosedCallback onClosedCallback, com.binance.connector.client.utils.websocketcallback.WebSocketFailureCallback onFailureCallback) Same as bookTicker(String, WebSocketMessageCallback) plus accepts callbacks for all major websocket connection events.
void	closeAllConnections() Closes all streams
void	closeConnection(int connectionId) Closes a specific stream based on stream ID.
int	combineStreams(ArrayList<String> streams, com.binance.connector.client.utils.websocketcallback.WebSocketMessageCallback callback) Combined streams are accessed at /stream?streams=<streamName1>/<streamName2>/<streamName3>
int	combineStreams(ArrayList<String> streams, com.binance.connector.client.utils.websocketcallback.WebSocketOpenCallback onOpenCallback, com.binance.connector.client.utils.websocketcallback.WebSocketMessageCallback onMessageCallback, com.binance.connector.client.utils.websocketcallback.WebSocketClosingCallback onClosingCallback, com.binance.connector.client.utils.websocketcallback.WebSocketClosedCallback onClosedCallback, com.binance.connector.client.utils.websocketcallback.WebSocketFailureCallback onFailureCallback) Same as combineStreams(ArrayList, WebSocketMessageCallback) plus accepts callbacks for all major websocket connection events.
int	diffDepthStream(String symbol, int speed, com.binance.connector.client.utils.websocketcallback.WebSocketMessageCallback callback) Order book price and quantity depth updates used to locally manage an order book.
int	diffDepthStream(String symbol, int speed, com.binance.connector.client.utils.websocketcallback.WebSocketOpenCallback onOpenCallback, com.binance.connector.client.utils.websocketcallback.WebSocketMessageCallback onMessageCallback, com.binance.connector.client.utils.websocketcallback.WebSocketClosingCallback onClosingCallback, com.binance.connector.client.utils.websocketcallback.WebSocketClosedCallback onClosedCallback, com.binance.connector.client.utils.websocketcallback.WebSocketFailureCallback onFailureCallback) Same as diffDepthStream(String, int, WebSocketMessageCallback) plus accepts callbacks for all major websocket connection events.
int	klineStream(String symbol, String interval, com.binance.connector.client.utils.websocketcallback.WebSocketMessageCallback callback) The Kline/Candlestick Stream push updates to the current klines/candlestick every second.
int	klineStream(String symbol, String interval, com.binance.connector.client.utils.websocketcallback.WebSocketOpenCallback onOpenCallback, com.binance.connector.client.utils.websocketcallback.WebSocketMessageCallback onMessageCallback, com.binance.connector.client.utils.websocketcallback.WebSocketClosingCallback onClosingCallback, com.binance.connector.client.utils.websocketcallback.WebSocketClosedCallback onClosedCallback, com.binance.connector.client.utils.websocketcallback.WebSocketFailureCallback onFailureCallback) Same as klineStream(String, String, WebSocketMessageCallback) plus accepts callbacks for all major websocket connection events.
int	listenUserStream(String listenKey, com.binance.connector.client.utils.websocketcallback.WebSocketMessageCallback callback) User Data Streams are accessed at /ws/<listenKey>
int	listenUserStream(String listenKey, com.binance.connector.client.utils.websocketcallback.WebSocketOpenCallback onOpenCallback, com.binance.connector.client.utils.websocketcallback.WebSocketMessageCallback onMessageCallback, com.binance.connector.client.utils.websocketcallback.WebSocketClosingCallback onClosingCallback, com.binance.connector.client.utils.websocketcallback.WebSocketClosedCallback onClosedCallback, com.binance.connector.client.utils.websocketcallback.WebSocketFailureCallback onFailureCallback) Same as listenUserStream(String, WebSocketMessageCallback) plus accepts callbacks for all major websocket connection events.
int	miniTickerStream(String symbol, com.binance.connector.client.utils.websocketcallback.WebSocketMessageCallback callback) 24hr rolling window mini-ticker statistics.
int	miniTickerStream(String symbol, com.binance.connector.client.utils.websocketcallback.WebSocketOpenCallback onOpenCallback, com.binance.connector.client.utils.websocketcallback.WebSocketMessageCallback onMessageCallback, com.binance.connector.client.utils.websocketcallback.WebSocketClosingCallback onClosingCallback, com.binance.connector.client.utils.websocketcallback.WebSocketClosedCallback onClosedCallback, com.binance.connector.client.utils.websocketcallback.WebSocketFailureCallback onFailureCallback) Same as miniTickerStream(String, WebSocketMessageCallback) plus accepts callbacks for all major websocket connection events.
int	partialDepthStream(String symbol, int levels, int speed, com.binance.connector.client.utils.websocketcallback.WebSocketMessageCallback callback) Top bids and asks, Valid are 5, 10, or 20.
int	partialDepthStream(String symbol, int levels, int speed, com.binance.connector.client.utils.websocketcallback.WebSocketOpenCallback onOpenCallback, com.binance.connector.client.utils.websocketcallback.WebSocketMessageCallback onMessageCallback, com.binance.connector.client.utils.websocketcallback.WebSocketClosingCallback onClosingCallback, com.binance.connector.client.utils.websocketcallback.WebSocketClosedCallback onClosedCallback, com.binance.connector.client.utils.websocketcallback.WebSocketFailureCallback onFailureCallback) Same as partialDepthStream(String, int, int, WebSocketMessageCallback) plus accepts callbacks for all major websocket connection events.
int	rollingWindowTicker(String symbol, String windowSize, com.binance.connector.client.utils.websocketcallback.WebSocketMessageCallback callback) Rolling window ticker statistics for a single symbol, computed over multiple windows.
int	rollingWindowTicker(String symbol, String windowSize, com.binance.connector.client.utils.websocketcallback.WebSocketOpenCallback onOpenCallback, com.binance.connector.client.utils.websocketcallback.WebSocketMessageCallback onMessageCallback, com.binance.connector.client.utils.websocketcallback.WebSocketClosingCallback onClosingCallback, com.binance.connector.client.utils.websocketcallback.WebSocketClosedCallback onClosedCallback, com.binance.connector.client.utils.websocketcallback.WebSocketFailureCallback onFailureCallback) Same as rollingWindowTicker(String, String, WebSocketMessageCallback) (String, WebSocketCallback)} plus accepts callbacks for all major websocket connection events.
int	symbolTicker(String symbol, com.binance.connector.client.utils.websocketcallback.WebSocketMessageCallback callback) 24hr rolling window ticker statistics for a single symbol.
int	symbolTicker(String symbol, com.binance.connector.client.utils.websocketcallback.WebSocketOpenCallback onOpenCallback, com.binance.connector.client.utils.websocketcallback.WebSocketMessageCallback onMessageCallback, com.binance.connector.client.utils.websocketcallback.WebSocketClosingCallback onClosingCallback, com.binance.connector.client.utils.websocketcallback.WebSocketClosedCallback onClosedCallback, com.binance.connector.client.utils.websocketcallback.WebSocketFailureCallback onFailureCallback) Same as symbolTicker(String, WebSocketMessageCallback) plus accepts callbacks for all major websocket connection events.
int	tradeStream(String symbol, com.binance.connector.client.utils.websocketcallback.WebSocketMessageCallback callback) The Trade Streams push raw trade information; each trade has a unique buyer and seller.
int	tradeStream(String symbol, com.binance.connector.client.utils.websocketcallback.WebSocketOpenCallback onOpenCallback, com.binance.connector.client.utils.websocketcallback.WebSocketMessageCallback onMessageCallback, com.binance.connector.client.utils.websocketcallback.WebSocketClosingCallback onClosingCallback, com.binance.connector.client.utils.websocketcallback.WebSocketClosedCallback onClosedCallback, com.binance.connector.client.utils.websocketcallback.WebSocketFailureCallback onFailureCallback) Same as tradeStream(String, WebSocketMessageCallback) plus accepts callbacks for all major websocket connection events.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

WebSocketStreamClientImpl

public WebSocketStreamClientImpl()

WebSocketStreamClientImpl

public WebSocketStreamClientImpl(String baseUrl)

Method Detail

aggTradeStream

public int aggTradeStream(String symbol,
                          com.binance.connector.client.utils.websocketcallback.WebSocketMessageCallback callback)

The Aggregate Trade Streams push trade information that is aggregated for a single taker order.

<symbol>@aggTrade

Update Speed: Real-time

Specified by:

aggTradeStream in interface WebSocketStreamClient

Parameters:

symbol - Name of the trading pair

Returns:

int - Connection ID

See Also:

https://binance-docs.github.io/apidocs/spot/en/#aggregate-trade-streams

aggTradeStream

public int aggTradeStream(String symbol,
                          com.binance.connector.client.utils.websocketcallback.WebSocketOpenCallback onOpenCallback,
                          com.binance.connector.client.utils.websocketcallback.WebSocketMessageCallback onMessageCallback,
                          com.binance.connector.client.utils.websocketcallback.WebSocketClosingCallback onClosingCallback,
                          com.binance.connector.client.utils.websocketcallback.WebSocketClosedCallback onClosedCallback,
                          com.binance.connector.client.utils.websocketcallback.WebSocketFailureCallback onFailureCallback)

Same as aggTradeStream(String, WebSocketMessageCallback) plus accepts callbacks for all major websocket connection events.

Specified by:

aggTradeStream in interface WebSocketStreamClient

Parameters:

symbol - Name of the trading pair

onOpenCallback - Callback for when the websocket connection is opened

onMessageCallback - Callback for when a message is received

onClosingCallback - Callback for when the websocket connection is closing

onFailureCallback - Callback for when an error occurs

Returns:

int - Connection ID

tradeStream

public int tradeStream(String symbol,
                       com.binance.connector.client.utils.websocketcallback.WebSocketMessageCallback callback)

The Trade Streams push raw trade information; each trade has a unique buyer and seller.

<symbol>@trade

Update Speed: Real-time

Specified by:

tradeStream in interface WebSocketStreamClient

Parameters:

symbol - Name of the trading pair

Returns:

int - Connection ID

See Also:

https://binance-docs.github.io/apidocs/spot/en/#trade-streams

tradeStream

public int tradeStream(String symbol,
                       com.binance.connector.client.utils.websocketcallback.WebSocketOpenCallback onOpenCallback,
                       com.binance.connector.client.utils.websocketcallback.WebSocketMessageCallback onMessageCallback,
                       com.binance.connector.client.utils.websocketcallback.WebSocketClosingCallback onClosingCallback,
                       com.binance.connector.client.utils.websocketcallback.WebSocketClosedCallback onClosedCallback,
                       com.binance.connector.client.utils.websocketcallback.WebSocketFailureCallback onFailureCallback)

Same as tradeStream(String, WebSocketMessageCallback) plus accepts callbacks for all major websocket connection events.

Specified by:

tradeStream in interface WebSocketStreamClient

Parameters:

symbol - Name of the trading pair

onOpenCallback - Callback for when the websocket connection is opened

onMessageCallback - Callback for when a message is received

onClosingCallback - Callback for when the websocket connection is closing

onFailureCallback - Callback for when an error occurs

Returns:

int - Connection ID

klineStream

public int klineStream(String symbol,
                       String interval,
                       com.binance.connector.client.utils.websocketcallback.WebSocketMessageCallback callback)

The Kline/Candlestick Stream push updates to the current klines/candlestick every second.

<symbol>@kline_<interval>

Update Speed: Real-time

Specified by:

klineStream in interface WebSocketStreamClient

Parameters:

symbol - Name of the trading pair

interval - Time interval for kline/candlestick

Returns:

int - Connection ID

See Also:

https://binance-docs.github.io/apidocs/spot/en/#kline-candlestick-streams

klineStream

public int klineStream(String symbol,
                       String interval,
                       com.binance.connector.client.utils.websocketcallback.WebSocketOpenCallback onOpenCallback,
                       com.binance.connector.client.utils.websocketcallback.WebSocketMessageCallback onMessageCallback,
                       com.binance.connector.client.utils.websocketcallback.WebSocketClosingCallback onClosingCallback,
                       com.binance.connector.client.utils.websocketcallback.WebSocketClosedCallback onClosedCallback,
                       com.binance.connector.client.utils.websocketcallback.WebSocketFailureCallback onFailureCallback)

Same as klineStream(String, String, WebSocketMessageCallback) plus accepts callbacks for all major websocket connection events.

Specified by:

klineStream in interface WebSocketStreamClient

Parameters:

symbol - Name of the trading pair

interval - Time interval for kline/candlestick

onOpenCallback - Callback for when the websocket connection is opened

onMessageCallback - Callback for when a message is received

onClosingCallback - Callback for when the websocket connection is closing

onFailureCallback - Callback for when an error occurs

Returns:

int - Connection ID

miniTickerStream

public int miniTickerStream(String symbol,
                            com.binance.connector.client.utils.websocketcallback.WebSocketMessageCallback callback)

24hr rolling window mini-ticker statistics. These are NOT the statistics of the UTC day, but a 24hr rolling window for the previous 24hrs.

<symbol>@miniTicker

Update Speed: Real-time

Specified by:

miniTickerStream in interface WebSocketStreamClient

Parameters:

symbol - Name of the trading pair

Returns:

int - Connection ID

See Also:

https://binance-docs.github.io/apidocs/spot/en/#individual-symbol-mini-ticker-stream

miniTickerStream

public int miniTickerStream(String symbol,
                            com.binance.connector.client.utils.websocketcallback.WebSocketOpenCallback onOpenCallback,
                            com.binance.connector.client.utils.websocketcallback.WebSocketMessageCallback onMessageCallback,
                            com.binance.connector.client.utils.websocketcallback.WebSocketClosingCallback onClosingCallback,
                            com.binance.connector.client.utils.websocketcallback.WebSocketClosedCallback onClosedCallback,
                            com.binance.connector.client.utils.websocketcallback.WebSocketFailureCallback onFailureCallback)

Same as miniTickerStream(String, WebSocketMessageCallback) plus accepts callbacks for all major websocket connection events.

Specified by:

miniTickerStream in interface WebSocketStreamClient

Parameters:

symbol - Name of the trading pair

onOpenCallback - Callback for when the websocket connection is opened

onMessageCallback - Callback for when a message is received

onClosingCallback - Callback for when the websocket connection is closing

onFailureCallback - Callback for when an error occurs

Returns:

int - Connection ID

allMiniTickerStream

public int allMiniTickerStream(com.binance.connector.client.utils.websocketcallback.WebSocketMessageCallback callback)

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.

!miniTicker@arr

Update Speed: Real-time

Specified by:

allMiniTickerStream in interface WebSocketStreamClient

Returns:

int - Connection ID

See Also:

https://binance-docs.github.io/apidocs/spot/en/#all-market-mini-tickers-stream

allMiniTickerStream

public int allMiniTickerStream(com.binance.connector.client.utils.websocketcallback.WebSocketOpenCallback onOpenCallback,
                               com.binance.connector.client.utils.websocketcallback.WebSocketMessageCallback onMessageCallback,
                               com.binance.connector.client.utils.websocketcallback.WebSocketClosingCallback onClosingCallback,
                               com.binance.connector.client.utils.websocketcallback.WebSocketClosedCallback onClosedCallback,
                               com.binance.connector.client.utils.websocketcallback.WebSocketFailureCallback onFailureCallback)

Same as allMiniTickerStream(WebSocketMessageCallback) plus accepts callbacks for all major websocket connection events.

Specified by:

allMiniTickerStream in interface WebSocketStreamClient

Parameters:

onOpenCallback - Callback for when the websocket connection is opened

onMessageCallback - Callback for when a message is received

onClosingCallback - Callback for when the websocket connection is closing

onFailureCallback - Callback for when an error occurs

Returns:

int - Connection ID

symbolTicker

public int symbolTicker(String symbol,
                        com.binance.connector.client.utils.websocketcallback.WebSocketMessageCallback callback)

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.

<symbol>@ticker

Update Speed: Real-time

Specified by:

symbolTicker in interface WebSocketStreamClient

Parameters:

symbol - Name of the trading pair

Returns:

int - Connection ID

See Also:

https://binance-docs.github.io/apidocs/spot/en/#individual-symbol-ticker-streams

symbolTicker

public int symbolTicker(String symbol,
                        com.binance.connector.client.utils.websocketcallback.WebSocketOpenCallback onOpenCallback,
                        com.binance.connector.client.utils.websocketcallback.WebSocketMessageCallback onMessageCallback,
                        com.binance.connector.client.utils.websocketcallback.WebSocketClosingCallback onClosingCallback,
                        com.binance.connector.client.utils.websocketcallback.WebSocketClosedCallback onClosedCallback,
                        com.binance.connector.client.utils.websocketcallback.WebSocketFailureCallback onFailureCallback)

Same as symbolTicker(String, WebSocketMessageCallback) plus accepts callbacks for all major websocket connection events.

Specified by:

symbolTicker in interface WebSocketStreamClient

Parameters:

symbol - Name of the trading pair

onOpenCallback - Callback for when the websocket connection is opened

onMessageCallback - Callback for when a message is received

onClosingCallback - Callback for when the websocket connection is closing

onFailureCallback - Callback for when an error occurs

Returns:

int - Connection ID

allTickerStream

public int allTickerStream(com.binance.connector.client.utils.websocketcallback.WebSocketMessageCallback callback)

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.

!ticker@arr

Update Speed: Real-time

Specified by:

allTickerStream in interface WebSocketStreamClient

Returns:

int - Connection ID

See Also:

https://binance-docs.github.io/apidocs/spot/en/#all-market-tickers-stream

allTickerStream

public int allTickerStream(com.binance.connector.client.utils.websocketcallback.WebSocketOpenCallback onOpenCallback,
                           com.binance.connector.client.utils.websocketcallback.WebSocketMessageCallback onMessageCallback,
                           com.binance.connector.client.utils.websocketcallback.WebSocketClosingCallback onClosingCallback,
                           com.binance.connector.client.utils.websocketcallback.WebSocketClosedCallback onClosedCallback,
                           com.binance.connector.client.utils.websocketcallback.WebSocketFailureCallback onFailureCallback)

Same as allTickerStream(WebSocketMessageCallback) plus accepts callbacks for all major websocket connection events.

Specified by:

allTickerStream in interface WebSocketStreamClient

Parameters:

onOpenCallback - Callback for when the websocket connection is opened

onMessageCallback - Callback for when a message is received

onClosingCallback - Callback for when the websocket connection is closing

onFailureCallback - Callback for when an error occurs

Returns:

int - Connection ID

rollingWindowTicker

public int rollingWindowTicker(String symbol,
                               String windowSize,
                               com.binance.connector.client.utils.websocketcallback.WebSocketMessageCallback callback)

Rolling window ticker statistics for a single symbol, computed over multiple windows.

<symbol>@ticker_<window_size>

Update Speed: Real-time

Specified by:

rollingWindowTicker in interface WebSocketStreamClient

Parameters:

symbol - Name of the trading pair

windowSize - Window Sizes: 1h,4h

Returns:

int - Connection ID

See Also:

https://binance-docs.github.io/apidocs/spot/en/#individual-symbol-rolling-window-statistics-streams

rollingWindowTicker

public int rollingWindowTicker(String symbol,
                               String windowSize,
                               com.binance.connector.client.utils.websocketcallback.WebSocketOpenCallback onOpenCallback,
                               com.binance.connector.client.utils.websocketcallback.WebSocketMessageCallback onMessageCallback,
                               com.binance.connector.client.utils.websocketcallback.WebSocketClosingCallback onClosingCallback,
                               com.binance.connector.client.utils.websocketcallback.WebSocketClosedCallback onClosedCallback,
                               com.binance.connector.client.utils.websocketcallback.WebSocketFailureCallback onFailureCallback)

Same as rollingWindowTicker(String, String, WebSocketMessageCallback) (String, WebSocketCallback)} plus accepts callbacks for all major websocket connection events.

Specified by:

rollingWindowTicker in interface WebSocketStreamClient

Parameters:

symbol - Name of the trading pair

onOpenCallback - Callback for when the websocket connection is opened

onMessageCallback - Callback for when a message is received

onClosingCallback - Callback for when the websocket connection is closing

onFailureCallback - Callback for when an error occurs

Returns:

int - Connection ID

allRollingWindowTicker

public int allRollingWindowTicker(String windowSize,
                                  com.binance.connector.client.utils.websocketcallback.WebSocketMessageCallback callback)

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.

!ticker_<window-size>@arr

Update Speed: Real-time

Specified by:

allRollingWindowTicker in interface WebSocketStreamClient

Parameters:

windowSize - Window Sizes: 1h,4h

Returns:

int - Connection ID

See Also:

https://binance-docs.github.io/apidocs/spot/en/#all-market-rolling-window-statistics-streams

allRollingWindowTicker

public int allRollingWindowTicker(String windowSize,
                                  com.binance.connector.client.utils.websocketcallback.WebSocketOpenCallback onOpenCallback,
                                  com.binance.connector.client.utils.websocketcallback.WebSocketMessageCallback onMessageCallback,
                                  com.binance.connector.client.utils.websocketcallback.WebSocketClosingCallback onClosingCallback,
                                  com.binance.connector.client.utils.websocketcallback.WebSocketClosedCallback onClosedCallback,
                                  com.binance.connector.client.utils.websocketcallback.WebSocketFailureCallback onFailureCallback)

Same as allRollingWindowTicker(String, WebSocketMessageCallback) plus accepts callbacks for all major websocket connection events.

Specified by:

allRollingWindowTicker in interface WebSocketStreamClient

Parameters:

windowSize - Window Sizes: 1h,4h

onOpenCallback - Callback for when the websocket connection is opened

onMessageCallback - Callback for when a message is received

onClosingCallback - Callback for when the websocket connection is closing

onFailureCallback - Callback for when an error occurs

Returns:

int - Connection ID

bookTicker

public int bookTicker(String symbol,
                      com.binance.connector.client.utils.websocketcallback.WebSocketMessageCallback callback)

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

<symbol>@bookTicker

Update Speed: Real-time

Specified by:

bookTicker in interface WebSocketStreamClient

Parameters:

symbol - Name of the trading pair

Returns:

int - Connection ID

See Also:

https://binance-docs.github.io/apidocs/spot/en/#individual-symbol-book-ticker-streams

bookTicker

public int bookTicker(String symbol,
                      com.binance.connector.client.utils.websocketcallback.WebSocketOpenCallback onOpenCallback,
                      com.binance.connector.client.utils.websocketcallback.WebSocketMessageCallback onMessageCallback,
                      com.binance.connector.client.utils.websocketcallback.WebSocketClosingCallback onClosingCallback,
                      com.binance.connector.client.utils.websocketcallback.WebSocketClosedCallback onClosedCallback,
                      com.binance.connector.client.utils.websocketcallback.WebSocketFailureCallback onFailureCallback)

Same as bookTicker(String, WebSocketMessageCallback) plus accepts callbacks for all major websocket connection events.

Specified by:

bookTicker in interface WebSocketStreamClient

Parameters:

symbol - Name of the trading pair

onOpenCallback - Callback for when the websocket connection is opened

onMessageCallback - Callback for when a message is received

onClosingCallback - Callback for when the websocket connection is closing

onFailureCallback - Callback for when an error occurs

Returns:

int - Connection ID

partialDepthStream

public int partialDepthStream(String symbol,
                              int levels,
                              int speed,
                              com.binance.connector.client.utils.websocketcallback.WebSocketMessageCallback callback)

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

<symbol>@depth<levels>@<speed>ms

Update Speed: 1000ms or 100ms

Specified by:

partialDepthStream in interface WebSocketStreamClient

Parameters:

symbol - Name of the trading pair

levels - Valid are 5, 10, or 20

speed - 1000ms or 100ms

Returns:

int - Connection ID

See Also:

https://binance-docs.github.io/apidocs/spot/en/#partial-book-depth-streams

partialDepthStream

public int partialDepthStream(String symbol,
                              int levels,
                              int speed,
                              com.binance.connector.client.utils.websocketcallback.WebSocketOpenCallback onOpenCallback,
                              com.binance.connector.client.utils.websocketcallback.WebSocketMessageCallback onMessageCallback,
                              com.binance.connector.client.utils.websocketcallback.WebSocketClosingCallback onClosingCallback,
                              com.binance.connector.client.utils.websocketcallback.WebSocketClosedCallback onClosedCallback,
                              com.binance.connector.client.utils.websocketcallback.WebSocketFailureCallback onFailureCallback)

Same as partialDepthStream(String, int, int, WebSocketMessageCallback) plus accepts callbacks for all major websocket connection events.

Specified by:

partialDepthStream in interface WebSocketStreamClient

Parameters:

symbol - Name of the trading pair

levels - Valid are 5, 10, or 20

speed - 1000ms or 100ms

onOpenCallback - Callback for when the websocket connection is opened

onMessageCallback - Callback for when a message is received

onClosingCallback - Callback for when the websocket connection is closing

onFailureCallback - Callback for when an error occurs

Returns:

int - Connection ID

diffDepthStream

public int diffDepthStream(String symbol,
                           int speed,
                           com.binance.connector.client.utils.websocketcallback.WebSocketMessageCallback callback)

Order book price and quantity depth updates used to locally manage an order book.

<symbol>@depth@<speed>ms

Update Speed: 1000ms or 100ms

Specified by:

diffDepthStream in interface WebSocketStreamClient

Parameters:

symbol - Name of the trading pair

speed - 1000ms or 100ms

Returns:

int - Connection ID

See Also:

https://binance-docs.github.io/apidocs/spot/en/#diff-depth-stream

diffDepthStream

public int diffDepthStream(String symbol,
                           int speed,
                           com.binance.connector.client.utils.websocketcallback.WebSocketOpenCallback onOpenCallback,
                           com.binance.connector.client.utils.websocketcallback.WebSocketMessageCallback onMessageCallback,
                           com.binance.connector.client.utils.websocketcallback.WebSocketClosingCallback onClosingCallback,
                           com.binance.connector.client.utils.websocketcallback.WebSocketClosedCallback onClosedCallback,
                           com.binance.connector.client.utils.websocketcallback.WebSocketFailureCallback onFailureCallback)

Same as diffDepthStream(String, int, WebSocketMessageCallback) plus accepts callbacks for all major websocket connection events.

Specified by:

diffDepthStream in interface WebSocketStreamClient

Parameters:

symbol - Name of the trading pair

speed - 1000ms or 100ms

onOpenCallback - Callback for when the websocket connection is opened

onMessageCallback - Callback for when a message is received

onClosingCallback - Callback for when the websocket connection is closing

onFailureCallback - Callback for when an error occurs

Returns:

int - Connection ID

listenUserStream

public int listenUserStream(String listenKey,
                            com.binance.connector.client.utils.websocketcallback.WebSocketMessageCallback callback)

User Data Streams are accessed at /ws/<listenKey>

Specified by:

listenUserStream in interface WebSocketStreamClient

Parameters:

listenKey - listen key obtained from this endpoint

Returns:

int - Connection ID

See Also:

https://binance-docs.github.io/apidocs/spot/en/#user-data-streams

listenUserStream

public int listenUserStream(String listenKey,
                            com.binance.connector.client.utils.websocketcallback.WebSocketOpenCallback onOpenCallback,
                            com.binance.connector.client.utils.websocketcallback.WebSocketMessageCallback onMessageCallback,
                            com.binance.connector.client.utils.websocketcallback.WebSocketClosingCallback onClosingCallback,
                            com.binance.connector.client.utils.websocketcallback.WebSocketClosedCallback onClosedCallback,
                            com.binance.connector.client.utils.websocketcallback.WebSocketFailureCallback onFailureCallback)

Same as listenUserStream(String, WebSocketMessageCallback) plus accepts callbacks for all major websocket connection events.

Specified by:

listenUserStream in interface WebSocketStreamClient

Parameters:

listenKey - listen key obtained from this endpoint

onOpenCallback - Callback for when the websocket connection is opened

onMessageCallback - Callback for when a message is received

onClosingCallback - Callback for when the websocket connection is closing

onFailureCallback - Callback for when an error occurs

Returns:

int - Connection ID

combineStreams

public int combineStreams(ArrayList<String> streams,
                          com.binance.connector.client.utils.websocketcallback.WebSocketMessageCallback callback)

Combined streams are accessed at /stream?streams=<streamName1>/<streamName2>/<streamName3>

Specified by:

combineStreams in interface WebSocketStreamClient

Parameters:

streams - ArrayList of stream names to be combined

Returns:

int - Connection ID

See Also:

https://binance-docs.github.io/apidocs/spot/en/#websocket-market-streams

combineStreams

public int combineStreams(ArrayList<String> streams,
                          com.binance.connector.client.utils.websocketcallback.WebSocketOpenCallback onOpenCallback,
                          com.binance.connector.client.utils.websocketcallback.WebSocketMessageCallback onMessageCallback,
                          com.binance.connector.client.utils.websocketcallback.WebSocketClosingCallback onClosingCallback,
                          com.binance.connector.client.utils.websocketcallback.WebSocketClosedCallback onClosedCallback,
                          com.binance.connector.client.utils.websocketcallback.WebSocketFailureCallback onFailureCallback)

Same as combineStreams(ArrayList, WebSocketMessageCallback) plus accepts callbacks for all major websocket connection events.

Specified by:

combineStreams in interface WebSocketStreamClient

Parameters:

streams - ArrayList of stream names to be combined

onOpenCallback - Callback for when the websocket connection is opened

onMessageCallback - Callback for when a message is received

onClosingCallback - Callback for when the websocket connection is closing

onFailureCallback - Callback for when an error occurs

Returns:

int - Connection ID

closeConnection

public void closeConnection(int connectionId)

Closes a specific stream based on stream ID.

Specified by:

closeConnection in interface WebSocketStreamClient

Parameters:

connectionId - The connection ID to close.

closeAllConnections

public void closeAllConnections()

Closes all streams

Specified by:

closeAllConnections in interface WebSocketStreamClient