com.binance.client

Interface SyncRequestClient

All Known Implementing Classes:

SyncRequestImpl

public interface SyncRequestClient

Synchronous request interface, invoking Binance RestAPI via synchronous method.
All methods in this interface will be blocked until the RestAPI response.

If the invoking failed or timeout, the BinanceApiException will be thrown.

Method Summary

Modifier and Type	Method and Description
com.alibaba.fastjson.JSONObject	addIsolatedPositionMargin(String symbolName, int type, String amount, PositionSide positionSide) add isolated position margin
com.alibaba.fastjson.JSONObject	autoCancelAllOrders(String symbol, Long countdownTime) Cancel all open orders of the specified symbol at the end of the specified countdown.
List<Object>	batchCancelOrders(String symbol, String orderIdList, String origClientOrderIdList) Batch cancel orders.
ResponseResult	cancelAllOpenOrder(String symbol) Cancel all open orders.
Order	cancelOrder(String symbol, Long orderId, String origClientOrderId) Cancel an active order.
Leverage	changeInitialLeverage(String symbol, Integer leverage) Change initial leverage.
ResponseResult	changeMarginType(String symbolName, MarginType marginType) Change margin type (ISOLATED, CROSSED)
ResponseResult	changePositionSide(String dual) Switch position side.
String	closeUserDataStream(String listenKey) Close user data stream.
static SyncRequestClient	create() Create the synchronous client.
static SyncRequestClient	create(String apiKey, String secretKey) Create the synchronous client.
static SyncRequestClient	create(String apiKey, String secretKey, RequestOptions options) Create the synchronous client.
List<PriceChangeTicker>	get24hrTickerPriceChange(String symbol) Get 24 hour rolling window price change statistics.
AccountInformation	getAccountInformation() Get current account information.
List<MyTrade>	getAccountTrades(String symbol, Long startTime, Long endTime, Long fromId, Integer limit) Get trades for a specific account and symbol.
List<AggregateTrade>	getAggregateTrades(String symbol, Long fromId, Long startTime, Long endTime, Integer limit) Get compressed, aggregate trades.
List<Order>	getAllOrders(String symbol, Long orderId, Long startTime, Long endTime, Integer limit) Get all account orders; active, canceled, or filled.
List<AccountBalance>	getBalance() Get account balances.
List<Candlestick>	getCandlestick(String symbol, CandlestickInterval interval, Long startTime, Long endTime, Integer limit) Get kline/candlestick bars for a symbol.
List<Candlestick>	getContinuousCandlesticks(String pair, ContractType contractType, CandlestickInterval interval, Long startTime, Long endTime, Integer limit) Get Kline/candlestick bars for a specific contract type.
ExchangeInformation	getExchangeInformation() Fetch current exchange trading rules and symbol information.
List<FundingRate>	getFundingRate(String symbol, Long startTime, Long endTime, Integer limit) Get funding rate history.
List<CommonLongShortRatio>	getGlobalAccountRatio(String symbol, PeriodType period, Long startTime, Long endTime, Long limit) Long/Short Ratio (MARKET DATA)
List<Income>	getIncomeHistory(String symbol, IncomeType incomeType, Long startTime, Long endTime, Integer limit) Get income history.
List<Candlestick>	getIndexPriceCandlesticks(String pair, CandlestickInterval interval, Long startTime, Long endTime, Integer limit) Get Kline/candlestick bars for the index price of a pair.
List<LiquidationOrder>	getLiquidationOrders(String symbol, AutoCloseType type, Long startTime, Long endTime, Integer limit) Get all liquidation orders.
List<MarkPrice>	getMarkPrice(String symbol) Get mark price for a symbol.
List<Candlestick>	getMarkPriceCandlesticks(String pair, CandlestickInterval interval, Long startTime, Long endTime, Integer limit) Get Kline/candlestick bars for the mark price of a symbol.
List<Trade>	getOldTrades(String symbol, Integer limit, Long fromId) Get old Trade.
OpenInterest	getOpenInterest(String symbol) Get present open interest of a specific symbol.
List<OpenInterestStat>	getOpenInterestStat(String symbol, PeriodType period, Long startTime, Long endTime, Long limit) Open Interest Stat (MARKET DATA)
Order	getOpenOrder(String symbol, Long orderId, String origClientOrderId) Get all open order on a symbol.
List<Order>	getOpenOrders(String symbol) Get current open order on a symbol.
Order	getOrder(String symbol, Long orderId, String origClientOrderId) Check an order's status.
OrderBook	getOrderBook(String symbol, Integer limit) Fetch order book.
List<WalletDeltaLog>	getPositionMarginHistory(String symbolName, int type, long startTime, long endTime, int limit) get position margin history
List<PositionRisk>	getPositionRisk(String symbol) Get position.
com.alibaba.fastjson.JSONObject	getPositionSide() Get if changed to HEDGE mode.
List<Trade>	getRecentTrades(String symbol, Integer limit) Get recent trades.
List<SymbolOrderBook>	getSymbolOrderBookTicker(String symbol) Get best price/qty on the order book for a symbol or symbols.
List<SymbolPrice>	getSymbolPriceTicker(String symbol) Get latest price for a symbol or symbols.
List<TakerLongShortStat>	getTakerLongShortRatio(String symbol, PeriodType period, Long startTime, Long endTime, Long limit) Taker Long/Short Ratio (MARKET DATA)
List<CommonLongShortRatio>	getTopTraderAccountRatio(String symbol, PeriodType period, Long startTime, Long endTime, Long limit) Top Trader Long/Short Ratio (Accounts) (MARKET DATA)
List<CommonLongShortRatio>	getTopTraderPositionRatio(String symbol, PeriodType period, Long startTime, Long endTime, Long limit) Top Trader Long/Short Ratio (Positions) (MARKET DATA)
String	keepUserDataStream(String listenKey) Keep user data stream.
List<Object>	postBatchOrders(String batchOrders) Place new orders
Order	postOrder(String symbol, OrderSide side, PositionSide positionSide, OrderType orderType, TimeInForce timeInForce, String quantity, String price, String reduceOnly, String newClientOrderId, String stopPrice, String closePosition, String activationPrice, String callbackRate, WorkingType workingType, String priceProtect, NewOrderRespType newOrderRespType) Send in a new order.
String	startUserDataStream() Start user data stream.

