Skip to main content

CoinGecko

Introduction

The CoinGecko source connector connects to the CoinGecko API and validates access using your API key.

This connector is currently in development. At this time, it supports credential validation (login) but does not yet support catalog discovery or data extraction.

Setup

  1. Create or locate your CoinGecko API key in your CoinGecko account.
  2. Determine which CoinGecko API plan you are using for this connector:
    • demo (CoinGecko Demo API)
    • pro (CoinGecko Pro API)

Authentication

CoinGecko authentication is performed by sending your API key in an HTTP header. The connector chooses the correct base URL and header based on the selected plan:

  • Pro plan

    • Base URL: https://pro-api.coingecko.com/api/v3
    • Header: x-cg-pro-api-key: <api_key>
  • Demo plan

    • Base URL: https://api.coingecko.com/api/v3
    • Header: x-cg-demo-api-key: <api_key>

During credential validation, the connector calls:

GET /simple/price?ids=bitcoin&vs_currencies=usd

If the request fails, the connector reports a credential validation error.

Configuration

FieldTypeRequiredDescription
planstringYesCoinGecko plan to use. Must be either demo or pro (case-insensitive).
api_keystringYesYour CoinGecko API key.

Streams

No streams are currently available.

  • Catalog discovery currently returns an empty catalog.
  • Extraction is not yet implemented and will fail with an “in development” error.

Limitations

  • This connector does not yet support syncing data from CoinGecko.
  • Only API key validation is supported at this time.