TypeScript SDK

Install the package

Code
npm install @coinmarketcap/sdk

Or with Yarn / pnpm:

Code
yarn add @coinmarketcap/sdk
pnpm add @coinmarketcap/sdk

Create a client

Set your API key from the Developer Portal. For keyless endpoints, use environment: 'public'.

Code
import { CoinMarketCap } from "@coinmarketcap/sdk";

const cmc = new CoinMarketCap({
  apiKey: process.env.CMC_PRO_API_KEY!,
});

Call an endpoint

Endpoints are grouped under cmc.api:

Code
const { data, error } = await cmc.api.cryptocurrency.quotesLatest({
  query: { id: "1,1027" },
});

if (data) {
  console.log(data);
}

Or throw on error:

Code
const { data } = await cmc.api.cryptocurrency.quotesLatest({
  query: { id: "1" },
  throwOnError: true,
});

Handle errors

The SDK returns typed error classes (or throws when throwOnError: true):

Code
import { RateLimitError, AuthenticationError, CMCError } from "@coinmarketcap/sdk";

const { data, error } = await cmc.api.cryptocurrency.quotesLatest({
  query: { id: "1" },
});

if (error instanceof RateLimitError) {
  // 429 — check Retry-After header
} else if (error instanceof AuthenticationError) {
  // 401 — check your API key
} else if (error instanceof CMCError) {
  console.log(error.status, error.message);
}