Overview

• IDs are stable, tickers are not. Several assets can share a ticker, so a lookup by symbol can return more than one. cryptocurrency.map resolves a ticker to the CMC IDs the other operations take.
• quote changes shape by route. The /v3 routes return an array with one entry per requested currency, and each entry names its currency with id and symbol. The /v1 and /v2 routes return an object keyed by currency symbol. This plugin passes each through unchanged.
• data changes shape too. cryptocurrency.info and exchange.info are keyed by the identifier passed, and a symbol or address lookup wraps each key’s value in an array. Both operations flatten that into one list and keep the provider’s key as lookup_key.
• Credits. A listing costs one credit per 250 assets returned and one more per extra convert currency. key.info reports the plan limits and what is left this minute, today and this month.
• Rate limits. CoinMarketCap answers 429 with an error_code that says which limit was hit. 1008 (per minute) and 1011 (per IP) are retried up to twice, using Retry-After when present and the documented 60 second window otherwise. 1009 (daily limit), 1010 (monthly limit) and 1022 (anonymous allowance) are not retried, because waiting out one window cannot clear them.
• Plans. exchange.info needs a paid plan: a Basic key gets 403 error_code 1005 for it. Every other operation here works on Basic.
• Empty results. A filter that matches nothing is a success: the route answers data: [] with error_code "0", and this plugin returns an empty list. A body with a success status and no data field at all is malformed, and the call throws instead of reporting an empty page.
• key.info costs no credits. On a paid plan it reports rate_limit_minute and credit_limit_monthly, plus what is left this minute and this month. The daily object carries credits_used only, with no credits_left, so this plugin types that field as optional.

• 8 typed API operations

​

Setup

npm install corsair @corsair-dev/coinmarketcap better-sqlite3
npm install --save-dev @types/better-sqlite3

yarn add corsair @corsair-dev/coinmarketcap better-sqlite3
yarn add --dev @types/better-sqlite3

pnpm install corsair @corsair-dev/coinmarketcap better-sqlite3
pnpm install --save-dev @types/better-sqlite3

bun add corsair @corsair-dev/coinmarketcap better-sqlite3
bun add --dev @types/better-sqlite3

import Database from 'better-sqlite3';
import { createCorsair } from 'corsair';
import { coinmarketcap } from '@corsair-dev/coinmarketcap';

export const corsair = createCorsair({
	plugins: [
		coinmarketcap(),
	],
	database: new Database('corsair.db'),
	kek: process.env.CORSAIR_KEK!,
	multiTenancy: true,
	hub: {
		projectApiKey: process.env.CORSAIR_API_KEY!,
		signingSecret: process.env.CORSAIR_SIGNING_SECRET!,
	},
});

coinmarketcap()

const { connectUrl } = await corsair.manage.connect.createLink({
	plugin: 'coinmarketcap',
	tenantId: 'acme',
});
// redirect the user's browser to connectUrl

​

Example API calls

const tenant = corsair.withTenant('acme');
await tenant.coinmarketcap.api.cryptocurrency.listings({ limit: 10 });

const tenant = corsair.withTenant('acme');
await tenant.coinmarketcap.api.tools.priceConversion({
	amount: 1,
	id: 1,
	convert: ['USD'],
});

​

What’s next