Package org.knowm.xchange.okcoin.service
Class OkCoinFuturesTradeService
- java.lang.Object
-
- org.knowm.xchange.service.BaseExchangeService
-
- org.knowm.xchange.okcoin.service.OkCoinBaseService
-
- org.knowm.xchange.okcoin.service.OKCoinBaseTradeService
-
- org.knowm.xchange.okcoin.service.OkCoinTradeServiceRaw
-
- org.knowm.xchange.okcoin.service.OkCoinFuturesTradeService
-
- All Implemented Interfaces:
BaseService
,TradeService
public class OkCoinFuturesTradeService extends OkCoinTradeServiceRaw implements TradeService
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interface
OkCoinFuturesTradeService.CancelOrderParamFuturesContract
static class
OkCoinFuturesTradeService.OkCoinFuturesCancelOrderParams
static class
OkCoinFuturesTradeService.OkCoinFuturesOrderQueryParams
static class
OkCoinFuturesTradeService.OkCoinFuturesTradeHistoryParams
static interface
OkCoinFuturesTradeService.OrderQueryParamFuturesContract
static interface
OkCoinFuturesTradeService.TradeHistoryParamFuturesContract
-
Field Summary
-
Fields inherited from class org.knowm.xchange.okcoin.service.OkCoinTradeServiceRaw
BATCH_DELIMITER
-
Fields inherited from class org.knowm.xchange.okcoin.service.OKCoinBaseTradeService
apikey, okCoin, secretKey
-
Fields inherited from class org.knowm.xchange.okcoin.service.OkCoinBaseService
useIntl
-
Fields inherited from class org.knowm.xchange.service.BaseExchangeService
exchange
-
-
Constructor Summary
Constructors Constructor Description OkCoinFuturesTradeService(Exchange exchange, FuturesContract futuresContract, int leverRate)
Constructor
-
Method Summary
All Methods Instance Methods Concrete Methods 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 orderParams)
cancels order with matching orderParamsOpenOrdersParams
createOpenOrdersParams()
CreateOpenOrdersParams
object specific to this exchange.OkCoinFuturesTradeService.OkCoinFuturesTradeHistoryParams
createTradeHistoryParams()
CreateTradeHistoryParams
object specific to this exchange.List<FuturesContract>
getExchangeContracts()
OpenOrders
getOpenOrders()
Gets the open ordersOpenOrders
getOpenOrders(OpenOrdersParams params)
Gets the open ordersCollection<Order>
getOrder(String... orderIds)
get's the latest order form the order book that with matching orderIdCollection<Order>
getOrder(OrderQueryParams... orderQueryParams)
get's the latest order form the order book that with matching orderQueryParamsOkCoinPriceLimit
getPriceLimits(CurrencyPair currencyPair, Object... args)
Retrieves the max price from the okex imposed by the price limitsUserTrades
getTradeHistory(TradeHistoryParams params)
Parameters: seeOkCoinFuturesTradeService.OkCoinFuturesTradeHistoryParams
String
liquidateLimitOrder(LimitOrder limitOrder)
Liquidate long or short contract using a limit orderString
liquidateMarketOrder(MarketOrder marketOrder)
Liquidate long or short contract (depending on market order order type) using a market orderString
placeLimitOrder(LimitOrder limitOrder)
Place a limit orderString
placeMarketOrder(MarketOrder marketOrder)
Place a market orderString
placeStopOrder(StopOrder stopOrder)
Place a stop order-
Methods inherited from class org.knowm.xchange.okcoin.service.OkCoinTradeServiceRaw
batchTrade, cancelOrder, cancelUpToThreeOrders, futureBatchTrade, futureExplosive, futuresCancelOrder, futuresTrade, getFuturesFilledOrder, getFuturesOrder, getFuturesOrders, getFuturesPosition, getFuturesPosition, getFuturesPositionsFixed, getFuturesPriceLimits, getFuturesTradesHistory, getOrder, getOrder, getOrder, getOrderHistory, placeMarketOrderBuy, placeMarketOrderSell, trade
-
Methods inherited from class org.knowm.xchange.okcoin.service.OKCoinBaseTradeService
returnOrThrow, signatureCreator
-
Methods inherited from class org.knowm.xchange.okcoin.service.OkCoinBaseService
createDelimitedString
-
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
changeOrder, verifyOrder, verifyOrder
-
-
-
-
Constructor Detail
-
OkCoinFuturesTradeService
public OkCoinFuturesTradeService(Exchange exchange, FuturesContract futuresContract, int leverRate)
Constructor- Parameters:
exchange
-
-
-
Method Detail
-
getOpenOrders
public OpenOrders getOpenOrders() throws IOException
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
-
getOpenOrders
public OpenOrders getOpenOrders(OpenOrdersParams params) throws IOException
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
-
placeMarketOrder
public String placeMarketOrder(MarketOrder marketOrder) throws IOException
Description copied from interface:TradeService
Place a market orderIf your orders amount does to meet the restrictions dictated by
CurrencyPairMetaData
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:
OrderValuesHelper
-
liquidateMarketOrder
public String liquidateMarketOrder(MarketOrder marketOrder) throws IOException
Liquidate long or short contract (depending on market order order type) using a market order- Throws:
IOException
-
getPriceLimits
public OkCoinPriceLimit getPriceLimits(CurrencyPair currencyPair, Object... args) throws IOException
Retrieves the max price from the okex imposed by the price limits- Throws:
IOException
-
placeLimitOrder
public String placeLimitOrder(LimitOrder limitOrder) throws IOException
Description copied from interface:TradeService
Place a limit orderIf your orders amount or limit price does to meet the restrictions dictated by
CurrencyPairMetaData
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:
OrderValuesHelper
-
placeStopOrder
public String placeStopOrder(StopOrder stopOrder) throws IOException
Description copied from interface:TradeService
Place a stop orderIf your orders amount or spot price does to meet the restrictions dictated by
CurrencyPairMetaData
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:
OrderValuesHelper
-
liquidateLimitOrder
public String liquidateLimitOrder(LimitOrder limitOrder) throws IOException
Liquidate long or short contract using a limit order- Throws:
IOException
-
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 interfaceTradeService
- 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(CancelOrderParams orderParams) throws IOException
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
-
getTradeHistory
public UserTrades getTradeHistory(TradeHistoryParams params) throws IOException
Parameters: seeOkCoinFuturesTradeService.OkCoinFuturesTradeHistoryParams
- 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:
TradeService.createTradeHistoryParams()
,TradeHistoryParamsAll
-
getExchangeContracts
public List<FuturesContract> getExchangeContracts()
-
createTradeHistoryParams
public OkCoinFuturesTradeService.OkCoinFuturesTradeHistoryParams createTradeHistoryParams()
Description copied from interface:TradeService
CreateTradeHistoryParams
object specific to this exchange. Object created by this method may be used to discover supported and requiredTradeService.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 interfaceTradeService
-
createOpenOrdersParams
public OpenOrdersParams createOpenOrdersParams()
Description copied from interface:TradeService
CreateOpenOrdersParams
object specific to this exchange. Object created by this method may be used to discover supported and requiredTradeService.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 interfaceTradeService
-
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 interfaceTradeService
- Returns:
- the order as it is on the exchange.
- Throws:
IOException
- - Indication that a networking error occurred while fetching JSON data
-
getOrder
public Collection<Order> getOrder(String... orderIds) throws IOException
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
-
-