Method Detail

create

static SyncRequestClient create()

Create the synchronous client. All interfaces defined in synchronous client are implemented by synchronous mode.

Returns:

The instance of synchronous client.

create

static SyncRequestClient create(String apiKey,
                                String secretKey)

Create the synchronous client. All interfaces defined in synchronous client are implemented by synchronous mode.

Parameters:

apiKey - The public key applied from binance.

secretKey - The private key applied from binance.

Returns:

The instance of synchronous client.

create

static SyncRequestClient create(String apiKey,
                                String secretKey,
                                RequestOptions options)

Create the synchronous client. All interfaces defined in synchronous client are implemented by synchronous mode.

Parameters:

apiKey - The public key applied from binance.

secretKey - The private key applied from binance.

options - The request option.

Returns:

The instance of synchronous client.

getExchangeInformation

ExchangeInformation getExchangeInformation()

Fetch current exchange trading rules and symbol information.

Returns:

Current exchange trading rules and symbol information.

getOrderBook

OrderBook getOrderBook(String symbol,
                       Integer limit)

Fetch order book.

Returns:

Order book.

getRecentTrades

List<Trade> getRecentTrades(String symbol,
                            Integer limit)

Get recent trades.

Returns:

Recent trades.

getOldTrades

List<Trade> getOldTrades(String symbol,
                         Integer limit,
                         Long fromId)

Get old Trade.

Returns:

Old trades.

getAggregateTrades

List<AggregateTrade> getAggregateTrades(String symbol,
                                        Long fromId,
                                        Long startTime,
                                        Long endTime,
                                        Integer limit)

Get compressed, aggregate trades.

Returns:

Aggregate trades.

getCandlestick

List<Candlestick> getCandlestick(String symbol,
                                 CandlestickInterval interval,
                                 Long startTime,
                                 Long endTime,
                                 Integer limit)

Get kline/candlestick bars for a symbol.

Returns:

Kline/candlestick bars for a symbol.

getContinuousCandlesticks

