Package org.knowm.xchange.mercadobitcoin.service

Class MercadoBitcoinTradeService

java.lang.Object

org.knowm.xchange.service.BaseExchangeService

org.knowm.xchange.mercadobitcoin.service.MercadoBitcoinBaseService

org.knowm.xchange.mercadobitcoin.service.MercadoBitcoinTradeServiceRaw

org.knowm.xchange.mercadobitcoin.service.MercadoBitcoinTradeService

All Implemented Interfaces:

BaseService, TradeService

public class MercadoBitcoinTradeService
extends MercadoBitcoinTradeServiceRaw
implements TradeService

Author:

Felipe Micaroni Lalli

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	MercadoBitcoinTradeService.MercadoTradeHistoryParams

Field Summary

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

exchange

Constructor Summary

Constructors

Constructor	Description
MercadoBitcoinTradeService(Exchange exchange)	Constructor

Method Summary

Modifier and Type	Method	Description
boolean	cancelOrder(String orderId)	The ID is composed by the currency pair and the id number separated by colon, like: btc_brl:3498 Please see and use MercadoBitcoinUtils.makeMercadoBitcoinOrderId(org.knowm.xchange.currency.CurrencyPair, java.lang.String) .
boolean	cancelOrder(CancelOrderParams orderParams)	cancels order with matching orderParams
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
UserTrades	getTradeHistory(TradeHistoryParams params)	Fetch the history of user trades.
String	placeLimitOrder(LimitOrder limitOrder)	The result is not the pure order id.
String	placeMarketOrder(MarketOrder marketOrder)	Place a market order

Methods inherited from class org.knowm.xchange.mercadobitcoin.service.MercadoBitcoinTradeServiceRaw

getMercadoBitcoinUserOrders, mercadoBitcoinCancelOrder, mercadoBitcoinPlaceLimitOrder

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

Constructor Details

MercadoBitcoinTradeService

public MercadoBitcoinTradeService(Exchange exchange)

Constructor

Parameters:

exchange -

Method Details

getOpenOrders

public OpenOrders getOpenOrders()
                         throws IOException

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:

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

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

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

See Also:

• OrderValuesHelper

placeLimitOrder

public String placeLimitOrder(LimitOrder limitOrder)
                       throws IOException

The result is not the pure order id. It is a composition with the currency pair and the order id (the same format used as parameter of cancelOrder(java.lang.String)). Please see MercadoBitcoinUtils.makeMercadoBitcoinOrderId(org.knowm.xchange.currency.CurrencyPair, java.lang.String) .

Specified by:

placeLimitOrder in interface TradeService

Returns:

the order ID

Throws:

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

See Also:

• OrderValuesHelper

cancelOrder

public boolean cancelOrder(String orderId)
                    throws IOException

The ID is composed by the currency pair and the id number separated by colon, like: btc_brl:3498 Please see and use MercadoBitcoinUtils.makeMercadoBitcoinOrderId(org.knowm.xchange.currency.CurrencyPair, java.lang.String) .

Specified by:

cancelOrder in interface TradeService

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 interface TradeService

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

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 - Required parameter types: TradeHistoryParamCurrencyPair. Supported types: TradeHistoryParamsIdSpan, TradeHistoryParamsTimeSpan.

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

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

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