Package info.bitrich.xchangestream.core

Interface StreamingMarketDataService

All Known Implementing Classes:
BinanceStreamingMarketDataService, BitfinexStreamingMarketDataService, BitflyerStreamingMarketDataService, BitmexStreamingMarketDataService, BitstampStreamingMarketDataService, BybitStreamingMarketDataService, CexioStreamingMarketDataService, CoinbaseProStreamingMarketDataService, CoincheckStreamingMarketDataService, CoinmateStreamingMarketDataService, dydxStreamingMarketDataService, dydxStreamingMarketDataService, FtxStreamingMarketDataService, GateioStreamingMarketDataService, GeminiStreamingMarketDataService, HitbtcStreamingMarketDataService, HuobiStreamingMarketDataService, KrakenFuturesStreamingMarketDataService, KrakenStreamingMarketDataService, KucoinStreamingMarketDataService, LgoStreamingMarketDataService, OkCoinStreamingMarketDataService, OkexStreamingMarketDataService, PoloniexStreamingMarketDataService
public interface StreamingMarketDataService

  • Method Details

    • getOrderBook

      default io.reactivex.rxjava3.core.Observable<OrderBook> getOrderBook(CurrencyPair currencyPair, Object... args)
      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.

      Parameters:
      currencyPair - Currency pair of the order book
      Returns:
      Observable that emits OrderBook when exchange sends the update.

    • getOrderBook

      default io.reactivex.rxjava3.core.Observable<OrderBook> getOrderBook(Instrument instrument, Object... args)

    • getTicker

      default io.reactivex.rxjava3.core.Observable<Ticker> getTicker(CurrencyPair currencyPair, Object... args)
      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.

      Parameters:
      currencyPair - Currency pair of the ticker
      Returns:
      Observable that emits Ticker when exchange sends the update.

    • getTicker

      default io.reactivex.rxjava3.core.Observable<Ticker> getTicker(Instrument instrument, Object... args)

    • getTrades

      default io.reactivex.rxjava3.core.Observable<Trade> getTrades(CurrencyPair currencyPair, Object... args)
      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.

      Parameters:
      currencyPair - Currency pair of the trades
      Returns:
      Observable that emits Trade when exchange sends the update.

    • getTrades

      default io.reactivex.rxjava3.core.Observable<Trade> getTrades(Instrument instrument, Object... args)

    • getFundingRate

      default io.reactivex.rxjava3.core.Observable<FundingRate> getFundingRate(Instrument instrument, Object... args)
      Get funding rate of specific instrument.
      Parameters:
      instrument - Instrument to get the funding rate for
      Returns:
      Observable that emits FundingRate when exchange sends the update.

    • getFundingRates

      default io.reactivex.rxjava3.core.Observable<FundingRates> getFundingRates()
      Get funding rates for all instruments of the platform.
      Returns:
      Observable that emits FundingRates when exchange sends the update.

    • getOrderBookUpdates

      default io.reactivex.rxjava3.core.Observable<List<OrderBookUpdate>> getOrderBookUpdates(Instrument instrument, Object... args)
      Get snapshots of orderBook update separately. Work only with getOrderBook(Instrument, Object...) subscription.
      Returns:
      Observable that emits OrderBookUpdate when exchange sends the orderBook snapshot.