List<Candlestick> getContinuousCandlesticks(String pair,
                                            ContractType contractType,
                                            CandlestickInterval interval,
                                            Long startTime,
                                            Long endTime,
                                            Integer limit)

Get Kline/candlestick bars for a specific contract type.

Returns:

Kline/candlestick bars for a specific contract type.

getIndexPriceCandlesticks

List<Candlestick> getIndexPriceCandlesticks(String pair,
                                            CandlestickInterval interval,
                                            Long startTime,
                                            Long endTime,
                                            Integer limit)

Get Kline/candlestick bars for the index price of a pair.

Returns:

Kline/candlestick bars for the index price of a pair.

getMarkPriceCandlesticks

List<Candlestick> getMarkPriceCandlesticks(String pair,
                                           CandlestickInterval interval,
                                           Long startTime,
                                           Long endTime,
                                           Integer limit)

Get Kline/candlestick bars for the mark price of a symbol.

Returns:

Kline/candlestick bars for the mark price of a symbol.

getMarkPrice

List<MarkPrice> getMarkPrice(String symbol)

Get mark price for a symbol.

Returns:

Mark price for a symbol.

getFundingRate

List<FundingRate> getFundingRate(String symbol,
                                 Long startTime,
                                 Long endTime,
                                 Integer limit)

Get funding rate history.

Returns:

funding rate history.

get24hrTickerPriceChange

List<PriceChangeTicker> get24hrTickerPriceChange(String symbol)

Get 24 hour rolling window price change statistics.

Returns:

24 hour rolling window price change statistics.

getSymbolPriceTicker

List<SymbolPrice> getSymbolPriceTicker(String symbol)

Get latest price for a symbol or symbols.

Returns:

Latest price for a symbol or symbols.

getSymbolOrderBookTicker

List<SymbolOrderBook> getSymbolOrderBookTicker(String symbol)

Get best price/qty on the order book for a symbol or symbols.

Returns:

Best price/qty on the order book for a symbol or symbols.

getLiquidationOrders

List<LiquidationOrder> getLiquidationOrders(String symbol,
                                            AutoCloseType type,
                                            Long startTime,
                                            Long endTime,
                                            Integer limit)

Get all liquidation orders.

Returns:

All liquidation orders.

postBatchOrders

List<Object> postBatchOrders(String batchOrders)

Place new orders

Parameters:

batchOrders -

Returns:

postOrder

Order postOrder(String symbol,
                OrderSide side,
                PositionSide positionSide,
                OrderType orderType,
                TimeInForce timeInForce,
                String quantity,
                String price,
                String reduceOnly,
                String newClientOrderId,
                String stopPrice,
                String closePosition,
                String activationPrice,
                String callbackRate,
                WorkingType workingType,
                String priceProtect,
                NewOrderRespType newOrderRespType)

Send in a new order.

Returns:

Order.

cancelOrder

Order cancelOrder(String symbol,
                  Long orderId,
                  String origClientOrderId)

Cancel an active order.

Returns:

Order.

cancelAllOpenOrder

ResponseResult cancelAllOpenOrder(String symbol)

Cancel all open orders.

Returns:

ResponseResult.

batchCancelOrders

List<Object> batchCancelOrders(String symbol,
                               String orderIdList,
                               String origClientOrderIdList)

Batch cancel orders.

Returns:

Order.

changePositionSide

ResponseResult changePositionSide(String dual)

Switch position side. (true == dual, false == both)

Returns:

ResponseResult.

changeMarginType

ResponseResult changeMarginType(String symbolName,
                                MarginType marginType)

Change margin type (ISOLATED, CROSSED)

Parameters:

symbolName -

marginType -

Returns:

addIsolatedPositionMargin

com.alibaba.fastjson.JSONObject addIsolatedPositionMargin(String symbolName,
                                                          int type,
                                                          String amount,
                                                          PositionSide positionSide)

add isolated position margin

Parameters:

symbolName -

type -

amount -

positionSide - SHORT, LONG, BOTH

Returns:

getPositionMarginHistory

List<WalletDeltaLog> getPositionMarginHistory(String symbolName,
                                              int type,
                                              long startTime,
                                              long endTime,
                                              int limit)

get position margin history

