Package org.knowm.xchange.okex

Interface Okex

All Known Subinterfaces:

OkexAuthenticated

@Path("/api/v5")
@Produces("application/json")
public interface Okex

Field Summary

Fields

Modifier and Type	Field	Description
static String	instrumentsPath
static Map<String,List<Integer>>	publicPathRateLimits

Method Summary

Modifier and Type	Method	Description
OkexResponse<List<OkexFundingRate>>	getFundingRate(String instrument, String simulatedTrading)
OkexResponse<List<OkexCandleStick>>	getHistoryCandles(String instrument, String after, String before, String bar, String limit, String simulatedTrading)
OkexResponse<List<OkexInstrument>>	getInstruments(String instrumentType, String underlying, String instrumentId, String simulatedTrading)
OkexResponse<List<OkexOrderbook>>	getOrderbook(String instrument, int depth, String simulatedTrading)
OkexResponse<List<OkexTicker>>	getTicker(String instrument, String simulatedTrading)
OkexResponse<List<OkexTrade>>	getTrades(String instrument, int limit, String simulatedTrading)

Field Details

instrumentsPath

static final String instrumentsPath

See Also:

Constant Field Values

publicPathRateLimits

static final Map<String,List<Integer>> publicPathRateLimits

Method Details

getInstruments

@GET
@Path("/public/instruments")
OkexResponse<List<OkexInstrument>> getInstruments(@QueryParam("instType")
String instrumentType,
@QueryParam("uly")
String underlying,
@QueryParam("instId")
String instrumentId,
@HeaderParam("X-SIMULATED-TRADING")
String simulatedTrading)
                                           throws OkexException,
IOException

Throws:

OkexException

IOException

getTrades

@GET
@Path("/market/trades")
@Consumes("application/json")
OkexResponse<List<OkexTrade>> getTrades(@QueryParam("instId")
String instrument,
@QueryParam("limit")
int limit,
@HeaderParam("X-SIMULATED-TRADING")
String simulatedTrading)
                                 throws IOException,
OkexException

Throws:

IOException

OkexException

getTicker

@GET
@Path("/market/ticker")
@Consumes("application/json")
OkexResponse<List<OkexTicker>> getTicker(@QueryParam("instId")
String instrument,
@HeaderParam("X-SIMULATED-TRADING")
String simulatedTrading)
                                  throws IOException,
OkexException

Throws:

IOException

OkexException

getOrderbook

@GET
@Path("/market/books")
OkexResponse<List<OkexOrderbook>> getOrderbook(@QueryParam("instId")
String instrument,
@QueryParam("sz")
int depth,
@HeaderParam("X-SIMULATED-TRADING")
String simulatedTrading)
                                        throws IOException,
OkexException

Throws:

IOException

OkexException

getHistoryCandles

@GET
@Path("/market/history-candles")
OkexResponse<List<OkexCandleStick>> getHistoryCandles(@QueryParam("instId")
String instrument,
@QueryParam("after")
String after,
@QueryParam("before")
String before,
@QueryParam("bar")
String bar,
@QueryParam("limit")
String limit,
@HeaderParam("X-SIMULATED-TRADING")
String simulatedTrading)
                                               throws IOException,
OkexException

Throws:

IOException

OkexException

getFundingRate

@GET
@Path("/public/funding-rate")
OkexResponse<List<OkexFundingRate>> getFundingRate(@QueryParam("instId")
String instrument,
@HeaderParam("X-SIMULATED-TRADING")
String simulatedTrading)
                                            throws IOException,
OkexException

Throws:

IOException

OkexException