Package org.knowm.xchange.simulated

Class SimulatedTradeService

java.lang.Object
org.knowm.xchange.service.BaseExchangeService<SimulatedExchange>
org.knowm.xchange.simulated.SimulatedTradeService
All Implemented Interfaces:
BaseService, TradeService
public class SimulatedTradeService
extends BaseExchangeService<SimulatedExchange>
implements TradeService

  • Constructor Details

    • SimulatedTradeService

      protected SimulatedTradeService​(SimulatedExchange exchange)

  • Method Details

    • placeLimitOrder

      public String placeLimitOrder​(LimitOrder limitOrder) throws IOException
      Description copied from interface: TradeService
      Place a limit order

      If your orders amount or limit price does to meet the restrictions dictated by CurrencyPairMetaData then the exchange will reject your order. Use OrderValuesHelper to validate and / or adjust those values while you'r building an order.

      Specified by:
      placeLimitOrder in interface TradeService
      Returns:
      the order ID
      Throws:
      IOException - - Indication that a networking error occurred while fetching JSON data
      See Also:
      OrderValuesHelper

    • placeLimitOrderUnrestricted

      public String placeLimitOrderUnrestricted​(LimitOrder limitOrder)
      Use instead of placeLimitOrder(LimitOrder) to bypass rate limitations and transient errors when building up a simulated order book.
      Parameters:
      limitOrder - The limit order.
      Returns:
      The id of the resulting order.

    • placeMarketOrder

      public String placeMarketOrder​(MarketOrder marketOrder) throws IOException
      Description copied from interface: TradeService
      Place a market order

      If your orders amount does to meet the restrictions dictated by CurrencyPairMetaData then the exchange will reject your order. Use OrderValuesHelper to validate and / or adjust it while you'r building an order.

      Specified by:
      placeMarketOrder in interface TradeService
      Returns:
      the order ID
      Throws:
      IOException - - Indication that a networking error occurred while fetching JSON data
      See Also:
      OrderValuesHelper

    • getOpenOrders

      public OpenOrders getOpenOrders​(OpenOrdersParams params) throws IOException
      Description copied from interface: TradeService
      Gets the open orders
      Specified by:
      getOpenOrders in interface TradeService
      Parameters:
      params - The parameters describing the filter. Note that OpenOrdersParams is an empty interface. Exchanges should implement its own params object. Params should be create with TradeService.createOpenOrdersParams().
      Returns:
      the open orders, null if some sort of error occurred. Implementers should log the error.
      Throws:
      IOException - - Indication that a networking error occurred while fetching JSON data

    • getTradeHistory

      public UserTrades getTradeHistory​(TradeHistoryParams params) throws IOException
      Description copied from interface: TradeService
      Fetch the history of user trades.

      If you are calling this method for single exchange, known at the development time, you may pass an object of specific *TradeHistoryParam class that is nested it that exchange's trade service.

      If, however, you are fetching user trade history from many exchanges using the same code, you will find useful to create the parameter object with TradeService.createTradeHistoryParams() and check which parameters are required or supported using instanceof operator. See subinterfaces of TradeHistoryParams. Note that whether an interface is required or supported will vary from exchange to exchange and it's described only through the javadoc.

      There is also implementation of all the common interfaces, TradeHistoryParamsAll , that, with all properties set non-null, should work with any exchange.

      Some exchanges allow extra parameters, not covered by any common interface. To access them, you will have to use the object returned by TradeService.createTradeHistoryParams() and cast it to the exchange-specific type.

      Specified by:
      getTradeHistory in interface TradeService
      Parameters:
      params - The parameters describing the filter. Note that TradeHistoryParams is an empty interface. Exact set of interfaces that are required or supported by this method is described by the type of object returned from TradeService.createTradeHistoryParams() and the javadoc of the method.
      Returns:
      UserTrades as returned by the exchange API
      Throws:
      IOException - - Indication that a networking error occurred while fetching JSON data
      See Also:
      TradeService.createTradeHistoryParams(), TradeHistoryParamsAll

    • createOpenOrdersParams

      public OpenOrdersParamCurrencyPair createOpenOrdersParams()
      Description copied from interface: TradeService
      Create OpenOrdersParams object specific to this exchange. Object created by this method may be used to discover supported and required TradeService.getOpenOrders(OpenOrdersParams) parameters and should be passed only to the method in the same class as the createOpenOrdersParams that created the object.
      Specified by:
      createOpenOrdersParams in interface TradeService

    • createTradeHistoryParams

      public TradeHistoryParamCurrencyPair createTradeHistoryParams()
      Description copied from interface: TradeService
      Create TradeHistoryParams object specific to this exchange. Object created by this method may be used to discover supported and required TradeService.getTradeHistory(TradeHistoryParams) parameters and should be passed only to the method in the same class as the createTradeHistoryParams that created the object.
      Specified by:
      createTradeHistoryParams in interface TradeService

    • cancelOrder

      public boolean cancelOrder​(CancelOrderParams orderParams) throws IOException
      Description copied from interface: TradeService
      cancels order with matching orderParams
      Specified by:
      cancelOrder in interface TradeService
      Returns:
      true if order was successfully cancelled, false otherwise.
      Throws:
      IOException - - Indication that a networking error occurred while fetching JSON data

    • cancelOrder

      public boolean cancelOrder​(String orderId) throws IOException
      Description copied from interface: TradeService
      cancels order with matching orderId (conveniance method, typical just delegate to cancelOrder(CancelOrderByIdParams))
      Specified by:
      cancelOrder in interface TradeService
      Returns:
      true if order was successfully cancelled, false otherwise.
      Throws:
      IOException - - Indication that a networking error occurred while fetching JSON data

    • getOrder

      public Collection<Order> getOrder​(OrderQueryParams... orderQueryParams)
      Description copied from interface: TradeService
      get's the latest order form the order book that with matching orderQueryParams
      Specified by:
      getOrder in interface TradeService
      Returns:
      the order as it is on the exchange.

    • getOrder

      public Collection<Order> getOrder​(String... orderIds)
      Description copied from interface: TradeService
      get's the latest order form the order book that with matching orderId
      Specified by:
      getOrder in interface TradeService
      Returns:
      the order as it is on the exchange.