https://github.com/ivoputzer/coinbase-pro-api
Lightweight Coinbase Pro API implementation wirtten in es6+
https://github.com/ivoputzer/coinbase-pro-api
api coinbase coinbase-pro coinbase-pro-api
Last synced: 11 months ago
JSON representation
Lightweight Coinbase Pro API implementation wirtten in es6+
- Host: GitHub
- URL: https://github.com/ivoputzer/coinbase-pro-api
- Owner: ivoputzer
- License: mit
- Created: 2018-06-23T20:42:12.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2019-01-18T21:55:29.000Z (over 7 years ago)
- Last Synced: 2025-06-28T02:49:07.749Z (12 months ago)
- Topics: api, coinbase, coinbase-pro, coinbase-pro-api
- Language: JavaScript
- Homepage: https://www.npmjs.com/package/coinbase-pro-api
- Size: 83 KB
- Stars: 25
- Watchers: 2
- Forks: 5
- Open Issues: 0
-
Metadata Files:
- Readme: readme.md
- License: license.md
Awesome Lists containing this project
README
coinbase-pro-api
===
Lightweight [Coinbase Pro API](https://docs.pro.coinbase.com/#api) implementation.
[](https://travis-ci.org/ivoputzer/coinbase-pro-api)
[](https://www.npmjs.com/package/coinbase-pro-api?activeTab=dependencies)
[](https://coveralls.io/github/ivoputzer/coinbase-pro-api?branch=master)
[](http://standardjs.com/)
[](https://nodejs.org/docs/v6.0.0/api)
[](https://www.npmjs.com/package/coinbase-pro-api)
[](https://spdx.org/licenses/MIT)
[](https://bundlephobia.com/scan-results?packages=coinbase-pro-api)
[](https://www.npmjs.com/package/coinbase-pro-api)
## Donations
If you find value in what I do then feel free to make a donation, it will be really appreciated! Maintaining projects isn't effortless nor free and if you'd like to kick in and help me cover those expenses, that would be awesome. If you don't, no problem; You can use my software completely free of charge and without limitation for any purpose you want ;)
- **BTC** `3BNL7UnYmByrdEguoEnA7S95WzdDYLmKuS`
- **LTC** `MEgxjro7E6z8Mfy4Uy8xaJPrskdwmrCers`
- **BCH** `qrtl83z594m7g4nv390xdg5mg7tywuwq5vzlsa82dp`
- **ETH** `0xeED2C60dd83e77F5650962E653b2a6F26A5c2f26`
- **ETC** `0x5B4224b376C0a32B70B0e25F6aEeCfc2d0131703`
- **ZRX** `0x345df25C52B81E045Bfb3C21b15343c4D114e43e`
- **BAT** `0xB23Bb1933bDF676502426AdcA2D7B3E0Ed18AfDF`
- **ZEC** `t1h78dUWEY9hA2UZVyNazbgAfZNmicEK6qA`
- **USDC** `0x7fb93FfBcFa9A537ddFaC9678b1C27DF776eE626`
## Installation
```sh
npm install coinbase-pro-api
```
## Usage
This library allows you to use both [public](#public-endpoints) and [private](#private-endpoints) endpoints as well as the [sandbox environment](https://docs.pro.coinbase.com/#sandbox) for testing connectivity and trading. You can learn about query parameters and responses of each endpoint in the [official documentation](https://docs.pro.coinbase.com).
## Public Endpoints
Public endpoints do not require authentication and can be used right away without further configuration.
#### .getProducts([query[, env[, parser=JSON[, stringifier=QS]]]])
```js
const { getProducts } = require('coinbase-pro-api')
getProducts()
```
[» query params and responses](https://docs.pro.coinbase.com/#get-products)
#### .getProductOrderBook(productId[, query[, env[, parser=JSON[, stringifier=QS]]]])
```js
const { getProductOrderBook } = require('coinbase-pro-api')
getProductOrderBook('BTC-EUR', { level: 3 })
```
[» query params and responses](https://docs.pro.coinbase.com/#get-product-order-book)
#### .getProductTicker(productId[, query[, env[, parser=JSON[, stringifier=QS]]]])
```js
const { getProductTicker } = require('coinbase-pro-api')
getProductTicker('BTC-EUR')
```
[» query params and responses](https://docs.pro.coinbase.com/#get-product-ticker)
#### .getProductTrades(productId[, query[, env[, parser=JSON[, stringifier=QS]]]])
```js
const { getProductTrades } = require('coinbase-pro-api')
getProductTrades('BTC-EUR', { after: 1000 })
```
[» query params and responses](https://docs.pro.coinbase.com/#get-trades)
#### .getProductHistoricRates(productId[, query[, env[, parser=JSON[, stringifier=QS]]]])
```js
const { getProductHistoricRates } = require('coinbase-pro-api')
getProductHistoricRates('BTC-EUR', { granularity: 3600 })
```
[» query params and responses](https://docs.pro.coinbase.com/#get-historic-rates)
#### .getProduct24HrStats(productId[, query[, env[, parser=JSON[, stringifier=QS]]]])
```js
const { getProduct24HrStats } = require('coinbase-pro-api')
getProduct24HrStats('BTC-EUR')
```
[» query params and responses](https://docs.pro.coinbase.com/#get-24hr-stats)
#### .getCurrencies([query[, env[, parser=JSON[, stringifier=QS]]]])
```js
const { getCurrencies } = require('coinbase-pro-api')
getCurrencies()
```
[» query params and responses](https://docs.pro.coinbase.com/#get-currencies)
#### .getTime([query[, env[, parser=JSON[, stringifier=QS]]]])
```js
const { getTime } = require('coinbase-pro-api')
getTime()
```
[» query params and responses](https://docs.pro.coinbase.com/#time)
## Private Endpoints
The private endpoints require authentication. You will need to configure your `coinbase-pro-api` installation by providing a configuration.
#### .getCoinbaseAccounts([query[, env[, parser=JSON[, stringifier=QS]]]])
```js
const { getCoinbaseAccounts } = require('coinbase-pro-api')
getCoinbaseAccounts()
```
[» query params and responses](https://docs.pro.coinbase.com/#coinbase-accounts)
#### .getPaymentMethods([query[, env[, parser=JSON[, stringifier=QS]]]])
```js
const { getPaymentMethods } = require('coinbase-pro-api')
getPaymentMethods()
```
[» query params and responses](https://docs.pro.coinbase.com/#payment-methods)
#### .getAccounts([query[, env[, parser=JSON[, stringifier=QS]]]])
```js
const { getAccounts } = require('coinbase-pro-api')
getAccounts()
```
[» query params and responses](https://docs.pro.coinbase.com/#list-accounts)
#### .getAccount(accountId[, query[, env[, parser=JSON[, stringifier=QS]]]])
```js
const { getAccount } = require('coinbase-pro-api')
getAccount('7d0f7d8e-dd34-4d9c-a846-06f431c381ba')
```
[» query params and responses](https://docs.pro.coinbase.com/#get-an-account)
#### .getAccountHistory(accountId[, query[, env[, parser=JSON[, stringifier=QS]]]])
```js
const { getAccountHistory } = require('coinbase-pro-api')
getAccountHistory('7d0f7d8e-dd34-4d9c-a846-06f431c381ba', { before: 3000 })
```
[» query params and responses](https://docs.pro.coinbase.com/#get-account-history)
#### .getAccountTransfers(accountId[, query[, env[, parser=JSON[, stringifier=QS]]]])
```js
const { getAccountTransfers } = require('coinbase-pro-api')
getAccountTransfers('7d0f7d8e-dd34-4d9c-a846-06f431c381ba', { before: 3000 })
```
[» query params and responses](https://docs.pro.coinbase.com/#get-account-transfers)
#### .getAccountHolds(accountId[, query[, env[, parser=JSON[, stringifier=QS]]]])
```js
const { getAccountHolds } = require('coinbase-pro-api')
getAccountHolds('7d0f7d8e-dd34-4d9c-a846-06f431c381ba', { before: 3000 })
```
[» query params and responses](https://docs.pro.coinbase.com/#get-holds)
#### .placeOrder(data[, env[, parser=JSON[, stringifier=JSON]]])
```js
const { placeOrder } = require('coinbase-pro-api')
// Buy 1 LTC @ 20 EUR
placeOrder({ side: 'buy', size: '1', price: '20.00', product_id: 'LTC-EUR' })
// Sell 1 LTC @ 20 EUR
placeOrder({ side: 'sell', size: '1', price: '20.00', product_id: 'LTC-EUR' })
```
[» query params and responses](https://docs.pro.coinbase.com/#place-a-new-order)
#### .cancelOrder(orderId[, query[, env[, parser=JSON[, stringifier=QS]]]])
```js
const { cancelOrder } = require('coinbase-pro-api')
cancelOrder('d50ec984-77a8-460a-b958-66f114b0de9b')
```
[» query params and responses](https://docs.pro.coinbase.com/#cancel-an-order)
#### .cancelOrders([query[, env[, parser=JSON[, stringifier=QS]]]])
```js
const { cancelOrders } = require('coinbase-pro-api')
cancelOrders()
```
[» query params and responses](https://docs.pro.coinbase.com/#cancel-all)
#### .getOrders([query[, env[, parser=JSON[, stringifier=QS]]]])
```js
const { getOrders } = require('coinbase-pro-api')
getOrders({ after: 3000, status: 'open' })
```
[» query params and responses](https://docs.pro.coinbase.com/#list-open-orders)
#### .getOrder(orderId[, query[, env[, parser=JSON[, stringifier=QS]]]])
```js
const { getOrder } = require('coinbase-pro-api')
getOrder('d50ec984-77a8-460a-b958-66f114b0de9b')
```
[» query params and responses](https://docs.pro.coinbase.com/#get-an-order)
#### .getFills([query[, env[, parser=JSON[, stringifier=QS]]]])
```js
const { getFills } = require('coinbase-pro-api')
getFills({ product_id: 'LTC-EUR', before: 3000 })
```
[» query params and responses](https://docs.pro.coinbase.com/#list-fills)
#### .convert([query[, env[, parser=JSON[, stringifier=QS]]]])
```js
const { convert } = require('coinbase-pro-api')
convert({from: 'USD', to: 'USDC', amount: '100' })
```
[» query params and responses](https://docs.pro.coinbase.com/#create-conversion)
## Configuration
Configurations such as credentials and environments follow the [npm configuration guideline](https://docs.npmjs.com/files/npmrc.html). Configurations can be set via [command line](#command-line), [environment variables](#environment-variables) and [`npmrc` files](#npmrc). To create an api key unique to your trading account refer to [this guide](https://support.pro.coinbase.com/customer/en/portal/articles/2945320-how-do-i-create-an-api-key-for-coinbase-pro).
- `sandbox` (optional) can be set to either `true`, `yes` and `1` to switch to sandbox environment;
- `hostname` (optional) allows to override default coinbase-pro hostname;
- `key` (mandatory for private endpoints only) coinbase-pro api key unique to your trading account;
- `passphrase` (mandatory for private endpoints only) coinbase-pro api passphrase unique to your trading account;
- `secret` (mandatory for private endpoints only) coinbase-pro api secret unique to your trading account;
#### command line
```shell
npm config set coinbase-pro-api:sandbox false
npm config set coinbase-pro-api:hostname api.pro.coinbase.com
npm config set coinbase-pro-api:key key
npm config set coinbase-pro-api:passphrase passphrase
npm config set coinbase-pro-api:secret secret
```
#### environment variables
```shell
env npm_config_coinbase_pro_api_sandbox="false" \
npm_config_coinbase_pro_api_hostname="api.pro.coinbase.com" \
npm_config_coinbase_pro_api_key="key" \
npm_config_coinbase_pro_api_passphrase="passphrase" \
npm_config_coinbase_pro_api_secret="secret" \
node script.js
```
#### npmrc
```ini
coinbase-pro-api:sandbox="false"
coinbase-pro-api:hostname="api.pro.coinbase.com"
coinbase-pro-api:key="key"
coinbase-pro-api:passphrase="passphrase"
coinbase-pro-api:secret="secret"
```
## Submodule Util
The `util` submodule is primarily designed to support the needs of [coinbase-pro-api](#coinbase-pro-api) own internal APIs. However, many of the utilities are useful for application and module developers as well. It can be accessed using:
```js
const util = require('coinbase-pro-api/util')
```
#### .configurationFor(options)
This utility generates an npm-like configuration object that can be used to override the internal configuration management:
```js
const { configurationFor } = require('coinbase-pro-api/util')
const env = configurationFor({
sandbox: false,
hostname: 'api.pro.coinbase.com',
key: 'key',
passphrase: 'passphrase',
secret: 'secret'
})
getAccounts(query, env)
.then(console.log)
.catch(console.error)
```
#### .signatureFor(options[, env[, crypto]])
This utility generates a base64 encoded sha256 hmac signature [compatible with coinbase-pro](https://docs.pro.coinbase.com/#signing-a-message):
```js
const timestamp = 1e-3 * Date.now()
const method = 'get'
const path = '/api/endpoint'
const body = '?query=string'
const signature = signatureFor({ timestamp, method, path, body}, configurationFor({ secret }))
```
[» selecting a timestamp](https://docs.pro.coinbase.com/#selecting-a-timestamp)
## Document submodule coinbase-pro-api/client
The `client` submodule is primarily designed to support the needs of [coinbase-pro-api](#coinbase-pro-api) own internal APIs. However, many of the utilities are useful for application and module developers as well. It can be accessed using:
```js
const util = require('coinbase-pro-api/client')
```
#### .request(options[, env])
This utility wraps [https.request](https://nodejs.org/api/https.html#https_https_request_options_callback) and returns a promise that resolves into [https.ClientRequest](https://nodejs.org/api/http.html#http_class_http_clientrequest).
```js
const { request } = require('coinbase-pro-api/client')
request({ method: 'get', path: '/products' })
.then(res => res.pipe(process.stdout))
.catch(console.error)
```