Package org.knowm.xchange.okex
Interface Okex
- All Known Subinterfaces:
OkexAuthenticated
@Path("/api/v5")
@Produces("application/json")
public interface Okex
-
Field Summary
Fields -
Method Summary
Modifier and TypeMethodDescriptiongetFundingRate
(String instrument, String simulatedTrading) getHistoryCandles
(String instrument, String after, String before, String bar, String limit, String simulatedTrading) getInstruments
(String instrumentType, String underlying, String instrumentId, String simulatedTrading) getOrderbook
(String instrument, int depth, String simulatedTrading) getTickers
(String instType, String simulatedTrading)
-
Field Details
-
instrumentsPath
- See Also:
-
tickerPath
- See Also:
-
tickersPath
- See Also:
-
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
-
getTickers
@GET @Path("/market/tickers") @Consumes("application/json") OkexResponse<List<OkexTicker>> getTickers(@QueryParam("instType") String instType, @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
-