πŸ”“ Authentication

πŸ“˜

Notes

  • Pro API Key is only available for CoinGecko API paid plan subscribers, the root URL for CoinGecko Pro API must be https://pro-api.coingecko.com/api/v3/
  • You are recommended to store the API key securely in your own backend and use a proxy to insert the key into the request URL

CoinGecko API Authentication Method

If this is your first time using the Pro API key, you can supply API Key to the root URL using one of these ways:

  1. Header: x-cg-pro-api-key
  2. Query String Parameter: x_cg_pro_api_key
Authentication MethodExample using Ping Endpoint
Header (cURL)curl -X GET "https://pro-api.coingecko.com/api/v3/ping" -H "x-cg-pro-api-key: YOUR_API_KEY"
Query String Parameterhttps://pro-api.coingecko.com/api/v3/ping?x_cg_pro_api_key=YOUR_API_KEY

πŸ”₯ Accessing On-Chain DEX data (Beta)

You can now use the Pro-API key (exclusive to any paid plan subscriber) to call on-chain DEX data powered by GeckoTerminal.

You can use the docs below to try out the API Endpoints.

πŸ“˜

Notes

  • Authentication method for on-chain endpoints is exactly same as other endpoints
  • When using the CG Pro API to access on-chain DEX data, include the /onchain/ endpoint path in the request
Authentication MethodExample using Simple Token Price Endpoint
Header (cURL)curl -X GET "<https://pro-api.coingecko.com/api/v3/onchain/simple/networks/eth/token_price/0xc02aaa39b223fe8d0a0e5c4f27ead9083c756cc2>" -H "x-cg-pro-api-key: YOUR_API_KEY"
Query String Parameterhttps://pro-api.coingecko.com/api/v3/onchain/simple/networks/eth/token_price/0xc02aaa39b223fe8d0a0e5c4f27ead9083c756cc2?x_cg_pro_api_key=YOUR_API_KEY

API Key Usage Credits

  • Each request made to any endpoint counts as a single call (1 call = 1 credit)
  • Your monthly credit & rate limit are determined by the paid plan to which you subscribe. For more details, please refer to this page
  • To check the API usage, please go to the developer dashboard or follow the guide here