com.binance.connector.futures.client.impl

Class WebsocketClientImpl

java.lang.Object

com.binance.connector.futures.client.impl.WebsocketClientImpl

All Implemented Interfaces:

WebsocketClient

Direct Known Subclasses:

CMWebsocketClientImpl, UMWebsocketClientImpl

public abstract class WebsocketClientImpl
extends Object
implements WebsocketClient

Futures Websocket Streams

All stream endpoints under the USDⓈ-M Websocket Market Streams and COIN-M Websocket Market Streams and USDⓈ-M User Data Streams and COIN-M 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
WebsocketClientImpl(String baseUrl)

Method Summary

Modifier and Type	Method and Description
int	aggTradeStream(String symbol, com.binance.connector.futures.client.utils.WebSocketCallback onMessageCallback) The Aggregate Trade Streams push market trade information that is aggregated for fills with same price and taking side every 100 milliseconds.
int	aggTradeStream(String symbol, com.binance.connector.futures.client.utils.WebSocketCallback onOpenCallback, com.binance.connector.futures.client.utils.WebSocketCallback onMessageCallback, com.binance.connector.futures.client.utils.WebSocketCallback onClosingCallback, com.binance.connector.futures.client.utils.WebSocketCallback onFailureCallback) Same as aggTradeStream(String, WebSocketCallback) plus accepts callbacks for all major websocket connection events.
int	allBookTickerStream(com.binance.connector.futures.client.utils.WebSocketCallback onMessageCallback) Pushes any update to the best bid or ask's price or quantity in real-time for all symbols.
int	allBookTickerStream(com.binance.connector.futures.client.utils.WebSocketCallback onOpenCallback, com.binance.connector.futures.client.utils.WebSocketCallback onMessageCallback, com.binance.connector.futures.client.utils.WebSocketCallback onClosingCallback, com.binance.connector.futures.client.utils.WebSocketCallback onFailureCallback) Same as allBookTickerStream(WebSocketCallback) plus accepts callbacks for all major websocket connection events.
int	allForceOrderStream(com.binance.connector.futures.client.utils.WebSocketCallback onMessageCallback) The All Liquidation Order Snapshot Streams push force liquidation order information for all symbols in the market.
int	allForceOrderStream(com.binance.connector.futures.client.utils.WebSocketCallback onOpenCallback, com.binance.connector.futures.client.utils.WebSocketCallback onMessageCallback, com.binance.connector.futures.client.utils.WebSocketCallback onClosingCallback, com.binance.connector.futures.client.utils.WebSocketCallback onFailureCallback) Same as allForceOrderStream(WebSocketCallback) plus accepts callbacks for all major websocket connection events.
int	allMiniTickerStream(com.binance.connector.futures.client.utils.WebSocketCallback onMessageCallback) 24hr rolling window mini-ticker statistics for all symbols that changed in an array.
int	allMiniTickerStream(com.binance.connector.futures.client.utils.WebSocketCallback onOpenCallback, com.binance.connector.futures.client.utils.WebSocketCallback onMessageCallback, com.binance.connector.futures.client.utils.WebSocketCallback onClosingCallback, com.binance.connector.futures.client.utils.WebSocketCallback onFailureCallback) Same as allMiniTickerStream(WebSocketCallback) plus accepts callbacks for all major websocket connection events.
int	allTickerStream(com.binance.connector.futures.client.utils.WebSocketCallback onMessageCallback) 24hr rolling window ticker statistics for all symbols.
int	allTickerStream(com.binance.connector.futures.client.utils.WebSocketCallback onOpenCallback, com.binance.connector.futures.client.utils.WebSocketCallback onMessageCallback, com.binance.connector.futures.client.utils.WebSocketCallback onClosingCallback, com.binance.connector.futures.client.utils.WebSocketCallback onFailureCallback) Same as allTickerStream(WebSocketCallback) plus accepts callbacks for all major websocket connection events.
int	bookTicker(String symbol, com.binance.connector.futures.client.utils.WebSocketCallback onMessageCallback) 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.futures.client.utils.WebSocketCallback onOpenCallback, com.binance.connector.futures.client.utils.WebSocketCallback onMessageCallback, com.binance.connector.futures.client.utils.WebSocketCallback onClosingCallback, com.binance.connector.futures.client.utils.WebSocketCallback onFailureCallback) Same as bookTicker(String, WebSocketCallback) 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.futures.client.utils.WebSocketCallback onMessageCallback) Combined streams are accessed at /stream?streams=<streamName1>/<streamName2>/<streamName3>
int	combineStreams(ArrayList<String> streams, com.binance.connector.futures.client.utils.WebSocketCallback onOpenCallback, com.binance.connector.futures.client.utils.WebSocketCallback onMessageCallback, com.binance.connector.futures.client.utils.WebSocketCallback onClosingCallback, com.binance.connector.futures.client.utils.WebSocketCallback onFailureCallback) Same as combineStreams(ArrayList, WebSocketCallback) plus accepts callbacks for all major websocket connection events.
int	continuousKlineStream(String pair, String contractType, String interval, com.binance.connector.futures.client.utils.WebSocketCallback onMessageCallback) The Kline/Candlestick Stream push updates to the current klines/candlestick every 250 milliseconds (if existing).
int	continuousKlineStream(String pair, String contractType, String interval, com.binance.connector.futures.client.utils.WebSocketCallback onOpenCallback, com.binance.connector.futures.client.utils.WebSocketCallback onMessageCallback, com.binance.connector.futures.client.utils.WebSocketCallback onClosingCallback, com.binance.connector.futures.client.utils.WebSocketCallback onFailureCallback) Same as continuousKlineStream(String, String, String, WebSocketCallback) plus accepts callbacks for all major websocket connection events.
int	createConnection(com.binance.connector.futures.client.utils.WebSocketCallback onOpenCallback, com.binance.connector.futures.client.utils.WebSocketCallback onMessageCallback, com.binance.connector.futures.client.utils.WebSocketCallback onClosingCallback, com.binance.connector.futures.client.utils.WebSocketCallback onFailureCallback, okhttp3.Request request)
int	diffDepthStream(String symbol, int speed, com.binance.connector.futures.client.utils.WebSocketCallback onMessageCallback) Bids and asks, pushed every 250 milliseconds, 500 milliseconds, 100 milliseconds (if existing) <symbol>@depth@<speed>ms Update Speed: 250ms, 500ms, 100ms
int	diffDepthStream(String symbol, int speed, com.binance.connector.futures.client.utils.WebSocketCallback onOpenCallback, com.binance.connector.futures.client.utils.WebSocketCallback onMessageCallback, com.binance.connector.futures.client.utils.WebSocketCallback onClosingCallback, com.binance.connector.futures.client.utils.WebSocketCallback onFailureCallback) Same as diffDepthStream(String, int, WebSocketCallback) plus accepts callbacks for all major websocket connection events.
int	forceOrderStream(String symbol, com.binance.connector.futures.client.utils.WebSocketCallback onMessageCallback) The Liquidation Order Snapshot Streams push force liquidation order information for specific symbol.
int	forceOrderStream(String symbol, com.binance.connector.futures.client.utils.WebSocketCallback onOpenCallback, com.binance.connector.futures.client.utils.WebSocketCallback onMessageCallback, com.binance.connector.futures.client.utils.WebSocketCallback onClosingCallback, com.binance.connector.futures.client.utils.WebSocketCallback onFailureCallback) Same as forceOrderStream(String, WebSocketCallback) plus accepts callbacks for all major websocket connection events.
String	getBaseUrl()
com.binance.connector.futures.client.utils.WebSocketCallback	getNoopCallback()
int	klineStream(String symbol, String interval, com.binance.connector.futures.client.utils.WebSocketCallback onMessageCallback) The Kline/Candlestick Stream push updates to the current klines/candlestick every 250 milliseconds (if existing).
int	klineStream(String symbol, String interval, com.binance.connector.futures.client.utils.WebSocketCallback onOpenCallback, com.binance.connector.futures.client.utils.WebSocketCallback onMessageCallback, com.binance.connector.futures.client.utils.WebSocketCallback onClosingCallback, com.binance.connector.futures.client.utils.WebSocketCallback onFailureCallback) Same as klineStream(String, String, WebSocketCallback) plus accepts callbacks for all major websocket connection events.
int	listenUserStream(String listenKey, com.binance.connector.futures.client.utils.WebSocketCallback onMessageCallback) User Data Streams are accessed at /ws/<listenKey>
int	listenUserStream(String listenKey, com.binance.connector.futures.client.utils.WebSocketCallback onOpenCallback, com.binance.connector.futures.client.utils.WebSocketCallback onMessageCallback, com.binance.connector.futures.client.utils.WebSocketCallback onClosingCallback, com.binance.connector.futures.client.utils.WebSocketCallback onFailureCallback) Same as listenUserStream(String, WebSocketCallback) plus accepts callbacks for all major websocket connection events.
int	markPriceStream(String symbol, int speed, com.binance.connector.futures.client.utils.WebSocketCallback onMessageCallback) Mark price and funding rate for a single symbol pushed every 3 seconds or every second.
int	markPriceStream(String symbol, int speed, com.binance.connector.futures.client.utils.WebSocketCallback onOpenCallback, com.binance.connector.futures.client.utils.WebSocketCallback onMessageCallback, com.binance.connector.futures.client.utils.WebSocketCallback onClosingCallback, com.binance.connector.futures.client.utils.WebSocketCallback onFailureCallback) Same as markPriceStream(String, int, WebSocketCallback) plus accepts callbacks for all major websocket connection events.
int	miniTickerStream(String symbol, com.binance.connector.futures.client.utils.WebSocketCallback onMessageCallback) 24hr rolling window mini-ticker statistics.
int	miniTickerStream(String symbol, com.binance.connector.futures.client.utils.WebSocketCallback onOpenCallback, com.binance.connector.futures.client.utils.WebSocketCallback onMessageCallback, com.binance.connector.futures.client.utils.WebSocketCallback onClosingCallback, com.binance.connector.futures.client.utils.WebSocketCallback onFailureCallback) Same as miniTickerStream(String, WebSocketCallback) plus accepts callbacks for all major websocket connection events.
int	partialDepthStream(String symbol, int levels, int speed, com.binance.connector.futures.client.utils.WebSocketCallback onMessageCallback) Top bids and asks, Valid are 5, 10, or 20.
int	partialDepthStream(String symbol, int levels, int speed, com.binance.connector.futures.client.utils.WebSocketCallback onOpenCallback, com.binance.connector.futures.client.utils.WebSocketCallback onMessageCallback, com.binance.connector.futures.client.utils.WebSocketCallback onClosingCallback, com.binance.connector.futures.client.utils.WebSocketCallback onFailureCallback) Same as partialDepthStream(String, int, int, WebSocketCallback) plus accepts callbacks for all major websocket connection events.
int	symbolTicker(String symbol, com.binance.connector.futures.client.utils.WebSocketCallback onMessageCallback) 24hr rolling window ticker statistics for a single symbol.
int	symbolTicker(String symbol, com.binance.connector.futures.client.utils.WebSocketCallback onOpenCallback, com.binance.connector.futures.client.utils.WebSocketCallback onMessageCallback, com.binance.connector.futures.client.utils.WebSocketCallback onClosingCallback, com.binance.connector.futures.client.utils.WebSocketCallback onFailureCallback) Same as symbolTicker(String, WebSocketCallback) 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

