Package org.knowm.xchange.coinbase.service

Class CoinbaseTradeService

java.lang.Object

org.knowm.xchange.service.BaseExchangeService

org.knowm.xchange.coinbase.service.CoinbaseBaseService

org.knowm.xchange.coinbase.service.CoinbaseTradeService

All Implemented Interfaces:

BaseService, TradeService

public final class CoinbaseTradeService
extends CoinbaseBaseService
implements TradeService

Author:

jamespedwards42

Field Summary

Fields inherited from class org.knowm.xchange.coinbase.service.CoinbaseBaseService

coinbase, signatureCreator

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

exchange

Constructor Summary

Constructors

Constructor	Description
CoinbaseTradeService(Exchange exchange)	Constructor

Method Summary

Modifier and Type	Method	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)
boolean	cancelOrder(CancelOrderParams orderParams)
OpenOrdersParams	createOpenOrdersParams()
TradeHistoryParams	createTradeHistoryParams()
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()
OpenOrders	getOpenOrders(OpenOrdersParams params)
UserTrades	getTradeHistory(TradeHistoryParams params)	Authenticated resource which returns the user’s Bitcoin purchases and sells.
String	placeLimitOrder(LimitOrder limitOrder)
String	placeMarketOrder(MarketOrder marketOrder)
String	placeStopOrder(StopOrder stopOrder)
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 org.knowm.xchange.coinbase.service.CoinbaseBaseService

createCoinbaseToken, createCoinbaseUser, createCoinbaseUser, getCoinbaseCurrencies, handleResponse

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

getClientConfig, 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, getOrder, getOrder, verifyOrder, verifyOrder

Constructor Detail

CoinbaseTradeService

public CoinbaseTradeService(Exchange exchange)

Constructor

Parameters:

exchange -

Method Detail

getOpenOrders

public OpenOrders getOpenOrders()
                         throws NotAvailableFromExchangeException,
                                IOException

Specified by:

getOpenOrders in interface TradeService

Throws:

NotAvailableFromExchangeException

IOException

getOpenOrders

public OpenOrders getOpenOrders(OpenOrdersParams params)
                         throws IOException

Specified by:

getOpenOrders in interface TradeService

Throws:

IOException

placeMarketOrder

public String placeMarketOrder(MarketOrder marketOrder)
                        throws ExchangeException,
                               IOException

Specified by:

placeMarketOrder in interface TradeService

Throws:

ExchangeException

IOException

placeLimitOrder

public String placeLimitOrder(LimitOrder limitOrder)
                       throws NotAvailableFromExchangeException

Specified by:

placeLimitOrder in interface TradeService

Throws:

NotAvailableFromExchangeException

placeStopOrder

public String placeStopOrder(StopOrder stopOrder)
                      throws IOException

Specified by:

placeStopOrder in interface TradeService

Throws:

IOException

cancelOrder

public boolean cancelOrder(String orderId)
                    throws NotAvailableFromExchangeException

Specified by:

cancelOrder in interface TradeService

Throws:

NotAvailableFromExchangeException

cancelOrder

public boolean cancelOrder(CancelOrderParams orderParams)
                    throws IOException

Specified by:

cancelOrder in interface TradeService

Throws:

IOException

getTradeHistory

public UserTrades getTradeHistory(TradeHistoryParams params)
                           throws IOException

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

Specified by:

getTradeHistory in interface TradeService

Throws:

IOException

See Also:

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

createTradeHistoryParams

public TradeHistoryParams createTradeHistoryParams()

Specified by:

createTradeHistoryParams in interface TradeService

createOpenOrdersParams

public OpenOrdersParams createOpenOrdersParams()

Specified by:

createOpenOrdersParams in interface TradeService

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