Package org.knowm.xchange.bitmex.service

Class BitmexTradeService

java.lang.Object

org.knowm.xchange.service.BaseExchangeService<BitmexExchange>

org.knowm.xchange.bitmex.service.BitmexBaseService

org.knowm.xchange.bitmex.service.BitmexTradeServiceRaw

org.knowm.xchange.bitmex.service.BitmexTradeService

All Implemented Interfaces:

BaseService, TradeService

public class BitmexTradeService
extends BitmexTradeServiceRaw
implements TradeService

Field Summary

Fields inherited from class org.knowm.xchange.bitmex.service.BitmexBaseService

bitmex, rateLimit, rateLimitRemaining, rateLimitReset, signatureCreator

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

exchange

Constructor Summary

Constructors

Constructor	Description
BitmexTradeService(BitmexExchange exchange)

Method Summary

Modifier and Type	Method	Description
boolean	cancelOrder(String orderId)	cancels order with matching orderId (conveniance method, typical just delegate to cancelOrder(CancelOrderByIdParams))
boolean	cancelOrder(CancelOrderParams params)	cancels order with matching orderParams
String	changeOrder(LimitOrder limitOrder)	Modify or cancel/replace an existing limit order
OpenOrdersParams	createOpenOrdersParams()	Create OpenOrdersParams object specific to this exchange.
TradeHistoryParams	createTradeHistoryParams()	Create TradeHistoryParams object specific to this exchange.
OpenOrders	getOpenOrders()	Gets the open orders
OpenOrders	getOpenOrders(OpenOrdersParams params)	Gets the open orders
Collection<Order>	getOrder(OrderQueryParams... orderQueryParams)	get's the latest order form the order book that with matching orderQueryParams
UserTrades	getTradeHistory(TradeHistoryParams params)	Fetch the history of user trades.
String	placeLimitOrder(LimitOrder limitOrder)	Place a limit order
String	placeMarketOrder(MarketOrder marketOrder)	Place a market order
String	placeStopOrder(StopOrder stopOrder)	Place a stop order

Methods inherited from class org.knowm.xchange.bitmex.service.BitmexTradeServiceRaw

cancelAllAfter, cancelAllOrders, cancelAllOrders, cancelBitmexOrder, cancelBitmexOrder, getBitmexOrders, getBitmexOrders, getBitmexPositions, getBitmexPositions, getExecutions, getTradeHistory, placeOrder, placeOrderBulk, replaceOrder, replaceOrderBulk, updateLeveragePosition

Methods inherited from class org.knowm.xchange.bitmex.service.BitmexBaseService

getRateLimit, getRateLimitRemaining, getRateLimitReset, handleError, updateRateLimit

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

verifyOrder, verifyOrder, 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, getOpenPositions, getOrder, getRequiredCancelOrderParamClasses, getRequiredOrderQueryParamClass, verifyOrder, verifyOrder

Constructor Details

BitmexTradeService

public BitmexTradeService(BitmexExchange exchange)

Method Details

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

getOpenOrders

public OpenOrders getOpenOrders()
                         throws ExchangeException

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.

Throws:

ExchangeException - - Indication that the exchange reported some kind of error with the request or response

getOpenOrders

public OpenOrders getOpenOrders(OpenOrdersParams params)
                         throws ExchangeException

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:

ExchangeException - - Indication that the exchange reported some kind of error with the request or response

placeMarketOrder

public String placeMarketOrder(MarketOrder marketOrder)
                        throws ExchangeException

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

Throws:

ExchangeException - - Indication that the exchange reported some kind of error with the request or response

See Also:

• OrderValuesHelper

placeLimitOrder

public String placeLimitOrder(LimitOrder limitOrder)
                       throws ExchangeException

Description copied from interface: TradeService

Place a limit order

If your orders amount or limit 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:

placeLimitOrder in interface TradeService

Returns:

the order ID

Throws:

ExchangeException - - Indication that the exchange reported some kind of error with the request or response

See Also:

• OrderValuesHelper

placeStopOrder

public String placeStopOrder(StopOrder stopOrder)
                      throws ExchangeException

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

Throws:

ExchangeException - - Indication that the exchange reported some kind of error with the request or response

See Also:

• OrderValuesHelper

changeOrder

public String changeOrder(LimitOrder limitOrder)
                   throws ExchangeException

Description copied from interface: TradeService

Modify or cancel/replace an existing limit order

Specified by:

changeOrder in interface TradeService

Parameters:

limitOrder - Order's data to change

Returns:

Order ID

Throws:

ExchangeException - Indication that the exchange reported some kind of error with the request or response

cancelOrder

public boolean cancelOrder(String orderId)
                    throws ExchangeException

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:

ExchangeException - - Indication that the exchange reported some kind of error with the request or response

cancelOrder

public boolean cancelOrder(CancelOrderParams params)
                    throws ExchangeException

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:

ExchangeException - - Indication that the exchange reported some kind of error with the request or response

getOrder

public Collection<Order> getOrder(OrderQueryParams... orderQueryParams)
                           throws IOException

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.

Throws:

IOException - - Indication that a networking error occurred while fetching JSON data

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

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