WebsocketClientImpl

public WebsocketClientImpl(String baseUrl)

Method Detail

getNoopCallback

public com.binance.connector.futures.client.utils.WebSocketCallback getNoopCallback()

getBaseUrl

public String getBaseUrl()

aggTradeStream

public int aggTradeStream(String symbol,
                          com.binance.connector.futures.client.utils.WebSocketCallback onMessageCallback)

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.

<symbol>@aggTrade

Update Speed: 100ms

Specified by:

aggTradeStream in interface WebsocketClient

Parameters:

symbol - trading symbol

onMessageCallback - onMessageCallback

Returns:

int - Connection ID

See Also:

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

aggTradeStream

public int aggTradeStream(String symbol,
                          com.binance.connector.futures.client.utils.WebSocketCallback onOpenCallback,
                          com.binance.connector.futures.client.utils.WebSocketCallback onMessageCallback,
                          com.binance.connector.futures.client.utils.WebSocketCallback onClosingCallback,
                          com.binance.connector.futures.client.utils.WebSocketCallback onFailureCallback)

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

Specified by:

aggTradeStream in interface WebsocketClient

Parameters:

symbol - trading symbol

onOpenCallback - onOpenCallback

onMessageCallback - onMessageCallback

onClosingCallback - onClosingCallback

