0.0.1 • Published 3 years ago

coingeckoclient v0.0.1

Weekly downloads
-
License
MIT
Repository
github
Last release
3 years ago

CoinGecko API Client for Node.js

• Quick Start Example

npm install axios
npm install extends-classes
npm install node-fetch
npm install query-string
//1. Import 
let Geko = require("./lib/geko");

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

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

• Constants

This module provides helper constants for use in calls. • To do

• Making Calls

All calls using the CoinGeckoClient are asynchronous. Each function receives an object as an argument. :warning: For more information on features, check out https://www.coingecko.com/en/api/documentation

• Ping

Check API server status.

Usage Example:

  let data = await CoinGeckoClient.ping();

Function price

ArgumentTypeOptional
idsarrayfalse
vs_currenciesarraytrue
  let params = {
    ids:["btc"],
    vs_currencies:["eur"],
  }
  let data = await CoinGeckoClient.simple.price(params);

Function tokenPrice

ArgumentTypeOptional
idpathfalse
vs_currenciesarraytrue
contract_addressesarrayfalse
 let params = {
    id:"ethereum",
    vs_currencies:["eur"],
    contract_addresses:["0xe41d2489571d322189246dafa5ebde1f4699f498"]
  }
  let data = await CoinGeckoClient.simple.price(params);

Function supportedVsCurrencies

  let data = await CoinGeckoClient.simple.supportedVsCurrencies();
let params = {
      id:"btc",
 }
 let data = await CoinGeckoClient.coins.markets(params);

Function tickers

ArgumentTypeOptional
idstringfalse
let params = {
      id:"btc",
 }
 let data = await CoinGeckoClient.coins.tickers(params);

Function history

ArgumentTypeOptional
idstringfalse
datestring dd-mm-yyyyfalse
let params = {
      id:"btc",
      date:"19-12-2022"
 }
 let data = await CoinGeckoClient.coins.date(params);

Function marketChart

ArgumentTypeOptional
idstringfalse
vs_currenciesstringtrue
daysstringfalse
  let params = {
    id:["btc"],
    vs_currencies:"eur",
    days:"1"
  }
  let data = await CoinGeckoClient.simple.marketChart(params);

Function marketChartRange

ArgumentTypeOptional
idstringfalse
vs_currenciesstringtrue
fromstring unixfalse
tostring unixfalse
  let params = {
    id:["btc"],
    vs_currencies:"eur",
    from:"1392577232",
    to:"1422577232"
  }
  let data = await CoinGeckoClient.simple.marketChartRange(params);

Function ohlc

ArgumentTypeOptional
idstringfalse
vs_currenciesstringtrue
daysstringfalse
  let params = {
    id:["btc"],
    vs_currencies:"eur",
    days:"1"
  }
  let data = await CoinGeckoClient.simple.ohlc(params);

:warning: Working process.