api documentation for coinbase (v2.0.6)

The Coinbase API for Node.js

table of contents

  1. module coinbase
    1. function coinbase.AccountBase (client, data)
    2. function coinbase.Base ()
    3. function coinbase.Client (opts)
    4. function coinbase.ClientBase (opts)
    5. function coinbase.Transfer (client, data, account)
    6. function coinbase.model.Account (client, data)
    7. function coinbase.model.Address (client, data, account)
    8. function coinbase.model.Buy (client, data, account)
    9. function coinbase.model.Checkout (client, data)
    10. function coinbase.model.Deposit (client, data, account)
    11. function coinbase.model.Order (client, data)
    12. function coinbase.model.Sell (client, data, account)
    13. function coinbase.model.Transaction (client, data, account)
    14. function coinbase.model.User (client, data)
    15. function coinbase.model.Withdrawal (client, data, account)
    16. object coinbase.AccountBase.prototype
    17. object coinbase.Base.prototype
    18. object coinbase.Client.prototype
    19. object coinbase.ClientBase.prototype
    20. object coinbase.Transfer.prototype
    21. object coinbase.errorHandler
    22. object coinbase.model
    23. object coinbase.model.Account.prototype
    24. object coinbase.model.Address.prototype
    25. object coinbase.model.Buy.prototype
    26. object coinbase.model.Checkout.prototype
    27. object coinbase.model.Deposit.prototype
    28. object coinbase.model.Order.prototype
    29. object coinbase.model.Sell.prototype
    30. object coinbase.model.Transaction.prototype
    31. object coinbase.model.User.prototype
    32. object coinbase.model.Withdrawal.prototype
  2. module coinbase.AccountBase
    1. function coinbase.AccountBase (client, data)
  3. module coinbase.AccountBase.prototype
    1. function coinbase.AccountBase.prototype._getAll (opts, callback, headers)
    2. function coinbase.AccountBase.prototype._getOne (opts, callback, headers)
    3. function coinbase.AccountBase.prototype._initTxn (args, callback, headers)
    4. function coinbase.AccountBase.prototype._postOne (opts, callback, headers)
  4. module coinbase.Base
    1. function coinbase.Base ()
  5. module coinbase.Base.prototype
    1. function coinbase.Base.prototype.dumpJSON ()
    2. function coinbase.Base.prototype.getProps ()
    3. function coinbase.Base.prototype.hasField (obj, field)
    4. function coinbase.Base.prototype.toString ()
  6. module coinbase.Client
    1. function coinbase.Client (opts)
  7. module coinbase.Client.prototype
    1. function coinbase.Client.prototype.createAccount (args, callback)
    2. function coinbase.Client.prototype.createCheckout (args, callback)
    3. function coinbase.Client.prototype.createOrder (args, callback)
    4. function coinbase.Client.prototype.getAccount (account_id, callback)
    5. function coinbase.Client.prototype.getAccounts (args, callback)
    6. function coinbase.Client.prototype.getBuyPrice (params, callback)
    7. function coinbase.Client.prototype.getCheckout (checkoutId, callback)
    8. function coinbase.Client.prototype.getCheckouts (args, callback)
    9. function coinbase.Client.prototype.getCurrencies (callback)
    10. function coinbase.Client.prototype.getCurrentUser (callback)
    11. function coinbase.Client.prototype.getExchangeRates (params, callback)
    12. function coinbase.Client.prototype.getHistoricPrices (params, callback)
    13. function coinbase.Client.prototype.getMerchant (merchantId, callback)
    14. function coinbase.Client.prototype.getNotification (notificationId, callback)
    15. function coinbase.Client.prototype.getNotifications (args, callback)
    16. function coinbase.Client.prototype.getOrder (orderId, callback)
    17. function coinbase.Client.prototype.getOrders (args, callback)
    18. function coinbase.Client.prototype.getPaymentMethod (methodId, callback)
    19. function coinbase.Client.prototype.getPaymentMethods (args, callback)
    20. function coinbase.Client.prototype.getSellPrice (params, callback)
    21. function coinbase.Client.prototype.getSpotPrice (params, callback)
    22. function coinbase.Client.prototype.getTime (callback)
    23. function coinbase.Client.prototype.getUser (userId, callback)
    24. function coinbase.Client.prototype.refresh (callback)
    25. function coinbase.Client.prototype.toString ()
    26. function coinbase.Client.prototype.verifyCallback (body, signature)
  8. module coinbase.ClientBase
    1. function coinbase.ClientBase (opts)
  9. module coinbase.ClientBase.prototype
    1. function coinbase.ClientBase.prototype._deleteHttp (path, callback, headers)
    2. function coinbase.ClientBase.prototype._generateReqOptions (url, path, body, method, headers)
    3. function coinbase.ClientBase.prototype._generateSignature (path, method, bodyStr)
    4. function coinbase.ClientBase.prototype._getAllHttp (opts, callback, headers)
    5. function coinbase.ClientBase.prototype._getHttp (path, args, callback, headers)
    6. function coinbase.ClientBase.prototype._getOneHttp (args, callback, headers)
    7. function coinbase.ClientBase.prototype._postHttp (path, body, callback, headers)
    8. function coinbase.ClientBase.prototype._postOneHttp (opts, callback, headers)
    9. function coinbase.ClientBase.prototype._putHttp (path, body, callback, headers)
    10. function coinbase.ClientBase.prototype._setAccessToken (path)
    11. function coinbase.ClientBase.prototype._stringToClass (name)
  10. module coinbase.Transfer
    1. function coinbase.Transfer (client, data, account)
  11. module coinbase.Transfer.prototype
    1. function coinbase.Transfer.prototype._commit (opts, callback)
  12. module coinbase.errorHandler
    1. function coinbase.errorHandler.handleError (err, obj, callback)
    2. function coinbase.errorHandler.handleHttpError (err, response, callback)
  13. module coinbase.model
    1. function coinbase.model.Account (client, data)
    2. function coinbase.model.Address (client, data, account)
    3. function coinbase.model.Buy (client, data, account)
    4. function coinbase.model.Checkout (client, data)
    5. function coinbase.model.Deposit (client, data, account)
    6. function coinbase.model.Merchant (client, data)
    7. function coinbase.model.Notification (client, data)
    8. function coinbase.model.Order (client, data)
    9. function coinbase.model.PaymentMethod (client, data)
    10. function coinbase.model.Sell (client, data, account)
    11. function coinbase.model.Transaction (client, data, account)
    12. function coinbase.model.User (client, data)
    13. function coinbase.model.Withdrawal (client, data, account)
  14. module coinbase.model.Account
    1. function coinbase.model.Account (client, data)
  15. module coinbase.model.Account.prototype
    1. function coinbase.model.Account.prototype.buy (args, callback)
    2. function coinbase.model.Account.prototype.createAddress (args, callback)
    3. function coinbase.model.Account.prototype.delete (callback)
    4. function coinbase.model.Account.prototype.deposit (args, callback)
    5. function coinbase.model.Account.prototype.getAddress (addressId, callback)
    6. function coinbase.model.Account.prototype.getAddresses (args, callback)
    7. function coinbase.model.Account.prototype.getBuy (buy_id, callback)
    8. function coinbase.model.Account.prototype.getBuys (args, callback)
    9. function coinbase.model.Account.prototype.getDeposit (deposit_id, callback)
    10. function coinbase.model.Account.prototype.getDeposits (args, callback)
    11. function coinbase.model.Account.prototype.getSell (sell_id, callback)
    12. function coinbase.model.Account.prototype.getSells (args, callback)
    13. function coinbase.model.Account.prototype.getTransaction (transaction_id, callback)
    14. function coinbase.model.Account.prototype.getTransactions (args, callback)
    15. function coinbase.model.Account.prototype.getWithdrawal (withdrawal_id, callback)
    16. function coinbase.model.Account.prototype.getWithdrawals (args, callback)
    17. function coinbase.model.Account.prototype.requestMoney (args, callback)
    18. function coinbase.model.Account.prototype.sell (args, callback)
    19. function coinbase.model.Account.prototype.sendMoney (args, callback, twoFactorAuth)
    20. function coinbase.model.Account.prototype.setPrimary (callback)
    21. function coinbase.model.Account.prototype.transferMoney (args, callback)
    22. function coinbase.model.Account.prototype.update (args, callback)
    23. function coinbase.model.Account.prototype.withdraw (args, callback)
  16. module coinbase.model.Address
    1. function coinbase.model.Address (client, data, account)
  17. module coinbase.model.Address.prototype
    1. function coinbase.model.Address.prototype.getTransactions (args, callback)
  18. module coinbase.model.Buy
    1. function coinbase.model.Buy (client, data, account)
  19. module coinbase.model.Buy.prototype
    1. function coinbase.model.Buy.prototype.commit (callback)
  20. module coinbase.model.Checkout
    1. function coinbase.model.Checkout (client, data)
  21. module coinbase.model.Checkout.prototype
    1. function coinbase.model.Checkout.prototype.createOrder (callback)
    2. function coinbase.model.Checkout.prototype.getOrders (args, callback)
  22. module coinbase.model.Deposit
    1. function coinbase.model.Deposit (client, data, account)
  23. module coinbase.model.Deposit.prototype
    1. function coinbase.model.Deposit.prototype.commit (callback)
  24. module coinbase.model.Order
    1. function coinbase.model.Order (client, data)
  25. module coinbase.model.Order.prototype
    1. function coinbase.model.Order.prototype.refund (args, callback)
  26. module coinbase.model.Sell
    1. function coinbase.model.Sell (client, data, account)
  27. module coinbase.model.Sell.prototype
    1. function coinbase.model.Sell.prototype.commit (callback)
  28. module coinbase.model.Transaction
    1. function coinbase.model.Transaction (client, data, account)
  29. module coinbase.model.Transaction.prototype
    1. function coinbase.model.Transaction.prototype.cancel (callback)
    2. function coinbase.model.Transaction.prototype.complete (callback)
    3. function coinbase.model.Transaction.prototype.resend (callback)
  30. module coinbase.model.User
    1. function coinbase.model.User (client, data)
  31. module coinbase.model.User.prototype
    1. function coinbase.model.User.prototype.showAuth (callback)
    2. function coinbase.model.User.prototype.update (args, callback)
  32. module coinbase.model.Withdrawal
    1. function coinbase.model.Withdrawal (client, data, account)
  33. module coinbase.model.Withdrawal.prototype
    1. function coinbase.model.Withdrawal.prototype.commit (callback)

