Package info.bitrich.xchangestream.coincheck

Class CoincheckStreamingMarketDataService

java.lang.Object

info.bitrich.xchangestream.coincheck.CoincheckStreamingMarketDataService

All Implemented Interfaces:

StreamingMarketDataService

public class CoincheckStreamingMarketDataService
extends Object
implements StreamingMarketDataService

Constructor Summary

Constructors

Constructor	Description
CoincheckStreamingMarketDataService()

Method Summary

Modifier and Type	Method	Description
io.reactivex.rxjava3.core.Observable<OrderBook>	getOrderBook(CurrencyPair currencyPair, Object... args)	Get an order book representing the current offered exchange rates (market depth).
io.reactivex.rxjava3.core.Observable<Ticker>	getTicker(CurrencyPair currencyPair, Object... args)	Get a ticker representing the current exchange rate.
io.reactivex.rxjava3.core.Observable<Trade>	getTrades(CurrencyPair currencyPair, Object... args)	Get the trades performed by the exchange.

Methods inherited from class java.lang.Object

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

Methods inherited from interface info.bitrich.xchangestream.core.StreamingMarketDataService

getFundingRate, getFundingRates, getOrderBook, getOrderBookUpdates, getTicker, getTrades

Constructor Details

CoincheckStreamingMarketDataService

public CoincheckStreamingMarketDataService()

Method Details

getOrderBook

public io.reactivex.rxjava3.core.Observable<OrderBook> getOrderBook(CurrencyPair currencyPair,
 Object... args)

Description copied from interface: StreamingMarketDataService

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

Warning: The library will attempt to keep the snapshots returned in sync with the exchange using the approaches published by that exchange. However, there are currently no guarantees that messages will not be skipped, or that any initial state message will be sent on connection. Emits NotConnectedException when not connected to the WebSocket API.

Specified by:

getOrderBook in interface StreamingMarketDataService

Parameters:

currencyPair - Currency pair of the order book

Returns:

Observable that emits OrderBook when exchange sends the update.

getTicker

public io.reactivex.rxjava3.core.Observable<Ticker> getTicker(CurrencyPair currencyPair,
 Object... args)

Description copied from interface: StreamingMarketDataService

Get a ticker representing the current exchange rate. Emits NotConnectedException When not connected to the WebSocket API.

Warning: There are currently no guarantees that messages will not be skipped, or that any initial state message will be sent on connection.

Specified by:

getTicker in interface StreamingMarketDataService

Parameters:

currencyPair - Currency pair of the ticker

Returns:

Observable that emits Ticker when exchange sends the update.

getTrades

public io.reactivex.rxjava3.core.Observable<Trade> getTrades(CurrencyPair currencyPair,
 Object... args)

Description copied from interface: StreamingMarketDataService

Get the trades performed by the exchange. Emits NotConnectedException When not connected to the WebSocket API.

Warning: There are currently no guarantees that messages will not be skipped.

Specified by:

getTrades in interface StreamingMarketDataService

Parameters:

currencyPair - Currency pair of the trades

Returns:

Observable that emits Trade when exchange sends the update.