onFailureCallback - onFailureCallback

Returns:

int - Connection ID

markPriceStream

public int markPriceStream(String symbol,
                           int speed,
                           com.binance.connector.futures.client.utils.WebSocketCallback onMessageCallback)

Mark price and funding rate for a single symbol pushed every 3 seconds or every second.

<symbol>@markPrice or <symbol>@markPrice@1s

Update Speed: 3000ms or 1000ms

Specified by:

markPriceStream in interface WebsocketClient

Parameters:

symbol - trading symbol

speed - speed in seconds, can be 1 or 3

onMessageCallback - onMessageCallback

Returns:

int - Connection ID

See Also:

https://binance-docs.github.io/apidocs/futures/en/#mark-price-stream, https://binance-docs.github.io/apidocs/delivery/en/#mark-price-stream

markPriceStream

public int markPriceStream(String symbol,
                           int speed,
                           com.binance.connector.futures.client.utils.WebSocketCallback onOpenCallback,
                           com.binance.connector.futures.client.utils.WebSocketCallback onMessageCallback,
                           com.binance.connector.futures.client.utils.WebSocketCallback onClosingCallback,
                           com.binance.connector.futures.client.utils.WebSocketCallback onFailureCallback)

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

Specified by:

markPriceStream in interface WebsocketClient