module coinbase

function coinbase.AccountBase (client, data)

function coinbase.Base ()

function coinbase.Client (opts)

function coinbase.ClientBase (opts)

function coinbase.Transfer (client, data, account)

function coinbase.model.Account (client, data)

function coinbase.model.Address (client, data, account)

function coinbase.model.Buy (client, data, account)

function coinbase.model.Checkout (client, data)

function coinbase.model.Deposit (client, data, account)

function coinbase.model.Order (client, data)

function coinbase.model.Sell (client, data, account)

function coinbase.model.Transaction (client, data, account)

function coinbase.model.User (client, data)

function coinbase.model.Withdrawal (client, data, account)

module coinbase.AccountBase

function coinbase.AccountBase (client, data)

module coinbase.AccountBase.prototype

function coinbase.AccountBase.prototype._getAll (opts, callback, headers)

function coinbase.AccountBase.prototype._getOne (opts, callback, headers)

function coinbase.AccountBase.prototype._initTxn (args, callback, headers)

function coinbase.AccountBase.prototype._postOne (opts, callback, headers)

module coinbase.Base

function coinbase.Base ()

module coinbase.Base.prototype

function coinbase.Base.prototype.dumpJSON ()

function coinbase.Base.prototype.getProps ()

function coinbase.Base.prototype.hasField (obj, field)

