CoinGecko

Installation

npm install @coingecko/coingecko-typescript

Usage

The full API of this library can be found in api.md.

import Coingecko from '@coingecko/coingecko-typescript';
const client = new Coingecko({
  proAPIKey: process.env['COINGECKO_PRO_API_KEY'], // demoAPIKey: process.env['COINGECKO_DEMO_API_KEY'], // Optional, for Demo API access
  environment: 'pro', // 'demo' to initialize the client with Demo API access
});

async function main() {
  const price = await client.simple.price.get({ vs_currencies: 'usd', ids: 'bitcoin' });
  console.log(price);
}
main();

Request & Response types

This library includes TypeScript definitions for all request params and response fields. You may import and use them like so:

import Coingecko from '@coingecko/coingecko-typescript';
const client = new Coingecko({
  proAPIKey: process.env['COINGECKO_PRO_API_KEY'], // demoAPIKey: process.env['COINGECKO_DEMO_API_KEY'], // Optional, for Demo API access
  environment: 'pro', // 'demo' to initialize the client with Demo API access
});
const params: Coingecko.Simple.PriceGetParams = { vs_currencies: 'usd', ids: 'bitcoin' };
const price: Coingecko.Simple.PriceGetResponse = await client.simple.price.get(params);

Documentation for each method, request param, and response field are available in docstrings and will appear on hover in most modern editors.