Java Binance API

binance-java-api is a lightweight Java library for interacting with the Binance API, providing complete API coverage, and supporting synchronous and asynchronous requests, as well as event streaming using WebSockets.

Features

• Support for synchronous and asynchronous REST requests to all General, Market Data, Account endpoints, and User stream endpoints.
• Support for User Data, Trade, Kline, and Depth event streaming using Binance WebSocket API.

Installation

1. Install library into your Maven's local repository by running mvn install
2. Add the following Maven dependency to your project's pom.xml:

<dependency>
<groupId>com.binance.api</groupId>
<artifactId>binance-api-client</artifactId>
<version>1.0.0</version>
</dependency>

Alternatively, you can clone this repository and run the examples.

Examples

Getting Started

There are three main client classes that can be used to interact with the API:

1. BinanceApiRestClient, a synchronous/blocking Binance API client;
2. BinanceApiAsyncRestClient, an asynchronous/non-blocking Binance API client;
3. BinanceApiWebSocketClient, a data streaming client using Binance WebSocket API.

These can be instantiated through the corresponding factory method of BinanceApiClientFactory, by passing the security parametersAPI-KEY and SECRET, which can be created at https://www.binance.com/userCenter/createApi.html.

BinanceApiClientFactoryfactory = BinanceApiClientFactory.newInstance("API-KEY", "SECRET");
BinanceApiRestClientclient = factory.newRestClient();

If the client only needs to access endpoints which do not require additional security, then these parameters are optional.

Once the client is instantiated, it is possible to start making requests to the API.

General endpoints

Test connectivity

client.ping();

Check server time

longserverTime = client.getServerTime();
System.out.println(serverTime);

View Response

1508380346873

Market Data endpoints

Order book of a symbol

OrderBookorderBook = client.getOrderBook("NEOETH", 10);
List<OrderBookEntry> asks = orderBook.getAsks();
OrderBookEntryfirstAskEntry = asks.get(0);
System.out.println(firstAskEntry.getPrice() + " / " + firstAskEntry.getQty());

View Response

0.09200000 / 5.52000000

Compressed/Aggregate trades list of a symbol

List<AggTrade> aggTrades = client.getAggTrades("NEOETH");
System.out.println(aggTrades);

View Response

[AggTrade[aggregatedTradeId=30593,price=0.09880800,quantity=40.89000000,firstBreakdownTradeId=33363,lastBreakdownTradeId=33363,tradeTime=1508331041246,isBuyerMaker=true], ...]

Weekly candlestick bars for a symbol

List<Candlestick> candlesticks = client.getCandlestickBars("NEOETH", CandlestickInterval.WEEKLY);
System.out.println(candlesticks);

View Response

[Candlestick[openTime=1506297600000,open=0.09700000,high=0.12000100,low=0.05500000,close=0.11986900,volume=25709.37000000,closeTime=1506902399999,quoteAssetVolume=2649.80091051,numberOfTrades=2435,takerBuyBaseAssetVolume=10520.59000000,takerBuyQuoteAssetVolume=1101.94985388], ...] 

Latest price of a symbol

TickerStatisticstickerStatistics = client.get24HrPriceStatistics("NEOETH");
System.out.println(tickerStatistics.getLastPrice());

View Response

0.09100100

Getting all latests prices

List<TickerPrice> allPrices = client.getAllPrices();
System.out.println(allPrices);

View Response

[TickerPrice[symbol=ETHBTC,price=0.05590400], TickerPrice[symbol=LTCBTC,price=0.01073300], ...]

Account Data endpoints

Get account balances

Accountaccount = client.getAccount();
System.out.println(account.getBalances());
System.out.println(account.getAssetBalance("ETH").getFree());

View Response

AssetBalance[asset=ETH,free=0.10000000,locked=0.00000000]
0.10000000

Get list of trades for an account and a symbol

List<Trade> myTrades = client.getMyTrades("NEOETH");
System.out.println(myTrades);

View Response

