com.xeiam.xchange.coinbase.service.polling

Class CoinbaseTradeService

java.lang.Object

com.xeiam.xchange.service.BaseExchangeService

com.xeiam.xchange.coinbase.service.polling.CoinbaseBasePollingService

com.xeiam.xchange.coinbase.service.polling.CoinbaseTradeService

All Implemented Interfaces:

BasePollingService, PollingTradeService

public final class CoinbaseTradeService
extends CoinbaseBasePollingService
implements PollingTradeService

Author:

jamespedwards42

Field Summary

Fields inherited from class com.xeiam.xchange.coinbase.service.polling.CoinbaseBasePollingService

coinbase, signatureCreator

Fields inherited from class com.xeiam.xchange.service.BaseExchangeService

exchange

Constructor Summary

Constructors

Constructor and Description
CoinbaseTradeService(Exchange exchange) Constructor

Method Summary

Modifier and Type	Method and Description
CoinbaseTransfer	buy(BigDecimal quantity) Authenticated resource that lets you purchase Bitcoin using the primary bank account that is linked to your account.
CoinbaseTransfer	buyAndAgreeBTCAmountVaries(BigDecimal quantity) Authenticated resource that lets you purchase Bitcoin using the primary bank account that is linked to your account.
boolean	cancelOrder(String orderId) cancels order with matching orderId
TradeHistoryParams	createTradeHistoryParams() Create TradeHistoryParams object specific to this exchange.
CoinbaseTransfers	getCoinbaseTransfers() Authenticated resource which returns the user’s Bitcoin purchases and sells.
CoinbaseTransfers	getCoinbaseTransfers(Integer page, Integer limit) Authenticated resource which returns the user’s Bitcoin purchases and sells.
OpenOrders	getOpenOrders() Gets the open orders
UserTrades	getTradeHistory(Object... arguments) Authenticated resource which returns the user’s Bitcoin purchases and sells.
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
CoinbaseTransfer	sell(BigDecimal quantity) Authenticated resource that lets you convert Bitcoin in your account to USD by crediting your primary bank account on Coinbase.

Methods inherited from class com.xeiam.xchange.coinbase.service.polling.CoinbaseBasePollingService

createCoinbaseToken, createCoinbaseUser, createCoinbaseUser, getCoinbaseCurrencies, handleResponse

Methods inherited from class com.xeiam.xchange.service.BaseExchangeService

getExchangeSymbols, 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 com.xeiam.xchange.service.polling.trade.PollingTradeService

verifyOrder, verifyOrder

Methods inherited from interface com.xeiam.xchange.service.polling.BasePollingService

getExchangeSymbols

Constructor Detail

CoinbaseTradeService

public CoinbaseTradeService(Exchange exchange)

Constructor

Parameters:

exchange -

Method Detail

getOpenOrders

public OpenOrders getOpenOrders()
                         throws NotAvailableFromExchangeException

Description copied from interface: PollingTradeService

Gets the open orders

Specified by:

getOpenOrders in interface PollingTradeService

Returns:

the open orders, null if some sort of error occurred. Implementers should log the error.

Throws:

NotAvailableFromExchangeException - - Indication that the exchange does not support the requested function or data

placeMarketOrder

public String placeMarketOrder(MarketOrder marketOrder)
                        throws ExchangeException,
                               IOException

Description copied from interface: PollingTradeService

Place a market order

Specified by:

placeMarketOrder in interface PollingTradeService

Returns:

the order ID

Throws:

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

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

placeLimitOrder

public String placeLimitOrder(LimitOrder limitOrder)
                       throws NotAvailableFromExchangeException

Description copied from interface: PollingTradeService

Place a limit order

Specified by:

placeLimitOrder in interface PollingTradeService

Returns:

the order ID

Throws:

NotAvailableFromExchangeException - - Indication that the exchange does not support the requested function or data

cancelOrder

public boolean cancelOrder(String orderId)
                    throws NotAvailableFromExchangeException

Description copied from interface: PollingTradeService

cancels order with matching orderId

Specified by:

cancelOrder in interface PollingTradeService

Returns:

true if order was successfully cancelled, false otherwise.

