Package org.knowm.xchange.kucoin

Class KucoinMarketDataService

java.lang.Object

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

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

org.knowm.xchange.kucoin.KucoinBaseService

org.knowm.xchange.kucoin.KucoinMarketDataServiceRaw

org.knowm.xchange.kucoin.KucoinMarketDataService

All Implemented Interfaces:

BaseService, MarketDataService

public class KucoinMarketDataService
extends KucoinMarketDataServiceRaw
implements MarketDataService

Field Summary

Fields

Modifier and Type	Field	Description
static String	PARAM_FULL_ORDERBOOK	Set on calls to getOrderBook(CurrencyPair, Object...) to return the full orderbook rather than the default 100 prices either side.
static String	PARAM_PARTIAL_SHALLOW_ORDERBOOK	Set on calls to getOrderBook(CurrencyPair, Object...) to return the shallow partial orderbook depth of 20.

Fields inherited from class org.knowm.xchange.kucoin.KucoinBaseService

accountApi, apiKey, depositAPI, digest, fillApi, histOrdersApi, historyApi, limitOrderAPI, nonceFactory, orderApi, orderBookApi, passphrase, symbolApi, tradingFeeAPI, websocketAPI, withdrawalAPI

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

resilienceRegistries

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

exchange

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	KucoinMarketDataService(KucoinExchange exchange, ResilienceRegistries resilienceRegistries)

Method Summary

Modifier and Type	Method	Description
OrderBook	getOrderBook(CurrencyPair currencyPair, Object... args)	Get an order book representing the current offered exchange rates (market depth)
Ticker	getTicker(CurrencyPair currencyPair, Object... args)	Get a ticker representing the current exchange rate
List<Ticker>	getTickers(Params params)	Get the tickers representing the current exchange rate for the provided parameters
Trades	getTrades(CurrencyPair currencyPair, Object... args)	Get the trades recently performed by the exchange

Methods inherited from class org.knowm.xchange.kucoin.KucoinMarketDataServiceRaw

getKucoin24hrStats, getKucoinBaseFee, getKucoinCurrencies, getKucoinKlines, getKucoinOrderBookFull, getKucoinOrderBookPartial, getKucoinOrderBookPartialShallow, getKucoinPrices, getKucoinSymbols, getKucoinTicker, getKucoinTickers, getKucoinTradeFee, getKucoinTrades

Methods inherited from class org.knowm.xchange.kucoin.KucoinBaseService

checkAuthenticated

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

getCandleStickData, getFundingRate, getFundingRates, getOrderBook, getOrderBook, getTicker, getTrades, getTrades

Field Details

PARAM_FULL_ORDERBOOK

public static final String PARAM_FULL_ORDERBOOK

Set on calls to getOrderBook(CurrencyPair, Object...) to return the full orderbook rather than the default 100 prices either side.

See Also:

Constant Field Values

PARAM_PARTIAL_SHALLOW_ORDERBOOK

public static final String PARAM_PARTIAL_SHALLOW_ORDERBOOK

Set on calls to getOrderBook(CurrencyPair, Object...) to return the shallow partial orderbook depth of 20.

See Also:

Constant Field Values

Constructor Details

KucoinMarketDataService

protected KucoinMarketDataService(KucoinExchange exchange,
ResilienceRegistries resilienceRegistries)

Method Details

getTicker

public Ticker getTicker(CurrencyPair currencyPair,
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

getTickers

public List<Ticker> getTickers(Params params)
                        throws IOException

Description copied from interface: MarketDataService

Get the tickers representing the current exchange rate for the provided parameters

Specified by:

getTickers in interface MarketDataService

Returns:

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

Throws:

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

getOrderBook

public OrderBook getOrderBook(CurrencyPair currencyPair,
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

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(CurrencyPair currencyPair,
Object... args)
                 throws IOException

Description copied from interface: MarketDataService

Get the trades recently performed by the exchange

Specified by:

getTrades in interface MarketDataService

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