Interface StreamingTradeService

All Known Implementing Classes:
BinanceStreamingTradeService, BitgetStreamingTradeService, BybitStreamingTradeService, CoinmateStreamingTradeService, CoinsphStreamingTradeService, CryptoComStreamingTradeService, DeribitStreamingTradeService, GateioStreamingTradeService, KrakenFuturesStreamingTradeService, KrakenStreamingTradeService, KucoinStreamingTradeService, OkexStreamingTradeService

public interface StreamingTradeService
  • Method Details

    • getOrderChanges

      default io.reactivex.rxjava3.core.Observable<Order> getOrderChanges(CurrencyPair currencyPair, Object... args)
      Get the changes of order state for the logged-in user.

      Warning: there are currently no guarantees that messages will arrive in order, that messages will not be skipped, or that any initial state message will be sent on connection. Most exchanges have a recommended approach for managing this, involving timestamps, sequence numbers and a separate REST API for re-sync when inconsistencies appear. You should implement these approaches, if required, by combining calls to this method with TradeService.getOpenOrders().

      Emits NotConnectedException When not connected to the WebSocket API.

      Immediately throws ExchangeSecurityException if called without authentication details

      Parameters:
      currencyPair - Currency pair of the order changes.
      Returns:
      Observable that emits Order when exchange sends the update.
    • getOrderChanges

      default io.reactivex.rxjava3.core.Observable<Order> getOrderChanges(Instrument instrument, Object... args)
    • getUserTrades

      default io.reactivex.rxjava3.core.Observable<UserTrade> getUserTrades(CurrencyPair currencyPair, Object... args)
      Gets authenticated trades for the logged-in user.

      Warning: there are currently no guarantees that messages will arrive in order, that messages will not be skipped, or that any initial state message will be sent on connection. Most exchanges have a recommended approach for managing this, involving timestamps, sequence numbers and a separate REST API for re-sync when inconsistencies appear. You should implement these approaches, if required, by combining calls to this method with TradeService.getTradeHistory(org.knowm.xchange.service.trade.params.TradeHistoryParams)

      Emits NotConnectedException When not connected to the WebSocket API.

      Immediately throws ExchangeSecurityException if called without authentication details

      Parameters:
      currencyPair - Currency pair for which to get trades.
      Returns:
      Observable that emits UserTrade when exchange sends the update.
    • getUserTrades

      default io.reactivex.rxjava3.core.Observable<UserTrade> getUserTrades(Instrument instrument, Object... args)
    • getUserTrades

      default io.reactivex.rxjava3.core.Observable<UserTrade> getUserTrades()
    • getPositionChanges

      default io.reactivex.rxjava3.core.Observable<OpenPosition> getPositionChanges(Instrument instrument)
    • placeMarketOrder

      default io.reactivex.rxjava3.core.Single<Integer> placeMarketOrder(MarketOrder marketOrder, Object... args)
      Places a market order on the exchange. A market order is an order to buy or sell a financial instrument immediately at the best available current price. Specific exchanges may require additional optional parameters to process the market order.
      Parameters:
      marketOrder - The details of the market order, including the instrument, amount, and side (buy/sell).
      args - Optional additional arguments that may be required by specific exchanges.
      Returns:
      A Single that emits the operation result code, typically 0 for success.
    • placeLimitOrder

      default io.reactivex.rxjava3.core.Single<Integer> placeLimitOrder(LimitOrder limitOrder, Object... args)
      Places a limit order on the exchange. A limit order specifies the price at which the user wants to buy or sell a financial instrument, potentially with additional optional parameters.
      Parameters:
      limitOrder - The details of the limit order, including instrument, price, volume, and side (buy/sell).
      args - Optional additional arguments that may be required by specific exchanges.
      Returns:
      A Single that emits the operation result code, typically 0 for success.
    • changeOrder

      default io.reactivex.rxjava3.core.Single<Integer> changeOrder(LimitOrder order, Object... args)
      Modifies an existing limit order on the exchange. This can include changes to the price, volume, or other adjustable parameters of the order, depending on the exchange's specific functionality and constraints.
      Parameters:
      order - The limit order to be modified, including the updated details such as price or/and volume.
      args - Optional additional arguments that may be required by specific exchanges.
      Returns:
      A Single that emits the operation result code, typically 0 for success.
    • cancelOrder

      default io.reactivex.rxjava3.core.Single<Integer> cancelOrder(CancelOrderParams params, Object... args)
      Cancels an existing order on the exchange. The operation requires specific parameters describing the order to be canceled, such as order ID or user reference ID.
      Parameters:
      params - An object implementing CancelOrderParams that contains order ID or user reference ID.
      args - Optional additional arguments that may be required by specific exchanges.
      Returns:
      A Single that emits the operation result code, typically 0 for success.