A Node.js wrapper for the CoinGecko API with no dependencies.

Latest version: 1.0.1

npm install coingecko-api

For complete API documentation, up-to-date parameters, responses and errors, please refer to https://www.coingecko.com/api/docs/v3.

//1. Import coingecko-api
const CoinGecko = require('coingecko-api');

//2. Initiate the CoinGecko API Client
const CoinGeckoClient = new CoinGecko();

//3. Make calls
var func = async() => {
  let data = await CoinGeckoClient.ping();
};

This module provides helper constants for use in calls.

Order results in specific calls by using one of the following values.

Available status update categories to filter by.

Available status update project types to filter by.

List of event types (most recent from CoinGeckoClient.events.fetchTypes())

All calls using the CoinGeckoClient are asynchronous.

All calls are returned in the following format:

{
    success: Boolean,
    message: String,
    code: Number,
    data: Object
}

The CoinGeckoClient splits up the currently available calls outline in the official CoinGecko API documentation into five parts. (Aside from the ping and global calls.)

Check API server status.

Check API server status.

Usage Example:

let data = await CoinGeckoClient.ping();

Get cryptocurrency global data.

Get cryptocurrency global data.

Usage Example:

let data = await CoinGeckoClient.global();

Calls related to coins.

List all coins with data (name, price, market, developer, community, etc) - paginated by 50.

Official documentation: https://www.coingecko.com/api/docs/v3#/coins/get_coins

Params:

• params: Object - Parameters to pass through to the request
• params.order: String - Order results by CoinGecko.ORDER[*]
• params.per_page: Number - Total results per page
• params.page: Number - Page through results
• params.localization: Boolean [default: true] - Set to false to exclude localized languages in response
• params.sparkline: Boolean [default: false] - Include sparkline 7 days data

Usage Example:

let data = await CoinGeckoClient.coins.all();

Use this to obtain all the coins’ id in order to make API calls

Official documentation: https://www.coingecko.com/api/docs/v3#/coins/get_coins_list

Usage Example:

let data = await CoinGeckoClient.coins.list();

Use this to obtain all the coins market data (price, market cap, volume).

Official documentation: https://www.coingecko.com/api/docs/v3#/coins/get_coins_markets

Params:

• params: Object - Parameters to pass through to the request
• params.order: String - Order results by CoinGecko.ORDER[*]
• params.per_page: Number - Total results per page
• params.page: Number - Page through results
• params.localization: Boolean [default: true] - Set to false to exclude localized languages in response
• params.sparkline: Boolean [default: false] - Include sparkline 7 days data
• params.vs_currency: String [default: usd] - The target currency of market data (usd, eur, jpy, etc.)
• params.ids: Array|String - List of coin id to filter if you want specific results

Usage Example:

let data = await CoinGeckoClient.coins.markets();

Get current data (name, price, market, … including exchange tickers) for a coin.

Official documentation: https://www.coingecko.com/api/docs/v3#/coins/get_coins__id_

Params:

• coinId: String - (Required) The coin id (can be obtained from coins.list()) eg. bitcoin
• params: Object - Parameters to pass through to the request
• params.tickers: Boolean - [default: true] - Include ticker data
• params.market_data: Boolean - [default: true] - Include market data
• params.community_data: Boolean - [default: true] - Include community data
• params.developer_data: Boolean - [default: true] - Include developer data
• params.localization: Boolean [default: true] - Set to false to exclude localized languages in response
• params.sparkline: Boolean [default: false] - Include sparkline 7 days data

Usage Example:

let data = await CoinGeckoClient.coins.fetch('bitcoin', {});

Get coin tickers (paginated to 100 items).

Official documentation: https://www.coingecko.com/api/docs/v3#/coins/get_coins__id__tickers

Params:

• coinId: String - (Required) The coin id (can be obtained from coins.list()) eg. bitcoin
• params: Object - Parameters to pass through to the request
• params.page: Number - Page through results

Usage Example:

let data = await CoinGeckoClient.coins.fetchTickers('bitcoin');

Get historical data (name, price, market, stats) at a given date for a coin.

Official documentation: https://www.coingecko.com/api/docs/v3#/coins/get_coins__id__history

Params:

• coinId: String - (Required) The coin id (can be obtained from coins.list()) eg. bitcoin
• params: Object - Parameters to pass through to the request
• params.date: String - (Required) The date of data snapshot in dd-mm-yyyy eg. 30-12-2017
• params.localization: Boolean [default: true] - Set to false to exclude localized languages in response

Usage Example:

let data = await CoinGeckoClient.coins.fetchHistory('bitcoin', {
  date: '30-12-2017'
});

Get historical market data include price, market cap, and 24h volume (granularity auto).

