Package org.knowm.xchange.gateio.service
Class GateioTradeService
java.lang.Object
org.knowm.xchange.service.BaseExchangeService
org.knowm.xchange.gateio.service.GateioBaseService
org.knowm.xchange.gateio.service.GateioTradeServiceRaw
org.knowm.xchange.gateio.service.GateioTradeService
- All Implemented Interfaces:
BaseService
,TradeService
public class GateioTradeService extends GateioTradeServiceRaw implements TradeService
-
Nested Class Summary
Nested classes/interfaces inherited from class org.knowm.xchange.gateio.service.GateioTradeServiceRaw
GateioTradeServiceRaw.GateioCancelOrderParams
-
Field Summary
Fields inherited from class org.knowm.xchange.gateio.service.GateioBaseService
apiKey, bter, signatureCreator
Fields inherited from class org.knowm.xchange.service.BaseExchangeService
exchange
-
Constructor Summary
Constructors Constructor Description GateioTradeService(Exchange exchange)
Constructor -
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 orderParams)
cancels order with matching orderParamsOpenOrdersParams
createOpenOrdersParams()
CreateOpenOrdersParams
object specific to this exchange.TradeHistoryParamCurrencyPair
createTradeHistoryParams()
CreateTradeHistoryParams
object specific to this exchange.OpenOrders
getOpenOrders()
Gets the open ordersOpenOrders
getOpenOrders(OpenOrdersParams params)
Gets the open ordersCollection<Order>
getOrder(OrderQueryParams... orderQueryParams)
get's the latest order form the order book that with matching orderQueryParamsClass[]
getRequiredCancelOrderParamClasses()
Returns required cancel order parameter as classesUserTrades
getTradeHistory(TradeHistoryParams params)
Required parameter:TradeHistoryParamCurrencyPair
String
placeLimitOrder(LimitOrder limitOrder)
Submits a Limit Order to be executed on the Gateio Exchange for the desired market defined byCurrencyPair
.String
placeMarketOrder(MarketOrder marketOrder)
Place a market orderMethods inherited from class org.knowm.xchange.gateio.service.GateioTradeServiceRaw
cancelAllOrders, cancelOrder, getGateioOpenOrders, getGateioOrderStatus, getGateioTradeHistory, placeGateioLimitOrder, placeGateioLimitOrder
Methods inherited from class org.knowm.xchange.gateio.service.GateioBaseService
getApiKey, handleResponse
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, changeOrder, getOpenPositions, getOrder, getRequiredOrderQueryParamClass, placeStopOrder, verifyOrder, verifyOrder
-
Constructor Details
-
GateioTradeService
Constructor- Parameters:
exchange
-
-
-
Method Details
-
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
-
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
-
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:
OrderValuesHelper
-
placeLimitOrder
Submits a Limit Order to be executed on the Gateio Exchange for the desired market defined byCurrencyPair
. WARNING - Gateio will return true regardless of whether or not an order actually gets created. The reason for this is that orders are simply submitted to a queue in their back-end. One example for why an order might not get created is because there are insufficient funds. The best attempt you can make to confirm that the order was created is to pollgetOpenOrders()
. However, if the order is created and executed before it is caught in its open state from callinggetOpenOrders()
then the only way to confirm would be confirm the expected difference in funds available for your account.- Specified by:
placeLimitOrder
in interfaceTradeService
- Returns:
- String "true"/"false" Used to determine if the order request was submitted successfully.
- Throws:
IOException
- - Indication that a networking error occurred while fetching JSON data- See Also:
OrderValuesHelper
-
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
-
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
-
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
-
getTradeHistory
Required parameter:TradeHistoryParamCurrencyPair
- 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:
ExchangeException
- - Indication that the exchange reported some kind of error with the request or responseIOException
- - Indication that a networking error occurred while fetching JSON data- See Also:
TradeService.createTradeHistoryParams()
,TradeHistoryParamsAll
-
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
-
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
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
-