Coin Gecko API Client for Deno

Hi! Vincent here. I hope you find it easy to use and powerful enough for all your use cases. If you have any issues or suggestions, please open an issue!

In the course of next month or so I will try to release a stable version of the client. It works but there a way too many things left to implement or change. If you’d like to help please open an issue or pull request!

Overview

API client library for Deno that allows you to work with the Coin Gecko API. I will be providing implementation for all the official routes listed. Yet for now, I have no plans to add tests because I do not own the API. For the latter I might actually do it, if I end up using this library on a constant basis.

Notes

While I’m still working on a better docs inside readme, checkout examples.ts for use cases on every single route.

Future plans

Add tests. Keep this up to date with the API. Better Error Handling. Better Docs.

Contributions And Feedback

Feel free to open an issue or pull requests, for now there are no strict guidelines, I don’t think this small library needs any.

Quick Start Example

//1. Import coingecko-api
//Make sure you use the latest version of the library it can be specified in the url.
//It's just a note in case I ever forget to update it in this section of readme
import Client from "https://deno.land/x/coingecko_deno_client@v0.2.0/mod.ts";

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

// do not forget top level async function of course, or use .then()
//3. Make any desired call to the API
const ping = await CoinGeckoClient.ping();

// get token price given contract addresses
const tokenPrice = await client.simple.tokenPrice({
  // asset platform is ethereum
  contract_addresses: [
    "0x514910771AF9Ca656af840dff83E8264EcF986CA",
    "0xB62132e35a6c13ee1EE0f84dC5d40bad8d815206",
  ],
  vs_currencies: "usd",
});
console.log(tokenPrice);

Making Calls

All calls using the CoinGeckoClient are asynchronous.

I try to keep the response types up to date with the API, please do refer to the deno doc for the response types and ds.

The CoinGeckoClient splits up the currently available calls outline in the official CoinGecko API documentation parts into 8 objectparts. (Aside from the ping, global, globalDefi, listStatusUpdates exchangeRates, trending, topHoldings calls. These are direct methods inside main client).

The table below shows the available getters for each of the objects. They strictly coincide with the API docs except for contracts it holds asset_platforms route.

Constants

This module provides helper constants for use in calls.

CoinGecko.ORDER

Order results in specific calls by using one of the following values. It’s mostly made to remind you what constants are available, you might as well just pass the desired string after referencing the ts doc instead of directly importing the object when build query params.

CoinGecko.STATUS_UPDATE_CATEGORY

Available status update categories to filter by.

CoinGecko.STATUS_UPDATE_PROJECT_TYPE

Available status update project types to filter by.

CoinGecko.EVENT_TYPE

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

License MIT