[Trade[id=123,price=0.00000100,qty=1000.00000000,commission=0.00172100,commissionAsset=ETH,time=1507927870561,buyer=false,maker=false,bestMatch=true,symbol=<null>,orderId=11289], Trade[id=123,price=0.00001000,qty=3.00000000,commission=0.00000003,commissionAsset=ETH,time=1507927874215,buyer=false,maker=false,bestMatch=true,symbol=<null>,orderId=123]]

Get account open orders for a symbol

List<Order> openOrders = client.getOpenOrders(newOrderRequest("LINKETH"));
System.out.println(openOrders);

View Response

[Order[symbol=LINKETH,orderId=12345,clientOrderId=XYZ,price=0.00010000,origQty=1000.00000000,executedQty=0.00000000,status=NEW,timeInForce=GTC,type=LIMIT,side=BUY,stopPrice=0.00000000,icebergQty=0.00000000,time=1508382291552]]

Get order status

Orderorder = client.getOrderStatus(newOrderStatusRequest("LINKETH", 12345L));
System.out.println(order.getExecutedQty());

View Response

0.00000000

Placing a MARKET order

NewOrderResponsenewOrderResponse = client.newOrder(marketBuy("LINKETH", "1000").orderRespType(OrderResponseType.FULL));
List<Trade> fills = newOrderResponse.getFills();
System.out.println(newOrderResponse.getClientOrderId());

View Response

XXXXXfc2XXzTXXGs66ZcXX

Placing a LIMIT order

NewOrderResponsenewOrderResponse = client.newOrder(limitBuy("LINKETH", TimeInForce.GTC, "1000", "0.0001"));
System.out.println(newOrderResponse.getTransactTime());

View Response

1508382322725

Canceling an order

client.cancelOrder(newCancelOrderRequest("LINKETH", 123015L));

Withdraw

In order to be able to withdraw programatically, please enable the Enable Withdrawals option in the API settings.

client.withdraw("ETH", "0x123", "0.1", null);

Fetch withdraw history

WithdrawHistorywithdrawHistory = client.getWithdrawHistory("ETH");
System.out.println(withdrawHistory);

View Response

WithdrawHistory[withdrawList=[Withdraw[amount=0.1,address=0x123,asset=ETH,applyTime=2017-10-1320:59:38,successTime=2017-10-1321:20:09,txId=0x456,id=789]],success=true]

Fetch deposit history

DepositHistorydepositHistory = client.getDepositHistory("ETH");
System.out.println(depositHistory);

View Response

DepositHistory[depositList=[Deposit[amount=0.100000000000000000,asset=ETH,insertTime=2017-10-1813:03:39], Deposit[amount=1.000000000000000000,asset=NEO,insertTime=2017-10-1320:24:04]],success=true]

Get deposit address

DepositAddressdepositAddress = client.getDepositAddress("ETH");
System.out.println(depositAddress);

View Response

DepositAddress[address=0x99...,success=true,addressTag=,asset=ETH]

User stream endpoints

Start user data stream, keepalive, and close data stream

StringlistenKey = client.startUserDataStream();
client.keepAliveUserDataStream(listenKey);
client.closeUserDataStream(listenKey);

WebSocket API

Initialize the WebSocket client

BinanceApiWebSocketClientclient = BinanceApiClientFactory.newInstance().newWebSocketClient();

User needs to be aware that REST symbols which are upper case differ from WebSocket symbols which must be lower case. In scenario of subscription with upper case styled symbol, server will return no error and subscribe to given channel - however, no events will be pushed.

Handling web socket errors

Each of the methods on BinanceApiWebSocketClient, which opens a new web socket, takes a BinanceApiCallback, which is called for each event received from the Binance servers.

The BinanceApiCallback interface also has a onFailure(Throwable) method, which, optionally, can be implemented to receive notifications if the web-socket fails, e.g. disconnection.