Parameters:

symbol - trading symbol

speed - speed in seconds, can be 1 or 3

onOpenCallback - onOpenCallback

onMessageCallback - onMessageCallback

onClosingCallback - onClosingCallback

onFailureCallback - onFailureCallback

Returns:

int - Connection ID

klineStream

public int klineStream(String symbol,
                       String interval,
                       com.binance.connector.futures.client.utils.WebSocketCallback onMessageCallback)

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

<symbol>@kline_<interval>

Update Speed: 250ms

Specified by:

klineStream in interface WebsocketClient

Parameters:

symbol - trading symbol

interval - kline interval - 1m 3m 5m 15m 30m 1h 2h 4h 6h 8h 12h 1d 3d 1w 1M

onMessageCallback - onMessageCallback

Returns:

int - Connection ID

See Also:

https://binance-docs.github.io/apidocs/futures/en/#kline-candlestick-streams, https://binance-docs.github.io/apidocs/delivery/en/#kline-candlestick-streams

klineStream

public int klineStream(String symbol,
                       String interval,
                       com.binance.connector.futures.client.utils.WebSocketCallback onOpenCallback,
                       com.binance.connector.futures.client.utils.WebSocketCallback onMessageCallback,
                       com.binance.connector.futures.client.utils.WebSocketCallback onClosingCallback,
                       com.binance.connector.futures.client.utils.WebSocketCallback onFailureCallback)

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

Specified by:

klineStream in interface WebsocketClient

Parameters:

symbol - trading symbol

interval - kline interval - 1m 3m 5m 15m 30m 1h 2h 4h 6h 8h 12h 1d 3d 1w 1M

onOpenCallback - onOpenCallback

onMessageCallback - onMessageCallback

onClosingCallback - onClosingCallback

onFailureCallback - onFailureCallback

Returns:

int - Connection ID

continuousKlineStream

public int continuousKlineStream(String pair,
                                 String contractType,
                                 String interval,
                                 com.binance.connector.futures.client.utils.WebSocketCallback onMessageCallback)

The Kline/Candlestick Stream push updates to the current klines/candlestick every 250 milliseconds (if existing). Contract Types are: perpetual, current_quarter, next_quarter

<pair>_<contractType>@continuousKline_<interval>

Update Speed: 250ms

Specified by:

continuousKlineStream in interface WebsocketClient

Parameters:

pair - trading pair