Throws:

NotAvailableFromExchangeException - - Indication that the exchange does not support the requested function or data

getTradeHistory

public UserTrades getTradeHistory(Object... arguments)
                           throws ExchangeException,
                                  IOException

Authenticated resource which returns the user’s Bitcoin purchases and sells. Sorted in descending order by creation date.

Specified by:

getTradeHistory in interface PollingTradeService

Parameters:

arguments - Optional Integer arguments page (arg[0]) and limit (arg[1]). If no arguments are given then page 1 will be returned and the results are limited to 25 per page by coinbase by default.

Returns:

Throws:

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

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

See Also:

coinbase.com/api/doc/1.0/transfers/index.html

getTradeHistory

public UserTrades getTradeHistory(TradeHistoryParams params)
                           throws IOException

Description copied from interface: PollingTradeService

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 PollingTradeService.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 PollingTradeService.createTradeHistoryParams() and cast it to the exchange-specific type.

Specified by:

getTradeHistory in interface PollingTradeService

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

PollingTradeService.getTradeHistory(Object...), PollingTradeService.createTradeHistoryParams(), TradeHistoryParamsAll

createTradeHistoryParams

public TradeHistoryParams createTradeHistoryParams()

Description copied from interface: PollingTradeService

Create TradeHistoryParams object specific to this exchange. Object created by this method may be used to discover supported and required PollingTradeService.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 PollingTradeService

buy

public CoinbaseTransfer buy(BigDecimal quantity)
                     throws IOException

Authenticated resource that lets you purchase Bitcoin using the primary bank account that is linked to your account. (You must link and verify your bank account through the website before this API call will work). The underlying optional parameter agree_btc_amount_varies is set to false. Use buyAndAgreeBTCAmountVaries(java.math.BigDecimal) to have it set to true.

Parameters:

quantity - The quantity of Bitcoin you would like to buy.

Returns:

The CoinbaseTransfer representing the buy.

Throws:

IOException

See Also:

coinbase.com/api/doc/1.0/buys/create.html

buyAndAgreeBTCAmountVaries

public CoinbaseTransfer buyAndAgreeBTCAmountVaries(BigDecimal quantity)
                                            throws IOException

Authenticated resource that lets you purchase Bitcoin using the primary bank account that is linked to your account. (You must link and verify your bank account through the website before this API call will work). The underlying optional parameter agree_btc_amount_varies is set to true. Use buyAndAgreeBTCAmountVaries(java.math.BigDecimal) to have it set to false.

Parameters:

quantity - The quantity of Bitcoin you would like to buy.

Returns:

A CoinbaseTransfer representing the buy.

Throws:

IOException

See Also:

coinbase.com/api/doc/1.0/buys/create.html

sell

public CoinbaseTransfer sell(BigDecimal quantity)
                      throws IOException

Authenticated resource that lets you convert Bitcoin in your account to USD by crediting your primary bank account on Coinbase. (You must link and verify your bank account through the website before this API call will work).

Parameters:

quantity - The quantity of Bitcoin you would like to sell.

Returns:

A CoinbaseTransfer representing the sell.

Throws:

IOException

See Also:

coinbase.com/api/doc/1.0/sells/create.html

getCoinbaseTransfers

public CoinbaseTransfers getCoinbaseTransfers()
                                       throws IOException

Authenticated resource which returns the user’s Bitcoin purchases and sells. Sorted in descending order by creation date. This is a paged resource and will return the first page by default.

Returns:

Throws:

IOException

See Also:

coinbase.com/api/doc/1.0/transfers/index.html

getCoinbaseTransfers

public CoinbaseTransfers getCoinbaseTransfers(Integer page,
                                              Integer limit)
                                       throws IOException

Authenticated resource which returns the user’s Bitcoin purchases and sells. Sorted in descending order by creation date.

Parameters:

page - Optional parameter to request a desired page of results. Will return page 1 if the supplied page is null or less than 1.

limit - Optional parameter to limit the maximum number of results to return. Will return up to 25 results by default if null or less than 1.

Returns:

Throws:

IOException

See Also:

coinbase.com/api/doc/1.0/transfers/index.html