cav

coingecko-api-v3

The nodejs api library for accessing coingecko api v3 , develop with typescript

Showing:

Popularity

Downloads/wk

548

GitHub Stars

7

Maintenance

Last Commit

2mos ago

Contributors

2

Package

Dependencies

0

License

MIT

Type Definitions

Built-In

Tree-Shakeable

No?

Categories

Readme

coingecko-api-v3

CI

codecov

version

The nodejs api library for accessing coingecko api v3 , develop with typescript with zero dependencies

Get started

npm install coingecko-api-v3

import { CoinGeckoClient } from 'coingecko-api-v3';
const client = new CoinGeckoClient({
  timeout: 10000,
  autoRetry: true,
});
const trendingSearch = await client.trendingSearch();

Options

  • timeout (optional): The http timeout, default 30s
  • autoRetry (optional): Auto retry if the http response code is 429 - to many request

Supported API method

Endpointfunctiontested?
/pingclient.ping()
/simple/priceclient.simplePrice()
/simple/token_price/:idclient.simplePriceId()
/simple/supported_vs_currenciesclient.simpleSupportedCurrencies()
/coins/listclient.coinList()
/coins/marketsclient.coinMarkets()
/coins/:idclient.coinId()
/coins/:id/tickersclient.coinIdTickers()
/coins/:id/historyclient.coinIdHistory()
/coins/:id/market_historyclient.coinIdMarketHistory()
/coins/id/market_chartclient.coinIdMarketChart()
/coins/{id}/market_chart/rangeclient.coinIdMarketChartRange()
/coins/{id}/status_updatesclient.coinIdStatusUpdates()
/coins/{id}/ohlcclient.coinIdOHLC()
/coins/{id}/contract/{contract_address}client.contract()
/coins/{id}/contract/{contract_address}/market_chart/client.contractMarketChart()
/coins/{id}/contract/{contract_address}/market_chart/rangeclient.contractMarketChartRange()
/exchangesclient.exchanges()
/exchanges/listclient.exchangeList()
/exchanges/{id}/tickersclient.exchangeIdTickers()
/exchanges/{id}/status_updateclient.exchangeIdStatusUpdates()
/exchanges/{id}/volume_chartclient.exchangeIdVolumeChart()
/finance_platformsclient.financePlatforms()
/finance_productsclient.financeProducts()
/indexesclient.indexes()
/indexes/{market_id}/{id}client.indexesMarketId()
/indexes/listclient.indexesList()
/indexes/list_by_market_and_id/{market_id}/{id}client.financeProducts()
/derivativesclient./derivatives()
/derivatives/exchangesclient./derivativesExchanges()
/derivatives/exchanges/{id}client./derivativesExchangesId()
/status_updatesclient.statusUpdates()
/eventclient.events()
//events/countriesclient.eventCountries()
/events/typesclient.eventsTypes()
/exchange_ratesclient.exhangesRates()
/search/trendingclient.searchTrending()
/globalclient.global()
/status_updatesclient.statusUpdates()
//global/decentralized_finance_deficlient.globalDefi()

Rate & Review

Great Documentation0
Easy to Use0
Performant0
Highly Customizable0
Bleeding Edge0
Responsive Maintainers0
Poor Documentation0
Hard to Use0
Slow0
Buggy0
Abandoned0
Unwelcoming Community0
100