contractType - perpetual, current_quarter, next_quarter

interval - kline interval - 1m 3m 5m 15m 30m 1h 2h 4h 6h 8h 12h 1d 3d 1w 1M

onMessageCallback - onMessageCallback

Returns:

int - Connection ID

See Also:

https://binance-docs.github.io/apidocs/delivery/en/#continuous-contract-kline-candlestick-streams

continuousKlineStream

public int continuousKlineStream(String pair,
                                 String contractType,
                                 String interval,
                                 com.binance.connector.futures.client.utils.WebSocketCallback onOpenCallback,
                                 com.binance.connector.futures.client.utils.WebSocketCallback onMessageCallback,
                                 com.binance.connector.futures.client.utils.WebSocketCallback onClosingCallback,
                                 com.binance.connector.futures.client.utils.WebSocketCallback onFailureCallback)

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

Specified by:

continuousKlineStream in interface WebsocketClient

Parameters:

pair - trading pair

interval - kline interval - 1m 3m 5m 15m 30m 1h 2h 4h 6h 8h 12h 1d 3d 1w 1M

contractType - perpetual, current_quarter, next_quarter

onOpenCallback - onOpenCallback

onMessageCallback - onMessageCallback

onClosingCallback - onClosingCallback

onFailureCallback - onFailureCallback

Returns:

int - Connection ID

miniTickerStream

public int miniTickerStream(String symbol,
                            com.binance.connector.futures.client.utils.WebSocketCallback onMessageCallback)

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: 500ms

Specified by:

miniTickerStream in interface WebsocketClient

Parameters:

symbol - trading symbol

onMessageCallback - onMessageCallback

Returns:

int - Connection ID

See Also:

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

miniTickerStream

public int miniTickerStream(String symbol,
                            com.binance.connector.futures.client.utils.WebSocketCallback onOpenCallback,
                            com.binance.connector.futures.client.utils.WebSocketCallback onMessageCallback,
                            com.binance.connector.futures.client.utils.WebSocketCallback onClosingCallback,
                            com.binance.connector.futures.client.utils.WebSocketCallback onFailureCallback)

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

Specified by:

miniTickerStream in interface WebsocketClient

Parameters:

symbol - trading symbol

onOpenCallback - onOpenCallback

onMessageCallback - onMessageCallback

onClosingCallback - onClosingCallback

onFailureCallback - onFailureCallback

Returns:

int - Connection ID

allMiniTickerStream

public int allMiniTickerStream(com.binance.connector.futures.client.utils.WebSocketCallback onMessageCallback)

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: 1000ms

Specified by:

allMiniTickerStream in interface WebsocketClient

Parameters:

onMessageCallback - onMessageCallback

Returns:

int - Connection ID

See Also:

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

allMiniTickerStream

public int allMiniTickerStream(com.binance.connector.futures.client.utils.WebSocketCallback onOpenCallback,
                               com.binance.connector.futures.client.utils.WebSocketCallback onMessageCallback,
                               com.binance.connector.futures.client.utils.WebSocketCallback onClosingCallback,
                               com.binance.connector.futures.client.utils.WebSocketCallback onFailureCallback)

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

Specified by:

allMiniTickerStream in interface WebsocketClient

Parameters:

onOpenCallback - onOpenCallback

onMessageCallback - onMessageCallback

onClosingCallback - onClosingCallback

onFailureCallback - onFailureCallback

Returns:

int - Connection ID

symbolTicker

public int symbolTicker(String symbol,
                        com.binance.connector.futures.client.utils.WebSocketCallback onMessageCallback)

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: 500ms

Specified by:

symbolTicker in interface WebsocketClient

Parameters:

symbol - trading symbol

onMessageCallback - onMessageCallback

Returns:

int - Connection ID

See Also:

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

symbolTicker

public int symbolTicker(String symbol,
                        com.binance.connector.futures.client.utils.WebSocketCallback onOpenCallback,
                        com.binance.connector.futures.client.utils.WebSocketCallback onMessageCallback,
                        com.binance.connector.futures.client.utils.WebSocketCallback onClosingCallback,
                        com.binance.connector.futures.client.utils.WebSocketCallback onFailureCallback)

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