function coinbase.Base.prototype.toString ()

module coinbase.Client

function coinbase.Client (opts)

module coinbase.Client.prototype

function coinbase.Client.prototype.createAccount (args, callback)

function coinbase.Client.prototype.createCheckout (args, callback)

function coinbase.Client.prototype.createOrder (args, callback)

function coinbase.Client.prototype.getAccount (account_id, callback)

function coinbase.Client.prototype.getAccounts (args, callback)

function coinbase.Client.prototype.getBuyPrice (params, callback)

function coinbase.Client.prototype.getCheckout (checkoutId, callback)

function coinbase.Client.prototype.getCheckouts (args, callback)

function coinbase.Client.prototype.getCurrencies (callback)

function coinbase.Client.prototype.getCurrentUser (callback)

function coinbase.Client.prototype.getExchangeRates (params, callback)

function coinbase.Client.prototype.getHistoricPrices (params, callback)

function coinbase.Client.prototype.getMerchant (merchantId, callback)

function coinbase.Client.prototype.getNotification (notificationId, callback)

function coinbase.Client.prototype.getNotifications (args, callback)

function coinbase.Client.prototype.getOrder (orderId, callback)

function coinbase.Client.prototype.getOrders (args, callback)

function coinbase.Client.prototype.getPaymentMethod (methodId, callback)

function coinbase.Client.prototype.getPaymentMethods (args, callback)

function coinbase.Client.prototype.getSellPrice (params, callback)

function coinbase.Client.prototype.getSpotPrice (params, callback)

function coinbase.Client.prototype.getTime (callback)

function coinbase.Client.prototype.getUser (userId, callback)

function coinbase.Client.prototype.refresh (callback)

function coinbase.Client.prototype.toString ()

function coinbase.Client.prototype.verifyCallback (body, signature)

module coinbase.ClientBase

function coinbase.ClientBase (opts)

module coinbase.ClientBase.prototype

function coinbase.ClientBase.prototype._deleteHttp (path, callback, headers)

function coinbase.ClientBase.prototype._generateReqOptions (url, path, body, method, headers)

function coinbase.ClientBase.prototype._generateSignature (path, method, bodyStr)

function coinbase.ClientBase.prototype._getAllHttp (opts, callback, headers)

function coinbase.ClientBase.prototype._getHttp (path, args, callback, headers)

function coinbase.ClientBase.prototype._getOneHttp (args, callback, headers)

function coinbase.ClientBase.prototype._postHttp (path, body, callback, headers)

