npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@moicky/coingecko-api

v3.1.5

Published

TypeScript wrapper for the Coingecko public and pro APIs

Downloads

359

Readme

CoinGecko API TypeScript Wrapper

This package provides a TypeScript wrapper for the CoinGecko API using fetch. It includes endpoints for both public and pro APIs, allowing you to interact with CoinGecko’s extensive cryptocurrency data.

Installation

Install the package via npm:

npm install @moicky/coingecko-api

Documentation

For full details on API endpoints and usage, refer to the following documentation:

Usage

The wrapper exports modules for both public and pro endpoints. Here’s an example of how to use them:

Public API

import { CoinsApi, Configuration } from "@moicky/coingecko-api/public";

const coinsAPI = new CoinsApi(
  new Configuration({
    apiKey: "YOUR_API_KEY",
  })
);

await coinsAPI.coinsList({ includePlatform: true });

Pro API

import { CoinsApi, Configuration } from "@moicky/coingecko-api/pro";

const coinsAPI = new CoinsApi(
  new Configuration({
    apiKey: "YOUR_API_KEY",
  })
);

await coinsAPI.coinsIdCirculatingSupplyChart({ id: "bitcoin", days: "2" });

Contributing

To contribute to this project by adding new or updated API endpoints, follow these steps:

  1. Open generate.js and add the new Swagger JSON file URL to the swaggerConfigs object. For example:

    // Source: https://docs.coingecko.com/v3.0.1/docs/clients-unofficial#swagger-json-official
    const swaggerConfigs = {
      public: "https://docs.coingecko.com/openapi/65bf9cabb0951b0072e2cade",
      pro: "https://docs.coingecko.com/openapi/6584ea6ce07e130056b1af99",
      // Add new configs here
    };
  2. Run the generation script to fetch the latest API definitions and generate TypeScript clients and docs:

    npm run generate
  3. After running the command, the generated files will be located in the appropriate folder within ./generated and ./dist.

  4. Test your changes and submit a pull request!

License

This project is licensed under the MIT License.