public interface Coinbase
| Modifier and Type | Method and Description |
|---|---|
Transfer |
buy(org.joda.money.Money amount)
Buy a given quantity of BTC from Coinbase
|
Transfer |
buy(org.joda.money.Money amount,
String paymentMethodId)
Buy a given quantity of BTC from Coinbase
|
Transaction |
completeRequest(String transactionId)
Complete a money request.
|
Account |
createAccount(Account account)
Create a new account
|
Application |
createApplication(Application application)
Create a new OAuth application
|
Button |
createButton(Button button)
Create a new payment button, page, or iFrame.
|
Order |
createOrder(Button button)
Create an order for a new button
|
Order |
createOrderForButton(String buttonCode)
Create an order for an existing button
|
Report |
createReport(Report reportParams)
Create a new report
|
Token |
createToken()
Create a token which can be redeemed for bitcoin
|
User |
createUser(User userParams)
Unauthenticated resource that creates a user with an email and password.
|
User |
createUser(User userParams,
String clientId,
String scope)
Unauthenticated resource that creates a user with an email and password.
|
void |
deleteAccount()
Delete the current account
|
void |
deleteAccount(String accountId)
Delete the specified account
|
void |
deleteRequest(String transactionId)
Cancel a money request.
|
AddressResponse |
generateReceiveAddress()
Generate a new receive address
|
AddressResponse |
generateReceiveAddress(Address addressParams)
Generate a new receive address
|
AccountChangesResponse |
getAccountChanges()
Retrieve account changes
|
AccountChangesResponse |
getAccountChanges(int page)
Retrieve account changes
|
AccountsResponse |
getAccounts()
Retrieve a list of accounts belonging to this user
|
AccountsResponse |
getAccounts(int page)
Retrieve a list of active accounts belonging to this user
|
AccountsResponse |
getAccounts(int page,
int limit)
Retrieve a list of active accounts belonging to this user
|
AccountsResponse |
getAccounts(int page,
int limit,
boolean includeInactive)
Retrieve a list of accounts belonging to this user
|
AddressesResponse |
getAddresses()
Retrieve a list of bitcoin addresses associated with this account
|
AddressesResponse |
getAddresses(int page)
Retrieve a list of bitcoin addresses associated with this account
|
Application |
getApplication(String id)
Retrieve details for an individual OAuth application.
|
ApplicationsResponse |
getApplications()
List OAuth applications on your account.
|
org.joda.money.Money |
getBalance()
Retrieve the balance of the current account
|
org.joda.money.Money |
getBalance(String accountId)
Retrieve the balance of the specified account
|
Quote |
getBuyQuote(org.joda.money.Money btcAmount)
Get a quote for purchasing a given amount of BTC
|
ContactsResponse |
getContacts()
Retrieve a list of the user's contacts
|
ContactsResponse |
getContacts(int page)
Retrieve a list of the user's contacts
|
ContactsResponse |
getContacts(String query)
Retrieve a list of the user's contacts
|
ContactsResponse |
getContacts(String query,
int page)
Retrieve a list of the user's contacts
|
Map<String,BigDecimal> |
getExchangeRates()
Unauthenticated resource that returns BTC to fiat (and vice versus) exchange rates in various currencies.
|
List<HistoricalPrice> |
getHistoricalPrices()
Get the historical spot price of bitcoin in USD.
|
List<HistoricalPrice> |
getHistoricalPrices(int page)
Get the historical spot price of bitcoin in USD.
|
Order |
getOrder(String idOrCustom)
Retrieve details of an individual merchant order
|
OrdersResponse |
getOrders()
Retrieve a list of the user's recently received merchant orders
|
OrdersResponse |
getOrders(int page)
Retrieve a list of the user's recently received merchant orders
|
PaymentMethodsResponse |
getPaymentMethods()
Get the user's payment methods
|
RecurringPayment |
getRecurringPayment(String id)
Retrieves the details of a recurring payment
|
RecurringPaymentsResponse |
getRecurringPayments()
Retrieve all the recurring payments (scheduled buys, sells, and subscriptions) you've created with merchants.
|
RecurringPaymentsResponse |
getRecurringPayments(int page)
Retrieve all the recurring payments (scheduled buys, sells, and subscriptions) you've created with merchants.
|
Report |
getReport(String reportId)
Retrieve details for a report
|
ReportsResponse |
getReports()
Retrieve all reports
|
ReportsResponse |
getReports(int page)
Retrieve all reports
|
Quote |
getSellQuote(org.joda.money.Money btcAmount)
Get a quote for selling a given amount of BTC
|
org.joda.money.Money |
getSpotPrice(org.joda.money.CurrencyUnit currency)
Retrieve the current spot price of 1 BTC
|
RecurringPayment |
getSubscriber(String id)
Retrieves the details of a subscriber's recurring payment
|
RecurringPaymentsResponse |
getSubscribers()
Retrieve all the subscriptions customers have made with you
|
RecurringPaymentsResponse |
getSubscribers(int page)
Retrieve all the subscriptions customers have made with you
|
List<org.joda.money.CurrencyUnit> |
getSupportedCurrencies()
Unauthenticated resource that returns currencies supported on Coinbase
|
Transaction |
getTransaction(String id)
Retrieve details of an individual transaction.
|
TransactionsResponse |
getTransactions()
Retrieve a list of the user's recent transactions
|
TransactionsResponse |
getTransactions(int page)
Retrieve a list of the user's recent transactions
|
TransfersResponse |
getTransfers()
Retrieve a list of the user's recent transfers (buys/sales)
|
TransfersResponse |
getTransfers(int page)
Retrieve a list of the user's recent transfers (buys/sales)
|
User |
getUser()
Retrieve the current user and their settings.
|
void |
redeemToken(String tokenId)
Redeem a token, claiming its address and all its bitcoins
|
Transaction |
requestMoney(Transaction transaction)
Send an invoice/money request to an email address.
|
void |
resendRequest(String transactionId)
Resend emails for a money request.
|
Transfer |
sell(org.joda.money.Money amount)
Sell a given quantity of BTC to Coinbase
|
Transfer |
sell(org.joda.money.Money amount,
String paymentMethodId)
Sell a given quantity of BTC to Coinbase
|
Transaction |
sendMoney(Transaction transaction)
Send money to an email address or bitcoin address
|
void |
setPrimaryAccount()
Set the current account as primary
|
void |
setPrimaryAccount(String accountId)
Set the specified account as primary
|
void |
updateAccount(Account account)
Update the settings of the current account
|
void |
updateAccount(String accountId,
Account account)
Update the settings of the current account
|
User |
updateUser(String userId,
User userParams)
Updates account settings for the current user
|
User getUser() throws IOException, CoinbaseException
IOExceptionCoinbaseExceptionTransaction getTransaction(String id) throws IOException, CoinbaseException
id - the transaction id or idem field valueCoinbaseExceptionIOExceptionTransactionsResponse getTransactions() throws IOException, CoinbaseException
CoinbaseExceptionIOExceptionTransactionsResponse getTransactions(int page) throws IOException, CoinbaseException
page - the page of transactions to retrieveCoinbaseExceptionIOExceptionTransaction requestMoney(Transaction transaction) throws CoinbaseException, IOException
transaction - a Transaction object containing the parameters for a money requestIOExceptionCoinbaseExceptionvoid resendRequest(String transactionId) throws CoinbaseException, IOException
transactionId - the id of the request money transaction to be resentCoinbaseExceptionIOExceptionvoid deleteRequest(String transactionId) throws CoinbaseException, IOException
transactionId - the id of the request money transaction to be canceledCoinbaseExceptionIOExceptionTransaction completeRequest(String transactionId) throws CoinbaseException, IOException
transactionId - the id of the request money transaction to be completedCoinbaseExceptionIOExceptionTransaction sendMoney(Transaction transaction) throws CoinbaseException, IOException
transaction - a Transaction object containing the send money parametersCoinbaseExceptionIOExceptionOrder getOrder(String idOrCustom) throws IOException, CoinbaseException
idOrCustom - the order id or custom field valueCoinbaseExceptionIOExceptionOrdersResponse getOrders() throws IOException, CoinbaseException
CoinbaseExceptionIOExceptionOrdersResponse getOrders(int page) throws IOException, CoinbaseException
page - the page of orders to retrieveCoinbaseExceptionIOExceptionTransfersResponse getTransfers() throws IOException, CoinbaseException
CoinbaseExceptionIOExceptionTransfersResponse getTransfers(int page) throws IOException, CoinbaseException
page - the page of transfers to retrieveCoinbaseExceptionIOExceptionAddressesResponse getAddresses() throws IOException, CoinbaseException
CoinbaseExceptionIOExceptionAddressesResponse getAddresses(int page) throws IOException, CoinbaseException
page - the page of addresses to retrieveCoinbaseExceptionIOExceptionAccountsResponse getAccounts() throws IOException, CoinbaseException
IOExceptionCoinbaseExceptionAccountsResponse getAccounts(int page) throws IOException, CoinbaseException
page - the page of accounts to retrieveIOExceptionCoinbaseExceptionAccountsResponse getAccounts(int page, int limit) throws IOException, CoinbaseException
page - the page of accounts to retrievelimit - the number of accounts to retrieve per pageIOExceptionCoinbaseExceptionAccountsResponse getAccounts(int page, int limit, boolean includeInactive) throws IOException, CoinbaseException
page - the page of accounts to retrievelimit - the number of accounts to retrieve per pageincludeInactive - include inactive accounts in the responseIOExceptionCoinbaseExceptionContactsResponse getContacts() throws IOException, CoinbaseException
CoinbaseExceptionIOExceptionContactsResponse getContacts(int page) throws IOException, CoinbaseException
page - the page of accounts to retrieveCoinbaseExceptionIOExceptionContactsResponse getContacts(String query) throws IOException, CoinbaseException
query - partial string match to filter contacts.CoinbaseExceptionIOExceptionContactsResponse getContacts(String query, int page) throws IOException, CoinbaseException
page - the page of accounts to retrievequery - partial string match to filter contacts.CoinbaseExceptionIOExceptionorg.joda.money.Money getBalance()
throws UnspecifiedAccount,
IOException,
CoinbaseException
UnspecifiedAccount - if the account was not specified during the creation of the clientIOExceptionCoinbaseExceptionorg.joda.money.Money getBalance(String accountId) throws IOException, CoinbaseException
accountId - the id of the account for which to retrieve the balanceIOExceptionCoinbaseExceptionvoid setPrimaryAccount()
throws UnspecifiedAccount,
CoinbaseException,
IOException
UnspecifiedAccount - if the account was not specified during the creation of the clientIOExceptionCoinbaseExceptionvoid setPrimaryAccount(String accountId) throws CoinbaseException, IOException
accountId - the id of the account to set as primaryIOExceptionCoinbaseExceptionvoid deleteAccount()
throws UnspecifiedAccount,
CoinbaseException,
IOException
UnspecifiedAccount - if the account was not specified during the creation of the clientIOExceptionCoinbaseExceptionvoid deleteAccount(String accountId) throws CoinbaseException, IOException
accountId - the id of the account to deleteIOExceptionCoinbaseExceptionvoid updateAccount(Account account) throws UnspecifiedAccount, CoinbaseException, IOException
account - an Account object containing the parameters to be updatedUnspecifiedAccount - if the account was not specified during the creation of the clientIOExceptionCoinbaseExceptionvoid updateAccount(String accountId, Account account) throws CoinbaseException, IOException
accountId - the id of the account to updateaccount - an Account object containing the parameters to be updatedCoinbaseExceptionIOExceptionAccount createAccount(Account account) throws CoinbaseException, IOException
account - an Account object containing the parameters to create an accountIOExceptionCoinbaseExceptionorg.joda.money.Money getSpotPrice(org.joda.money.CurrencyUnit currency)
throws IOException,
CoinbaseException
currency - the currency in which to retrieve the priceIOExceptionCoinbaseExceptionQuote getBuyQuote(org.joda.money.Money btcAmount) throws IOException, CoinbaseException
btcAmount - the amount of bitcoin for which to retrieve a quoteIOExceptionCoinbaseExceptionQuote getSellQuote(org.joda.money.Money btcAmount) throws IOException, CoinbaseException
btcAmount - the amount of bitcoin for which to retrieve a quoteIOExceptionCoinbaseExceptionButton createButton(Button button) throws CoinbaseException, IOException
button - a Button object containing the parameters for creating a buttonCoinbaseExceptionIOExceptionOrder createOrder(Button button) throws CoinbaseException, IOException
button - a Button object containing the parameters for creating a buttonCoinbaseExceptionIOExceptionOrder createOrderForButton(String buttonCode) throws CoinbaseException, IOException
buttonCode - the code of the button for which to create an orderCoinbaseExceptionIOExceptionTransfer sell(org.joda.money.Money amount) throws CoinbaseException, IOException
amount - the quantity of BTC to sellIOExceptionCoinbaseExceptionTransfer sell(org.joda.money.Money amount, String paymentMethodId) throws CoinbaseException, IOException
amount - the quantity of BTC to sellpaymentMethodId - the ID of the payment method to credit with the proceeds of the saleIOExceptionCoinbaseExceptionTransfer buy(org.joda.money.Money amount) throws CoinbaseException, IOException
amount - the quantity of BTC to buyIOExceptionCoinbaseExceptionTransfer buy(org.joda.money.Money amount, String paymentMethodId) throws CoinbaseException, IOException
amount - the quantity of BTC to buypaymentMethodId - the ID of the payment method to debit for the purchaseIOExceptionCoinbaseExceptionPaymentMethodsResponse getPaymentMethods() throws IOException, CoinbaseException
CoinbaseExceptionIOExceptionRecurringPaymentsResponse getRecurringPayments() throws IOException, CoinbaseException
CoinbaseExceptionIOExceptionRecurringPaymentsResponse getRecurringPayments(int page) throws IOException, CoinbaseException
page - the page of recurring payments to retrieveCoinbaseExceptionIOExceptionRecurringPaymentsResponse getSubscribers() throws IOException, CoinbaseException
CoinbaseExceptionIOExceptionRecurringPaymentsResponse getSubscribers(int page) throws IOException, CoinbaseException
page - the page of subscribers to retrieveCoinbaseExceptionIOExceptionMap<String,BigDecimal> getExchangeRates() throws IOException, CoinbaseException
CoinbaseExceptionIOExceptionList<org.joda.money.CurrencyUnit> getSupportedCurrencies() throws IOException, CoinbaseException
CoinbaseExceptionIOExceptionUser createUser(User userParams) throws CoinbaseException, IOException
userParams - a User object containing the parameters to create a new UserCoinbaseException - on errorIOExceptionUser createUser(User userParams, String clientId, String scope) throws CoinbaseException, IOException
userParams - a User object containing the parameters to create a new UserclientId - your OAuth application's client idscope - a space-separated list of Coinbase OAuth permissionsCoinbaseException - on errorIOExceptionUser updateUser(String userId, User userParams) throws CoinbaseException, IOException
userId - the user's iduserParams - a User object containing the parameters to updateCoinbaseException - on errorIOExceptionRecurringPayment getRecurringPayment(String id) throws CoinbaseException, IOException
id - the id of the recurring paymentCoinbaseException - on errorIOExceptionRecurringPayment getSubscriber(String id) throws CoinbaseException, IOException
id - the id of the recurring paymentCoinbaseException - on errorIOExceptionToken createToken() throws CoinbaseException, IOException
CoinbaseException - on errorIOExceptionvoid redeemToken(String tokenId) throws CoinbaseException, IOException
tokenId - the id of the tokenCoinbaseException - on errorIOExceptionAddressResponse generateReceiveAddress(Address addressParams) throws CoinbaseException, IOException
addressParams - an Address object containing any arguments for the new addressCoinbaseException - on errorIOExceptionAddressResponse generateReceiveAddress() throws CoinbaseException, IOException
CoinbaseException - on errorIOExceptionApplication getApplication(String id) throws CoinbaseException, IOException
id - the id of the OAuth applicationCoinbaseException - on errorIOExceptionApplicationsResponse getApplications() throws CoinbaseException, IOException
id - the id of the OAuth applicationCoinbaseException - on errorIOExceptionApplication createApplication(Application application) throws CoinbaseException, IOException
applicationParams - an Application object containing the arguments for creating an OAuth applicationCoinbaseException - on errorIOExceptionList<HistoricalPrice> getHistoricalPrices(int page) throws CoinbaseException, IOException
page - the page of results to retrieveCoinbaseExceptionIOExceptionList<HistoricalPrice> getHistoricalPrices() throws CoinbaseException, IOException
CoinbaseExceptionIOExceptionReport createReport(Report reportParams) throws CoinbaseException, IOException
CoinbaseExceptionIOExceptionReport getReport(String reportId) throws CoinbaseException, IOException
reportId - the id of the report to retrieveCoinbaseExceptionIOExceptionReportsResponse getReports(int page) throws CoinbaseException, IOException
page - the page of results to retrieveCoinbaseExceptionIOExceptionReportsResponse getReports() throws CoinbaseException, IOException
CoinbaseExceptionIOExceptionAccountChangesResponse getAccountChanges(int page) throws CoinbaseException, IOException
page - the page of results to retrieveCoinbaseExceptionIOExceptionAccountChangesResponse getAccountChanges() throws CoinbaseException, IOException
CoinbaseExceptionIOExceptionCopyright © 2014. All rights reserved.