Specified by:

symbolTicker in interface WebsocketClient

Parameters:

symbol - trading symbol

onOpenCallback - onOpenCallback

onMessageCallback - onMessageCallback

onClosingCallback - onClosingCallback

onFailureCallback - onFailureCallback

Returns:

int - Connection ID

allTickerStream

public int allTickerStream(com.binance.connector.futures.client.utils.WebSocketCallback onMessageCallback)

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.

!ticker@arr

Update Speed: 1000ms

Specified by:

allTickerStream in interface WebsocketClient

Parameters:

onMessageCallback - onMessageCallback

Returns:

int - Connection ID

See Also:

https://binance-docs.github.io/apidocs/futures/en/#all-market-tickers-streams, https://binance-docs.github.io/apidocs/delivery/en/#all-market-tickers-streams

allTickerStream

public int allTickerStream(com.binance.connector.futures.client.utils.WebSocketCallback onOpenCallback,
                           com.binance.connector.futures.client.utils.WebSocketCallback onMessageCallback,
                           com.binance.connector.futures.client.utils.WebSocketCallback onClosingCallback,
                           com.binance.connector.futures.client.utils.WebSocketCallback onFailureCallback)

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

Specified by:

allTickerStream in interface WebsocketClient

Parameters:

onOpenCallback - onOpenCallback

onMessageCallback - onMessageCallback

onClosingCallback - onClosingCallback

onFailureCallback - onFailureCallback

Returns:

int - Connection ID

bookTicker

public int bookTicker(String symbol,
                      com.binance.connector.futures.client.utils.WebSocketCallback onMessageCallback)

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 WebsocketClient

Parameters:

symbol - trading symbol

onMessageCallback - onMessageCallback

Returns:

int - Connection ID

See Also:

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

bookTicker

public int bookTicker(String symbol,
                      com.binance.connector.futures.client.utils.WebSocketCallback onOpenCallback,
                      com.binance.connector.futures.client.utils.WebSocketCallback onMessageCallback,
                      com.binance.connector.futures.client.utils.WebSocketCallback onClosingCallback,
                      com.binance.connector.futures.client.utils.WebSocketCallback onFailureCallback)

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

Specified by:

bookTicker in interface WebsocketClient

Parameters:

symbol - trading symbol

onOpenCallback - onOpenCallback

onMessageCallback - onMessageCallback

onClosingCallback - onClosingCallback

onFailureCallback - onFailureCallback

Returns:

int - Connection ID

allBookTickerStream

public int allBookTickerStream(com.binance.connector.futures.client.utils.WebSocketCallback onMessageCallback)

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

!bookTicker

Update Speed: Real-time

Specified by:

allBookTickerStream in interface WebsocketClient

Parameters:

onMessageCallback - onMessageCallback

Returns:

int - Connection ID

See Also:

https://binance-docs.github.io/apidocs/futures/en/#all-book-tickers-stream, https://binance-docs.github.io/apidocs/delivery/en/#all-book-tickers-stream

allBookTickerStream

public int allBookTickerStream(com.binance.connector.futures.client.utils.WebSocketCallback onOpenCallback,
                               com.binance.connector.futures.client.utils.WebSocketCallback onMessageCallback,
                               com.binance.connector.futures.client.utils.WebSocketCallback onClosingCallback,
                               com.binance.connector.futures.client.utils.WebSocketCallback onFailureCallback)

Same as allBookTickerStream(WebSocketCallback) plus accepts callbacks for all major websocket connection events.

Specified by:

allBookTickerStream in interface WebsocketClient

Parameters:

onOpenCallback - onOpenCallback

onMessageCallback - onMessageCallback

onClosingCallback - onClosingCallback

onFailureCallback - onFailureCallback

Returns:

int - Connection ID

forceOrderStream

public int forceOrderStream(String symbol,
                            com.binance.connector.futures.client.utils.WebSocketCallback onMessageCallback)

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.

<symbol>@forceOrder

Update Speed: 1000ms

Specified by:

forceOrderStream in interface WebsocketClient

Parameters:

symbol - trading symbol

onMessageCallback - onMessageCallback

Returns:

int - Connection ID

See Also:

