Package org.knowm.xchange.idex

Class IdexTradeService

java.lang.Object

org.knowm.xchange.service.BaseExchangeService

org.knowm.xchange.idex.IdexTradeService

All Implemented Interfaces:

BaseService, TradeService

public class IdexTradeService
extends BaseExchangeService
implements TradeService

Field Summary

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

exchange

Constructor Summary

Constructors

Constructor	Description
IdexTradeService(IdexExchange idexExchange)

Method Summary

Modifier and Type	Method	Description
boolean	cancelOrder(String s)	cancels order with matching orderId (conveniance method, typical just delegate to cancelOrder(CancelOrderByIdParams))
boolean	cancelOrder(CancelOrderParams cancelOrderParams)	cancels order with matching orderParams
OrderReq	createNormalizedLimitOrderReq(Currency baseCurrency, Currency counterCurrency, Order.OrderType type, BigDecimal limitPrice, BigDecimal originalAmount, String contractAddress, BigInteger nonce, BigInteger expires)
OpenOrdersParams	createOpenOrdersParams()	Create OpenOrdersParams object specific to this exchange.
TradeHistoryParams	createTradeHistoryParams()	Create TradeHistoryParams object specific to this exchange.
String	getApiKey()
OpenOrders	getOpenOrders()	Gets the open orders
OpenOrders	getOpenOrders(OpenOrdersParams openOrdersParams)	Gets the open orders
UserTrades	getTradeHistory(TradeHistoryParams tradeHistoryParams)	Fetch the history of user trades.
String	placeLimitOrder(LimitOrder placeOrder)	returns OrderHash so you can fetch it and cancel it...
String	placeMarketOrder(MarketOrder marketOrder)	Place a market order
String	placeStopOrder(StopOrder stopOrder)	Place a stop order
void	verifyOrder(LimitOrder limitOrder)	Verify the order against the exchange meta data.
void	verifyOrder(MarketOrder marketOrder)	Verify the order against the exchange meta data.

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

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.trade.TradeService

cancelAllOrders, changeOrder, getOpenPositions, getOrder, getOrder, getRequiredCancelOrderParamClasses, getRequiredOrderQueryParamClass

Constructor Details

IdexTradeService

public IdexTradeService(IdexExchange idexExchange)

Method Details

getOpenOrders

public OpenOrders getOpenOrders()

Description copied from interface: TradeService

Gets the open orders

Specified by:

getOpenOrders in interface TradeService

Returns:

the open orders, null if some sort of error occurred. Implementers should log the error.

getOpenOrders

public OpenOrders getOpenOrders(OpenOrdersParams openOrdersParams)

Description copied from interface: TradeService

Gets the open orders

Specified by:

getOpenOrders in interface TradeService

Parameters:

openOrdersParams - 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.

cancelOrder

public boolean cancelOrder(String s)

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.

cancelOrder

public boolean cancelOrder(CancelOrderParams cancelOrderParams)

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.

getTradeHistory

public UserTrades getTradeHistory(TradeHistoryParams tradeHistoryParams)

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:

tradeHistoryParams - 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

See Also:

TradeService.createTradeHistoryParams(), TradeHistoryParamsAll

createOpenOrdersParams

public OpenOrdersParams 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

verifyOrder

public void verifyOrder(LimitOrder limitOrder)

Description copied from interface: TradeService

Verify the order against the exchange meta data. Most implementations will require that Exchange.remoteInit() be called before this method

Specified by:

verifyOrder in interface TradeService

Overrides:

verifyOrder in class BaseExchangeService

verifyOrder

public void verifyOrder(MarketOrder marketOrder)

Description copied from interface: TradeService

Verify the order against the exchange meta data. Most implementations will require that Exchange.remoteInit() be called before this method

Specified by:

verifyOrder in interface TradeService

Overrides:

verifyOrder in class BaseExchangeService

createTradeHistoryParams

public TradeHistoryParams 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

placeMarketOrder

public String placeMarketOrder(MarketOrder marketOrder)

Description copied from interface: TradeService

Place a market order

If your orders amount does to meet the restrictions dictated by InstrumentMetaData 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

See Also:

OrderValuesHelper

placeStopOrder

public String placeStopOrder(StopOrder stopOrder)

Description copied from interface: TradeService

Place a stop order

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

Specified by:

placeStopOrder in interface TradeService

Returns:

the order ID

See Also:

OrderValuesHelper

placeLimitOrder

public String placeLimitOrder(LimitOrder placeOrder)

returns OrderHash so you can fetch it and cancel it... but there is a OrderNumber that you can intercept if you need to.

Specified by:

placeLimitOrder in interface TradeService

Returns:

the order ID

See Also:

OrderValuesHelper

createNormalizedLimitOrderReq

public final OrderReq createNormalizedLimitOrderReq(Currency baseCurrency,
Currency counterCurrency,
Order.OrderType type,
BigDecimal limitPrice,
BigDecimal originalAmount,
String contractAddress,
BigInteger nonce,
BigInteger expires)

getApiKey

public String getApiKey()