net.sealake.binance.api.client.BinanceApiRestClient Maven / Gradle / Ivy
The newest version!
package net.sealake.binance.api.client;
import net.sealake.binance.api.client.domain.account.Account;
import net.sealake.binance.api.client.domain.account.DepositAddress;
import net.sealake.binance.api.client.domain.account.DepositHistory;
import net.sealake.binance.api.client.domain.account.NewOrder;
import net.sealake.binance.api.client.domain.account.NewOrderResponse;
import net.sealake.binance.api.client.domain.account.Order;
import net.sealake.binance.api.client.domain.account.Trade;
import net.sealake.binance.api.client.domain.account.TradeHistoryItem;
import net.sealake.binance.api.client.domain.account.WithdrawHistory;
import net.sealake.binance.api.client.domain.account.WithdrawResult;
import net.sealake.binance.api.client.domain.account.request.AllOrdersRequest;
import net.sealake.binance.api.client.domain.account.request.CancelOrderRequest;
import net.sealake.binance.api.client.domain.account.request.OrderRequest;
import net.sealake.binance.api.client.domain.account.request.OrderStatusRequest;
import net.sealake.binance.api.client.domain.general.Asset;
import net.sealake.binance.api.client.domain.general.ExchangeInfo;
import net.sealake.binance.api.client.domain.market.AggTrade;
import net.sealake.binance.api.client.domain.market.BookTicker;
import net.sealake.binance.api.client.domain.market.Candlestick;
import net.sealake.binance.api.client.domain.market.CandlestickInterval;
import net.sealake.binance.api.client.domain.market.OrderBook;
import net.sealake.binance.api.client.domain.market.TickerPrice;
import net.sealake.binance.api.client.domain.market.TickerStatistics;
import java.util.List;
/**
* Binance API façade, supporting synchronous/blocking access Binance's REST API.
*/
public interface BinanceApiRestClient {
// General endpoints
/**
* Test connectivity to the Rest API.
*/
void ping();
/**
* Test connectivity to the Rest API and get the current server time.
*
* @return current server time.
*/
Long getServerTime();
/**
* @return Current exchange trading rules and symbol information
*/
ExchangeInfo getExchangeInfo();
/**
* @return All the supported assets and whether or not they can be withdrawn.
*/
List getAllAssets();
// Market Data endpoints
/**
* Get order book of a symbol.
*
* @param symbol ticker symbol (e.g. ETHBTC)
* @param limit depth of the order book (max 100)
*/
OrderBook getOrderBook(String symbol, Integer limit);
/**
* Get recent trades (up to last 500). Weight: 1
*
* @param symbol ticker symbol (e.g. ETHBTC)
* @param limit of last trades (Default 500; max 500.)
*/
List getTrades(String symbol, Integer limit);
/**
* Get older trades. Weight: 5
*
* @param symbol ticker symbol (e.g. ETHBTC)
* @param limit of last trades (Default 500; max 500.)
* @param fromId TradeId to fetch from. Default gets most recent trades.
*/
List getHistoricalTrades(String symbol, Integer limit, Long fromId);
/**
* Get compressed, aggregate trades. Trades that fill at the time, from the same order, with
* the same price will have the quantity aggregated.
*
* If both startTime and endTime are sent, limitshould not
* be sent AND the distance between startTime and endTime must be less than 24 hours.
*
* @param symbol symbol to aggregate (mandatory)
* @param fromId ID to get aggregate trades from INCLUSIVE (optional)
* @param limit Default 500; max 500 (optional)
* @param startTime Timestamp in ms to get aggregate trades from INCLUSIVE (optional).
* @param endTime Timestamp in ms to get aggregate trades until INCLUSIVE (optional).
* @return a list of aggregate trades for the given symbol
*/
List getAggTrades(String symbol, String fromId, Integer limit, Long startTime, Long endTime);
/**
* Return the most recent aggregate trades for symbol
*
* @see #getAggTrades(String, String, Integer, Long, Long)
*/
List getAggTrades(String symbol);
/**
* Kline/candlestick bars for a symbol. Klines are uniquely identified by their open time.
*
* @param symbol symbol to aggregate (mandatory)
* @param interval candlestick interval (mandatory)
* @param limit Default 500; max 500 (optional)
* @param startTime Timestamp in ms to get candlestick bars from INCLUSIVE (optional).
* @param endTime Timestamp in ms to get candlestick bars until INCLUSIVE (optional).
* @return a candlestick bar for the given symbol and interval
*/
List getCandlestickBars(String symbol, CandlestickInterval interval, Integer limit, Long startTime, Long endTime);
/**
* Kline/candlestick bars for a symbol. Klines are uniquely identified by their open time.
*
* @see #getCandlestickBars(String, CandlestickInterval, Integer, Long, Long)
*/
List getCandlestickBars(String symbol, CandlestickInterval interval);
/**
* Get 24 hour price change statistics.
*
* @param symbol ticker symbol (e.g. ETHBTC)
*/
TickerStatistics get24HrPriceStatistics(String symbol);
/**
* Get 24 hour price change statistics for all symbols.
*/
List getAll24HrPriceStatistics();
/**
* Get Latest price for all symbols.
*/
List getAllPrices();
/**
* Get latest price for symbol.
*
* @param symbol ticker symbol (e.g. ETHBTC)
*/
TickerPrice getPrice(String symbol);
/**
* Get best price/qty on the order book for all symbols.
*/
List getBookTickers();
// Account endpoints
/**
* Send in a new order.
*
* @param order the new order to submit.
* @return a response containing details about the newly placed order.
*/
NewOrderResponse newOrder(NewOrder order);
/**
* Test new order creation and signature/recvWindow long. Creates and validates a new order but does not send it into the matching engine.
*
* @param order the new TEST order to submit.
*/
void newOrderTest(NewOrder order);
/**
* Check an order's status.
* @param orderStatusRequest order status request options/filters
*
* @return an order
*/
Order getOrderStatus(OrderStatusRequest orderStatusRequest);
/**
* Cancel an active order.
*
* @param cancelOrderRequest order status request parameters
*/
void cancelOrder(CancelOrderRequest cancelOrderRequest);
/**
* Get all open orders on a symbol.
*
* @param orderRequest order request parameters
* @return a list of all account open orders on a symbol.
*/
List getOpenOrders(OrderRequest orderRequest);
/**
* Get all account orders; active, canceled, or filled.
*
* @param orderRequest order request parameters
* @return a list of all account orders
*/
List getAllOrders(AllOrdersRequest orderRequest);
/**
* Get current account information.
*/
Account getAccount(Long recvWindow, Long timestamp);
/**
* Get current account information using default parameters.
*/
Account getAccount();
/**
* Get trades for a specific account and symbol.
*
* @param symbol symbol to get trades from
* @param limit default 500; max 500
* @param fromId TradeId to fetch from. Default gets most recent trades.
* @return a list of trades
*/
List getMyTrades(String symbol, Integer limit, Long fromId, Long recvWindow, Long timestamp);
/**
* Get trades for a specific account and symbol.
*
* @param symbol symbol to get trades from
* @param limit default 500; max 500
* @return a list of trades
*/
List getMyTrades(String symbol, Integer limit);
/**
* Get trades for a specific account and symbol.
*
* @param symbol symbol to get trades from
* @return a list of trades
*/
List getMyTrades(String symbol);
/**
* Submit a withdraw request.
*
* Enable Withdrawals option has to be active in the API settings.
*
* @param asset asset symbol to withdraw
* @param address address to withdraw to
* @param amount amount to withdraw
* @param name description/alias of the address
* @param addressTag Secondary address identifier for coins like XRP,XMR etc.
*/
WithdrawResult withdraw(String asset, String address, String amount, String name, String addressTag);
/**
* Fetch account deposit history.
*
* @return deposit history, containing a list of deposits
*/
DepositHistory getDepositHistory(String asset);
/**
* Fetch account withdraw history.
*
* @return withdraw history, containing a list of withdrawals
*/
WithdrawHistory getWithdrawHistory(String asset);
/**
* Fetch deposit address.
*
* @return deposit address for a given asset.
*/
DepositAddress getDepositAddress(String asset);
// User stream endpoints
/**
* Start a new user data stream.
*
* @return a listen key that can be used with data streams
*/
String startUserDataStream();
/**
* PING a user data stream to prevent a time out.
*
* @param listenKey listen key that identifies a data stream
*/
void keepAliveUserDataStream(String listenKey);
/**
* Close out a new user data stream.
*
* @param listenKey listen key that identifies a data stream
*/
void closeUserDataStream(String listenKey);
}