coinbase-pro-node-api

Node.js library for Coinbase Pro

Installation

1npm install coinbase-pro-node-api

Usage

PublicClient

1import { PublicClient } from "coinbase-pro-node-api";
2const sandbox = true;
3const client = new PublicClient({ sandbox });

• getProducts

1const products = await client.getProducts();

• getProduct

1const product_id = "ETH-BTC";
2const product = await client.getProduct({ product_id });

• getOrderBook

1const level = 2;
2const book = await client.getOrderBook({ level });

• getTicker

1const product_id = "ETH-BTC";
2const ticker = await client.getTicker({ product_id });

• getTrades

1const product_id = "ETH-BTC";
2const limit = 10;
3const after = 74;
4const trades = await client.getTrades({ product_id, limit, after });

• getHistoricRates

1const product_id = "ETH-BTC";
2const end = "2019-11-12T16:40:00-0500";
3const start = "2019-11-12T16:37:00-0500";
4const granularity = 60;
5const candles = await client.getHistoricRates({
6  product_id,
7  end,
8  start,
9  granularity,
10});

• get24hrStats

1const product_id = "ETH-BTC";
2const stats = await client.get24hrStats({ product_id });

• getCurrencies

1const currencies = await client.getCurrencies();

• getCurrency

1const id = "BTC";
2const currency = await client.getCurrency({ id });

• getTime

1const time = await client.getTime();

AuthenticatedClient

1import { AuthenticatedClient } from "coinbase-pro-node-api";
2const key = "CoinbaseProAPIKey";
3const secret = "CoinbaseProAPISecret";
4const passphrase = "CoinbaseProAPIPassphrase";
5const client = new AuthenticatedClient({ key, secret, passphrase });

• getAccounts

1const accounts = await client.getAccounts();

• getAccount

1const account_id = "71452118-efc7-4cc4-8780-a5e22d4baa53";
2const account = await client.getAccount({ account_id });

• getAccountHistory

1const account_id = "71452118-efc7-4cc4-8780-a5e22d4baa53";
2const after = "100";
3const limit = 5;
4const history = await client.getAccountHistory({ account_id, after, limit });

• getHolds

1const account_id = "71452118-efc7-4cc4-8780-a5e22d4baa53";
2const after = "2019-11-22T14:33:58.093436Z";
3const before = "2019-11-21T14:33:58.093436Z";
4const limit = 40;
5const holds = await client.getHolds({ account_id, after, before, limit });

• placeOrder

1const client_oid = "71452118-efc7-4cc4-8780-a5e22d4baa53";
2const type = "limit";
3const side = "buy";
4const product_id = "BTC-USD";
5const stp = "cb";
6const price = 10000;
7const size = 1;
8const post_only = true;
9const cancel_after = "hour";
10const order = await client.placeOrder({
11  client_oid,
12  type,
13  side,
14  product_id,
15  stp,
16  price,
17  size,
18  post_only,
19  cancel_after,
20});

• cancelOrder

1const id = "71452118-efc7-4cc4-8780-a5e22d4baa53";
2let result = await client.cancelOrder({ id });
3// or by `client_oid`
4const client_oid = "5523db2a-f6cb-4680-86a5-23ff21d9f514";
5result = await client.cancelOrder({ client_oid });

• cancelAll

1const product_id = "BTC-USD";
2const result = await client.cancelAll({ product_id });

• getOrders

1const limit = 2;
2const after = "2019-09-29T19:16:37.991967Z";
3const status = ["done", "rejected"];
4const product_id = "BTC-USD";
5const orders = await client.getOrders({ after, product_id, limit, status });

• getOrder

1const id = "71452118-efc7-4cc4-8780-a5e22d4baa53";
2let order = await client.getOrder({ id });
3// or by `client_oid`
4const client_oid = "5523db2a-f6cb-4680-86a5-23ff21d9f514";
5order = await client.getOrder({ client_oid });

• getFills

