Package org.knowm.xchange.bitmex

Interface Bitmex

All Known Subinterfaces:

BitmexAuthenticated

@Path("api/v1")
@Produces("application/json")
public interface Bitmex

Method Summary

Modifier and Type	Method	Description
BitmexTickerList	getActiveTickers()
BitmexKlineList	getBucketedTrades(String binSize, Boolean partial, String symbol, Long count, Boolean reverse)
BitmexPublicOrderList	getDepth(String currencyPair, Double depth)
BitmexFundingList	getFundingHistory(String symbol, String filter, String columns, Integer count, Long start, Boolean reverse, Date startTime, Date endTime)
BitmexSymbolsAndPromptsResult	getPromptsAndSymbols()
BitmexTickerList	getTicker(String symbol)
BitmexTickerList	getTickers(Integer count, Long start, Boolean reverse)
BitmexPublicTradeList	getTrades(String currencyPair, Boolean reverse, Integer count, Long start)

Method Details

getTrades

@GET
@Path("trade")
BitmexPublicTradeList getTrades(@QueryParam("symbol")
 String currencyPair,
 @QueryParam("reverse")
 Boolean reverse,
 @Nullable @QueryParam("count")
 Integer count,
 @Nullable @QueryParam("start")
 Long start)
                         throws IOException,
BitmexException

Throws:

IOException

BitmexException

getBucketedTrades

@GET
@Path("trade/bucketed")
BitmexKlineList getBucketedTrades(@QueryParam("binSize")
 String binSize,
 @QueryParam("partial")
 Boolean partial,
 @QueryParam("symbol")
 String symbol,
 @QueryParam("count")
 Long count,
 @QueryParam("reverse")
 Boolean reverse)
                           throws IOException,
BitmexException

Throws:

IOException

BitmexException

getDepth

@GET
@Path("orderBook/L2")
BitmexPublicOrderList getDepth(@QueryParam("symbol")
 String currencyPair,
 @QueryParam("depth")
 Double depth)
                        throws IOException,
BitmexException

Throws:

IOException

BitmexException

getTickers

@GET
@Path("instrument")
BitmexTickerList getTickers(@Nullable @QueryParam("count")
 Integer count,
 @Nullable @QueryParam("start")
 Long start,
 @Nullable @QueryParam("reverse")
 Boolean reverse)
                     throws IOException,
BitmexException

Throws:

IOException

BitmexException

getTicker

@GET
@Path("instrument")
BitmexTickerList getTicker(@QueryParam("symbol")
 String symbol)
                    throws IOException,
BitmexException

Throws:

IOException

BitmexException

getActiveTickers

@GET
@Path("instrument/active")
BitmexTickerList getActiveTickers()
                           throws IOException,
BitmexException

Throws:

IOException

BitmexException

getPromptsAndSymbols

@GET
@Path("instrument/activeIntervals")
BitmexSymbolsAndPromptsResult getPromptsAndSymbols()
                                            throws IOException,
BitmexException

Throws:

IOException

BitmexException

getFundingHistory

@GET
@Path("funding")
BitmexFundingList getFundingHistory(@Nullable @QueryParam("symbol")
 String symbol,
 @Nullable @QueryParam("filter")
 String filter,
 @Nullable @QueryParam("columns")
 String columns,
 @Nullable @QueryParam("count")
 Integer count,
 @Nullable @QueryParam("start")
 Long start,
 @Nullable @QueryParam("reverse")
 Boolean reverse,
 @Nullable @QueryParam("startTime")
 Date startTime,
 @Nullable @QueryParam("endTime")
 Date endTime)
                             throws IOException,
BitmexException

Throws:

IOException

BitmexException