NaNoWriMo Promotes Manuscription

    This package has been deprecated

    Author message:

    This package has been deprecated. Refer to the latest Coinbase API docs for support: https://docs.cloud.coinbase.com/sign-in-with-coinbase/docs

    coinbase
    DefinitelyTyped icon, indicating that this package has TypeScript declarations provided by the separate @types/coinbase package

    2.0.8 • Public • Published

    Coinbase

    The official Node.js library for the Coinbase API.

    Features

    • Full Test coverage.
    • Support for both API Key + Secret and OAuth 2 authentication.
    • Convenient methods for making calls to the API.
    • Automatic parsing of API responses into relevant Javascript objects.
    • Adheres to the nodejs error-first callback protocol.
    • Continuous Integration testing against node 0.10, 0.11, and 0.12.

    Installation

    npm install coinbase

    Version Compatibility

    Version GitHub repository
    2.0.x This repository
    0.1.x mateodelnorte/coinbase

    Npm coinbase package name used to refer to the unofficial coinbase library maintained by Matt Walters. Matt graciously allowed us to use the name for this package instead. You can still find that package on Github. Thanks, Matt.

    Quick Start

    The first thing you'll need to do is sign up for coinbase.

    API Key

    If you're writing code for your own Coinbase account, enable an API key. Next, create a Client object for interacting with the API:

    var Client = require('coinbase').Client;
    var client = new Client({'apiKey': mykey, 'apiSecret': mysecret});

    OAuth2

    If you're writing code that will act on behalf of another user, start by creating a new OAuth 2 application. You will need to do some work to obtain OAuth credentials for your users; while outside the scope of this document, please refer to our OAuth 2 tutorial and documentation. Once you have these credentials, create a client:

    var Client = require('coinbase').Client;
    var client = new Client({'accessToken': accessToken, 'refreshToken': refreshToken});

    Making API Calls

    With a client instance, you can now make API calls. We've included some examples below, but in general the library has Javascript prototypes for each of the objects described in our REST API documentation. These classes each have methods for making the relevant API calls; for instance, coinbase.model.Transaction.complete maps to the complete bitcoin request API endpoint. The comments of each method in the code references the endpoint it implements. Each API method returns an object representing the JSON response from the API.

    Listing available accounts

    var coinbase = require('coinbase');
    var client   = new coinbase.Client({'apiKey': mykey, 'apiSecret': mysecret});
     
    client.getAccounts({}, function(err, accounts) {
      accounts.forEach(function(acct) {
        console.log('my bal: ' + acct.balance.amount + ' for ' + acct.name);
      });
    });

    Get Balance from an Account Id

    var coinbase = require('coinbase');
    var client   = new coinbase.Client({'apiKey': mykey, 'apiSecret': mysecret});
     
    client.getAccount('<ACCOUNT ID>', function(err, account) {
      console.log('bal: ' + account.balance.amount + ' currency: ' + account.balance.currency);
    });

    Selling bitcoin

    var args = {
      "amount": "12",
      "currency": "BTC"
    };
    account.sell(args, function(err, xfer) {
      console.log('my xfer id is: ' + xfer.id);
    });

    Sending bitcoin

    var args = {
      "to": "user1@example.com",
      "amount": "1.234",
      "currency": "BTC",
      "description": "Sample transaction for you"
    };
    account.sendMoney(args, function(err, txn) {
      console.log('my txn id is: ' + txn.id);
    });

    Requesting bitcoin

    var args = {
      "to": "user1@example.com",
      "amount": "1.234",
      "currency": "BTC",
      "description": "Sample transaction for you"
    };
    account.requestMoney(args, function(err, txn) {
      console.log('my txn id is: ' + txn.id);
    });

    Listing current transactions

    account.getTransactions(null, function(err, txns) {
      txns.forEach(function(txn) {
        console.log('my txn status: ' + txn.status);
      });
    });

    Using pagination

    account.getTransactions(null, function(err, txns, pagination) {
      txns.forEach(function(txn) {
        console.log('my txn: ' + txn.id);
      });
      console.log(pagination.next_uri);
      account.getTransactions(pagination, function(err, txns) {
        txns.forEach(function(txn) {
          console.log('my txn: ' + txn.id);
        });
      });
    });

    Checking bitcoin prices

    client.getBuyPrice({'currencyPair': 'BTC-USD'}, function(err, obj) {
      console.log('total amount: ' + obj.data.amount);
    });

    Verifying merchant callback authenticity

    if (client.verifyCallback(req.raw_body, req.headers['CB-SIGNATURE'])) {
      // Process callback
    }

    Error Handling

    Errors are thrown for invalid arguments but are otherwise returned as the first argument to callback functions using http-errors module.

    Errors contain name, status, and message fields for error handling. You can find more information about error types here

    Testing / Contributing

    Any and all contributions are welcome! The process is simple:

    1. Fork this repo
    2. Make your changes and add tests
    3. Run the test suite
    4. Submit a pull request.

    Tests are run via mocha and nock. To run the tests, clone the repository and then:

    npm install

    npm test

    Please also scan the packages for known vulnerabilities.

    npm install -g nsp
    nsp check --output summary

    You can also run the tests against various node environments using the Dockerfile.example file.

    1. cp Dockerfile.example Dockerfile
    2. edit Dockerfile and uncomment the node version that interests you
    3. [sudo] docker build -t coinbase-node .
    4. [sudo] docker run -it coinbase-node

    Install

    npm i coinbase

    DownloadsWeekly Downloads

    2,605

    Version

    2.0.8

    License

    MIT

    Unpacked Size

    152 kB

    Total Files

    45

    Last publish

    Collaborators

    • coinbase-owner