com.binance.client

Interface SubscriptionClient

All Known Implementing Classes:

WebSocketStreamClientImpl

public interface SubscriptionClient

The subscription client interface, it is used for subscribing any market data update and account change, it is asynchronous, so you must implement the SubscriptionListener interface. The server will push any update to the client. if client get the update, the onReceive method will be called.

Method Summary

Modifier and Type	Method and Description
static SubscriptionClient	create() Create the subscription client to subscribe the update from server.
static SubscriptionClient	create(SubscriptionOptions subscriptionOptions) Create the subscription client to subscribe the update from server.
void	subscribeAggregateTradeEvent(String symbol, SubscriptionListener<AggregateTradeEvent> callback, SubscriptionErrorHandler errorHandler) Subscribe aggregate trade event.
void	subscribeAllBookTickerEvent(SubscriptionListener<SymbolBookTickerEvent> callback, SubscriptionErrorHandler errorHandler) Subscribe all market book tickers event.
void	subscribeAllLiquidationOrderEvent(SubscriptionListener<LiquidationOrderEvent> callback, SubscriptionErrorHandler errorHandler) Subscribe all market book tickers event.
void	subscribeAllMiniTickerEvent(SubscriptionListener<List<SymbolMiniTickerEvent>> callback, SubscriptionErrorHandler errorHandler) Subscribe all market mini tickers event.
void	subscribeAllTickerEvent(SubscriptionListener<List<SymbolTickerEvent>> callback, SubscriptionErrorHandler errorHandler) Subscribe all market tickers event.
void	subscribeBookDepthEvent(String symbol, Integer limit, SubscriptionListener<OrderBookEvent> callback, SubscriptionErrorHandler errorHandler) Subscribe partial book depth event.
void	subscribeCandlestickEvent(String symbol, CandlestickInterval interval, SubscriptionListener<CandlestickEvent> callback, SubscriptionErrorHandler errorHandler) Subscribe candlestick event.
void	subscribeDiffDepthEvent(String symbol, SubscriptionListener<OrderBookEvent> callback, SubscriptionErrorHandler errorHandler) Subscribe diff depth event.
void	subscribeMarkPriceEvent(String symbol, SubscriptionListener<MarkPriceEvent> callback, SubscriptionErrorHandler errorHandler) Subscribe mark price event.
void	subscribeSymbolBookTickerEvent(String symbol, SubscriptionListener<SymbolBookTickerEvent> callback, SubscriptionErrorHandler errorHandler) Subscribe individual symbol book ticker event.
void	subscribeSymbolLiquidationOrderEvent(String symbol, SubscriptionListener<LiquidationOrderEvent> callback, SubscriptionErrorHandler errorHandler) Subscribe individual symbol book ticker event.
void	subscribeSymbolMiniTickerEvent(String symbol, SubscriptionListener<SymbolMiniTickerEvent> callback, SubscriptionErrorHandler errorHandler) Subscribe individual symbol mini ticker event.
void	subscribeSymbolTickerEvent(String symbol, SubscriptionListener<SymbolTickerEvent> callback, SubscriptionErrorHandler errorHandler) Subscribe individual symbol ticker event.
void	subscribeUserDataEvent(String listenKey, SubscriptionListener<UserDataUpdateEvent> callback, SubscriptionErrorHandler errorHandler) Subscribe user data event.
void	unsubscribeAll() Unsubscribe all subscription.

Method Detail

create

static SubscriptionClient create()

Create the subscription client to subscribe the update from server.

Returns:

The instance of synchronous client.

create

static SubscriptionClient create(SubscriptionOptions subscriptionOptions)

Create the subscription client to subscribe the update from server.

Parameters:

subscriptionOptions - The option of subscription connection, see SubscriptionOptions

Returns:

The instance of synchronous client.

unsubscribeAll

void unsubscribeAll()

Unsubscribe all subscription.

subscribeAggregateTradeEvent

void subscribeAggregateTradeEvent(String symbol,
                                  SubscriptionListener<AggregateTradeEvent> callback,
                                  SubscriptionErrorHandler errorHandler)

Subscribe aggregate trade event. If the aggregate trade is updated, server will send the data to client and onReceive in callback will be called.

Parameters:

symbol - The symbol, like "btcusdt".

callback - The implementation is required. onReceive will be called if receive server's update.

errorHandler - The error handler will be called if subscription failed or error happen between client and Binance server.

subscribeMarkPriceEvent

void subscribeMarkPriceEvent(String symbol,
                             SubscriptionListener<MarkPriceEvent> callback,
                             SubscriptionErrorHandler errorHandler)

Subscribe mark price event. If the mark price is updated, server will send the data to client and onReceive in callback will be called.

Parameters:

symbol - The symbol, like "btcusdt".

callback - The implementation is required. onReceive will be called if receive server's update.

errorHandler - The error handler will be called if subscription failed or error happen between client and Binance server.

subscribeCandlestickEvent

void subscribeCandlestickEvent(String symbol,
                               CandlestickInterval interval,
                               SubscriptionListener<CandlestickEvent> callback,
                               SubscriptionErrorHandler errorHandler)

Subscribe candlestick event. If the candlestick is updated, server will send the data to client and onReceive in callback will be called.

Parameters:

symbol - The symbol, like "btcusdt".

interval - The candlestick interval, like "ONE_MINUTE".

callback - The implementation is required. onReceive will be called if receive server's update.

errorHandler - The error handler will be called if subscription failed or error happen between client and Binance server.

subscribeSymbolMiniTickerEvent