https://binance-docs.github.io/apidocs/futures/en/#liquidation-order-streams, https://binance-docs.github.io/apidocs/delivery/en/#liquidation-order-streams

forceOrderStream

public int forceOrderStream(String symbol,
                            com.binance.connector.futures.client.utils.WebSocketCallback onOpenCallback,
                            com.binance.connector.futures.client.utils.WebSocketCallback onMessageCallback,
                            com.binance.connector.futures.client.utils.WebSocketCallback onClosingCallback,
                            com.binance.connector.futures.client.utils.WebSocketCallback onFailureCallback)

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

Specified by:

forceOrderStream in interface WebsocketClient

Parameters:

symbol - trading symbol

onOpenCallback - onOpenCallback

onMessageCallback - onMessageCallback

onClosingCallback - onClosingCallback

onFailureCallback - onFailureCallback

Returns:

int - Connection ID

allForceOrderStream

public int allForceOrderStream(com.binance.connector.futures.client.utils.WebSocketCallback onMessageCallback)

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.

!forceOrder@arr

Update Speed: 1000ms

Specified by:

allForceOrderStream in interface WebsocketClient

Parameters:

onMessageCallback - onMessageCallback

Returns:

int - Connection ID

See Also:

https://binance-docs.github.io/apidocs/futures/en/#all-book-tickers-stream, https://binance-docs.github.io/apidocs/delivery/en/#all-market-liquidation-order-streams

allForceOrderStream

public int allForceOrderStream(com.binance.connector.futures.client.utils.WebSocketCallback onOpenCallback,
                               com.binance.connector.futures.client.utils.WebSocketCallback onMessageCallback,
                               com.binance.connector.futures.client.utils.WebSocketCallback onClosingCallback,
                               com.binance.connector.futures.client.utils.WebSocketCallback onFailureCallback)

Same as allForceOrderStream(WebSocketCallback) plus accepts callbacks for all major websocket connection events.

Specified by:

allForceOrderStream in interface WebsocketClient

Parameters:

onOpenCallback - onOpenCallback

onMessageCallback - onMessageCallback

onClosingCallback - onClosingCallback

onFailureCallback - onFailureCallback

Returns:

int - Connection ID

partialDepthStream

public int partialDepthStream(String symbol,
                              int levels,
                              int speed,
                              com.binance.connector.futures.client.utils.WebSocketCallback onMessageCallback)

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

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

Update Speed: 250ms, 500ms or 100ms

Specified by:

partialDepthStream in interface WebsocketClient

Parameters:

symbol - trading symbol

levels - order book depth level, can be 5, 10, or 20

speed - update speed in ms, can be 250, 500 or 100

onMessageCallback - onMessageCallback

Returns:

int - Connection ID

See Also:

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

partialDepthStream

public int partialDepthStream(String symbol,
                              int levels,
                              int speed,
                              com.binance.connector.futures.client.utils.WebSocketCallback onOpenCallback,
                              com.binance.connector.futures.client.utils.WebSocketCallback onMessageCallback,
                              com.binance.connector.futures.client.utils.WebSocketCallback onClosingCallback,
                              com.binance.connector.futures.client.utils.WebSocketCallback onFailureCallback)

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

Specified by:

partialDepthStream in interface WebsocketClient

Parameters:

symbol - trading symbol

levels - order book depth level, can be 5, 10, or 20

speed - update speed in ms, can be 250, 500 or 100

onOpenCallback - onOpenCallback

onMessageCallback - onMessageCallback

onClosingCallback - onClosingCallback

onFailureCallback - onFailureCallback

Returns:

int - Connection ID

diffDepthStream

public int diffDepthStream(String symbol,
                           int speed,
                           com.binance.connector.futures.client.utils.WebSocketCallback onMessageCallback)

Bids and asks, pushed every 250 milliseconds, 500 milliseconds, 100 milliseconds (if existing)

<symbol>@depth@<speed>ms

Update Speed: 250ms, 500ms, 100ms

Specified by:

diffDepthStream in interface WebsocketClient

Parameters:

symbol - trading symbol

speed - update speed in ms, can be 250, 500 or 100

onMessageCallback - onMessageCallback