function coinbase.ClientBase.prototype._postOneHttp (opts, callback, headers)

function coinbase.ClientBase.prototype._putHttp (path, body, callback, headers)

function coinbase.ClientBase.prototype._setAccessToken (path)

function coinbase.ClientBase.prototype._stringToClass (name)

module coinbase.Transfer

function coinbase.Transfer (client, data, account)

module coinbase.Transfer.prototype

function coinbase.Transfer.prototype._commit (opts, callback)

module coinbase.errorHandler

function coinbase.errorHandler.handleError (err, obj, callback)

function coinbase.errorHandler.handleHttpError (err, response, callback)

module coinbase.model

function coinbase.model.Account (client, data)

function coinbase.model.Address (client, data, account)

function coinbase.model.Buy (client, data, account)

function coinbase.model.Checkout (client, data)

function coinbase.model.Deposit (client, data, account)

function coinbase.model.Merchant (client, data)

function coinbase.model.Notification (client, data)

function coinbase.model.Order (client, data)

function coinbase.model.PaymentMethod (client, data)

function coinbase.model.Sell (client, data, account)

function coinbase.model.Transaction (client, data, account)

function coinbase.model.User (client, data)

function coinbase.model.Withdrawal (client, data, account)

module coinbase.model.Account

function coinbase.model.Account (client, data)

module coinbase.model.Account.prototype

function coinbase.model.Account.prototype.buy (args, callback)

function coinbase.model.Account.prototype.createAddress (args, callback)

function coinbase.model.Account.prototype.delete (callback)

function coinbase.model.Account.prototype.deposit (args, callback)

function coinbase.model.Account.prototype.getAddress (addressId, callback)

function coinbase.model.Account.prototype.getAddresses (args, callback)

function coinbase.model.Account.prototype.getBuy (buy_id, callback)

function coinbase.model.Account.prototype.getBuys (args, callback)

function coinbase.model.Account.prototype.getDeposit (deposit_id, callback)

function coinbase.model.Account.prototype.getDeposits (args, callback)

function coinbase.model.Account.prototype.getSell (sell_id, callback)

function coinbase.model.Account.prototype.getSells (args, callback)

function coinbase.model.Account.prototype.getTransaction (transaction_id, callback)

function coinbase.model.Account.prototype.getTransactions (args, callback)

function coinbase.model.Account.prototype.getWithdrawal (withdrawal_id, callback)

function coinbase.model.Account.prototype.getWithdrawals (args, callback)

function coinbase.model.Account.prototype.requestMoney (args, callback)

function coinbase.model.Account.prototype.sell (args, callback)

function coinbase.model.Account.prototype.sendMoney (args, callback, twoFactorAuth)

function coinbase.model.Account.prototype.setPrimary (callback)

function coinbase.model.Account.prototype.transferMoney (args, callback)

function coinbase.model.Account.prototype.update (args, callback)

function coinbase.model.Account.prototype.withdraw (args, callback)

module coinbase.model.Address

function coinbase.model.Address (client, data, account)

module coinbase.model.Address.prototype

function coinbase.model.Address.prototype.getTransactions (args, callback)

module coinbase.model.Buy

function coinbase.model.Buy (client, data, account)

module coinbase.model.Buy.prototype

function coinbase.model.Buy.prototype.commit (callback)

module coinbase.model.Checkout

function coinbase.model.Checkout (client, data)

module coinbase.model.Checkout.prototype

function coinbase.model.Checkout.prototype.createOrder (callback)

function coinbase.model.Checkout.prototype.getOrders (args, callback)

module coinbase.model.Deposit

function coinbase.model.Deposit (client, data, account)

module coinbase.model.Deposit.prototype

function coinbase.model.Deposit.prototype.commit (callback)

module coinbase.model.Order

function coinbase.model.Order (client, data)

module coinbase.model.Order.prototype

function coinbase.model.Order.prototype.refund (args, callback)

module coinbase.model.Sell

function coinbase.model.Sell (client, data, account)

module coinbase.model.Sell.prototype

function coinbase.model.Sell.prototype.commit (callback)

module coinbase.model.Transaction

function coinbase.model.Transaction (client, data, account)

module coinbase.model.Transaction.prototype

function coinbase.model.Transaction.prototype.cancel (callback)

function coinbase.model.Transaction.prototype.complete (callback)

function coinbase.model.Transaction.prototype.resend (callback)

module coinbase.model.User

function coinbase.model.User (client, data)

module coinbase.model.User.prototype

function coinbase.model.User.prototype.showAuth (callback)

function coinbase.model.User.prototype.update (args, callback)

module coinbase.model.Withdrawal

function coinbase.model.Withdrawal (client, data, account)

module coinbase.model.Withdrawal.prototype

function coinbase.model.Withdrawal.prototype.commit (callback)

[ this document was created with utility2 ]