Parameters:

symbolName -

type -

startTime -

endTime -

limit -

Returns:

getPositionSide

com.alibaba.fastjson.JSONObject getPositionSide()

Get if changed to HEDGE mode. (true == hedge mode, false == one-way mode)

Returns:

ResponseResult.

getOrder

Order getOrder(String symbol,
               Long orderId,
               String origClientOrderId)

Check an order's status.

Returns:

Order status.

getOpenOrder

Order getOpenOrder(String symbol,
                   Long orderId,
                   String origClientOrderId)

Get all open order on a symbol.

Returns:

Open order.

getOpenOrders

List<Order> getOpenOrders(String symbol)

Get current open order on a symbol. Careful when accessing this with no symbol.

Returns:

Open orders.

getAllOrders

List<Order> getAllOrders(String symbol,
                         Long orderId,
                         Long startTime,
                         Long endTime,
                         Integer limit)

Get all account orders; active, canceled, or filled.

Returns:

All orders.

getBalance

List<AccountBalance> getBalance()

Get account balances.

Returns:

Balances.

getAccountInformation

AccountInformation getAccountInformation()

Get current account information.

Returns:

Current account information.

changeInitialLeverage

Leverage changeInitialLeverage(String symbol,
                               Integer leverage)

Change initial leverage.

Returns:

Leverage.

getPositionRisk

List<PositionRisk> getPositionRisk(String symbol)

Get position.

Returns:

Position.

getAccountTrades

List<MyTrade> getAccountTrades(String symbol,
                               Long startTime,
                               Long endTime,
                               Long fromId,
                               Integer limit)

Get trades for a specific account and symbol.

Returns:

Trades.

getIncomeHistory

List<Income> getIncomeHistory(String symbol,
                              IncomeType incomeType,
                              Long startTime,
                              Long endTime,
                              Integer limit)

Get income history.

Returns:

Income history.

startUserDataStream

String startUserDataStream()

Start user data stream.

Returns:

listenKey.

keepUserDataStream

String keepUserDataStream(String listenKey)

Keep user data stream.

Returns:

null.

closeUserDataStream

String closeUserDataStream(String listenKey)

Close user data stream.

Returns:

null.

getOpenInterest

OpenInterest getOpenInterest(String symbol)

Get present open interest of a specific symbol.

Returns:

open interest of a specific symbol.

getOpenInterestStat

List<OpenInterestStat> getOpenInterestStat(String symbol,
                                           PeriodType period,
                                           Long startTime,
                                           Long endTime,
                                           Long limit)

Open Interest Stat (MARKET DATA)

Returns:

Open Interest Stat.

getTopTraderAccountRatio

List<CommonLongShortRatio> getTopTraderAccountRatio(String symbol,
                                                    PeriodType period,
                                                    Long startTime,
                                                    Long endTime,
                                                    Long limit)

Top Trader Long/Short Ratio (Accounts) (MARKET DATA)

Returns:

Top Trader Long/Short Ratio (Accounts).

getTopTraderPositionRatio

List<CommonLongShortRatio> getTopTraderPositionRatio(String symbol,
                                                     PeriodType period,
                                                     Long startTime,
                                                     Long endTime,
                                                     Long limit)

Top Trader Long/Short Ratio (Positions) (MARKET DATA)

Returns:

Top Trader Long/Short Ratio (Positions).

getGlobalAccountRatio

List<CommonLongShortRatio> getGlobalAccountRatio(String symbol,
                                                 PeriodType period,
                                                 Long startTime,
                                                 Long endTime,
                                                 Long limit)

Long/Short Ratio (MARKET DATA)

Returns:

global Long/Short Ratio.

getTakerLongShortRatio

List<TakerLongShortStat> getTakerLongShortRatio(String symbol,
                                                PeriodType period,
                                                Long startTime,
                                                Long endTime,
                                                Long limit)

Taker Long/Short Ratio (MARKET DATA)

Returns:

Taker Long/Short Ratio.

autoCancelAllOrders

com.alibaba.fastjson.JSONObject autoCancelAllOrders(String symbol,
                                                    Long countdownTime)

Cancel all open orders of the specified symbol at the end of the specified countdown.

Returns:

Ack.