Package org.knowm.xchange.okex.service

Class OkexMarketDataService

java.lang.Object

org.knowm.xchange.service.BaseExchangeService<E>

org.knowm.xchange.service.BaseResilientExchangeService<OkexExchange>

org.knowm.xchange.okex.service.OkexBaseService

org.knowm.xchange.okex.service.OkexMarketDataServiceRaw

org.knowm.xchange.okex.service.OkexMarketDataService

All Implemented Interfaces:

BaseService, MarketDataService

public class OkexMarketDataService
extends OkexMarketDataServiceRaw
implements MarketDataService

Author: Max Gao (gaamox@tutanota.com) Created: 08-06-2021

Field Summary

Fields inherited from class org.knowm.xchange.okex.service.OkexBaseService

apiKey, okex, okexAuthenticated, passphrase, signatureCreator

Fields inherited from class org.knowm.xchange.service.BaseResilientExchangeService

resilienceRegistries

Fields inherited from class org.knowm.xchange.service.BaseExchangeService

exchange

Constructor Summary

Constructors

Constructor	Description
OkexMarketDataService(OkexExchange exchange, ResilienceRegistries resilienceRegistries)

Method Summary

Modifier and Type	Method	Description
CandleStickData	getCandleStickData(CurrencyPair currencyPair, CandleStickDataParams params)	Get the CandleStickData for given currency between startDate to endDate.
FundingRate	getFundingRate(Instrument instrument)	Get the FundingRate for specific instrument.
OrderBook	getOrderBook(Instrument instrument, Object... args)	Get an order book representing the current offered exchange rates (market depth)
Ticker	getTicker(Instrument instrument, Object... args)	Get a ticker representing the current exchange rate
Trades	getTrades(Instrument instrument, Object... args)	Get the trades recently performed by the exchange

Methods inherited from class org.knowm.xchange.okex.service.OkexMarketDataServiceRaw

getHistoryCandle, getOkexCurrencies, getOkexFundingRate, getOkexInstruments, getOkexOrderbook, getOkexTicker, getOkexTrades

Methods inherited from class org.knowm.xchange.okex.service.OkexBaseService

handleError

Methods inherited from class org.knowm.xchange.service.BaseResilientExchangeService

decorateApiCall, rateLimiter, rateLimiter, retry, retry

Methods inherited from class org.knowm.xchange.service.BaseExchangeService

verifyOrder, verifyOrder, verifyOrder

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.knowm.xchange.service.marketdata.MarketDataService

getFundingRates, getOrderBook, getOrderBook, getTicker, getTickers, getTrades, getTrades

Constructor Details

OkexMarketDataService

public OkexMarketDataService(OkexExchange exchange,
 ResilienceRegistries resilienceRegistries)

Method Details

getOrderBook

public OrderBook getOrderBook(Instrument instrument,
 Object... args)
                       throws IOException

Description copied from interface: MarketDataService

Get an order book representing the current offered exchange rates (market depth)

Specified by:

getOrderBook in interface MarketDataService

Parameters:

args - Optional arguments. Exchange-specific

Returns:

The OrderBook, null if some sort of error occurred. Implementers should log the error.

Throws:

IOException - - Indication that a networking error occurred while fetching JSON data

getTrades

public Trades getTrades(Instrument instrument,
 Object... args)
                 throws IOException

Description copied from interface: MarketDataService

Get the trades recently performed by the exchange

Specified by:

getTrades in interface MarketDataService

Parameters:

args - Optional arguments. Exchange-specific

Returns:

The Trades, null if some sort of error occurred. Implementers should log the error.

Throws:

IOException - - Indication that a networking error occurred while fetching JSON data

getTicker

public Ticker getTicker(Instrument instrument,
 Object... args)
                 throws IOException

Description copied from interface: MarketDataService

Get a ticker representing the current exchange rate

Specified by:

getTicker in interface MarketDataService

Returns:

The Ticker, null if some sort of error occurred. Implementers should log the error.

Throws:

IOException - - Indication that a networking error occurred while fetching JSON data

getCandleStickData

public CandleStickData getCandleStickData(CurrencyPair currencyPair,
 CandleStickDataParams params)
                                   throws IOException

Description copied from interface: MarketDataService

Get the CandleStickData for given currency between startDate to endDate.

Specified by:

getCandleStickData in interface MarketDataService

Parameters:

currencyPair - currencyPair.

params - Params for query, including start(e.g. march 2022.) and end date, period etc.,

Returns:

The CandleStickData, null if some sort of error occurred. Implementers should log the error.

Throws:

IOException - - Indication that a networking error occurred while fetching JSON data

getFundingRate

public FundingRate getFundingRate(Instrument instrument)
                           throws IOException

Description copied from interface: MarketDataService

Get the FundingRate for specific instrument.

Specified by:

getFundingRate in interface MarketDataService

Parameters:

instrument - Instrument to get the funding rate.

Returns:

The FundingRate, null if some sort of error occurred. Implementers should log the error.

Throws:

IOException - - Indication that a networking error occurred while fetching JSON data