coinbase-pro-node-api

Node.js library for Coinbase Pro

Installation

npm install coinbase-pro-node-api

Usage

PublicClient

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

• getProducts

const products = await client.getProducts();

• getProduct

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

• getOrderBook

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

• getTicker

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

• getTrades

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

• getHistoricRates

const product_id = "ETH-BTC";
const end = "2019-11-12T16:40:00-0500";
const start = "2019-11-12T16:37:00-0500";
const granularity = 60;
const candles = await client.getHistoricRates({
  product_id,
  end,
  start,
  granularity,
});

• get24hrStats

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

• getCurrencies

const currencies = await client.getCurrencies();

• getCurrency

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

• getTime

const time = await client.getTime();

AuthenticatedClient

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

• getAccounts

const accounts = await client.getAccounts();

• getAccount

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

• getAccountHistory

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

• getHolds

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

• placeOrder

const client_oid = "71452118-efc7-4cc4-8780-a5e22d4baa53";
const type = "limit";
const side = "buy";
const product_id = "BTC-USD";
const stp = "cb";
const price = 10000;
const size = 1;
const post_only = true;
const cancel_after = "hour";
const order = await client.placeOrder({
  client_oid,
  type,
  side,
  product_id,
  stp,
  price,
  size,
  post_only,
  cancel_after,
});

• cancelOrder

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

• cancelAll

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

• getOrders

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

• getOrder

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

• getFills

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

• deposit

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

• depositCoinbase

const amount = 10;
const currency = "BTC";
const coinbase_account_id = "c13cd0fc-72ca-55e9-843b-b84ef628c198";
const deposit = await client.depositCoinbase({
  amount,
  currency,
  coinbase_account_id,
});

• withdraw

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

• withdrawCoinbase

const amount = 10;
const currency = "BTC";
const coinbase_account_id = "c13cd0fc-72ca-55e9-843b-b84ef628c198";
const withdraw = await client.withdrawCoinbase({
  amount,
  currency,
  coinbase_account_id,
});

• withdrawCrypto

const amount = 20000;
const currency = "XRP";
const crypto_address = "r4hzEbkVkAaFyK23ZkgED2LZDAyHTfnBJg";
const no_destination_tag = true;
const withdraw = await client.withdrawCrypto({
  amount,
  currency,
  crypto_address,
  no_destination_tag,
});

• feeEstimate

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

• convert

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

• getPaymentMethods

const methods = await client.getPaymentMethods();

• getCoinbaseAccounts

const accounts = await client.getCoinbaseAccounts();

• getFees

const fees = await client.getFees();

• createReport

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

• getReport

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

• getProfiles

const profiles = await client.getProfiles();

• getProfile

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

• transfer

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

• getTrailingVolume

const volume = await client.getTrailingVolume();

WebsocketClient

import { WebsocketClient } from "coinbase-pro-node-api";
const sandbox = false;
const key = "CoinbaseProAPIKey";
const secret = "CoinbaseProAPISecret";
const passphrase = "CoinbaseProAPIPassphrase";
const channels = [
  { name: "status" },
  { name: "ticker", product_ids: ["BTC-USD"] },
];
const websocket = new WebsocketClient({
  key,
  secret,
  passphrase,
  channels,
  sandbox,
});

• connect

await websocket.connect();

• disconnect

await websocket.disconnect();

• subscribe

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

• unsubscribe

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