void subscribeSymbolMiniTickerEvent(String symbol,
                                    SubscriptionListener<SymbolMiniTickerEvent> callback,
                                    SubscriptionErrorHandler errorHandler)

Subscribe individual symbol mini ticker event. If the symbol mini ticker is updated, server will send the data to client and onReceive in callback will be called.

Parameters:

symbol - The symbol, like "btcusdt".

callback - The implementation is required. onReceive will be called if receive server's update.

errorHandler - The error handler will be called if subscription failed or error happen between client and Binance server.

subscribeAllMiniTickerEvent

void subscribeAllMiniTickerEvent(SubscriptionListener<List<SymbolMiniTickerEvent>> callback,
                                 SubscriptionErrorHandler errorHandler)

Subscribe all market mini tickers event. If the mini tickers are updated, server will send the data to client and onReceive in callback will be called.

Parameters:

callback - The implementation is required. onReceive will be called if receive server's update.

errorHandler - The error handler will be called if subscription failed or error happen between client and Binance server.

subscribeSymbolTickerEvent

void subscribeSymbolTickerEvent(String symbol,
                                SubscriptionListener<SymbolTickerEvent> callback,
                                SubscriptionErrorHandler errorHandler)

Subscribe individual symbol ticker event. If the symbol ticker is updated, server will send the data to client and onReceive in callback will be called.

Parameters:

symbol - The symbol, like "btcusdt".

callback - The implementation is required. onReceive will be called if receive server's update.

errorHandler - The error handler will be called if subscription failed or error happen between client and Binance server.

subscribeAllTickerEvent

void subscribeAllTickerEvent(SubscriptionListener<List<SymbolTickerEvent>> callback,
                             SubscriptionErrorHandler errorHandler)

Subscribe all market tickers event. If the tickers are updated, server will send the data to client and onReceive in callback will be called.

Parameters:

callback - The implementation is required. onReceive will be called if receive server's update.

errorHandler - The error handler will be called if subscription failed or error happen between client and Binance server.

subscribeSymbolBookTickerEvent

void subscribeSymbolBookTickerEvent(String symbol,
                                    SubscriptionListener<SymbolBookTickerEvent> callback,
                                    SubscriptionErrorHandler errorHandler)

Subscribe individual symbol book ticker event. If the symbol book ticker is updated, server will send the data to client and onReceive in callback will be called.

Parameters:

symbol - The symbol, like "btcusdt".

callback - The implementation is required. onReceive will be called if receive server's update.

errorHandler - The error handler will be called if subscription failed or error happen between client and Binance server.

subscribeAllBookTickerEvent

void subscribeAllBookTickerEvent(SubscriptionListener<SymbolBookTickerEvent> callback,
                                 SubscriptionErrorHandler errorHandler)

Subscribe all market book tickers event. If the book tickers are updated, server will send the data to client and onReceive in callback will be called.

Parameters:

callback - The implementation is required. onReceive will be called if receive server's update.

errorHandler - The error handler will be called if subscription failed or error happen between client and Binance server.

subscribeSymbolLiquidationOrderEvent

void subscribeSymbolLiquidationOrderEvent(String symbol,
                                          SubscriptionListener<LiquidationOrderEvent> callback,
                                          SubscriptionErrorHandler errorHandler)

Subscribe individual symbol book ticker event. If the symbol book ticker is updated, server will send the data to client and onReceive in callback will be called.

Parameters:

symbol - The symbol, like "btcusdt".

callback - The implementation is required. onReceive will be called if receive server's update.

errorHandler - The error handler will be called if subscription failed or error happen between client and Binance server.

subscribeAllLiquidationOrderEvent

void subscribeAllLiquidationOrderEvent(SubscriptionListener<LiquidationOrderEvent> callback,
                                       SubscriptionErrorHandler errorHandler)

Subscribe all market book tickers event. If the book tickers are updated, server will send the data to client and onReceive in callback will be called.

Parameters:

callback - The implementation is required. onReceive will be called if receive server's update.

errorHandler - The error handler will be called if subscription failed or error happen between client and Binance server.

subscribeBookDepthEvent

void subscribeBookDepthEvent(String symbol,
                             Integer limit,
                             SubscriptionListener<OrderBookEvent> callback,
                             SubscriptionErrorHandler errorHandler)

Subscribe partial book depth event. If the book depth is updated, server will send the data to client and onReceive in callback will be called.

Parameters:

symbol - The symbol, like "btcusdt".

limit - The limit.

callback - The implementation is required. onReceive will be called if receive server's update.

errorHandler - The error handler will be called if subscription failed or error happen between client and Binance server.

subscribeDiffDepthEvent

void subscribeDiffDepthEvent(String symbol,
                             SubscriptionListener<OrderBookEvent> callback,
                             SubscriptionErrorHandler errorHandler)

Subscribe diff depth event. If the book depth is updated, server will send the data to client and onReceive in callback will be called.

Parameters:

symbol - The symbol, like "btcusdt".

callback - The implementation is required. onReceive will be called if receive server's update.

errorHandler - The error handler will be called if subscription failed or error happen between client and Binance server.

subscribeUserDataEvent

void subscribeUserDataEvent(String listenKey,
                            SubscriptionListener<UserDataUpdateEvent> callback,
                            SubscriptionErrorHandler errorHandler)

Subscribe user data event. If the user data is updated, server will send the data to client and onReceive in callback will be called.

Parameters:

listenKey - The listenKey.

callback - The implementation is required. onReceive will be called if receive server's update.

errorHandler - The error handler will be called if subscription failed or error happen between client and Binance server.