Official documentation: https://www.coingecko.com/api/docs/v3#/coins/get_coins__id__market_chart

Params:

• coinId: String - (Required) The coin id (can be obtained from coins.list()) eg. bitcoin
• params: Object - Parameters to pass through to the request
• params.days: String - Data up to number of days ago (eg. 1, 14, 30, max)
• params.vs_currency: String [default: usd] - The target currency of market data (usd, eur, jpy, etc.)

Usage Example:

let data = await CoinGeckoClient.coins.fetchMarketChart('bitcoin');

Get status updates for a given coin.

Official documentation: https://www.coingecko.com/api/docs/v3#/coins/get_coins__id__status_updates

Params:

• coinId: String - (Required) The coin id (can be obtained from coins.list()) eg. bitcoin
• params: Object - Parameters to pass through to the request
• params.per_page: Number - Total results per page
• params.page: Number - Page through results

Usage Example:

let data = await CoinGeckoClient.coins.fetchStatusUpdates('bitcoin');

Calls related to exchanges.

List all exchanges.

Official documentation: https://www.coingecko.com/api/docs/v3#/exchanges_(beta)/get_exchanges

Usage Example:

let data = await CoinGeckoClient.exchanges.all();

Get exchange volume in BTC and top 100 tickers only for a given exchange.

Official documentation: https://www.coingecko.com/api/docs/v3#/exchanges_(beta)/get_exchanges__id_

Params:

• exchangeId: String - (Required) The exchange id (can be obtained from exchanges.all()) eg. binance

Usage Example:

let data = await CoinGeckoClient.exchanges.fetch('binance');

Get tickers for a given exchange.

Official documentation: https://www.coingecko.com/api/docs/v3#/exchanges_(beta)/get_exchanges__id__tickers

Params:

• exchangeId: String - (Required) The exchange id (can be obtained from exchanges.all()) eg. binance
• params: Object - Parameters to pass through to the request
• params.page: Number - Page through results

Usage Example:

let data = await CoinGeckoClient.exchanges.fetchTickers('binance');

Get status updates for a given exchange.

Official documentation: https://www.coingecko.com/api/docs/v3#/exchanges_(beta)/get_exchanges__id__status_updates

Params:

• exchangeId: String - (Required) The exchange id (can be obtained from exchanges.all()) eg. binance
• params: Object - Parameters to pass through to the request
• params.page: Number - Page through results
• params.per_page: Number - Total results per page

Usage Example:

let data = await CoinGeckoClient.exchanges.fetchStatusUpdates('binance');

Calls related to status updates.

List all status_updates with data (description, category, created_at, user, user_title and pin).

Official documentation: https://www.coingecko.com/api/docs/v3#/status_updates_(beta)/get_status_updates

Params:

• params: Object - Parameters to pass through to the request
• params.category: Number - Filter results by CoinGecko.STATUS_UPDATE_CATEGORY[*]
• params.project_type: Number - Filter results by CoinGecko.STATUS_UPDATE_PROJECT_TYPE[*] (If left empty returns both status from coins and markets)
• params.page: Number - Page through results
• params.per_page: Number - Total results per page

Usage Example:

let data = await CoinGeckoClient.statusUpdates.all();

Calls related to events.

Get events, paginated by 100.

Official documentation: https://www.coingecko.com/api/docs/v3#/events/get_events

Params:

• params: Object - Parameters to pass through to the request
• params.country_code: Number - country_code of event (eg. US). Use events.fetchHistory() for list of country_codes
• params.type: String - Type of event (eg. Conference). Use events.fetchTypes() for list of types. Or use CoinGecko.EVENT_TYPE[*]
• params.page: Number - Page through results
• params.upcoming_events_only: Boolean - [default: true] - Lists only upcoming events
• params.from_date: String - Lists events after this date yyyy-mm-dd
• params.to_date: String - Lists events before this date yyyy-mm-dd (set upcoming_events_only to false if fetching past events)

Usage Example:

let data = await CoinGeckoClient.events.all();

Get list of event countries.

Official documentation: https://www.coingecko.com/api/docs/v3#/events/get_events_countries

Usage Example:

let data = await CoinGeckoClient.events.fetchCountries();

Get list of event types.

Official documentation: https://www.coingecko.com/api/docs/v3#/events/get_events_types

Usage Example:

let data = await CoinGeckoClient.events.fetchTypes();

Calls related to exchange rates.

Get BTC-to-Currency exchange rates.

Official documentation: https://www.coingecko.com/api/docs/v3#/exchange_rates/get_exchange_rates

Usage Example:

let data = await CoinGeckoClient.exchangeRates.all();

Find me on Gab: @markmiscavage.

Tweet at me: @markmiscavage.

MIT License

Copyright (c) 2018 Mark Miscavage

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.