Package org.knowm.xchange.binance

Interface BinanceFutures

All Known Subinterfaces:

BinanceFuturesAuthenticated

@Path("")
@Produces("application/json")
public interface BinanceFutures

Method Summary

Modifier and Type	Method	Description
List<BinanceAggTrades>	aggTrades(String symbol, Long fromId, Long startTime, Long endTime, Integer limit)	Get compressed, aggregate trades.
BinanceOrderbook	depth(String symbol, Integer limit)
BinanceExchangeInfo	exchangeInfo()	Current exchange trading rules and symbol information.
BinanceFundingRate	fundingRate(String symbol)
List<BinanceFundingRate>	fundingRates()
BinanceSystemStatus	systemStatus()	Fetch system status which is normal or system maintenance.
List<BinanceTicker24h>	ticker24h()	24 hour price change statistics for all symbols
BinanceTicker24h	ticker24h(String symbol)	24 hour price change statistics.

Method Details

exchangeInfo

@GET
@Path("/fapi/v1/exchangeInfo")
BinanceExchangeInfo exchangeInfo()
                          throws IOException

Current exchange trading rules and symbol information.

Returns:

Throws:

IOException

systemStatus

@GET
@Path("sapi/v1/system/status")
BinanceSystemStatus systemStatus()
                          throws IOException

Fetch system status which is normal or system maintenance.

Throws:

IOException

depth

@GET
@Path("fapi/v1/depth")
BinanceOrderbook depth(@QueryParam("symbol")
 String symbol,
 @QueryParam("limit")
 Integer limit)
                throws IOException,
BinanceException

Parameters:

symbol -

limit - optional, default 100 max 5000. Valid limits: [5, 10, 20, 50, 100, 500, 1000, 5000]

Returns:

Throws:

IOException

BinanceException

ticker24h

@GET
@Path("fapi/v1/ticker/24hr")
BinanceTicker24h ticker24h(@QueryParam("symbol")
 String symbol)
                    throws IOException,
BinanceException

24 hour price change statistics.

Parameters:

symbol -

Returns:

Throws:

IOException

BinanceException

ticker24h

@GET
@Path("fapi/v1/ticker/24hr")
List<BinanceTicker24h> ticker24h()
                          throws IOException,
BinanceException

24 hour price change statistics for all symbols

Returns:

Throws:

IOException

BinanceException

aggTrades

@GET
@Path("fapi/v1/aggTrades")
List<BinanceAggTrades> aggTrades(@QueryParam("symbol")
 String symbol,
 @QueryParam("fromId")
 Long fromId,
 @QueryParam("startTime")
 Long startTime,
 @QueryParam("endTime")
 Long endTime,
 @QueryParam("limit")
 Integer limit)
                          throws IOException,
BinanceException

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, limit should not be sent AND the distance between startTime and endTime must be less than 24 hours.
If frondId, startTime, and endTime are not sent, the most recent aggregate trades will be returned.

Parameters:

symbol -

fromId - optional, ID to get aggregate trades from INCLUSIVE.

startTime - optional, Timestamp in ms to get aggregate trades from INCLUSIVE.

endTime - optional, Timestamp in ms to get aggregate trades until INCLUSIVE.

limit - optional, Default 500; max 500.

Returns:

Throws:

IOException

BinanceException

fundingRates

@GET
@Path("fapi/v1/premiumIndex")
List<BinanceFundingRate> fundingRates()
                               throws IOException,
BinanceException

Returns:

List

Throws:

IOException

BinanceException

fundingRate

@GET
@Path("fapi/v1/premiumIndex")
BinanceFundingRate fundingRate(@QueryParam("symbol")
 String symbol)
                        throws IOException,
BinanceException

Parameters:

symbol - the instrument to get the funding rate for

Returns:

BinanceFundingRate

Throws:

IOException

BinanceException