1const product_id = "BTC-ETH";
2const before = 74;
3const fills = await client.getFills({ product_id, before });

• deposit

1const amount = 10000;
2const currency = "USD";
3const payment_method_id = "bc677162-d934-5f1a-968c-a496b1c1270b";
4const deposit = await client.deposit({ amount, currency, payment_method_id });

• depositCoinbase

1const amount = 10;
2const currency = "BTC";
3const coinbase_account_id = "c13cd0fc-72ca-55e9-843b-b84ef628c198";
4const deposit = await client.depositCoinbase({
5  amount,
6  currency,
7  coinbase_account_id,
8});

• withdraw

1const amount = 10000;
2const currency = "USD";
3const payment_method_id = "bc677162-d934-5f1a-968c-a496b1c1270b";
4const withdraw = await client.withdraw({ amount, currency, payment_method_id });

• withdrawCoinbase

1const amount = 10;
2const currency = "BTC";
3const coinbase_account_id = "c13cd0fc-72ca-55e9-843b-b84ef628c198";
4const withdraw = await client.withdrawCoinbase({
5  amount,
6  currency,
7  coinbase_account_id,
8});

• withdrawCrypto

1const amount = 20000;
2const currency = "XRP";
3const crypto_address = "r4hzEbkVkAaFyK23ZkgED2LZDAyHTfnBJg";
4const no_destination_tag = true;
5const withdraw = await client.withdrawCrypto({
6  amount,
7  currency,
8  crypto_address,
9  no_destination_tag,
10});

• feeEstimate

1const currency = "ETH";
2const crypto_address = "0x5ad5769cd04681FeD900BCE3DDc877B50E83d469";
3const estimate = await client.feeEstimate({ currency, crypto_address });

• convert

1const amount = 100;
2const from = "USD";
3const to = "USDC";
4const conversion = await client.convert({ amount, from, to });

• getPaymentMethods

1const methods = await client.getPaymentMethods();

• getCoinbaseAccounts

1const accounts = await client.getCoinbaseAccounts();

• getFees

1const fees = await client.getFees();

• createReport

1const type = "fills";
2const start_date = "2019-01-01T00:00:00.000Z";
3const end_date = "2019-11-30T23:59:59.000Z";
4const report = await client.createReport({ type, start_date, end_date });

• getReport

1const id = "0428b97b-bec1-429e-a94c-59232926778d";
2const report = await client.getReport({ id });

• getProfiles

1const profiles = await client.getProfiles();

• getProfile

1const id = "86602c68-306a-4500-ac73-4ce56a91d83c";
2const profile = await client.getProfile({ id });

• transfer

1const from = "86602c68-306a-4500-ac73-4ce56a91d83c";
2const to = "e87429d3-f0a7-4f28-8dff-8dd93d383de1";
3const currency = "ETH";
4const amount = 100;
5const result = await client.transfer({ from, to, currency, amount });

• getTrailingVolume

1const volume = await client.getTrailingVolume();

WebsocketClient

1import { WebsocketClient } from "coinbase-pro-node-api";
2const sandbox = false;
3const key = "CoinbaseProAPIKey";
4const secret = "CoinbaseProAPISecret";
5const passphrase = "CoinbaseProAPIPassphrase";
6const channels = [
7  { name: "status" },
8  { name: "ticker", product_ids: ["BTC-USD"] },
9];
10const websocket = new WebsocketClient({
11  key,
12  secret,
13  passphrase,
14  channels,
15  sandbox,
16});

• connect

1await websocket.connect();

• disconnect

1await websocket.disconnect();

• subscribe

1const channels = [
2  { name: "heartbeat", product_ids: ["ETH-USD"] },
3  { name: "ticker", product_ids: ["ETH-EUR"] },
4  { name: "status" },
5];
6await websocket.subscribe({ channels });

• unsubscribe

1const channels = [{ name: "ticker", product_ids: ["ETH-USD", "ETH-EUR"] }];
2await websocket.unsubscribe({ channels });