client.onAggTradeEvent(symbol.toLowerCase(), newBinanceApiCallback<AggTradeEvent>() {
@OverridepublicvoidonResponse(finalAggTradeEventresponse) {
System.out.println(response);
}
@OverridepublicvoidonFailure(finalThrowablecause) {
System.err.println("Web socket failed");
cause.printStackTrace(System.err);
}
});

Closing web sockets

Each of the methods on BinanceApiWebSocketClient, which opens a new web socket, also returns a Closeable. This Closeable can be used to close the underlying web socket and free any associated resources, e.g.

Closablews = client.onAggTradeEvent("ethbtc", someCallback);
// some time later...ws.close();

Listen for aggregated trade events for ETH/BTC

client.onAggTradeEvent("ethbtc", (AggTradeEventresponse) -> {
System.out.println(response.getPrice());
System.out.println(response.getQuantity());
});

View Response

0.05583500 / 1.0640000015083833330690.05557200 / 2.0000000015083833450700.05583200 / 2.685000001508383352961
...

Listen for changes in the order book for ETH/BTC

client.onDepthEvent("ethbtc", (DepthEventresponse) -> {
System.out.println(response.getAsks());
});

View Response

[OrderBookEntry[price=0.05559500,qty=7.94200000], OrderBookEntry[price=0.05559800,qty=0.00000000]]
[OrderBookEntry[price=0.05558400,qty=30.61800000], OrderBookEntry[price=0.05559500,qty=0.00000000], OrderBookEntry[price=0.05560600,qty=8.32100000]]
[OrderBookEntry[price=0.05559100,qty=7.86600000], OrderBookEntry[price=0.05560600,qty=0.00000000], OrderBookEntry[price=0.05607700,qty=5.15500000], OrderBookEntry[price=0.05620700,qty=0.00000000], OrderBookEntry[price=0.05842200,qty=0.00000000]]
[OrderBookEntry[price=0.05558400,qty=29.61700000]]
...

Get 1m candlesticks in real-time for ETH/BTC

client.onCandlestickEvent("ethbtc", CandlestickInterval.ONE_MINUTE, response -> System.out.println(response));

View Response

CandlestickEvent[eventType=kline,eventTime=1508417055113,symbol=ETHBTC,openTime=1508417040000,open=0.05376300,high=0.05376300,low=0.05372900,close=0.05372900,volume=0.49400000,closeTime=1508417099999,intervalId=1m,firstTradeId=2199019,lastTradeId=2199020,quoteAssetVolume=0.02654552,numberOfTrades=2,takerBuyBaseAssetVolume=0.00000000,takerBuyQuoteAssetVolume=0.00000000,isBarFinal=false]
CandlestickEvent[eventType=kline,eventTime=1508417055145,symbol=ETHBTC,openTime=1508417040000,open=0.05376300,high=0.05376300,low=0.05371700,close=0.05371700,volume=0.62900000,closeTime=1508417099999,intervalId=1m,firstTradeId=2199019,lastTradeId=2199021,quoteAssetVolume=0.03379731,numberOfTrades=3,takerBuyBaseAssetVolume=0.00000000,takerBuyQuoteAssetVolume=0.00000000,isBarFinal=false]
CandlestickEvent[eventType=kline,eventTime=1508417096085,symbol=ETHBTC,openTime=1508417040000,open=0.05376300,high=0.05376300,low=0.05370900,close=0.05370900,volume=0.68000000,closeTime=1508417099999,intervalId=1m,firstTradeId=2199019,lastTradeId=2199022,quoteAssetVolume=0.03653646,numberOfTrades=4,takerBuyBaseAssetVolume=0.00000000,takerBuyQuoteAssetVolume=0.00000000,isBarFinal=false]
...

Keep a local depth cache for a symbol

Please see DepthCacheExample.java for an implementation which uses the binance-java-api for maintaining a local depth cache for a symbol. In the same folder, you can also find how to do caching of account balances, aggregated trades, and klines/candlesticks.

View Response

