Skip to content

Latest commit

 

History

History
241 lines (163 loc) · 10.1 KB

README.md

File metadata and controls

241 lines (163 loc) · 10.1 KB
Raw

Important

On 2022-06-22 Coinbase announced that it will discontinue the Pro API in favor of its Advanced Trade API.

With this news the coinbase-pro-node package, which has been serving users effectively since 2019-04-11, will become non functional.

Luckily, the code of this library is open-source, allowing you to fork it and tailor it to the new Advanced Trade API. Coinbase offers a Pro to Advanced Trade API Mapping guide to assist in this process.

Coinbase API

Language Details Code Coverage License Package Version

🌟 Better than the original Coinbase API. See why. 🌟

Community-maintained Coinbase API for Node.js & Deno, written in TypeScript and covered by tests.

Motivation

The purpose of this coinbase-pro-node package is to maintain a recent Coinbase API for Node.js with type safety through TypeScript.

Features

  • ✅ Typed. Source code is 100% TypeScript. No need to install external typings.
  • ✅ Tested. Code coverage is 100%. No surprises when using "coinbase-pro-node".
  • ✅ Convenient. Request throttling is built-in. Don't worry about rate limiting.
  • ✅ Comfortable. More than an API client. You will get extras like candle watching.
  • ✅ Maintained. Automated security updates. No threats from outdated dependencies.
  • ✅ Documented. Get started with demo scripts and generated documentation.
  • ✅ Modern. HTTP client with Promise API. Don't lose yourself in callback hell.
  • ✅ Robust. WebSocket reconnection is built-in. No problems if your Wi-Fi is gone.
  • ✅ Reliable. Following semantic versioning. Get notified about breaking changes.

Installation

npm

npm install coinbase-pro-node

Yarn

yarn add coinbase-pro-node

Setup

JavaScript

const {CoinbasePro} = require('coinbase-pro-node');
const client = new CoinbasePro();

TypeScript

import {CoinbasePro} from 'coinbase-pro-node';
const client = new CoinbasePro();

Usage

The demo section provides many examples on how to use "coinbase-pro-node". There is also an automatically generated API documentation. For a quick start, here is a simple example for a REST request:

REST Example

import {CoinbasePro} from 'coinbase-pro-node';

// API Keys can be generated here:
// https://pro.coinbase.com/profile/api
// https://public.sandbox.pro.coinbase.com/profile/api
const auth = {
  apiKey: '',
  apiSecret: '',
  passphrase: '',
  // The Sandbox is for testing only and offers a subset of the products/assets:
  // https://docs.cloud.coinbase.com/exchange/docs#sandbox
  useSandbox: true,
};

const client = new CoinbasePro(auth);

client.rest.account.listAccounts().then(accounts => {
  const message = `You can trade "${accounts.length}" different pairs.`;
  console.log(message);
});

WebSocket Example

If you want to listen to WebSocket messages, have a look at these demo scripts:

Demos

All demo scripts are executable from the root directory. If you want to use specific credentials with a demo script, simply add a .env file to the root of this package to modify environment variables used in init-client.ts.

npx ts-node ./src/demo/dump-candles.ts

Tip: There is a .env.defaults file which serves as a template. Just remove its .defaults extension and enter your credentials to get started. Do not commit this file (or your credentials) to any repository!

Web Frontend Applications

The "coinbase-pro-node" library was built to be used in Node.js environments BUT you can also make use of it in web frontend applications (using React, Vue.js, etc.). However, due to the CORS restrictions of modern web browser, you will have to use a proxy server.

A proxy server can be setup with webpack's DevServer proxy configuration or http-proxy-middleware.

Here is an example:

Backend

import {createProxyMiddleware} from 'http-proxy-middleware';
import express from 'express';

const app = express();

app.use(
  '/api-coinbase-pro',
  createProxyMiddleware({
    target: 'https://api.exchange.coinbase.com',
    changeOrigin: true,
    pathRewrite: {
      [`^/api-coinbase-pro`]: '',
    },
  })
);

Later on, you can use the proxy URL (/api-coinbase-pro from above) in your web application to initialize "coinbase-pro-node" with it:

Frontend

const client = new CoinbasePro({
  httpUrl: '/api-coinbase-pro',
  apiKey: '',
  apiSecret: '',
  passphrase: '',
  useSandbox: false,
});

Real-world Examples

Checkout GitHub's dependency graph to see who uses "coinbase-pro-node" in production. There are also npm packages depending on "coinbase-pro-node".

Maintainers

Benny Neugebauer on Stack Exchange

Stargazers

Stargazers

Contributing

Contributions, issues and feature requests are welcome!

Feel free to check the issues page.

The following commits will help you getting started quickly with the code base:

All resources can be found in the Coinbase Exchange API reference. For the latest updates, check Coinbase's API Changelog.

License

This project is MIT licensed.

⭐️ Show your support ⭐️

Please leave a star if you find this project useful.

If you like this project, you might also like these related projects:

  • trading-signals, Technical indicators, written in TypeScript, with arbitrary-precision arithmetic.
  • ig-trading-api, REST API, written in TypeScript, for CFD trading with IG.
  • binance-api-node, Heavily tested and Promise-based Binance API with TypeScript definitions.

Problems with official Coinbase APIs

There are official Coinbase APIs for Node.js, but they all come with some disadvantages leading to decreased developer experience (DX):

  1. Coinbase's first Node.js API has no type safety and got deprecated on July, 19th 2016
  2. Coinbase's second Node.js API has no type safety and got deprecated on January, 16 2020
  3. Coinbase's current Node.js API (OAS spec) still lacks type safety and does not incorporate best practices like automatic reconnections and request throttling

Official Coinbase API

Coinbase is versioning its API through ReadMe.com, so you can generate an API client from their OpenAPI Specification. ReadMe provides a Node.js package named "api" which allows you to retrieve an automatically generated Node.js client:

Installation

npm install api@^4.5.1

Usage

import api from 'api';

const sdk = api('@coinbase-exchange/v1.0#qgumw1pl3iz4yut');

sdk['ExchangeRESTAPI_GetProductTrades']({
  product_id: 'BTC-USD',
}).then(response => {
  console.log(`Found "${response.length}" trades.`);
});

Drawbacks

The current Coinbase Node.js SDK (provided by the api package) does not support typings for response payloads:

Official Coinbase API