Class FtxTradeService
- All Implemented Interfaces:
BaseService
,TradeService
-
Field Summary
Fields inherited from class org.knowm.xchange.ftx.service.FtxBaseService
ftx, signatureCreator
Fields inherited from class org.knowm.xchange.service.BaseExchangeService
exchange
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptioncancelAllOrders
(CancelAllOrders orderParams) boolean
cancelOrder
(String orderId) cancels order with matching orderId (conveniance method, typical just delegate to cancelOrder(CancelOrderByIdParams))boolean
cancelOrder
(CancelOrderParams orderParams) cancels order with matching orderParamschangeOrder
(LimitOrder limitOrder) Modify or cancel/replace an existing limit orderGets the open ordersgetOpenOrders
(OpenOrdersParams params) Gets the open ordersGet all openPositions of the exchangeget's the latest order form the order book that with matching orderIdgetOrder
(OrderQueryParams... orderQueryParams) get's the latest order form the order book that with matching orderQueryParamsClass[]
Returns required cancel order parameter as classesgetTradeHistory
(TradeHistoryParams params) Fetch the history of user trades.placeLimitOrder
(LimitOrder limitOrder) Place a limit orderplaceMarketOrder
(MarketOrder marketOrder) Place a market orderplaceStopOrder
(StopOrder stopOrder) Place a stop orderMethods inherited from class org.knowm.xchange.ftx.service.FtxTradeServiceRaw
cancelAllFtxOrders, cancelFtxByClientId, cancelFtxConditionalOrderForSubAccount, cancelFtxOrder, cancelOrderForSubaccount, cancelOrderForSubaccount, cancelStopOrder, changeStopOrder, getFtxAllOpenOrdersForSubaccount, getFtxConditionalOrderHistory, getFtxFills, getFtxOpenConditionalOrdersForSubAccount, getFtxOpenOrders, getFtxOrderHistory, getFtxOrderStatus, getFtxPositions, getFtxTriggers, getFtxTriggersForSubAccount, getOpenOrdersForSubaccount, getOpenOrdersForSubaccount, getOpenPositionsForSubaccount, getOrderFromSubaccount, getOrderHistoryForSubaccount, getTradeHistoryForSubaccount, modifyFtxConditionalOrderForSubAccount, modifyFtxOrder, modifyFtxOrderByClientId, placeLimitOrderForSubaccount, placeMarketOrderForSubaccount, placeNewFtxConditionalOrderForSubAccount, placeNewFtxOrder, placeStopOrderForSubAccount
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
createOpenOrdersParams, createTradeHistoryParams, getRequiredOrderQueryParamClass, verifyOrder, verifyOrder
-
Constructor Details
-
FtxTradeService
-
-
Method Details
-
placeMarketOrder
Description copied from interface:TradeService
Place a market orderIf your orders amount does to meet the restrictions dictated by
InstrumentMetaData
then the exchange will reject your order. UseOrderValuesHelper
to validate and / or adjust it while you'r building an order.- Specified by:
placeMarketOrder
in interfaceTradeService
- Returns:
- the order ID
- Throws:
IOException
- - Indication that a networking error occurred while fetching JSON data- See Also:
-
placeLimitOrder
Description copied from interface:TradeService
Place a limit orderIf your orders amount or limit price does to meet the restrictions dictated by
InstrumentMetaData
then the exchange will reject your order. UseOrderValuesHelper
to validate and / or adjust those values while you'r building an order.- Specified by:
placeLimitOrder
in interfaceTradeService
- Returns:
- the order ID
- Throws:
IOException
- - Indication that a networking error occurred while fetching JSON data- See Also:
-
placeStopOrder
Description copied from interface:TradeService
Place a stop orderIf your orders amount or spot price does to meet the restrictions dictated by
InstrumentMetaData
then the exchange will reject your order. UseOrderValuesHelper
to validate and / or adjust those values while you'r building an order.- Specified by:
placeStopOrder
in interfaceTradeService
- Returns:
- the order ID
- Throws:
IOException
- - Indication that a networking error occurred while fetching JSON data- See Also:
-
getTradeHistory
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 ofTradeHistoryParams
. 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 interfaceTradeService
- Parameters:
params
- The parameters describing the filter. Note thatTradeHistoryParams
is an empty interface. Exact set of interfaces that are required or supported by this method is described by the type of object returned fromTradeService.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:
-
cancelAllOrders
- Specified by:
cancelAllOrders
in interfaceTradeService
- Throws:
IOException
-
cancelOrder
Description copied from interface:TradeService
cancels order with matching orderId (conveniance method, typical just delegate to cancelOrder(CancelOrderByIdParams))- Specified by:
cancelOrder
in interfaceTradeService
- Returns:
- true if order was successfully cancelled, false otherwise.
- Throws:
IOException
- - Indication that a networking error occurred while fetching JSON data
-
cancelOrder
Description copied from interface:TradeService
cancels order with matching orderParams- Specified by:
cancelOrder
in interfaceTradeService
- Returns:
- true if order was successfully cancelled, false otherwise.
- Throws:
IOException
- - Indication that a networking error occurred while fetching JSON data
-
getRequiredCancelOrderParamClasses
Description copied from interface:TradeService
Returns required cancel order parameter as classesDifferent trading services requires different parameters for order cancellation. To provide generic operation of the trade service interface. This method returns
Class
of the parameter objects as an array. This class information can be utilized by the caller ofTradeService.cancelOrder(CancelOrderParams)
to create instances of the required parameters such asCancelOrderByIdParams
,CancelOrderByInstrument
etc...- Specified by:
getRequiredCancelOrderParamClasses
in interfaceTradeService
- Returns:
- Class types for the required parameter classes. Default implementation returns an array
with a single
CancelOrderByIdParams
element
-
getOrder
Description copied from interface:TradeService
get's the latest order form the order book that with matching orderId- Specified by:
getOrder
in interfaceTradeService
- Returns:
- the order as it is on the exchange.
- Throws:
IOException
- - Indication that a networking error occurred while fetching JSON data
-
getOrder
Description copied from interface:TradeService
get's the latest order form the order book that with matching orderQueryParams- Specified by:
getOrder
in interfaceTradeService
- Returns:
- the order as it is on the exchange.
- Throws:
IOException
- - Indication that a networking error occurred while fetching JSON data
-
getOpenOrders
Description copied from interface:TradeService
Gets the open orders- Specified by:
getOpenOrders
in interfaceTradeService
- Parameters:
params
- The parameters describing the filter. Note thatOpenOrdersParams
is an empty interface. Exchanges should implement its own params object. Params should be create withTradeService.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
-
getOpenOrders
Description copied from interface:TradeService
Gets the open orders- Specified by:
getOpenOrders
in interfaceTradeService
- 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
-
getOpenPositions
Description copied from interface:TradeService
Get all openPositions of the exchange- Specified by:
getOpenPositions
in interfaceTradeService
- Throws:
IOException
-
changeOrder
Description copied from interface:TradeService
Modify or cancel/replace an existing limit order- Specified by:
changeOrder
in interfaceTradeService
- Parameters:
limitOrder
- Order's data to change- Returns:
- Order ID
- Throws:
IOException
- Indication that a networking error occurred while fetching JSON data
-