Returns:

int - Connection ID

See Also:

https://binance-docs.github.io/apidocs/futures/en/#diff-book-depth-streams, https://binance-docs.github.io/apidocs/delivery/en/#diff-book-depth-streams

diffDepthStream

public int diffDepthStream(String symbol,
                           int speed,
                           com.binance.connector.futures.client.utils.WebSocketCallback onOpenCallback,
                           com.binance.connector.futures.client.utils.WebSocketCallback onMessageCallback,
                           com.binance.connector.futures.client.utils.WebSocketCallback onClosingCallback,
                           com.binance.connector.futures.client.utils.WebSocketCallback onFailureCallback)

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

Specified by:

diffDepthStream in interface WebsocketClient

Parameters:

symbol - trading symbol

speed - update speed in ms, can be 250, 500 or 100

onOpenCallback - onOpenCallback

onMessageCallback - onMessageCallback

onClosingCallback - onClosingCallback

onFailureCallback - onFailureCallback

Returns:

int - Connection ID

listenUserStream

public int listenUserStream(String listenKey,
                            com.binance.connector.futures.client.utils.WebSocketCallback onMessageCallback)

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

Specified by:

listenUserStream in interface WebsocketClient

Parameters:

listenKey - listen key

onMessageCallback - onMessageCallback

Returns:

int - Connection ID

See Also:

https://binance-docs.github.io/apidocs/futures/en/#user-data-streams, https://binance-docs.github.io/apidocs/delivery/en/#user-data-streams

listenUserStream

public int listenUserStream(String listenKey,
                            com.binance.connector.futures.client.utils.WebSocketCallback onOpenCallback,
                            com.binance.connector.futures.client.utils.WebSocketCallback onMessageCallback,
                            com.binance.connector.futures.client.utils.WebSocketCallback onClosingCallback,
                            com.binance.connector.futures.client.utils.WebSocketCallback onFailureCallback)

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

Specified by:

listenUserStream in interface WebsocketClient

Parameters:

listenKey - listen key

onOpenCallback - onOpenCallback

onMessageCallback - onMessageCallback

onClosingCallback - onClosingCallback

onFailureCallback - onFailureCallback

Returns:

int - Connection ID

combineStreams

public int combineStreams(ArrayList<String> streams,
                          com.binance.connector.futures.client.utils.WebSocketCallback onMessageCallback)

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

Specified by:

combineStreams in interface WebsocketClient

Parameters:

streams - A list of stream names to be combined

onMessageCallback - onMessageCallback

Returns:

int - Connection ID

See Also:

https://binance-docs.github.io/apidocs/futures/en/#websocket-market-streams, https://binance-docs.github.io/apidocs/delivery/en/#websocket-market-streams

combineStreams

public int combineStreams(ArrayList<String> streams,
                          com.binance.connector.futures.client.utils.WebSocketCallback onOpenCallback,
                          com.binance.connector.futures.client.utils.WebSocketCallback onMessageCallback,
                          com.binance.connector.futures.client.utils.WebSocketCallback onClosingCallback,
                          com.binance.connector.futures.client.utils.WebSocketCallback onFailureCallback)

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

Specified by:

combineStreams in interface WebsocketClient

Parameters:

streams - stream name list

onOpenCallback - onOpenCallback

onMessageCallback - onMessageCallback

onClosingCallback - onClosingCallback

onFailureCallback - onFailureCallback

Returns:

int - Connection ID

closeConnection

public void closeConnection(int connectionId)

Closes a specific stream based on stream Id.

Specified by:

closeConnection in interface WebsocketClient

Parameters:

connectionId - Connection ID

closeAllConnections

public void closeAllConnections()

Closes all streams

Specified by:

closeAllConnections in interface WebsocketClient

createConnection

public int createConnection(com.binance.connector.futures.client.utils.WebSocketCallback onOpenCallback,
                            com.binance.connector.futures.client.utils.WebSocketCallback onMessageCallback,
                            com.binance.connector.futures.client.utils.WebSocketCallback onClosingCallback,
                            com.binance.connector.futures.client.utils.WebSocketCallback onFailureCallback,
                            okhttp3.Request request)