1. Creating a new API Key
-
Once you have signed up and logged in to your CoinGecko account, go to Developer Dashboard:
-
Click on + Add New Key button to create a new API key:
2. Making API Request
-
Root URLs:
- Pro API:
https://pro-api.coingecko.com/api/v3/
, refer to Pro API Authentication. - Demo API:
https://api.coingecko.com/api/v3/
, refer to Demo API Authentication.
- Pro API:
-
Example using the
/ping
endpoint:- Pro API:
https://pro-api.coingecko.com/api/v3/ping?x_cg_pro_api_key=YOUR_API_KEY
- Demo API:
https://api.coingecko.com/api/v3/ping?x_cg_demo_api_key=YOUR_API_KEY
- Pro API:
3. Edit or Delete API Key
- Go to Developerโs Dashboard and click โEditโ button on a specific API Key.
- In case the API Key is compromised, you may delete the API Key by clicking the โDeleteโ button.
-
You may also update the label and save the changes by clicking โSaveโ button.
4. API Usage Report
-
You can monitor your API usage in the Usage Report section, which provides details such as:
- Total Monthly API Calls.
- Remaining Monthly API Calls.
- Rate Limit (Request Per Minute) โ maximum number of API requests allowed in one minute.
- Last Used โ the timestamp of the last used instance.
-
You can also check your full historical usage by specifying โAPI Keysโ, โtimeframeโ or โdate rangeโ. You may export as CSV for more comprehensive view.
5. Others
Call Consumption Alerts
You may enable or disable call consumption alerts in the tab below to receive emails when specific credit usage thresholds are reached.
Overage Option (Beta)
- The overage option enables you to make API calls when your usage exceeds the monthly credits.
- You can activate the overage option by clicking the โTurn On Overageโ button, ensuring uninterrupted service and allowing you to continue making API calls or vice versa.