ASKS:
0.05690700 / 6.151000000.05447800 / 0.095000000.05447700 / 28.220000000.05439000 / 0.545000000.05438400 / 1.103000000.05436600 / 0.061000000.05434000 / 0.055000000.05432800 / 3.451000000.05422700 / 1.111000000.05410600 / 5.859000000.05409300 / 4.50000000BIDS:
0.05390000 / 2.260000000.05389000 / 15.000000000.05385600 / 1.950000000.05367900 / 0.100000000.05366700 / 2.276000000.05360000 / 10.961000000.05348500 / 14.040000000.05345000 / 0.561000000.05336200 / 21.100000000.05336100 / 21.150000000.05306600 / 0.211000000.05116300 / 10.95000000BESTASK: 0.05409300 / 4.50000000BESTBID: 0.05390000 / 2.26000000
...

Listen for changes in the account

client.onUserDataUpdateEvent(listenKey, response -> {
if (response.getEventType() == UserDataUpdateEventType.ACCOUNT_UPDATE) {
AccountUpdateEventaccountUpdateEvent = response.getAccountUpdateEvent();
// Print new balances of every available assetSystem.out.println(accountUpdateEvent.getBalances());
} else {
OrderTradeUpdateEventorderTradeUpdateEvent = response.getOrderTradeUpdateEvent();
// Print details about an order/tradeSystem.out.println(orderTradeUpdateEvent);
// Print original quantitySystem.out.println(orderTradeUpdateEvent.getOriginalQuantity());
// Or priceSystem.out.println(orderTradeUpdateEvent.getPrice());
}
});

Multi-channel subscription

Client provides a way for user to subscribe to multiple channels using same websocket - to achieve that user needs to coma-separate symbols as it is in following examples.

client.onAggTradeEvent("ethbtc,ethusdt", (AggTradeEventresponse) -> {
if (Objects.equals(response.getSymbol(),"ethbtc")) {
// handle ethbtc event
} elseif(Objects.equals(response.getSymbol()),"ethusdt")) {
// handle ethusdt event
}
});

client.onDepthEvent("ethbtc,ethusdt", (DepthEventresponse) -> {
if (Objects.equals(response.getSymbol(),"ethbtc")) {
// handle ethbtc event
} elseif(Objects.equals(response.getSymbol()),"ethusdt")) {
// handle ethusdt event
}
});

client.onCandlestickEvent("ethbtc,ethusdt", CandlestickInterval.ONE_MINUTE, (CandlestickEventresponse) -> {
if (Objects.equals(response.getSymbol(),"ethbtc")) {
// handle ethbtc event
} elseif(Objects.equals(response.getSymbol()),"ethusdt")) {
// handle ethusdt event
}
});

Asynchronous requests

To make an asynchronous request it is necessary to use the BinanceApiAsyncRestClient, and call the method with the same name as in the synchronous version, but passing a callback BinanceApiCallback that handles the response whenever it arrives.

Get latest price of a symbol asynchronously

client.get24HrPriceStatistics("NEOETH", (TickerStatisticsresponse) -> {
System.out.println(response.getLastPrice());
System.out.println(response.getVolume());
});

View Response

0.09100100

Placing a LIMIT order asynchronously

client.newOrder(limitBuy("LINKETH", TimeInForce.GTC, "1000", "0.0001"), (NewOrderResponseresponse) -> {
System.out.println(response.getTransactTime());
});

View Response

1508382322725

Exception handling

Every API method can potentially throw an unchecked BinanceApiException which wraps the error message returned from the Binance API, or an exception, in case the request never properly reached the server.

try {
client.getOrderBook("UNKNOWN", 10);
} catch (BinanceApiExceptione) {
System.out.println(e.getError().getCode()); // -1121System.out.println(e.getError().getMsg()); // Invalid symbol
}

View Response

-1121Invalidsymbol

More examples

An extensive set of examples, covering most aspects of the API, can be found at https://github.com/joaopsilva/binance-java-api/tree/master/src/test/java/com/binance/api/examples.