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

geckoterm

v0.2.2

Published

Coin Gecko Terminal Open Source SDK

Downloads

92

Readme

license npm latest package npm downloads Follow on Twitter

CoinGecko Terminal / TS SDK

OpenAPI + TypeScript + Type Safe API

Summary

This package provides a type-safe SDK for interacting with the CoinGecko Terminal API. The main feature is a strongly typed API client generated using OpenAPI 3 specs. The repository is open source and hosted at In This GitHub Repository.

Check out the Changelog to see what changed in the latest releases.

Important Note: This SDK only Support ESM (ECMAScript Modules).

Quick Start

Install the SDK

You can install the CoinGecko Terminal SDK using Bun:

bun add geckoterm

Use the SDK

Here's an example of how to use the SDK to fetch the available networks:

import { getNetworks, setGeckotermAPIConfg } from 'geckoterm'

// Set the config for the client with the Base URL and API key
setGeckotermAPIConfg({
  baseUrl: 'https://api.geckoterminal.com/api/v2',
  // Replace with your API key / if you have one
  headers: {
    Authorization: `Bearer ${process.env.GECKOTERM_API_KEY}`,
  },
})

// Use the internal method to call the API
const response = await getNetworks({
  query: {
    page: 1,
  },
})

// Log the response
console.log('API response data:', response.data)

Install dependencies for Contributions

Prerequisites

Before running the SDK, ensure you have the following dependencies installed:

  • Bun (optional, but recommended): Used for runtime and testing.

You can install the required dependencies as follows:

Install Bun (for testing primitives, not required for the SDK itself)

# Supported on macOS, Linux, and WSL
curl -fsSL https://bun.sh/install | bash

# Upgrade Bun occasionally
bun upgrade

Compile API Client

To generate the TypeScript client from the OpenAPI spec, run the following commands:

# Step 1: Install dependencies
bun install

# Step 2: Compile the API client
bun run compile:api

The compile:api command performs the following steps:

  • Uses the @hey-api/openapi-ts Generator CLI to generate the TypeScript API client from the OpenAPI 3 spec.
  • Formats the generated code using Prettier.

How to make a release

For the Maintainer: Add NPM_TOKEN to the GitHub Secrets.

  1. Open a Pull Request with your changes.
  2. Merge the PR into the main branch.
  3. Checkout the main branch locally:
    git checkout main
  4. Pull the latest changes:
    git pull
  5. Run the release command:
    bun release: '' | alpha | beta -- --release-as minor | major
  6. Verify everything looks good (e.g., in CHANGELOG.md).
  7. Follow the instructions provided by the release log.
  8. Done!

Summary

This SDK provides a type-safe interface for interacting with the CoinGecko Terminal API. It uses OpenAPI to generate a fully typed API client, making it easier to work with the API in TypeScript.

Check out the GitHub repository for more information.