);
## Improved Update Frequency for selected Pro-API On-chain Endpoints
๐๏ธ **August 18, 2025**
\[Changes below are applicable to all [paid plan subscribers](https://www.coingecko.com/en/api/pricing).]
Dear CoinGecko API paid plan subscribers,
We're excited to announce an improvement to our API, aimed at providing you with even faster access to real-time data! Starting **02:00 UTC, September 2, 2025**, the edge cache duration for the following endpoints will be reduced from \*\*30s \*\*to **10s**, allowing you to retrieve updated data more frequently.
| Endpoints | Effective Date & Time | Current Update Frequency | New Update Frequency |
| :----------------------------------------------------------------------------------------------------------- | :-------------------------------------- | :----------------------- | :------------------- |
| [Token Price by Token Addresses](https://docs.coingecko.com/reference/onchain-simple-price) | Tuesday, 02:00 UTC, September 2, 2025 | 30s | 10s |
| [Token Data by Token Address](https://docs.coingecko.com/reference/token-data-contract-address) | Tuesday, 02:00 UTC, September 2, 2025 | 30s | 10s |
| [Tokens Data by Token Addresses](https://docs.coingecko.com/reference/tokens-data-contract-addresses) | Tuesday, 02:00 UTC, September 2, 2025 | 30s | 10s |
| [Specific Pool Data by Pool Address](https://docs.coingecko.com/reference/pool-address) | Wednesday, 02:00 UTC, September 3, 2025 | 30s | 10s |
| [Multiple Pools Data by Pool Addresses](https://docs.coingecko.com/reference/pools-addresses) | Wednesday, 02:00 UTC, September 3, 2025 | 30s | 10s |
| [Pool OHLCV chart by Pool Address](https://docs.coingecko.com/reference/pool-ohlcv-contract-address) | Thursday, 02:00 UTC, September 4, 2025 | 30s | 10s |
| [Token OHLCV chart by Token Address](https://docs.coingecko.com/reference/token-ohlcv-token-address) | Thursday, 02:00 UTC, September 4, 2025 | 30s | 10s |
| [Past 24 Hour Trades by Pool Address](https://docs.coingecko.com/reference/pool-trades-contract-address) | Thursday, 02:00 UTC, September 4, 2025 | 30s | 10s |
| [Past 24 Hour Trades by Token Address](https://docs.coingecko.com/reference/token-trades-contract-address#/) | Thursday, 02:00 UTC, September 4, 2025 | 30s | 10s |
#### **What This Means for You:**
* **Fresher Data, Quicker**: With a reduced cache time, you'll now have the option to access more up-to-date data, closer to real-time!
* **No Extra Credits for Cached Data**: If your request hits the cache (now updated every 10 seconds for endpoints above), there will be no additional credits charged - just like before.
**Things to Keep in Mind:**
* If your request hits our origin server instead of the cache to retrieve the latest data, there may be additional credits used.
* To balance cost and real-time data needs, we recommend reviewing your request frequency. For those who prefer to obtain data without extra credits, consider keeping your request interval at 30 seconds or more to align with the new cache duration.
We're committed to continuously improving your experience and ensuring you get the data you need, as efficiently as possible. If you have any questions or need assistance, feel free to reach out to [soonaik@coingecko.com](mailto:soonaik@coingecko.com) .
**CoinGecko API Team**
## Now Supported: Launchpad Data (Pump.fun & More), Granular OHLCV, and Honeypot Info
๐๏ธ **August 05, 2025**
We're excited to announce a major update to our on-chain API endpoints! This release introduces support for popular token launchpads, adds high-frequency OHLCV data, and enhances our honeypot detection capabilities to give you deeper and more timely on-chain insights.
### ๐ Now Supporting Launchpad Data (Pump.fun & More!)
In addition to the 1,600+ DEXes already integrated with GeckoTerminal.com, you can now track token data from popular launchpad platforms directly through the CoinGecko API. More launchpads will be supported soon!
**New Supported Launchpads:**
| Launchpad | network id (API) | dex id (API) |
| :---------------------------------------------------------------------------------------------- | :--------------- | :---------------- |
| [Meteora DBC](https://www.geckoterminal.com/solana/meteora-dbc/pools) | solana | meteora-dbc |
| [Pump.fun](https://www.geckoterminal.com/solana/pump-fun/pools) | solana | pump-fun |
| [Raydium Launchpad](https://www.geckoterminal.com/solana/raydium-launchlab/pools) (LetsBonkFun) | solana | raydium-launchlab |
| [Boop.fun](https://www.geckoterminal.com/solana/boop-fun/pools) | solana | boop-fun |
| [Virtuals (Base)](https://www.geckoterminal.com/base/virtuals-base/pools) | base | virtuals-base |
**Improved endpoints to track launchpad data:**
* [Token Data by Token Address](https://docs.coingecko.com/reference/token-data-contract-address)
* [Tokens Data by Token Addresses](https://docs.coingecko.com/reference/tokens-data-contract-addresses)
* [Specific Pool Data by Pool Address](https://docs.coingecko.com/reference/pool-address)
* [Multiple Pools Data by Pool Addresses](https://docs.coingecko.com/reference/pools-addresses)
More launchpad-specific data will be supported soon for the endpoints above!
**Tips:** use [megafilter endpoint](https://docs.coingecko.com/reference/pools-megafilter) to retrieve latest launchpad data, by flagging `sort=pool_created_at_desc`
**Request example** (Get latest pools on Pump.fun):
```curl
https://pro-api.coingecko.com/api/v3/onchain/pools/megafilter?page=1&networks=solana&dexes=pump-fun&sort=pool_created_at_desc&x_cg_pro_api_key=YOUR_KEY
```
### \[Pro-API Exclusive] More Granular OHLCV Data
On-chain OHLCV endpoints now support higher frequency intervals, down to 1-second granularity.
| Timeframe | Aggregate (Before) | Aggregate (New) |
| :-------- | :----------------- | :-------------- |
| day | 1 | 1 |
| hour | 1, 4, 12 | 1, 4, 12 |
| minute | 1, 5, 15 | 1, 5, 15 |
| second | n/a | 1, 15, 30 |
**Improved Endpoints:**
* [Pool OHLCV chart by Pool Address](https://docs.coingecko.com/reference/pool-ohlcv-contract-address)
* [Token OHLCV chart by Token Address](https://docs.coingecko.com/reference/token-ohlcv-token-address)
**New interval supported:**
* 1s
* 15s
* 30s
**Example Request (Get the last 100 1-second intervals for a pool on Ethereum):**
```curl
https://pro-api.coingecko.com/api/v3/onchain/networks/eth/pools/0x06da0fd433c1a5d7a4faa01111c044910a184553/ohlcv/second?aggregate=1&limit=100&include_empty_intervals=false&x_cg_pro_api_key=YOUR_KEY
```
### ๐ฏ Enhanced Honeypot Information
We've expanded our honeypot detection features to provide more comprehensive risk assessment. You can now check if a token is a potential honeypot using the main info endpoints.
**Improved Endpoints:**
* [Token Info by Token Address](https://docs.coingecko.com/reference/token-info-contract-address)
* [Pool Tokens Info by Pool Address](https://docs.coingecko.com/reference/pool-token-info-contract-address)
**Example Payload:**
```json
{
"mint_authority": null,
"freeze_authority": null,
"is_honeypot": true // possible values: true / false / unknown
}
```
### \[Pro-API Exclusive] New Filtering Option in Megafilter
Previously, the[Pools Megafilter](https://docs.coingecko.com/reference/pools-megafilter) endpoint could only show tokens confirmed as ***not*** a honeypot (`checks=no_honeypot`). Now, you can also include tokens where the honeypot status is 'unknown'.
* To use this, set `include_unknown_honeypot_tokens=true`.
* Important: This parameter only takes effect when `checks=no_honeypot` is also specified in the request.
**Example Request (Get trending pools that are not confirmed honeypots, including those with an unknown status):**
```curl
https://pro-api.coingecko.com/api/v3/onchain/pools/megafilter?page=1&sort=h6_trending&checks=no_honeypot&include_unknown_honeypot_tokens=true&x_cg_pro_api_key=YOUR_KEY
```
### ๐ Expanded Pool Data
**Endpoint**: [Pool Tokens Info by Pool Address](https://docs.coingecko.com/reference/pool-token-info-contract-address)
By adding `include=pool` to your request on the pool tokens endpoint, you can now retrieve additional context about the pool itself.
* Base and quote token address
* Sentiment vote percentage (positive and negative)
* Community suspicious reports count
**Payload Example**:
```json
"included": [
{
"id": "eth_0x06da0fd433c1a5d7a4faa01111c044910a184553",
"type": "pool",
"attributes": {
"base_token_address": "0xdac17f958d2ee523a2206206994597c13d831ec7",
"quote_token_address": "0xc02aaa39b223fe8d0a0e5c4f27ead9083c756cc2",
"sentiment_vote_positive_percentage": 100,
"sentiment_vote_negative_percentage": 0,
"community_sus_report": 0
}
}
]
```
## SOL Currency Is Now Supported for CoinGecko Endpoints
๐๏ธ **June 19, 2025**
We're excited to announce that you can now obtain real-time and historical price & market data for tokens listed on CoinGecko.com, with the option to return data value in **SOL** (Solana) currency.
Note: for dates prior to May 2025, 'SOL' historical data is limited to hourly and daily granularity
#### **Improved endpoints:**
* [Coin Price by IDs](https://docs.coingecko.com/reference/simple-price)
* [Coin Price by Token Addresses](https://docs.coingecko.com/reference/simple-token-price)
* [Supported Currencies List](https://docs.coingecko.com/reference/simple-supported-currencies)
* [Top Gainers & Losers](https://docs.coingecko.com/reference/coins-top-gainers-losers)
* [Coins List with Market Data](https://docs.coingecko.com/reference/coins-markets)
* [Coin Data by ID](https://docs.coingecko.com/reference/coins-id)
* [Coin Historical Data by ID](https://docs.coingecko.com/reference/coins-id-history)
* [Coin Historical Chart Data by ID](https://docs.coingecko.com/reference/coins-id-market-chart)
* [Coin Historical Chart Data within Time Range by ID](https://docs.coingecko.com/reference/coins-id-market-chart-range)
* [Coin OHLC Chart by ID](https://docs.coingecko.com/reference/coins-id-ohlc)
* [Coin OHLC Chart within Time Range by ID](https://docs.coingecko.com/reference/coins-id-ohlc-range)
* [Coin Data by Token Address](https://docs.coingecko.com/reference/coins-contract-address)
* [Coin Historical Chart Data by Token Address](https://docs.coingecko.com/reference/contract-address-market-chart)
* [Coin Historical Chart Data within Time Range by Token Address](https://docs.coingecko.com/reference/contract-address-market-chart-range)
* [Trending Search List](https://docs.coingecko.com/reference/trending-search)
* [Crypto Global Market Data](https://docs.coingecko.com/reference/crypto-global)
**Example**: price of Bitcoin in Solana, using [Coin Price by IDs](https://docs.coingecko.com/reference/simple-price) endpoint.
```json
{
"bitcoin": {
"sol": 720.21
}
}
```
**Example:** historical daily price, market cap and volume of Trump in Solana, using [Coin Historical Chart Data by ID](https://docs.coingecko.com/reference/coins-id-market-chart) endpoint.
```json
{
"prices": [
[
1750118400000,
0.0640701365814472
],
[
1750204800000,
0.0644263929356261
],
[
1750291200000,
0.0639713357587322
],
[
1750326151000,
0.06415963364804504
]
],
"market_caps": [
[
1750118400000,
12843589.584485611
],
[
1750204800000,
12882547.839086628
],
[
1750291200000,
12793790.726102708
],
[
1750326151000,
12826247.390733324
]
],
"total_volumes": [
[
1750118400000,
2425793.780846796
],
[
1750204800000,
2055697.9106767387
],
[
1750291200000,
1871087.4334618242
],
[
1750326151000,
2008278.189223005
]
]
}
```
## New Endpoints & Improvements: Historical Token Holders Chart, OHLCV by Token Address, Multi-pool Token Data Support
๐๏ธ **June 09, 2025**
### \[Pro-API Exclusive] New Endpoint - Historical Token Holders Chart by Token Address
This new endpoint allows you to get the historical token holders chart based on the provided token contract address on a network.
* Supported chains include: Solana, EVM (Ethereum, Polygon, BNB, Arbitrum, Optimism, Base), Sui, TON, and Ronin.
Check it out now: [Historical Token Holders Chart by Token Address](https://docs.coingecko.com/reference/token-holders-chart-token-address)
### \[Pro-API Exclusive] New Endpoint - Token OHLCV chart by Token Address
This endpoint allows you to get the OHLCV chart (Open, High, Low, Close, Volume) of a token based on the provided token address on a network.
* This endpoint will return OHLCV data of the most liquid pool of the specified token. You may use this endpoint Top Pools by Token Address to check the top pools of a token.
Check it out now: [Token OHLCV chart by Token Address](https://docs.coingecko.com/reference/token-ohlcv-token-address#/)
### Improved Endpoints - Support Multi-pool Token Data
Previously, we only surfaced 1 quote token for pools with more than 2 tokens. With this new improvements, for pools that have 2 or more tokens:
* Extra quote tokens being listed under a new key `relationships.quote_tokens`
* If `include=quote_token` is flagged, the extra quote tokens will be also listed under `included`
```json
"relationships": {
"base_token": {
"data": {
"id": "eth_0x40d16fc0246ad3160ccc09b8d0d3a2cd28ae6c2f",
"type": "token"
}
},
"quote_token": {
"data": {
"id": "eth_0x8353157092ed8be69a9df8f95af097bbf33cb2af",
"type": "token"
}
},
"quote_tokens": {
"data": [
{
"id": "eth_0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48",
"type": "token"
},
{
"id": "eth_0xdac17f958d2ee523a2206206994597c13d831ec7",
"type": "token"
}
```
This improvement is applicable to all onchain pool endpoints that support `relationships.quote_token`, including but not limited to:
* [Top Pools by Token Address](https://docs.coingecko.com/reference/top-pools-contract-address#/)
* [Search Pools](https://docs.coingecko.com/reference/search-pools#/)
* [Megafilter for Pools](https://docs.coingecko.com/reference/pools-megafilter#/)
* [Trending Pools List](https://docs.coingecko.com/reference/trending-pools-list#/)
* [Specific Pool Data by Pool Address](https://docs.coingecko.com/reference/pool-address#/)
* [Top Pools by Network](https://docs.coingecko.com/reference/top-pools-network#/)
* [New Pools List](https://docs.coingecko.com/reference/latest-pools-list#/)
## Upcoming Change Notice: Removal of normalized\_volume\_btc Data
๐๏ธ **May 30, 2025**
**Notice: Upcoming Change to CoinGecko API Endpoints - Removal of`normalized_volume_btc` Data**
**Effective Date: 16 June 2025**
**Affected Endpoints:**
* [Exchange Data by ID](https://docs.coingecko.com/reference/exchanges-id)
* [Exchanges List with Data](https://docs.coingecko.com/reference/exchanges#/)
**Details of the Change:**
Please be advised that the `normalized_volume_btc` data point will be removed from the above-listed API endpoints, effective 16 June 2025. This change is being implemented due to significant recent change to a 3rd party data source provider, which have fundamentally altered how this specific data can be accessed.
Example of Affected Data Structure:
```json
{
"trade_volume_24h_btc_normalized": 47765.5886637453
},
```
After the effective date, the `trade_volume_24h_btc_normalized` field will no longer be present in the API responses for these endpoints.
**Action Required:**
If your applications or integrations currently rely on the `trade_volume_24h_btc_normalized` data from these CoinGecko API endpoints, please make the necessary adjustments to your code before 16 June 2025 to avoid potential errors or data discrepancies.
## New Endpoint & Improvements: On-Chain Trades, Net Buy Volume, and More
๐๏ธ **May 29, 2025**
### \[Pro-API Exclusive] New Endpoint - On-chain Trades by Token Address
Previously, the [Past 24 Hour Trades by Pool Address](https://docs.coingecko.com/reference/pool-trades-contract-address) endpoint allows you to retrieve the last 300 trades of a specific pool only.
With this new endpoint [Past 24 Hour Trades by Token Address](https://docs.coingecko.com/reference/token-trades-contract-address), you can now retrieve the last 300 trades **across different pools**, based on the provided **token contract address** on a network.
### Improved Endpoints - Support Net Buy Volume Data
The following endpoints now support more volume breakdown data:
* [Specific Pool Data by Pool Address](https://docs.coingecko.com/reference/pool-address)
* [Multiple Pools Data by Pool Addresses](https://docs.coingecko.com/reference/pools-addresses#/)
By flagging `include_volume_breakdown=true` , you can surface the following data:
* net\_buy\_volume\_usd
* buy\_volume\_usd
* sell\_volume\_usd
Sample Response:
```json JSON
{
"data": {
"id": "eth_0x88e6a0c2ddd26feeb64f039a2c41296fcb3f5640",
"type": "pool",
"attributes": {
...
},
"net_buy_volume_usd": {
"m5": "-40796.577553965",
"m15": "-69765.771189161",
"m30": "-88014.095440243",
"h1": "0.000000000000",
"h6": "1884879.921855301",
"h24": "17555422.243003801"
},
"buy_volume_usd": {
"m5": "30597.433165473",
"m15": "139531.542378324",
"m30": "396063.429481099",
"h1": "969922.728762430",
"h6": "10366839.570204150",
"h24": "52666266.729011402"
},
"sell_volume_usd": {
"m5": "71394.010719438",
"m15": "209297.313567485",
"m30": "484077.524921342",
"h1": "969922.728762430",
"h6": "8481959.648348849",
"h24": "35110844.486007601"
},
```
### Improved Endpoint - On-Chain OHLCV endpoint
[Pool OHLCV chart by Pool Address](https://docs.coingecko.com/reference/pool-ohlcv-contract-address) endpoint now supports to include empty intervals by flagging `include_empty_intervals=true` .
* By default, specific timeframe intervals (e.g. minutely) with no recorded swaps are excluded (or **skipped**) from the response.
* This new parameter option provides the flexibility to get **padded** data, when there's no trade data.
Sample Response:
```json
{
"data": {
"id": "81da0682-1c4f-445a-9bed-9b5454004df5",
"type": "ohlcv_request_response",
"attributes": {
"ohlcv_list": [
[
1744712700,
0.000212149802253853,
0.000212173305907688,
0.000212149802253853,
0.000212173305907688,
46.48164903882
],
[
1744712400,
0.000212149802253853, ๐ O โ Follow previous Close value
0.000212149802253853, ๐ H โ Follow previous Close value
0.000212149802253853, ๐ L โ Follow previous Close value
0.000212149802253853, ๐ C โ Follow previous Close value
0.0 ๐ V โ Set to zero
],
[
1744712100,
0.000210532522666822,
0.000212149802253853,
0.000210532522666822,
0.000212149802253853, ๐ Previous Close value
46.4765
],
...
}
```
### Improved Endpoints - Support Large Images
The following endpoints now support more size options for coin logo image:
* [Token Info by Token Address](https://docs.coingecko.com/reference/token-info-contract-address)
* [Pool Tokens Info by Pool Address](https://docs.coingecko.com/reference/pool-token-info-contract-addres)
Sample Response:
```json
"data": {
"id": "eth_0xdac17f958d2ee523a2206206994597c13d831ec7",
"type": "token",
"attributes": {
...
"image_url": "https://assets.coingecko.com/coins/images/325/small/Tether.png?1696501661",
"image": {
"thumb": "https://assets.coingecko.com/coins/images/325/thumb/Tether.png?1696501661",
"small": "https://assets.coingecko.com/coins/images/325/small/Tether.png?1696501661",
"large": "https://assets.coingecko.com/coins/images/325/large/Tether.png?1696501661"
},
```
### Improved Endpoints - Support Normalized Supply Data
The following endpoints now support `normalized_total_supply`:
* [Token Data by Token Address](https://docs.coingecko.com/reference/token-data-contract-address)
* [Tokens Data by Token Addresses](https://docs.coingecko.com/reference/tokens-data-contract-addresses)
Sample Response:
```json
"decimals": 6,
"total_supply": "49999156520373530.0",
"normalized_total_supply": "49999156520.37353",
```
### Improved Endpoints - Support Pool 'Name' and 'Fee' Data
The following endpoints now support `pool_name` and `pool_fee`:
* [Specific Pool Data by Pool Address](https://docs.coingecko.com/reference/pool-address)
* [Multiple Pools Data by Pool Addresses](https://docs.coingecko.com/reference/pools-addresses)
Sample Response:
```json
"name": "WETH / USDC 0.05%",
"pool_name": "WETH / USDC",
"pool_fee_percentage": "0.05",
```
### Improved Endpoints - Support Symbols of DEX Pairs
The following endpoints now allow to flag `dex_pair_format=symbol` to return DEX pair symbols instead of contract address.
* [Coin Data by ID](https://docs.coingecko.com/reference/coins-id)
* [Coin Tickers by ID](https://docs.coingecko.com/reference/coins-id-tickers)
* [Exchange Tickers by ID](https://docs.coingecko.com/reference/exchanges-id-tickers)
* [Exchange Data by ID](https://docs.coingecko.com/reference/exchanges-id)
Sample Response:
```json
// before
{
"base": "0X8FC8F8269EBCA376D046CE292DC7EAC40C8D358A",
"target": "0XA0B86991C6218B36C1D19D4A2E9EB0CE3606EB48",
"market": {
"name": "Uniswap V2 (Ethereum)",
"identifier": "uniswap_v2",
...
}
// now when "dex_pair_format=symbol" is flagged
{
"base": "DFI",
"target": "USDC",
"market": {
"name": "Uniswap V2 (Ethereum)",
"identifier": "uniswap_v2",
...
}
```
## New Endpoint & Improvements: On-Chain Trending Data, Enhanced Trending Search, and Improved Token Lookup
๐๏ธ **April 25, 2025**
### \[Pro-API Exclusive] New Endpoint - On-chain Trending Search Data
With this new endpoint [Trending Search Pools](https://docs.coingecko.com/reference/trending-search-pools), you can now retrieve the on-chain trending search pools and tokens data, as seen on GeckoTerminal.com .
By default, this endpoint returns the top 4 trending pools data, you may specify the `pools` parameter to retrieve up to top 10 pools data.
Tips: you may flag `include=base_token` to retrieve the trending tokens data.
Note: this exclusive endpoint is available for our API [paid plan](https://www.coingecko.com/en/api/pricing) subscribers (Analyst plan & above).
### \[Pro-API Exclusive] Improved Endpoint - Trending Search List
[Paid plan](https://www.coingecko.com/en/api/pricing) subscribers (Analyst plan & above) can now use [Trending Search List](https://docs.coingecko.com/reference/trending-search) endpoint and flag `show_max` parameter to retrieve more trending coins, NFTs and coin categories on CoinGecko.com.
| Trending Data | Public API (Demo plan) | Paid API (Analyst plan & above) |
| :-------------- | :--------------------- | :------------------------------ |
| Coins | 15 | 30 |
| NFTs | 7 | 10 |
| Coin Categories | 6 | 10 |
### Improved Endpoints - Support Token Lookup by Symbol and Name
The following endpoints now support token lookup by symbol and name, in addition to the existing API ID support:
* [Coin Price by IDs and Symbols](https://docs.coingecko.com/reference/simple-price)
* [Coins List with Market Data](https://docs.coingecko.com/reference/coins-markets)
Previously, these endpoints only supported token lookup by \[API IDs]\([https://docs.coingecko.com/docs/1-get-data-by-id-or-address#/methods-to-query-price--market-data-of-coins](https://docs.coingecko.com/docs/1-get-data-by-id-or-address#/methods-to-query-price--market-data-of-coins\)). This enhancement streamlines token data retrieval and eliminates the need for manual coin ID mapping.
Example Mapping:
| API Ids | Symbol | Name |
| :------- | :----- | :------ |
| bitcoin | btc | Bitcoin |
| tether | usdt | Tether |
| usd-coin | usdc | USDC |
Lookup Priority: When multiple lookup parameters are provided, the system applies the following priority order: id (highest) > name > symbol (lowest).
**Filtering by Symbol with`include_tokens`**
The `include_tokens`parameter has been added to provide flexibility when filtering by symbol:
* `include_tokens=top` : Returns only the top market cap token for the specified symbol.
* `include_tokens=all`: Returns all tokens that share the specified symbol.
Example Request & Data:
| Request Example | Token Data Returned | Remarks |
| :-------------------------------------------------------------------------------------------- | :--------------------------------------------------------------------------------------------------------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| pro-api.coingecko.com/api/v3/coins/markets?vs\_currency=usd\&symbols=btc\&include\_tokens=top | 1. Bitcoin | When symbols and 'include\_tokens=**top**' is specified, only the top market cap tokens will be returned. |
| pro-api.coingecko.com/api/v3/coins/markets?vs\_currency=usd\&symbols=btc\&include\_tokens=all | 1. Bitcoin 2. Osmosis allBTC 3. atcat 4. Meld Bridged BTC (Meld) 5. BlackrockTradingCurrency | When symbols and 'include\_tokens=**all**' is specified, all the coins that share the same symbol will be returned.
All the 5 coins stated in the example have the same symbol 'btc'. |
### /coins/markets Endpoint Improvement
We've enhanced the`/coins/markets` endpoint [Coins List with Market Data](https://docs.coingecko.com/reference/coins-markets), by including 'total' and 'per-page' values in the Response Headers.
This addition to the Response Headers enables developers to identify the total number of active coins on coingecko.com and specify the required pagination to retrieve all available data.
```Text Response Header (Example)
per-page: 250
total:16989
```
## Upcoming Change Notice: Removal of twitter\_followers Data
๐๏ธ **April 25, 2025**
**Notice: Upcoming Change to CoinGecko API Endpoints - Removal of`twitter_followers` Data**
**Effective Date: 15 May 2025**
**Affected Endpoints:**
* [Coin Data by ID](https://docs.coingecko.com/reference/coins-id)
* [Coin Data by Token Address](https://docs.coingecko.com/reference/coins-contract-address)
* [Coin Historical Data by ID](https://docs.coingecko.com/reference/coins-id-history)
**Details of the Change:**
Please be advised that the `twitter_followers` data point within the `community_data` object will be removed from the above-listed API endpoints, effective 15 May 2025. This change is being implemented due to significant recent changes to the X (formerly Twitter) API, which have fundamentally altered how this specific data can be accessed.
Example of Affected Data Structure:
```json
"community_data": {
"twitter_followers": 7694251,
// ... other community data points ...
}
```
After the effective date, the `twitter_followers` field will no longer be present in the API responses for these endpoints.
**Action Required:**
If your applications or integrations currently rely on the `twitter_followers` data from these CoinGecko API endpoints, please make the necessary adjustments to your code before 15 May 2025 to avoid potential errors or data discrepancies.
**Important Note Regarding Previously Stored`twitter_followers` Data:**
Please be aware that if you have previously stored `twitter_followers` data obtained from the CoinGecko API and archived it within your own systems, you are solely responsible for its continued use and any implications thereof.
We appreciate your understanding as we adapt to changes in third-party platforms to maintain the stability and reliability of our API. If you have any questions or require further clarification, please do not hesitate to contact our support team.
## New Endpoint & Multiple Improvements: On-Chain Top Token Holder Address, Security Data, Historical Supply.
๐๏ธ **March 28, 2025**
### \[Pro-API Exclusive] New Endpoint - Top Token Holder Address Data
You can now access the top 50 token holder address data for tokens, as seen on GeckoTerminal.com.
By default, this endpoint returns the top 10 holders data, you can also specify the `holders` parameter to retrieve up to top 50 holders data.
**Network supported:**
* EVM: Ethereum, Polygon, BNB, Arbitrum, Optimism, Base
* Solana
* Sui
* TON
* Ronin
๐ Visit the endpoint reference page - [Top Token Holders by Token Address](https://docs.coingecko.com/reference/top-token-holders-token-address) to learn more and try it out now!
**Note:** this exclusive endpoint is available for our API [paid plan](https://www.coingecko.com/en/api/pricing) subscribers (Analyst plan & above).
* The holders data is currently in **Beta**, with ongoing improvements to data quality, coverage, and update frequency.
* For Solana tokens, the maximum number of retrievable top holders data is 40 instead of 50.
**Tips:** You may also use the following endpoints to retrieve **token holders count** and **top holders distribution percentage data**:
* [Token Info by Token Address](https://docs.coingecko.com/reference/token-info-contract-address)
* [Pool Tokens Info by Pool Address](https://docs.coingecko.com/reference/pool-token-info-contract-address)
### Historical Supply endpoints - Support for Inactive Coins
You may now access historical total and circulating supply data of inactive coins using the following endpoints. To check for list of inactive coins, you may use [Coin List (ID Map)](https://docs.coingecko.com/reference/coins-list) endpoint and flag `status=inactive`.
Note: these endpoints below are exclusive for [Enterprise plan](https://www.coingecko.com/en/api/pricing) customers only.
**Improved endpoints:**
* [Circulating Supply Chart by ID](https://docs.coingecko.com/reference/coins-id-circulating-supply-chart)
* [Circulating Supply Chart within Time Range by ID](https://docs.coingecko.com/reference/coins-id-circulating-supply-chart-range)
* [Total Supply Chart by ID](https://docs.coingecko.com/reference/coins-id-total-supply-chart)
* [Total Supply Chart within time range by ID](https://docs.coingecko.com/reference/coins-id-total-supply-chart-range)
### Onchain Pool Data endpoints - Locked Liquidity
Now support **`locked_liquidity_percentage`** data.
**Improved endpoints:**
* [Specific Pool Data by Pool Address](https://docs.coingecko.com/reference/pool-address)
* [Multiple Pools Data by Pool Addresses](https://docs.coingecko.com/reference/pools-addresses)
```json
{
"data": [
{
"id": "eth_0x88e6a0c2ddd26feeb64f039a2c41296fcb3f5640",
"type": "pool",
"attributes": {
"base_token_price_usd": "3653.12491645176",
"base_token_price_native_currency": "1.0",
..
"volume_usd": {
"m5": "868581.7348314",
"h1": "16798158.0138526",
"h6": "164054610.850188",
"h24": "536545444.904535"
},
"reserve_in_usd": "163988541.3812",
"locked_liquidity_percentage": "99.82"
},
```
### Onchain Token Info endpoints - GT Score, Mint Authority, Freeze Authority
The following Token Info endpoints now provide more security related information:
* **GeckoTerminal Score Details** - Learn more about GT Score [here](https://support.coingecko.com/hc/en-us/articles/38381394237593-What-is-GT-Score-How-is-GT-Score-calculated).
* **Pool** - Combination of pool signals such as honeypot risk, buy/sell tax, proxy contract, liquidity amount, and whether the liquidity is locked.
* **Transaction** - Total number of transactions and trading volume in the last 24 hours.
* **Creation** - Age of the pool since creation. The longer, the better it is for the score.
* **Info** - Submitted social info and metadata to the token.
* **Holders** - Distribution of tokens among unique addresses.
* **Mint Authority**
* **Freeze Authority**
**Improved endpoints:**
* [Token Info by Token Address](https://docs.coingecko.com/reference/token-info-contract-address)
* [Pool Tokens Info by Pool Address](https://docs.coingecko.com/reference/pool-token-info-contract-address)
```json
"gt_score": 92.6605504587156,
"gt_score_details": {
"pool": 0,
"transaction": 32.2,
"creation": 0,
"info": 0,
"holders": 0
}
"mint_authority": "no",
"freeze_authority": "no"
```
### Onchain Simple Token Price endpoint - Market Cap to FDV Fallback
The [Onchain Simple Token Price](https://docs.coingecko.com/reference/onchain-simple-price) endpoint now supports fallback option for Market Cap to return FDV value, when the Market Cap value is not available.
Notes:
* If the token's market cap is not verified by the CoinGecko team, the onchain endpoints will return **null** for its market cap value, even though it has a displayed value on GeckoTerminal, which might not be accurate as it often matches the Fully Diluted Valuation (FDV).
* Market Cap can be verified by and sourced from CoinGecko, and the number may be higher than FDV as it may include Market Cap of tokens issued on other blockchain network.
If you require the Market Cap key (`market_cap_usd`) to return FDV value (as seen on GeckoTerminal.com) when Market Cap data is unavailable, please specify this parameter `marketcap_fdv_fallback=true`.
## Update Frequency Improvements for selected Pro-API endpoints (March 2025)
๐๏ธ **March 14, 2025**
\[Changes below are applicable to Analyst/Lite/Pro/Enterprise [plan subscribers](https://www.coingecko.com/en/api/pricing) only.]
Dear CoinGecko API paid plan subscribers,
We're excited to announce an improvement to our API, aimed at providing you with even faster access to real-time data! Starting **02:00 UTC, March 25, 2025**, the edge cache duration for the following endpoints will be reduced from 60s to 30s, allowing you to retrieve updated data more frequently.
1. Effective from 02:00 UTC, March 25, 2025:
1. [Trending Pools List](https://docs.coingecko.com/reference/trending-pools-list)
2. [Trending Pools by Network](https://docs.coingecko.com/reference/trending-pools-network)
3. [Top Pools by Network](https://docs.coingecko.com/reference/top-pools-network)
4. [Top Pools by Dex](https://docs.coingecko.com/reference/top-pools-dex)
2. Effective from 02:00 UTC, March 26, 2025:
1. [New Pools by Network](https://docs.coingecko.com/reference/latest-pools-network)
2. [New Pools List](https://docs.coingecko.com/reference/latest-pools-list)
3. [ Megafilter for Pools](https://docs.coingecko.com/reference/pools-megafilter)
4. [Search Pools](https://docs.coingecko.com/reference/search-pools)
3. Effective from 02:00 UTC, March 27, 2025:
1. [Top Pools by Token Address](https://docs.coingecko.com/reference/top-pools-contract-address)
2. [Most Recently Updated Tokens List](https://docs.coingecko.com/reference/tokens-info-recent-updated)
3. [Pools by Category ID](https://docs.coingecko.com/reference/pools-category)
**What This Means for You:**
* **Fresher Data, Quicker**: With a reduced cache time, you'll now have the option to access more up-to-date data, closer to real-time!
* **No Extra Credits for Cached Data**: If your request hits the cache (now updated every 30 seconds for endpoints above), there will be no additional credits chargedโjust like before.
**Things to Keep in Mind:**
* If your request hits our origin server instead of the cache to retrieve the latest data, there may be additional credits used.
* To balance cost and real-time data needs, we recommend reviewing your request frequency. For those who prefer to obtain data without extra credits, consider keeping your request interval at 60 seconds or more to align with the new cache duration.
We're committed to continuously improving your experience and ensuring you get the data you need, as efficiently as possible. If you have any questions or need assistance, feel free to reach out to [soonaik@coingecko.com](mailto:soonaik@coingecko.com) .
**CoinGecko API Team**
## Multiple Improvement: Holders data, Pool Stats, Simple Token Price
๐๏ธ **March 14, 2025**
### Onchain Token Info endpoints - Holders data
Now support the following holder data **(Beta)**:
* holders count
* top holders distribution percentage
**Improved endpoints:**
* [Token Info by Token Address](https://docs.coingecko.com/reference/token-info-contract-address)
* [Pool Tokens Info by Pool Address](https://docs.coingecko.com/reference/pool-token-info-contract-address)
```json
"holders": {
"count": 1432761,
"distribution_percentage": {
"top_10": "1.3019",
"11_20": "0.1024",
"21_40": "0.095",
"rest": "98.5007"
},
"last_updated": "2025-03-06T01:21:18Z"
```
### Onchain Pool Data endpoints - More Data Support
Now support the following data:
* `price_change_percentage`: m15, m30
* `volume_usd`: m15, m30
* `transactions`: h6
**Improved endpoints:**
* [Specific Pool Data by Pool Address](https://docs.coingecko.com/reference/pool-address)
* [Multiple Pools Data by Pool Addresses](https://docs.coingecko.com/reference/pools-addresses)
```json
"price_change_percentage": {
"m5": "0.06",
"m15": "0.06",
"m30": "0.89",
"h1": "-4.31",
"h6": "-1.02",
"h24": "3.32"
},
"transactions": {
"m5": {
"buys": 0,
"sells": 2,
"buyers": 0,
"sellers": 2
},
"m15": {
"buys": 0,
"sells": 2,
"buyers": 0,
"sellers": 2
},
"m30": {
"buys": 0,
"sells": 3,
"buyers": 0,
"sellers": 3
},
"h1": {
"buys": 1,
"sells": 23,
"buyers": 1,
"sellers": 7
},
"h6": {
"buys": 60,
"sells": 38,
"buyers": 23,
"sellers": 18
},
"h24": {
"buys": 206,
"sells": 138,
"buyers": 96,
"sellers": 77
}
},
"volume_usd": {
"m5": "130.5119858698",
"m15": "130.5119858698",
"m30": "177.109036156",
"h1": "4942.2463835639",
"h6": "28362.2127269542",
"h24": "112426.585893123"
}
```
### Onchain Simple Token Price endpoint - Liquidity & Price Change Percentage data
Now supports the following optional parameter to return more data.
* `include_24hr_price_change` (24hr price change percentage)
* `include_total_reverse_in_usd` (token liquidity data - total liquidity portion attributable to a specific token across all available pools)
**Improved Endpoint:**
* [Token Price by Token Addresses](https://docs.coingecko.com/reference/onchain-simple-price)
```json
{
"data": {
"id": "e58258f7-8368-4968-bbe1-b5343540cd71",
"type": "simple_token_price",
"attributes": {
"token_prices": {
"0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48": "1.00276143983565",
"0xc02aaa39b223fe8d0a0e5c4f27ead9083c756cc2": "3175.22870146126"
},
"market_cap_usd": {
"0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48": "25000000000",
"0xc02aaa39b223fe8d0a0e5c4f27ead9083c756cc2": "500000000000"
},
"h24_volume_usd": {
"0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48": "50000000",
"0xc02aaa39b223fe8d0a0e5c4f27ead9083c756cc2": "10000000000"
},
"h24_price_change_percentage": {
"0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48": "-0.15",
"0xc02aaa39b223fe8d0a0e5c4f27ead9083c756cc2": "1.15"
},
"total_reserve_in_usd": {
"0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48": "417994486.4342195821530162288",
"0xc02aaa39b223fe8d0a0e5c4f27ead9083c756cc2": "417994486.4342195821530162288"
}
}
}
```
## New Megafilter Endpoint, 200+ Chains Supported: Hyperliquid, Abstract, Berachain & MOAR!
๐๏ธ **February 27, 2025**
Powered by GeckoTerminal, the CoinGecko API now supports on-chain data across **200+ blockchain networks**, including the latest additions: Hyperliquid, HyperEVM, Abstract, Berachain, Story, Monad, Unichain, and Soneium.
While we offer the widest on-chain data coverage, we understand that you may have specific needs when slicing and dicing data for your use case. That's why we're introducing Megafilter, an exclusive endpoint available for our API paid plan subscribers (Analyst plan & above).
### ๐ฅ What's Megafilter?
This new endpoint provides unmatched flexibility, allowing you to query and filter data exactly the way you want.
๐ Docs: [Megafilter for Pools](https://docs.coingecko.com/reference/pools-megafilter)
### ๐ What Can You Do?
With the /megafilter endpoint, you can slice and dice on-chain data your way across:
* 200+ blockchain networks, 1,400+ dexes, 6M+ pools, and 5M+ tokens
* Advanced filtering options based on liquidity, FDV, volume, transactions, buy/sell trends, and time range
* Custom sorting, including trending pools (5m), newest pools, or liquidity growth
* Fraud detection filters: Exclude honeypots, check GT Score, verify CG listings, and track social metrics
Here's some quick examples:
* Track fresh pools on Uniswap V4 & Aerodrome with liquidity above \$1,000
* Discover trending DEX pools across Solana, Base, and other chains with a high GT Score.
* Filter out risky pools with built-in honeypot protection & fraud checks
* Customize data retrieval based on your strategy: time-based, volume-based, or trend-driven
### Try it out now!
๐ API Docs: [Megafilter for Pools](https://docs.coingecko.com/reference/pools-megafilter)\
๐ Live Filtering on [GeckoTerminal](https://www.geckoterminal.com/)
## Update Frequency Improvements for selected Pro-API endpoints
๐๏ธ **February 14, 2025**
\[Changes below are applicable to Analyst/Lite/Pro/Enterprise [plan subscribers](https://www.coingecko.com/en/api/pricing) only.]
Dear CoinGecko API paid plan subscribers,
We're excited to announce an improvement to our API, aimed at providing you with even faster access to real-time data! Starting **02:00 UTC, February 24, 2025**, the edge cache duration for the following endpoints will be reduced to 30s, allowing you to retrieve updated data more frequently.
| Endpoints | Effective Date & Time | Current Update Frequency | New Update Frequency |
| :------------------------------------------------------------------------------------------------------------------- | :--------------------------------------------------------------- | :----------------------- | :------------------- |
| Onchain [/networks/../tokens/{address}](https://docs.coingecko.com/reference/token-data-contract-address) | 02:00 UTC, February 24, 2025 | 60s | 30s |
| Onchain [/networks/../tokens/multi/{addresses}](https://docs.coingecko.com/reference/tokens-data-contract-addresses) | 06:00 UTC, February 24, 2025 | 60s | 30s |
| Onchain [/networks/../pools/../ohlcv](https://docs.coingecko.com/reference/pool-ohlcv-contract-address) | 02:00 UTC, February 25, 2025 - Enterprise plan subscribers only | 60s | 30s |
| Onchain [/networks/../pools/../ohlcv](https://docs.coingecko.com/reference/pool-ohlcv-contract-address) | 02:00 UTC, February 26, 2025 - Analyst/Lite/Pro plan subscribers | 60s | 30s |
**What This Means for You:**
* **Fresher Data, Quicker**: With a reduced cache time, you'll now have the option to access more up-to-date data, closer to real-time!
* **No Extra Credits for Cached Data**: If your request hits the cache (now updated every 30 seconds for endpoints above), there will be no additional credits chargedโjust like before.
**Things to Keep in Mind:**
* If your request hits our origin server instead of the cache to retrieve the latest data, there may be additional credits used.
* To balance cost and real-time data needs, we recommend reviewing your request frequency. For those who prefer to obtain data without extra credits, consider keeping your request interval at 60 seconds or more to align with the new cache duration.
We're committed to continuously improving your experience and ensuring you get the data you need, as efficiently as possible. If you have any questions or need assistance, feel free to reach out to [soonaik@coingecko.com](mailto:soonaik@coingecko.com) .
**CoinGecko API Team**
## Enhanced Onchain Metadata, Increased Max Address Limit for Multi Endpoints, Improved Exchange Tickers Sorting
๐๏ธ **February 09, 2025**
### Onchain Metadata: Improved Coverage
**Previously:** Payload may return 'missing.png' for `image_url` for tokens that do not have image data.
**Now:** Coverage of metadata (images, websites, description, socials) is now improved for tokens on Solana, Ton, Base, and Sui networks. For tokens that do not contain image data, 'null' value will be returned for `image_url`.
**Improved endpoints with image data:**
1. [Trending Pools List](https://docs.coingecko.com/reference/trending-pools-list)
2. [Trending Pools by Network](https://docs.coingecko.com/reference/trending-pools-network)
3. [Specific Pool Data by Pool Address](https://docs.coingecko.com/reference/pool-address)
4. [Multiple Pools Data by Pool Addresses](https://docs.coingecko.com/reference/pools-addresses)
5. [Top Pools by Network](https://docs.coingecko.com/reference/top-pools-network)
6. [Top Pools by Dex](https://docs.coingecko.com/reference/top-pools-dex)
7. [New Pools by Network](https://docs.coingecko.com/reference/latest-pools-network)
8. [New Pools List](https://docs.coingecko.com/reference/latest-pools-list)
9. [Search Pools](https://docs.coingecko.com/reference/search-pools)
10. [Top Pools by Token Address](https://docs.coingecko.com/reference/top-pools-contract-address)
11. [Token Data by Token Address](https://docs.coingecko.com/reference/token-data-contract-address)
12. [Tokens Data by Token Addresses](https://docs.coingecko.com/reference/tokens-data-contract-addresses)
13. [Token Info by Token Address](https://docs.coingecko.com/reference/token-info-contract-address)
14. [Pool Tokens Info by Pool Address](https://docs.coingecko.com/reference/pool-token-info-contract-address)
15. [Most Recently Updated Tokens List](https://docs.coingecko.com/reference/tokens-info-recent-updated)
**Improved endpoints with metadata (images, websites, description, socials):**
1. [Token Info by Token Address](https://docs.coingecko.com/reference/token-info-contract-address)
2. [Pool Tokens Info by Pool Address](https://docs.coingecko.com/reference/pool-token-info-contract-address)
3. [Most Recently Updated Tokens List](https://docs.coingecko.com/reference/tokens-info-recent-updated)
Note: Metadata may be sourced on-chain and is not vetted by the CoinGecko team. If you wish to get metadata reviewed by CoinGecko team, you may use the following endpoints:
* [Coin Data by ID](https://docs.coingecko.com/reference/coins-id)
* [Coin Data by Token Address](https://docs.coingecko.com/reference/coins-contract-address)
### Improved Max Address Limit for onchain /multi endpoints
**Previously:** Onchain /multi endpoints support up to 30 token or pool contract addresses per request.
**Now:** Onchain /multi endpoints support up to 50 token or pool contract addresses per request.
**Improved endpoints:**
1. [Tokens Data by Token Addresses](https://docs.coingecko.com/reference/tokens-data-contract-addresses)
2. [Multiple Pools Data by Pool Addresses ](https://docs.coingecko.com/reference/pools-addresses)
Note: this new max address input limit is exclusive for paid plan subscribers (Analyst plan & above) only.
### Improved Data Consistency for Exchange Tickers by ID
For [Exchange Tickers by ID](https://docs.coingecko.com/reference/exchanges-id-tickers) endpoint, the order is sorted by **trust\_score\_desc** by default.
* Sometimes duplicate or missing data may occur due to paginated cached response, especially when a ticker's rank changes between 2 paginated requests, e.g. it might shift from Page 2 to Page 1, vice versa.
* We've added a new `order` option: **base\_target**, which will sort the tickers by **base** symbol, then **target** symbol, in lexicographical order, i.e. `0->9`, then `a->Z`.
Example: flagging ?order=base\_target
```
pro-api.coingecko.com/api/v3/exchanges/binance/tickers?order=base_target
```
This sorting method ensures stable pagination, reducing issues where cached responses may cause duplicate or missing tickers across pages.
## Multiple Improvements: Onchain Pools Page Limit, Trades Token Filter
๐๏ธ **January 27, 2025**
### Onchain Pools Data: Supports more than 10 pages of data
**Previously:** There was a limitation of a maximum of 10 pages for accessing pools data in the related endpoints.
**Now:** All paid plan subscribers (Analyst & above) can access more than 10 pages of pools data for the endpoints below.
**Improved Endpoints:**
1. [Search Pools](https://docs.coingecko.com/reference/search-pools)
2. [Top Pools by Token Address](https://docs.coingecko.com/reference/top-pools-contract-address)
3. [Trending Pools List](https://docs.coingecko.com/reference/trending-pools-list)
4. [Trending Pools by Network](https://docs.coingecko.com/reference/trending-pools-network)
5. [New Pools by Network](https://docs.coingecko.com/reference/latest-pools-network)
6. [New Pools List](https://docs.coingecko.com/reference/latest-pools-list)
7. [Top Pools by Network](https://docs.coingecko.com/reference/top-pools-network)
8. [Top Pools by Dex](https://docs.coingecko.com/reference/top-pools-dex)
### Onchain Trades: Added Token Filter
**Endpoint:** [Past 24 Hour Trades by Pool Address](https://docs.coingecko.com/reference/pool-trades-contract-address)
**Previously:** There was no way to filter trades data by base or quote token.
**Now**: A new optional parameter has been added to allow filtering by base or quote token of a pool.
* Parameter: `token`
* Value options:
* `base`
* `quote`
* `{token_address}`
**Example**:
```json Example
?token=base // get the trades data of base token
?token=quote // get the trades data of quote token
?token=8FqXr6dw5NHA2TtwFeDz6q9p7y9uWyoEdZmpXqqUpump // get the trades data of specific token based on address
```
## Multiple Improvements: Onchain Token Price, NFT Market Cap
๐๏ธ **January 24, 2025**
### Onchain Simple Token Price: Added Market Cap and 24h Volume Data
**Endpoint:** [Token Price by Token Addresses](https://docs.coingecko.com/reference/onchain-simple-price)
* You can now flag `include_market_cap=true` and `include_24hr_vol=true` to retrieve market cap and 24h trading volume data. e.g.
```json json
{
"data": {
"id": "e1979db1-5c3e-4ba8-b103-cb0258af4a7c",
"type": "simple_token_price",
"attributes": {
"token_prices": {
"0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48": "0.999365729816931",
"0xc02aaa39b223fe8d0a0e5c4f27ead9083c756cc2": "3399.24368371279"
},
"market_cap_usd": {
"0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48": "51963214441.24363",
"0xc02aaa39b223fe8d0a0e5c4f27ead9083c756cc2": "10005535878.50094"
},
"h24_volume_usd": {
"0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48": "2095689865.85327",
"0xc02aaa39b223fe8d0a0e5c4f27ead9083c756cc2": "2544539948.02599"
}
}
}
}
```
### NFT Data: Added 'Market Cap Rank'
You can now obtain the `market_cap_rank` data of NFT collections via the following endpoints:
* [NFTs Collection Data by ID](https://docs.coingecko.com/reference/nfts-id)
* [NFTs Collection Data by Contract Address](https://docs.coingecko.com/reference/nfts-contract-address)
```json example
"market_cap_rank": 75,
```
## Removal of Unsupported Categories
๐๏ธ **January 23, 2025**
### Upcoming Removal of Unsupported Categories from CoinGecko and CoinGecko API
#### Summary
We are announcing the removal of certain categories from CoinGecko and CoinGecko API. These categories will no longer be supported across all API endpoints starting **February 12, 2025**.
| No | Category Name | Category ID |
| :- | :--------------------- | :------------------ |
| 1 | US Election 2020 | us-election-2020 |
| 2 | Governance | governance |
| 3 | Cryptocurrency | cryptocurrency |
| 4 | Technology and Science | technology-science |
| 5 | Presale Meme | presale-meme-coins |
| 6 | Business Platform | business-platform |
| 7 | Number | number |
| 8 | Structured Product | structured-products |
| 9 | Investment | investment |
| 10 | Niftex Shards | niftex-shards |
| 11 | Ethereum POW IOU | ethereum-pow-iou |
| 12 | Mirrored Assets | mirrored-assets |
| 13 | Remittance | remittance |
| 14 | Protocol | protocol |
| 15 | Unicly Ecosystem | utokens |
| 16 | Finance and Banking | finance-banking |
| 17 | Eth 2.0 Staking | eth-2-0-staking |
#### Reason for Removal
Many of these categories no longer have associated coins. Some categories are outdated and no longer relevant in the crypto space. The changes align with updated category topology standards to maintain data accuracy and relevance.
#### Impact
API responses for the `/coins/markets` [endpoint](https://docs.coingecko.com/reference/coins-markets) will no longer support data of the categories above. Any requests specifying these categories will return an error.
#### Action Required
Ensure applications using the `/coins/markets` [endpoint](https://docs.coingecko.com/reference/coins-markets) are not querying these removed categories. Please update any code or documentation referencing these categories to prevent errors.
## Extended Historical Data for Onchain OHLCV Endpoint
๐๏ธ **January 15, 2025**
### What's New?
We've improved the [Pool OHLCV Chart by Pool Address](https://docs.coingecko.com/reference/pool-ohlcv-contract-address) endpoint to provide access to a much broader range of historical data.
#### Key Updates
* **Previous Behavior:** Users could only query data for the past 6 months from today.
* **New Behavior**: Users can now access data from September 2021 to the present, depending on the pool's tracking start date on GeckoTerminal.
* Each API request is **limited to a 6-month date range**, but users can query older data by using the before\_timestamp parameter.
Note: access to data beyond the past 6 months is only available to [Paid Plan](https://www.coingecko.com/en/api/pricing) subscribers (Analyst plan & above).
#### Action Required
No changes are required for existing integrations. However, users who need data beyond the past 6 months should adjust their queries to use the `before_timestamp` parameter to fetch additional data.
## Update to Total Supply of POW Coins
๐๏ธ **January 15, 2025**
#### What's Changing?
We are updating the definition of Total Supply for PoW (Proof-of-Work) coins to reflect the actual number of mined coins rather than the maximum supply. This change ensures consistency and accuracy in representing the supply data.
#### Key Updates
* **Previous Behavior:**
* Total Supply: Displayed as the maximum possible supply (e.g., Bitcoin: 21,000,000).
* **New Behavior:**
* Total Supply: Now reflects the actual number of mined coins.\
For example: Bitcoin: \~19,500,000 (as of January 2025).
This update will also affect historical Total Supply data for consistency. This change applies to all affected PoW coins, including Bitcoin, Bitcoin Cash, Litecoin, Ethereum Classic, and more.
#### Affected endpoints that contain "total\_supply" data:
* **Current Data**
* [Coin Data by ID](https://docs.coingecko.com/reference/coins-id)
* [Coins List with Market Data](https://docs.coingecko.com/reference/coins-markets)
* **Historical Darta**
* [Total Supply Chart by ID](https://docs.coingecko.com/reference/coins-id-total-supply-chart)
* [Total Supply chart within time range by ID](https://docs.coingecko.com/reference/coins-id-total-supply-chart-range)
#### Timeline:
**Bitcoin:** Updated on Jan 14, 2025
**Other PoW Coins**: Scheduled for Jan 22, 2025
* [Bitcoin Cash](https://www.coingecko.com/en/coins/bitcoin-cash)
* [Litecoin](https://www.coingecko.com/en/coins/litecoin)
* [Ethereum Classic](https://www.coingecko.com/en/coins/ethereum-classic)
* [Bitcoin SV](https://www.coingecko.com/en/coins/bitcoin-sv)
* [Zcash](https://www.coingecko.com/en/coins/zcash)
* [eCash](https://www.coingecko.com/en/coins/ecash)
* [Dash](https://www.coingecko.com/en/coins/dash)
* [Verus Coin](https://www.coingecko.com/en/coins/verus-coin)
* [Ravencoin](https://www.coingecko.com/en/coins/ravencoin)
* [Kadena](https://www.coingecko.com/en/coins/kadena)
* [Decred](https://www.coingecko.com/en/coins/decred)
* [Flux (Zelcash)](https://www.coingecko.com/en/coins/flux-zelcash)
* [DigiByte](https://www.coingecko.com/en/coins/digibyte)
* [Quantum Resistant Ledger](https://www.coingecko.com/en/coins/quantum-resistant-ledger)
* [Komodo](https://www.coingecko.com/en/coins/komodo)
* [Groestlcoin](https://www.coingecko.com/en/coins/groestlcoin)
* [Firo](https://www.coingecko.com/en/coins/firo)
* [Litecoin Cash](https://www.coingecko.com/en/coins/litecoin-cash)
* [LuckyCoin](https://www.coingecko.com/en/coins/luckycoin)
* [Enecuum](https://www.coingecko.com/en/coins/enecuum)
* [Wownero](https://www.coingecko.com/en/coins/wownero)
* [Radiant](https://www.coingecko.com/en/coins/radiant)
* [Tidecoin](https://www.coingecko.com/en/coins/tidecoin)
* [Handshake](https://www.coingecko.com/en/coins/handshake)
* [Neoxa](https://www.coingecko.com/en/coins/neoxa)
* [Vertcoin](https://www.coingecko.com/en/coins/vertcoin)
* [Feathercoin](https://www.coingecko.com/en/coins/feathercoin)
* [Bitcore](https://www.coingecko.com/en/coins/bitcore)
* [Phoenixcoin](https://www.coingecko.com/en/coins/phoenixcoin)
* [BitcoinZ](https://www.coingecko.com/en/coins/bitcoinz)
* [Hush](https://www.coingecko.com/en/coins/hush)
* [DigitalNote](https://www.coingecko.com/en/coins/digitalnote)
* [EquityPay](https://www.coingecko.com/en/coins/equitypay)
* [Evadore](https://www.coingecko.com/en/coins/evadore)
* [Swap](https://www.coingecko.com/en/coins/swap)
* [DeVault](https://www.coingecko.com/en/coins/devault)
* [AXE](https://www.coingecko.com/en/coins/axe)
* [Iridium](https://www.coingecko.com/en/coins/iridium)
* [X-Cash](https://www.coingecko.com/en/coins/x-cash)
* [Bolivarcoin](https://www.coingecko.com/en/coins/bolivarcoin)
* [uPlexa](https://www.coingecko.com/en/coins/uplexa)
* [WorldCoin (WDC)](https://www.coingecko.com/en/coins/worldcoin-wdc)
## Improved Update Frequency for selected Pro-API endpoints
๐๏ธ **January 13, 2025**
\[Changes below are applicable to Analyst/Lite/Pro/Enterprise [plan subscribers](https://www.coingecko.com/en/api/pricing) only.]
The edge cache duration for the following endpoints are now reduced to 20-30s, allowing you to retrieve updated data more frequently.
| Endpoints | Previous Update Frequency | Current Update Frequency |
| :-------------------------------------------------------------------------------------------------------- | :------------------------ | :----------------------- |
| CoinGecko [/simple/price](https://docs.coingecko.com/reference/simple-price) | 30s | 20s |
| CoinGecko [/simple/token\_price](https://docs.coingecko.com/reference/simple-token-price) | 30s | 20s |
| Onchain [/simple/networks/../token\_price](https://docs.coingecko.com/reference/onchain-simple-price) | 60s | 30s |
| Onchain [/networks/../pools/../trades](https://docs.coingecko.com/reference/pool-trades-contract-address) | 60s | 30s |
| Onchain [/networks/../pools/..](https://docs.coingecko.com/reference/pool-address) | 60s | 30s |
| Onchain [/networks/../pools/multi/..](https://docs.coingecko.com/reference/pools-addresses) | 60s | 30s |
**What This Means for You:**
* **Fresher Data, Quicker**: With a reduced cache time, you'll now have the option to access more up-to-date data, closer to real-time!
* **No Extra Credits for Cached Data**: If your request hits the cache (now updated every 20-30 seconds for endpoints above), there will be no additional credits chargedโjust like before.
**Things to Keep in Mind:**
* If your request hits our origin server instead of the cache to retrieve the latest data, there may be additional credits used.
* To balance cost and real-time data needs, we recommend reviewing your request frequency. For those who prefer fresher data without extra credits, consider keeping your request interval at 30 seconds or more to align with the new cache duration.
We're committed to continuously improving your experience and ensuring you get the data you need, as efficiently as possible. If you have any questions or need assistance, feel free to reach out to [soonaik@coingecko.com](mailto:soonaik@coingecko.com) .
**CoinGecko API Team**
## Improved 5-minutely data for Historical Chart Data endpoints
๐๏ธ **January 09, 2025**
For the following 4 historical chart endpoints, the data of the *last 48 hours from now* is no longer excluded.
* [Coin Historical Chart Data by ID](https://docs.coingecko.com/reference/coins-id-market-chart)
* [Coin Historical Chart Data within Time Range by ID](https://docs.coingecko.com/reference/coins-id-market-chart-range)
* [Coin Historical Chart Data by Token Address](https://docs.coingecko.com/reference/contract-address-market-chart)
* [Coin Historical Chart Data within Time Range by Token Address](https://docs.coingecko.com/reference/contract-address-market-chart-range)
**Note:** The **5-minutely** and **hourly** interval params are exclusively available to Enterprise plan subscribers, bypassing auto-granularity:
* `interval=5m`: 5-minutely historical data, supports up to any 10 days date range per request.
* `interval=hourly`: hourly historical data, supports up to any 100 days date range per request.
* **Data availability:**
* `interval=5m`: Available from 9 February 2018 onwards
* `interval=hourly`: Available from 30 Jan 2018 onwards
For non-Enterprise plan subscribers who would like to get hourly data, please leave the `interval` params empty for auto granularity:
* 1 day from current time = 5-minutely data
* 1 day from any time (except current time) = hourly data
* 2 - 90 days from any time = hourly data
* above 90 days from any time = daily data (00:00 UTC)
## Added: Onchain Categories Data, CG data improvements
๐๏ธ **December 24, 2024**
### NEW: Onchain Categories : Get Categories on GeckoTerminal.com
This new [Categories List](https://docs.coingecko.com/reference/categories-list) endpoint allows you to query all the categories supported on GeckoTerminal.com such as 'Pump Fun' and 'Animal'.
* This endpoint is exclusively available for [Analyst/Lite/Pro/Enterprise plan](https://www.coingecko.com/en/api/pricing) subscribers only.
### NEW: Onchain Catergory Pools: Get Pools of a specific Category
This new [Pools by Category ID](https://docs.coingecko.com/reference/pools-category) endpoint allows you to query all the pools of a specific category on GeckoTerminal.com.
* This endpoint is exclusively available for [Analyst/Lite/Pro/Enterprise plan](https://www.coingecko.com/en/api/pricing) subscribers only.
* You can also obtain tokens of a specific category, by flagging `include=base_token`
### Onchain Token Info: Added Categories Data
You can now obtain the categories of a token via the following endpoints:
1. [Token Info by Token Address](https://docs.coingecko.com/reference/token-info-contract-address)
2. [Pool Tokens Info by Pool Address](https://docs.coingecko.com/reference/pool-token-info-contract-address)
Payload example:
```yaml json
"categories": [
"Doge",
"Baby",
"Animal"
],
"gt_category_ids": [
"doge",
"baby",
"animal"
```
### Onchain New Pools Data: Bug Fixed
Previously, this [/networks/new\_pools](https://docs.coingecko.com/reference/latest-pools-network) endpoint omitted new pools that are created within the last 24 hours.
It now returns all newly created pools in the last 48 hours.
### CoinGecko Exchange Data: Added support of inactive exchange id
You now query the the list of id of delisted exchanges with [Exchanges List (ID Map)](https://docs.coingecko.com/reference/exchanges-list) endpoint, by flagging `status=inactive `
Payload example:
```yaml json
{
"id": "ftx",
"name": "FTX (Derivatives)"
},
{
"id": "ftx_spot",
"name": "FTX"
},
{
"id": "ftx_tr",
"name": "FTX TR"
},
{
"id": "ftx_us",
"name": "FTX.US"
},
```
**Tips**: you may query to get historical volume delisted exchanges for via the following endpoints:
* [Exchange Volume Chart by ID](https://docs.coingecko.com/reference/exchanges-id-volume-chart)
* [Exchange Volume Chart within Time Range by ID](https://docs.coingecko.com/reference/exchanges-id-volume-chart-range)
### CoinGecko Historical Chart Data: Faster Last UTC Day (00:00) Data Update
For [Coin Historical Chart Data by ID](https://docs.coingecko.com/reference/coins-id-market-chart) endpoint, the last completed UTC day (00:00) data is now available **10 minutes after midnight** on the next UTC day (00:10).
Previously, the last completed UTC day (00:00) was only made available **35 minutes** after midnight.
## \[Updated: Q4 2024] CoinGecko Asset Issuance Standardisation Initiative Updates
๐๏ธ **December 17, 2024**
As part of our commitment to improving data quality and enhancing the consistency of asset information, we are rolling out an asset standardization initiative at CoinGecko.
**What is asset standardization?**\
Standardization involves refining how we classify and display assets. By systematically organizing asset listings into more precise categories - such as native, bridged, or wrapped tokens each following specific naming conventions, we aim to eliminate confusion and enhance data reliability.
**What changes should I expect?**\
The most notable change is that non-native token contracts previously grouped under native asset listings will now be assigned their own distinct pages.
For example, a bridged version of USDT that might have been aggregated under the original, native USDT page, will now be featured on a dedicated page specifically for that bridged variant.
Additionally, there may be varying levels of changes in various aggregated data points of the standardized assets, including trading volume, supply, market cap rankings, etc., due to misplaced contracts being transitioned away from the original page to accurately reflect their true metrics.
**Focus for Q3 2024** **\[Completed โ ]**
* [Wrapped Bitcoin (WBTC)](https://www.coingecko.com/en/coins/wrapped-bitcoin)
* [Wrapped Ethereum (WETH)](https://www.coingecko.com/en/coins/weth)
* [Dai (DAI)](https://www.coingecko.com/en/coins/dai)
\*\*For full list of FAQs and updated infomation, please refer [here](https://support.coingecko.com/hc/en-us/articles/35555248857497-CoinGecko-Asset-Issuance-Standardisation-Initiative-Updates-and-FAQ)
### What's New in Q4 2024? ๐
Building on Q3's achievements, we're expanding the scope of Standardization to include four additional Coins this quarter, selected based on their significance and impact on the DeFi ecosystem.
* [Frax (FRAX)](https://www.coingecko.com/en/coins/frax)
* [Wrapped AVAX (WAVAX)](https://www.coingecko.com/en/coins/wrapped-avax)
* [Wrapped BNB (WBNB)](https://www.coingecko.com/en/coins/wbnb)
* [Wrapped stETH (wstETH)](https://www.coingecko.com/en/coins/wrapped-steth)
### Tips and FAQs for API users
#### **1. How does this affect my current API setup?**
The following CoinGecko API endpoints will be impacted, with full details tracked in [this spreadsheet](https://docs.google.com/spreadsheets/d/15FyY1gvUi20LdnlJRly-pXvm5ATNbFbSy06VoI1vVs4/edit?usp=sharing). We encourage you to make the necessary adjustments and enable edit notifications on the Google Sheets, to receive real-time updates when non-native token contracts have been successfully standardized.
**Simple**
* /simple/price
* /simple/token\_price/{id}
**Coins**
* /coins/markets
* /coins/{id}
* /coins/{id}/tickers
* /coins/{id}/history
* /coins/{id}/market\_chart
* /coins/{id}/market\_chart/range
* /coins/{id}/ohlc
* /coins/{id}/ohlc/range
* /coins/{id}/circulating\_supply\_chart
* /coins/{id}/circulating\_supply\_chart/range
* /coins/{id}/total\_supply\_chart
* /coins/{id}/total\_supply\_chart/range
**Contract**
* /coins/{id}/contract/{contract_address}
* /coins/{id}/contract/{contract_address}/market\_chart
* /coins/{id}/contract/{contract_address}/market\_chart/range
**Exchange**
* /exchanges/{id}/tickers
* /exchanges/{id}/volume\_chart
* /exchanges/{id}/volume\_chart/range
#### **2. Do I have to make changes to my API?**
**No changes are necessary** if you do not need data for non-native token contracts that will be separated away from the native tokens.
#### **3. What will happen to the coins that are separated into a new coin page?**
Historical data for new non-native or bridged assets will only be available from the date of asset page creation (i.e. stnadardized). To access historical data prior to the asset standardization, we recommend retrieving data from the original native assets.
#### **4. How do I identify the list of coins that will be separated?**
For a finalised list of token contracts and API IDs that have been separated from its native asset page and listed individually, please refer to this [Google Sheets](https://docs.google.com/spreadsheets/d/15FyY1gvUi20LdnlJRly-pXvm5ATNbFbSy06VoI1vVs4/edit?usp=sharing)
You may also identify the list of bridged coins via API: you may also use [/categories/list endpoint](/reference/coins-categories-list) to look for bridged categories such as:
1. bridged-usdc
2. bridged-wbtc
3. bridged-weth
Then you may use [/coins/market endpoint](/reference/coins-markets) to retrieve the list of coins
## Enhancing Your Access to Even Fresher Data!
๐๏ธ **December 16, 2024**
\[Changes below are applicable to Analyst/Lite/Pro/Enterprise [plan subscribers](https://www.coingecko.com/en/api/pricing) only.]
**Dear CoinGecko API paid plan subscribers,**
We're excited to announce an improvement to our API, aimed at providing you with even faster access to real-time data! Starting **02:00 UTC, January 13, 2025**, the edge cache duration for the following endpoints will be reduced to 20-30s, allowing you to retrieve updated data more frequently.
| Endpoints | Current Update Frequency | New Update Frequency |
| :-------------------------------------------------------------------------------------------------------- | :----------------------- | :------------------- |
| CoinGecko [/simple/price](https://docs.coingecko.com/reference/simple-price) | 30s | 20s |
| CoinGecko [/simple/token\_price](https://docs.coingecko.com/reference/simple-token-price) | 30s | 20s |
| Onchain [/simple/networks/../token\_price](https://docs.coingecko.com/reference/onchain-simple-price) | 60s | 30s |
| Onchain [/networks/../pools/../trades](https://docs.coingecko.com/reference/pool-trades-contract-address) | 60s | 30s |
| Onchain [/networks/../pools/..](https://docs.coingecko.com/reference/pool-address) | 60s | 30s |
| Onchain [/networks/../pools/multi/..](https://docs.coingecko.com/reference/pools-addresses) | 60s | 30s |
**What This Means for You:**
* **Fresher Data, Quicker**: With a reduced cache time, you'll now have the option to access more up-to-date data, closer to real-time!
* **No Extra Credits for Cached Data**: If your request hits the cache (now updated every 20-30 seconds for endpoints above), there will be no additional credits chargedโjust like before.
**Things to Keep in Mind:**
* If your request hits our origin server instead of the cache to retrieve the latest data, there may be additional credits used.
* To balance cost and real-time data needs, we recommend reviewing your request frequency. For those who prefer fresher data without extra credits, consider keeping your request interval at 30 seconds or more to align with the new cache duration.
We're committed to continuously improving your experience and ensuring you get the data you need, as efficiently as possible. If you have any questions or need assistance, feel free to reach out to [soonaik@coingecko.com](mailto:soonaik@coingecko.com) .
**CoinGecko API Team**
## Multiple Improvements: Onchain Trending Pools, CG New Currencies Support, Snapshot, Exchange Info
๐๏ธ **December 15, 2024**
### Onchain Trending Pools: Added Support to Filter by Duration
You can now query trending pools with the following endpoints, and filter them by different duration: 5m, 1h, 6h, 24h, using `duration` parameter. e.g. `duration=5m`
* [Trending Pools List](https://docs.coingecko.com/reference/trending-pools-list): query all the trending pools across all networks on GeckoTerminal
* [Trending Pools by Network](https://docs.coingecko.com/reference/trending-pools-network): query the trending pools based on the provided network
### CG Coin Prices: Added Support for New Fiat Currencies
You can now query coin prices in the 13 new currencies for the following 3 endpoints:
* [Coin Price by IDs](https://docs.coingecko.com/reference/simple-price): query latest price in selected currencies, by coin id
* [Coin Price by Token Addresses](https://docs.coingecko.com/reference/simple-token-price): query latest price in selected currencies, by token address
* [BTC-to-Currency Exchange Rates](https://docs.coingecko.com/reference/exchange-rates): query BTC exchange rates with other currencies
**New supported currencies:**
1. Colombia | COP
2. Kenya | KES
3. Romania | RON
4. Dominican Republic | DOP
5. Costa Rica | CRC
6. Honduras | HNL
7. Zambia | ZMW
8. El Salvador | SVC
9. Bosnia and Herzegovina | BAM
10. Peru | PEN
11. Guatemala | GTQ
12. Lebanon | LBP
13. Armenian Dram | AMD
### CG Coin Info: Included Snapshot URL
[Coin Data by ID](https://docs.coingecko.com/reference/coins-id) now includes Snapshot link, e.g.
```asp json
"snapshot_url": "https://snapshot.org/#/lido-snapshot.eth",
```
### CG Exchange Info: Included Number of Coins and Pairs
[https://docs.coingecko.com/reference/exchanges-id](https://docs.coingecko.com/reference/exchanges-id) now includes "coins" and "pairs", e.g.
```asp json
"coins": 384,
"pairs": 1281,
```
## Multiple Improvements: Onchain Simple Price, Onchain Recently Updated Info, NFT Collection Data
๐๏ธ **October 09, 2024**
### Onchain: Simple Price - Increased Token Address Limit from 30 to 100
[Token Price by Token Addresses](/reference/onchain-simple-price) now allows to input up to 100 contract addresses, instead of 30.
* You may now retrieve data of up to 100 token prices of a specific network, in one single request.
* Available exclusively to Pro API paid plan subscribers.
### Onchain: Recently Updated Info - Added Filter by Network
[Most Recently Updated Token List](/reference/tokens-info-recent-updated) now allows to filter by blockchain network, by flagging the `network` parameter. e.g. `network=eth`.
* You can use the `network` parameter to retrieve the 100 most recently updated token info of a specific network.
* View list of supported network via [Supported Networks List](https://docs.coingecko.com/reference/networks-list) endpoint.
### NFT Collection Data - Included Banner Image
[NFTs Collection Data by ID](/reference/nfts-id) now provides banner image of a NFT collection.
View banner image [example](https://coin-images.coingecko.com/nft_contracts/images/38/pudgy-penguins-banner.png?1708416126) on: [https://www.coingecko.com/en/nft/pudgy-penguins](https://www.coingecko.com/en/nft/pudgy-penguins)
```json
{
"symbol": "PPG",
"image": {
"small": "https://coin-images.coingecko.com/nft_contracts/images/38/small/da64989d9762c8a61b3c65917edfdf97.png?1707287183"
},
"banner_image": "https://coin-images.coingecko.com/nft_contracts/images/38/pudgy-penguins-banner.png?1708416126",
..
```
## Multiple Improvements: Global Market Chart, Asset Platforms, Coin Categories, Historical Supply Chart
๐๏ธ **September 26, 2024**
### Global Market Chart - Improved Daily Data Update
Previously, for [Global Market Cap Chart Data endpoint](https://docs.coingecko.com/reference/global-market-cap-chart) , the daily data is returned at 23:00 UTC. We've made improvement to return daily data at 00:00 UTC.
The last completed UTC day (00:00) is available 5 minutes after midnight on the next UTC day (00:05). The cache will **always expire at 00:05 UTC**. If you wish to get the latest daily data (00:00 UTC), you can make request at 00:05 UTC or later.
### Asset Platforms - Included Images of Blockchain Network Logos
[Asset Platforms List (ID Map)](/reference/asset-platforms-list) now provides the logos of blockchain networks.
For example:
```json
"image": {
"thumb": "https://coin-images.coingecko.com/asset_platforms/images/93/thumb/AN_logomark.png?1706606703",
"small": "https://coin-images.coingecko.com/asset_platforms/images/93/small/AN_logomark.png?1706606703",
"large": "https://coin-images.coingecko.com/asset_platforms/images/93/large/AN_logomark.png?1706606703"
}
```
### Coins Categories - Included Ids of Top 3 Coins
[Coins Categories List with Market Data](/reference/coins-categories) now provides coins id of the top 3 coins of a category.
For example:
```json
"top_3_coins_id": [
"bitcoin",
"ethereum",
"binancecoin"
],
```
### Circulating Supply Chart and Total Supply Chart - Fixed '0' data issue
For the following **Enterprise-plan** exclusive endpoints below, there was a bug that returned wrong '0' value in the payload. This is fixed and will no longer return wrong '0' value in the payload.
1. [๐ Circulating Supply Chart by ID](https://docs.coingecko.com/reference/coins-id-circulating-supply-chart)
2. [๐ Circulating Supply chart within Time Range by ID](https://docs.coingecko.com/reference/coins-id-circulating-supply-chart-range)
3. [๐ Total Supply Chart by ID](https://docs.coingecko.com/reference/coins-id-total-supply-chart)
4. [๐ Total Supply Chart within time range by ID](https://docs.coingecko.com/reference/coins-id-total-supply-chart-range)
## Improvement of update frequency for OHLC endpoints
๐๏ธ **September 04, 2024**
The cache & update frequency of the following endpoints have been improved from every 30 minutes to every 15 minutes:
* [/coins/{id}/ohlc](/reference/coins-id-ohlc)
* [/coins/{id}/ohlc/range](/reference/coins-id-ohlc-range)
## Included new fields - NFT data
๐๏ธ **August 18, 2024**
We've added 'user\_favorites\_count', and 'ath' (all-time-high) related data to the following NFT endpoints:
* [/nfts/{id}](/reference/nfts-id)
* [/nfts/{asset_platform_id}/contract/{contract_address}](/reference/nfts-contract-address)
**Example of responses:**
```json
{
"user_favorites_count": 3660,
"ath": {
"native_currency": 22.9,
"usd": 67535
},
"ath_change_percentage": {
"native_currency": -59.825327510917,
"usd": -64.3396788440525
},
"ath_date": {
"native_currency": "2024-02-17T09:25:05.056Z",
"usd": "2024-02-29T11:45:08.150Z"
}
```
## Introduced /coins/{id}/ohlc/range endpoint
๐๏ธ **May 10, 2024**
We've introduced a new endpoint [/coins/{id}/ohlc/range](/reference/coins-id-ohlc-range).
This endpoint allows you to get the OHLC chart (Open, High, Low, Close) of a coin within a range of timestamp based on particular coin id.
Please note that this endpoint is available exclusively for **paid plan subscribers only**.
## Added interval hourly params to /coins/{id}/ohlc
๐๏ธ **May 04, 2024**
We've expanded functionality to include support for the `interval=hourly` parameter within the [/coins/{id}/ohlc](/reference/coins-id-ohlc) endpoint.
Users can use this parameter to retrieve OHLC (Open/High/Low/Close) data on a hourly interval for up to 90 days of the date range.
Example of endpoint request:
`https://pro-api.coingecko.com/api/v3/coins/bitcoin/ohlc?vs_currency=usd&days=1&interval=hourly&x_cg_pro_api_key=YOUR_API_KEY`
## Added support for inactive coins in /coins/list and historical data endpoints
๐๏ธ **April 30, 2024**
We've now enhanced the [/coins/list](/reference/coins-list) endpoint to include inactive coins
* You may access the inactive coins by specifying `status=inactive` in your query
* Example of endpoint request:\
`https://pro-api.coingecko.com/api/v3/coins/list?include_platform=false&status=inactive&x_cg_pro_api_key=YOUR_API_KEY`
Additionally, historical data for inactive coins can be queried using their IDs in the following endpoints:
* [/coins/{id}/history](/reference/coins-id-history)
* [/coins/{id}/market\_chart](/reference/coins-id-market-chart)
* [/coins/{id}/market\_chart/range](/reference/coins-id-market-chart-range)
* [/coins/{id}/contract/{contract_address}/market\_chart](/reference/contract-address-market-chart)
* [/coins/{id}/contract/{contract_address}/market\_chart/range](/reference/contract-address-market-chart-range)
Please note that these features are available exclusively for **paid plan subscribers only**
## Introduced /key endpoint
๐๏ธ **March 27, 2024**
We've introduced a new endpoint [/key](/reference/api-usage) for conveniently monitoring your account's API usage, including rate limits and remaining credits.
**Example of responses**:
```json
{
"plan": "Other",
"rate_limit_request_per_minute": 1000,
"monthly_call_credit": 1000000,
"current_total_monthly_calls": 307,
"current_remaining_monthly_calls": 999693
}
```
## Multiple Improvements (Onchain/GT)
๐๏ธ **February 28, 2024**
* image\_url is now returned in the token response for pools and tokens endpoints:
Example of responses:
```json JSON
"data": {
"id": "eth_0xdac17f958d2ee523a2206206994597c13d831ec7",
"type": "token",
"attributes": {
"address": "0xdac17f958d2ee523a2206206994597c13d831ec7",
"name": "Tether USD",
"symbol": "USDT",
"image_url": "https://assets.coingecko.com/coins/images/325/small/Tether.png?1696501661", ๐
......
"market_cap_usd": "100719721661.467"
},
"relationships": {}
}
```
* We've added sorting parameters such as order= `h24_volume_usd_desc` and order=` h24_tx_count_desc` for /pools endpoints
* The 'token' parameter within the [/ohlcv ](/reference/pool-ohlcv-contract-address) endpoint can now accept a token address, provided it exists in the queried pool, to return OHLCV data\
Example of endpoint request (**token=0xc02aaa39b223fe8d0a0e5c4f27ead9083c756cc2**):\
`https://pro-api.coingecko.com/api/v3/onchain/networks/eth/pools/0x06da0fd433c1a5d7a4faa01111c044910a184553/ohlcv/day?token=0xc02aaa39b223fe8d0a0e5c4f27ead9083c756cc2&x_cg_pro_api_key=YOUR_API_KEY`
* [/ohlcv ](/reference/pool-ohlcv-contract-address) endpoint now includes the base and target token metadata in the response\
Example of responses:
```json JSON
{
"data": {
"id": "46303eb4-fba1-44f3-a3c8-c542e4cd5d1a",
"type": "ohlcv_request_response",
"attributes": {
"ohlcv_list": []
}
},
"meta": {
"base": {
"address": "0xdac17f958d2ee523a2206206994597c13d831ec7",
"name": "Tether USD",
"symbol": "USDT",
"coingecko_coin_id": "tether"
},
"quote": {
"address": "0xc02aaa39b223fe8d0a0e5c4f27ead9083c756cc2",
"name": "Wrapped Ether",
"symbol": "WETH",
"coingecko_coin_id": "weth"
}
}
}
```
## Introduced /networks/{network}/trending\_pools endpoint (Onchain/GT)
๐๏ธ **February 19, 2024**
Trending Pools endpoint, [/networks/{network}/trending\_pools](/reference/trending-pools-network) is now available to fetch a list of pools that are trending as seen on GeckoTerminal based on web visits and on-chain activities.
## Introduced /search/pools endpoint (Onchain/GT)
๐๏ธ **February 19, 2024**
Added new endpoint to search for pools /search/pools based on keywords passed into query.
## Included new field for /coins/{id} endpoint
๐๏ธ **January 18, 2024**
We've included a new field "whitepaper" under "links" section for [/coins/{id}](/reference/coins-id) endpoint
**Example of responses:**
```json
{
"id": "bitcoin",
......
"links": {
"homepage": [],
"whitepaper": "https://bitcoin.org/bitcoin.pdf", ๐
"blockchain_site": [],
"official_forum_url": [],
"chat_url": [],
"announcement_url": [],
"twitter_screen_name": "bitcoin",
"facebook_username": "bitcoins",
"bitcointalk_thread_identifier": null,
"telegram_channel_identifier": "",
"subreddit_url": "https://www.reddit.com/r/Bitcoin/",
"repos_url": {}
},
.......
}
```
## Deprecated response fields for /coins/{id}
๐๏ธ **December 13, 2023**
The following data is now deprecated for [/coins/{id}](/reference/coins-id) endpoint:
* coingecko\_rank
* coingecko\_score
* developer\_score
* community\_score
* liquidity\_score
* public\_interest\_score
* public\_interest\_stats
* alexa\_rank
* bing\_matches
## Introduced new historical total supply endpoints
๐๏ธ **December 12, 2023**
We've introduced Historical Total Supply data to Enterprise plan subscribers via these 2 exclusive endpoints:
* [/coins/{id}/total\_supply\_chart](/reference/coins-id-total-supply-chart) : get historical total supply of a coin, by number of days away from now.
* [/coins/{id}/total\_supply\_chart/range](/reference/coins-id-total-supply-chart-range) : get historical total supply of a coin, within a range of timestamp.
## Included more trending coins
๐๏ธ **December 07, 2023**
We've expanded the capabilities of the [/search/trending](/reference/trending-search) endpoint.
It now supports up to 15 trending coins, a significant increase from the previous limit of 7.
## Improvement on pool data (Onchain/GT)
๐๏ธ **December 03, 2023**
Pool data now returns transaction stats for the last 1 hour. Unique buyers and sellers in the last 1 hour and 24 hours are now returned in the response
## Multiple Improvements
๐๏ธ **November 21, 2023**
The web\_slug data is now available in the following endpoints.
* [/coins/{id}](/reference/coins-id)
* [/coins/{contract}/contract/{contract_address}](/reference/coins-contract-address)
This addition allows users to accurately link to a CoinGecko coin page using [www.coingecko.com/en/{web_slug}](http://www.coingecko.com/en/\{web_slug}).
**Example of responses:**
```Text JSON
{
"id": "bitcoin",
"symbol": "btc",
"name": "Bitcoin",
"web_slug": "bitcoin", ๐
......
"tickers": [...]
}
```
For the [/asset\_platforms](/reference/asset-platforms-list) endpoint, we've introduced the native\_coin\_id data. This enables users to obtain the coin ID of different blockchain networks or asset platforms that may not have a contract address to look up
**Example of responses:**
```Text JSON
{
"id": "polygon-pos",
"chain_identifier": 137,
"name": "Polygon POS",
"shortname": "MATIC",
"native_coin_id": "matic-network" ๐
},
```
## Introduced /simple/networks/{network}/token\_price/{addresses} endpoint (Onchain/GT)
๐๏ธ **November 10, 2023**
Inspired by CoinGecko API most popular endpoint, we have launched the [/simple/networks/{network}/token\_price/{addresses}](/reference/onchain-simple-price), simple endpoint. Simply pass in addresses of any tokens on supported blockchain and get price data for it
## Introduced /networks/{network}/pools/{pool_address}/trades endpoint (Onchain/GT)
๐๏ธ **November 08, 2023**
You can now get the latest 300 trades in the past 24 hours of a given pool from this endpoint [/networks/{network}/pools/{pool_address}/trades](/reference/pool-trades-contract-address). You may optionally filter by trade size as well. You can now build your own telegram bot alert!
## Introduced new endpoints (Onchain/GT)
๐๏ธ **October 23, 2023**
You can now fetch token information such as name, image, social links, and description via these endpoints:
* To fetch information of tokens inside a pool, use [/networks/{network}/pools/{pool_address}/info](/reference/pool-token-info-contract-address)
* To fetch information of a specific token use [/networks/{network}/tokens/{address}/info](/reference/token-info-contract-address)
* If you like to get token information of the most recently updated tokens, use [/tokens/info\_recently\_updated](/reference/tokens-info-recent-updated)
## Included new fields (Onchain/GT)
๐๏ธ **September 11, 2023**
Pool response data now returns price in the base and quote token of the pool base\_token\_price\_quote\_token and quote\_token\_price\_base\_token for your convenience without the need to do additional calculation to derive these values
## Introduced new endpoints (Onchain/GT)
๐๏ธ **September 06, 2023**
Added new endpoints to allow querying multiple pools and tokens in a single API call. /networks/{network}/pools/multi/{addresses} and /networks/{network}/tokens/multi/{addresses}
## Included new fields (Onchain/GT)
๐๏ธ **June 23, 2023**
* More data added to the Pool response such as FDV, market cap (from CoinGecko if available), price change percentage, volume, number of buy/sell transactions
* More data added when querying for token such as FDV, volume, market cap, and the top 3 pools
## Introduced precision params for other endpoints
๐๏ธ **June 15, 2023**
The uses of 'precision' parameter allows to specify price data in full or 0-18 decimals, and previously was only made available for [/simple/price](/reference/simple-price) and [/simple/token\_price/{id}](/reference/simple-token-price) endpoints.
This parameter is now supported for more endpoints as listed below:
* [/coins/markets](/reference/coins-markets)
* [/coins/market\_chart](/reference/coins-market-chart)
* [/coins/{id}market\_chart/range](/reference/coins-id-market-chart)
* [/coins/{id}/contract/{contract_address}/market\_chart](/reference/contract-address-market-chart)
* [/coins/{id}/contract/{contract_address}/market\_chart/range](/reference/contract-address-market-chart-range)
* [/coins/{id}/ohlc](/reference/coins-id-ohlc)
## Multiple Improvements
๐๏ธ **June 01, 2023**
We've made enhancements to the /search/trending and /coins/{asset_platform_id}/contract/{contract_address} endpoints:
* Top 5 trending NFT data (based on high trading volume in the last 24 hours) is now included in the [/search/trending](/reference/trending-search) endpoint
* Near Protocol contract address (e.g. wrap.near) is now supported for [/coins/{asset_platform_id}/contract/{contract_address} ](/reference/coins-contract-address) endpoint
## Multiple Improvements (Onchain/GT)
๐๏ธ **May 28, 2023**
* Token metadata such as name, symbol, and CoinGecko ID are now returned in the responses for pools endpoints. Users will need to pass in this attribute include=base\_token, quote\_token
* CoinGecko asset platform ID added to the response for [/networks](/reference/networks-list) endpoint
## Added interval daily params to /coins/{id}/ohlc
๐๏ธ **May 22, 2023**
The [/coins/{id}/ohlc](/reference/coins-id-ohlc) endpoint now supports the "interval=daily" parameter for Paid Plan Subscribers
Users can use this parameter to retrieve OHLC (Open/High/Low/Close) data on a daily interval for up to 180 days of date range.
## Included new fields
๐๏ธ **April 26, 2023**
We've added 'watchlist\_portfolio\_users' field to [/coins/{id}](/reference/coins-id) endpoint responses.
This refers to number of users who added the coin into a watchlist or portfolio.
**Example of responses:**
```json JSON
{
"id": "bitcoin",
......
"watchlist_portfolio_users": 1449601, ๐
"market_cap_rank": 1,
......
"tickers": []
}
```
## Increased Rate Limit (Onchain/GT)
๐๏ธ **April 19, 2023**
We've increased the rate limit of Public Plan from 10 calls per minute to 30 calls per minute
## Multiple Improvements (Onchain/GT)
๐๏ธ **April 18, 2023**
* base\_token\_native\_currency and quote\_token\_native\_currency added to the pools endpoint response. This allows you to obtain price in the network's native currency in addition to in USD
* reserve\_in\_usd added to the pools endpoint response. This returns the total liquidity/reserve of the pool in USD
* pool\_created\_at added to the pools endpoint response
Example of responses for [/networks/{network}/pools/{address}](/reference/pool-address) :
```json
{
"data": {
"id": "eth_0xeb2eae8a9912a09cb0f13bfafd5ad56cd263bb3f",
"type": "pool",
"attributes": {
"base_token_price_usd": "0.0000186523882966482",
"base_token_price_native_currency": "0.00000000647822280242372", ๐
"quote_token_price_usd": "2881.71870575097",
"quote_token_price_native_currency": "1.0", ๐
"base_token_price_quote_token": "0.000000006478222802",
"quote_token_price_base_token": "154363323",
"address": "0xeb2eae8a9912a09cb0f13bfafd5ad56cd263bb3f",
"name": "DGX-1 / WETH",
"pool_created_at": "2024-02-18T08:10:59Z", ๐
"fdv_usd": "784687",
"market_cap_usd": null,
"price_change_percentage": {
"h1": "34.67",
"h24": "8406.81"
},
"transactions": {},
"volume_usd": {},
"reserve_in_usd": "110214.6247" ๐
},
"relationships": {}
}
}
```
* [/networks/{network}/new\_pools](/reference/latest-pools-network) endpoint added to query new pools discovered for a network
* [/networks/new\_pools](/reference/latest-pools-list) endpoint added to query new pools discovered across all networks
## Included new fields
๐๏ธ **April 03, 2023**
We've added "symbol" field to these NFT endpoints responses:
* [/nfts/markets](/reference/nfts-markets)
* [/nfts/{id} ](/reference/nfts-id)
* [/nfts/{assets_platform}/contract/{contract_address}](/reference/nfts-contract-address)
**Example of responses:**
```Text JSON
{
"id": "pudgy-penguins",
"contract_address": "0xBd3531dA5CF5857e7CfAA92426877b022e612cf8",
"asset_platform_id": "ethereum",
"name": "Pudgy Penguins",
"symbol": "PPG", ๐
....
},
```
## Included new fields
๐๏ธ **March 27, 2023**
We've added "links" field (e.g. homepage, twitter, discord) to these NFT endpoints responses:
* [/nfts/{id}](/reference/nfts-id)
* [/nfts/{asset_platform}/contract/{contract_address}](/reference/nfts-contract-address)
**Example of responses:**
```json
{
"id": "pudgy-penguins",
"contract_address": "0xBd3531dA5CF5857e7CfAA92426877b022e612cf8",
.......
"links": {
"homepage": "https://www.pudgypenguins.com/", ๐
"twitter": "https://twitter.com/pudgypenguins",๐
"discord": "https://discord.gg/pudgypenguins" ๐
},
.......
}
```
## Introduced /coins/top\_gainer\_losers endpoint
๐๏ธ **March 23, 2023**
We've added [/coins/top\_gainers\_losers](/reference/coins-top-gainers-losers) endpoint exclusively for Paid Plan Subscribers.
Users can now get the top 30 coins with largest price gain and loss by a specific time duration with this endpoint.
## Improved OHLCV endpoint (Onchain/GT)
๐๏ธ **March 23, 2023**
[/networks/{network}/pools/{pool_address}/ohlcv/{timeframe}](/reference/pool-ohlcv-contract-address) now returns more granularity `day,` `hour`, `minute` and multiple aggregates
## Multiple Improvements
๐๏ธ **February 23, 2023**
We've made some updates to the /coins/categories and /simple/token\_price/{id} endpoints:
* Market cap and volume data for 'ecosystem' categories in the [/coins/categories](/reference/coins-categories) endpoint will now return 'null' until further notice. The CoinGecko team is actively working on improvements to provide more accurate data. If you have any feedback or suggestions, please reach out via [api@coingecko.com](mailto:api@coingecko.com).
* Previously, the [/simple/token\_price/{id}](/reference/simple-token-price) endpoint was unable to return data for some Solana coins. This issue has been resolved, and users can now expect accurate data for Solana coins from this endpoint.
## Introduced /exchange/{id}/volume\_chart/range endpoint
๐๏ธ **February 15, 2023**
We've introduced the [/exchange/{id}/volume\_chart/range](/reference/exchanges-id-volume-chart-range) endpoint for Paid Plan Subscribers.
This exclusive feature allows users to query full historical volume data of an exchange.
## Introduced /coins/list/new endpoint
๐๏ธ **January 09, 2023**
We've introduced the [/coins/list/new](/reference/coins-list-new) endpoint for Paid Plan Subscribers.
This exclusive feature allows users to query the latest 200 coins on CoinGecko.
## Introduced new NFT endpoints
๐๏ธ **December 15, 2022**
We've added exclusive NFTs beta endpoints for Paid Plan Subscribers. These endpoints include:
* [/nfts/{id}/market\_chart](/reference/nfts-id-market-chart) (for historical market data)
* [/nfts/{contract_address}/market\_chart](/reference/nfts-contract-address-market-chart) (for historical market data based on contract address)
* [/nfts/{id}/tickers](/reference/nfts-id-tickers) (to retrieve floor price and volume information on each marketplace)
## Introduced new endpoints and improvements
๐๏ธ **October 25, 2022**
We've added new [/global/market\_cap\_chart](/reference/global-market-cap-chart) endpoint for Paid Plan Subscribers. This allows users to query historical market cap chart data.
We've introduced a filter param, currently limited to "nft," to the [/asset\_platforms](/reference/asset-platforms-list) endpoint. This allows users to obtain a comprehensive list of NFT blockchain networks supported by CoinGecko.
A new parameter, "precision," has been added to the [/simple/price](/reference/simple-price) endpoint. This enhancement allows users to customize the returned coin price based on the specified number of decimals or retrieve it with full decimal precision.
## Introduced NFTs and Token Lists Endpoints
๐๏ธ **September 29, 2022**
We've introduced beta endpoints for NFTs:
* [/nfts/list ](/reference/nfts-list)
* [/nfts/{id}](/reference/nfts-id)
* [/nfts/{asset_platform_id}/contract/{contract_address}](/reference/nfts-contract-address)
* [/nfts/market ](/reference/nfts-markets) (Exclusive for Enterprise Plan Subscribers)
Furthermore we've introduced the Token Lists endpoint for Enterprise Plan Subscribers
* [/token\_lists/{asset_platform_id}/all.json](/reference/token-lists)
## Included new fields to multiple endpoints
๐๏ธ **September 06, 2022**
We have added a new field, "details\_platform," to the [/coins/{id}](/reference/coins-id) and [/coins/{asset_platform_id}/contract/{contract_address}](/reference/coins-contract-address) endpoints responses.
The field contains information about the asset platform, specifically the "decimal\_places," providing details on the decimal places associated with the asset platform.
**Example of responses:**
```Text JSON
{
"id": "arbitrum",
"symbol": "arb",
"name": "Arbitrum",
"web_slug": "arbitrum",
"asset_platform_id": "arbitrum-one",
"platforms": {},
"detail_platforms": {
"arbitrum-one": { ๐
"decimal_place": 18, ๐
"contract_address": "0x912ce59144191c1204e64559fe8253a0e49e6548" ๐
},
......
},
......
}
```
## Introduced historical circulating supply endpoint
๐๏ธ **February 21, 2022**
We've introduced the Historical Circulating Supply endpoint exclusively for Enterprise plan subscribers.
* [/coins/{id}/circulating\_supply\_chart](/reference/coins-id-circulating-supply-chart)
* [/coins/{id}/circulating\_supply\_chart/range](/reference/coins-id-circulating-supply-chart-range)
These endpoints provide access to historical circulating supply data of a specific coin.
## Deprecated event endpoint
๐๏ธ **September 07, 2020**
Event endpoint deprecated
## Included new fields to /exchanges/{id}
๐๏ธ **September 07, 2020**
We've enhanced the [/exchanges/{id}](/reference/exchanges-id) endpoint by adding two new fields, public\_notice and alert\_notice.
These additions provide information on public notices and alerts associated with the specified exchange.
**Example of responses**:
```json JSON
{
"name": "Uniswap V3 (Ethereum)",
......
"centralized": false,
"public_notice": "This page refers to Uniswap V3. This is an alpha release of the exchange tracker, we will continue to improve the stats here specifically for the new approach introduced by the V3 protocol. For Uniswap V2, please refer to https://www.coingecko.com/en/exchanges/uniswap-v2-ethereum", ๐
"alert_notice": "", ๐
......
"status_updates": []
}
```
## Introduced /search/trending endpoint
๐๏ธ **August 03, 2020**
We've introduced new [/search/trending](/reference/trending-search) endpoint.
This addition allows users to access trending search data including coins on CoinGecko.
## Introduced category filter params to /coins/markets
๐๏ธ **August 03, 2020**
We've implemented a category filter, currently limited to "decentralized\_finance\_defi," for the [/coins/markets](/reference/coins-markets) endpoint.
This addition allows users to filter and retrieve market data specifically related to decentralized finance (DeFi) within the endpoint.
## Introduced /coins/{id}/ohlc endpoint
๐๏ธ **July 15, 2020**
We've introduced new [/coins/{id}/ohlc](/reference/coins-id-ohlc) endpoint.
This endpoint allows you to retrieve Open, High, Low, and Close (OHLC) data for a specific coin.
## Included new fields to /coins/markets
๐๏ธ **April 23, 2020**
We've introduced three new fields atl, atl\_change\_percentage, and atl\_date to the responses of [/coins/markets](/reference/coins-markets) endpoint.
These additions provide valuable data on the all-time low (atl) price, percentage change since the all-time low, and the date of the all-time low for improved analysis and insights.
**Example of responses:**
```json
[
{
"id": "bitcoin",
"symbol": "btc",
"ath": 69045,
"ath_change_percentage": -38.01241,
"ath_date": "2021-11-10T14:24:11.849Z",
"atl": 67.81, ๐
"atl_change_percentage": 63017.26399, ๐
"atl_date": "2013-07-06T00:00:00.000Z", ๐
"roi": null,
"last_updated": "2024-02-05T07:23:50.583Z"
},
......
]
```
## Improved /coins/{id}/tickers
๐๏ธ **March 31, 2020**
Starting from April 14th, 2020, there's a crucial update to the[ /coins/{id}/tickers](/reference/coins-id-tickers) API endpoint. Previously, the converted\_last value represented the converted price per coin in USD. Now, it will accurately reflect the market price of the base currency itself.
For example, if querying coins/tether/tickers, and there's a BTC/USDT ticker pair, the old converted\_last might show 6491.51 USD. After the update, it will return 1, representing the actual market price of Tether.
If you utilize converted\_last for calculations, be aware of potential breaking changes and take necessary actions. If it's solely for display, no action is required, as this update ensures a more accurate representation of the intended value.
**Example of responses:**
```json JSON
{
"name": "Tether",
"tickers": [
{
"base": "BTC",
"target": "USDT",
......
"converted_last": {
"btc": 0.00002336, //USDT price in BTC
"eth": 0.00043493, // USDT price in ETH
"usd": 0.99901 ๐ //showing USDT price instead of Bitcoin Price
},
......
"coin_id": "bitcoin",
"target_coin_id": "tether"
},
......
]
}
```
## Updated params for /derivatives endpoint
๐๏ธ **January 09, 2020**
We have made updates to the `include_tickers` parameter for [/derivatives/exchanges/{id} ](/reference/derivatives-exchanges-id)endpoint.
Please refer to the documentation for a comprehensive list of available values for this parameter
## Introduced finance and derivatives endpoints
๐๏ธ **November 08, 2019**
We have introduced finance and derivatives endpoints to our API.
Feel free to explore these new features, and your feedback and suggestions are highly encouraged.
## Introduced /exchanges/{id}/volume\_chart
๐๏ธ **July 22, 2019**
We have added a new endpoint, [/exchanges/{id}/volume\_chart](/reference/exchanges-id-volume-chart).
This endpoint is designed to provide volume chart data related to the specified exchange, with the information presented in BTC.
**Example of responses**:
```Text JSON
[
[
1707030000000,
"141206.9308600928467152" ๐ value in BTC
],
[
1707030600000,
"141639.1493761186305005" ๐ value in BTC
],
......
]
```
## Set default params value for tickers endpoints
๐๏ธ **June 13, 2019**
We've implemented an enhancement to the [/coins/{id}/tickers](/reference/coins-id-tickers) and [/exchanges/{id}/tickers ](/reference/exchanges-id-tickers) endpoints.
Now, users have the flexibility to use the optional `order` parameter, which defaults to trust\_score\_desc.
This addition allows users to customize the sorting order of tickers based on trust score, providing a more tailored experience for data retrieval.
## Included new trust score field to tickers
๐๏ธ **June 12, 2019**
We have added `trust_score` field to [/coins/{id}/tickers](/reference/coins-id-tickers) and [/exchanges/{id}/tickers](/reference/exchanges-id-tickers) endpoints
**Example of responses:**
[/coins/{id}/tickers](/reference/coins-id-tickers) endpoint
```json JSON
{
"name": "Bitcoin",
"tickers": [
{
"base": "BTC",
"target": "USDT",
......
"trust_score": "green", ๐
........
"coin_id": "bitcoin",
"target_coin_id": "tether"
},
...
]
},
```
[/exchanges/{id}/tickers ](/reference/exchanges-id-tickers) endpoint
```json JSON
{
"name": "Binance",
"tickers": [
{
"base": "USDC",
......
"trust_score": "green", ๐
......
"coin_id": "usd-coin",
"target_coin_id": "tether"
},
{...},
{...},
]
},
```
## Included new fields
๐๏ธ **June 10, 2019**
We have introduced two new fields, last\_traded\_at and last\_fetched\_at, to the ticker data.
The existing timestamp field, which currently reflects the last\_traded\_at value, will be retained for compatibility.
However, please be advised that the timestamp field may be deprecated in the future.
We recommend updating your application to make use of the newly added last\_traded\_at and last\_fetched\_at fields for improved accuracy and compatibility.
**Example of responses**:
[/coins/{id}/tickers](/reference/coins-id-tickers) endpoint
```json JSON
{
"name": "Bitcoin",
"tickers": [
{
"base": "BTC",
"target": "USDT",
......
"last_traded_at": "2024-02-05T04:36:55+00:00", ๐
"last_fetch_at": "2024-02-05T04:36:55+00:00", ๐
......
"coin_id": "bitcoin",
"target_coin_id": "tether"
},
...
]
},
```
[/exchanges/{id}/tickers ](/reference/exchanges-id-tickers)endpoint
```json JSON
{
"name": "Binance",
"tickers": [
{
"base": "USDC",
......
"last_traded_at": "2024-02-05T04:49:34+00:00", ๐
"last_fetch_at": "2024-02-05T04:49:34+00:00", ๐
......
"coin_id": "usd-coin",
"target_coin_id": "tether"
},
{...},
{...},
]
},
```
## Introduced optional params for multiple endpoints
๐๏ธ **April 10, 2019**
Added `coin_ids` optional params to [/exchanges/{id}/tickers](/reference/exchanges-id-tickers) endpoint. Users can specify the `coin_ids` to get the exchanges tickers for a particular coin.
Added `exchange_ids` optional params to [/coins/{id}/tickers](/reference/coins-id-tickers) endpoint. Users can specify the `exchange_ids` to get the coin tickers on a particular exchange.
## Introduced /exchanges/list endpoint
๐๏ธ **January 24, 2019**
We have introduced a new endpoint: [/exchanges/list](/reference/exchanges-list).
This addition expands the functionality of our API, allowing users to retrieve a list of available exchanges on CoinGecko with id and name easily.
## Set default params value for /coins/markets
๐๏ธ **January 18, 2019**
To minimize bandwidth usage, the [/coins/markets](/reference/coins-markets) endpoint will now automatically default to retrieving data for the top 100 coins by market cap when the 'ids' parameter is left blank.
This implies that the Order parameters will automatically default to `market_cap_desc`, ensuring a descending order based on market cap. The `Per_Page` parameters will default to 100, optimizing the response by providing data for the 100 results of coins per page if no coin's ids are mentioned.
This enhancement aims to streamline the user experience while conserving bandwidth resources.
## Reduced the usage of /coins (paginated) endpoint
๐๏ธ **December 10, 2018**
Recognizing the limitations of the paginated /coins feature, particularly its inability to query for specific coins, we have temporarily hidden it from the documentation to prevent confusion for new users.
Rest assured, there are no plans to remove or deprecate it in the near future.
Instead, we encourage you to transition to the more versatile [/coins/list](/reference/coins-list) and [coins/{id}](/reference/coins-id) options for a more tailored and efficient experience.
## Increased Requests Per Minute (RPM)
๐๏ธ **December 07, 2018**
Due the substantial volume of requests we've received, we are adjusting the API rate for Public API to **100 requests per minute**, allowing for **over 4 million requests per month**.
The increased capacity aims to accommodate the growing demand and ensure a smoother experience for our users.
## Introduced /simple endpoints
๐๏ธ **November 30, 2018**
In response to user feedback requesting reduced API payloads, we have introduced our [/simple](/reference/simple-price) endpoints, offering simplified responses.
Additional simple endpoints will be released soon to further enhance user experience.
## Improved /exchanges/{id} endpoint
๐๏ธ **November 13, 2018**
To ensure the consistent uptime and scalability of this API, we can only provide a maximum of 100 tickers in the responses for a specific exchange through the [/exchanges/{id}](/reference/exchanges-id) endpoint.
```json
{
"name": "Binance",
"year_established": 2017,
......
"tickers": [...], //100 items ๐
"status_updates": [...] //7 items
}
```
To retrieve more tickers, kindly utilize [/exchanges/{id}/tickers](/reference/exchanges-id-tickers) endpoint.
## Improved /coins/{id} endpoint
๐๏ธ **November 07, 2018**
To ensure the consistent uptime and scalability of this API, we can only provide a maximum of 100 tickers in the responses across multiple exchanges through the [/coins/{id}](/reference/coins-id) endpoint.
```json JSON
{
"id": "bitcoin",
"symbol": "btc",
......
"last_updated": "2024-02-05T03:45:46.327Z",
"tickers": [...] //100 items ๐
}
```
To retrieve more tickers, kindly utilize [/coins/{id}/tickers](/reference/coins-id-tickers) endpoint.
# 1. Get data by ID or Address
Source: https://docs.coingecko.com/docs/1-get-data-by-id-or-address
## Methods to query price & market data of coins
### a. Coin ID
Using [/simple/price](/reference/simple-price) endpoint as example:
* `https://pro-api.coingecko.com/api/v3/simple/price?ids=bitcoin&vs_currencies=usd&x_cg_pro_api_key=YOUR_API_KEY`
* The provided endpoint URL includes parameters such as `ids=bitcoin` and `vs_currencies=usd`, indicating that the intention to retrieve the current price of Bitcoin in US Dollars.
**How to obtain Coin ID aka API ID?** There are 3 options:
* Use [/coins/list](/reference/coins-list) endpoint, example of responses:
```json JSON
[
......
{
"id": "bitcoin", ๐
"symbol": "btc",
"name": "Bitcoin"
},
......
]
```
* View the full list of coins with API ID, symbol and name using this [Google Sheet](https://docs.google.com/spreadsheets/d/1wTTuxXt8n9q7C4NDXqQpI3wpKu1_5bGVmP9Xz0XGSyU/edit?usp=sharing).
* Look for the "API IDโ by visiting the info section of a coin page on CoinGecko:
### b. Contract Address
Other than using Coin ID, you may also query price & market data of a coin using contract address, using [/simple/token\_price/\{id](/reference/simple-token-price)} endpoint as example:
* `https://pro-api.coingecko.com/api/v3/simple/token_price/ethereum?contract_addresses=0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48&vs_currencies=usd&x_cg_pro_api_key=YOUR_API_KEY`
There are 3 parameters values required to apply for this endpoint:
* `id`: `Ethereum` (Asset Platform ID)
* `contract_addresses`: `0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48` (Contract Address)
* `vs_currencies`: `usd` (Target Currencies)
**How to obtain Coins/Tokens Contract Address**
* Use [/coins/list](/reference/coins-list) endpoint (`include_platform=true`), example of responses:
```json JSON
[
......
{
"id": "1inch",
"symbol": "1inch",
"name": "1inch",
"platforms": {
"ethereum": "0x111111111117dc0aa78b770fa6a738034120c302",
"avalanche": "0xd501281565bf7789224523144fe5d98e8b28f267",
"binance-smart-chain": "0x111111111117dc0aa78b770fa6a738034120c302",
"near-protocol": "111111111117dc0aa78b770fa6a738034120c302.factory.bridge.near",
"energi": "0xdda6205dc3f47e5280eb726613b27374eee9d130",
"harmony-shard-0": "0x58f1b044d8308812881a1433d9bbeff99975e70c",
"polygon-pos": "0x9c2c5fd7b07e95ee044ddeba0e97a665f142394f"
}
},
......
]
```
* Look for the "Contractโ by visiting the info section of a coin page on CoinGecko.
### Notes
* Not all coins will have a contract address listed on the CoinGecko site.
* If an address is not shown on the CoinGecko page, you will not be able to query the coin by its contract address via the API.
* The contract addresses are curated by the CoinGecko team, if you find out any missing contract address, feel free to [share](https://support.coingecko.com/hc/en-us/requests/new) with us to review.
* Get the token contract address from project website, white-paper, documentation, or block explorer site:
* [Uniswap Documentation](https://docs.uniswap.org/protocol/concepts/governance/overview#uni-address)
* [Block Explorer (Etherscan)](https://etherscan.io/token/0x1f9840a85d5af5bf1d1762f925bdaddc4201f984)
## Specify target currency to return
In the 2 examples above, both queries for Coin ID and Contract Address contain `vs_currencies=usd`. Most of the CoinGecko API endpoints will require you to specify the currency.
CoinGecko API data supports all major fiat currencies and some famous crypto currencies like the following:
| Type | Currency | vs\_currencies (Param value) |
| -------------- | ------------ | ---------------------------- |
| Fiat | US Dollar | `usd` |
| Fiat | Japanese Yen | `jpy` |
| Fiat | Euro | `eur` |
| Cryptocurrency | Bitcoin | `btc` |
| Cryptocurrency | Ether | `eth` |
| Cryptocurrency | Binance Coin | `bnb` |
For full list of supported currencies, please go to [/simple/supported\_vs\_currencies](/reference/simple-supported-currencies) endpoint
## Other way to obtain coin prices & market data
Using [/coins/market ](/reference/coins-markets) endpoint as example to query prices and market data of coins in bulk
* `https://pro-api.coingecko.com/api/v3/coins/markets?vs_currency=usd&order=market_cap_desc&per_page=100&page=1&x_cg_pro_api_key=YOUR_API_KEY`
There are 4 parameters values applied for this endpoint:
* `vs_currency`: `usd`
* `order`: `market_cap_desc` โย The endpoint response will be sorted in descending order, from the coins with the largest market cap to those with the smallest.
* `per_page`: `100` โ The results of coins per page are set at 100 in this case (maximum is 250).
* `page`: `1` โ The page number of the results is determined by the parameter `per_page`. In the case of `per_page=100` and `page=2`, the responses will include coins ranked 101 to 200 on CoinGecko, sorted by market cap, as per the specified endpoint.
# 10-mins Tutorial Guide
Source: https://docs.coingecko.com/docs/10-mins-tutorial-guide
New to CoinGecko API? Fret not. Whether youโre a programmer or someone with zero coding experience, weโve got you covered!
If you are not a developer and prefer to learn only specific tutorials on Google Sheet/Excel, feel free to check [๐ถ Tutorials (Beginner-friendly)](/docs/tutorials-beginner-friendly)
| Tutorial Steps | Description |
| ----------------------------------------------------------------- | ------------------------------------------------------------------------------------------------ |
| [1. Get data by ID or Address](/docs/1-get-data-by-id-or-address) | Learn how to use different endpoints by obtaining Coin ID and token's contract address at first. |
| [2. Get Historical Data](/docs/2-get-historical-data) | Learn how to get historical data of a coin by using different historical endpoints. |
| [3. Get Exchanges & NFT Data](/docs/3-get-exchanges-nft-data) | Learn how to query exchanges and NFT data by accessing different endpoints. |
| [4. Get On-chain Data](/docs/4-get-on-chain-data) | Learn how to use `/onchain` GT endpoints to query onchain data. |
# 2. Get Historical Data
Source: https://docs.coingecko.com/docs/2-get-historical-data
### **Tips**
* Most of the historical data are returned and queried using UNIX Timestamp.
* If you are not familiar with UNIX Timestamp, you may use tool like [epochconverter.com](https://www.epochconverter.com/) to convert between UNIX Timestamp and human readable date.
* You may use either coin ID or contract address to get the historical data.
There are five different endpoints to get historical data of a coin:
| Endpoint | Description |
| ---------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- |
| [/coins/\{id}/history](/reference/coins-id-history) | Get the historical data (price, market cap, 24hrs volume, etc.) at a given date for a coin based on a particular coin ID. |
| [/coins/\{id}/market\_chart](/reference/coins-id-market-chart) | Get the historical chart data of a coin including time in UNIX, price, market cap and 24hrs volume based on particular coin ID. |
| [/coins/\{id}/market\_chart/range](/reference/coins-id-market-chart-range) | Get the historical chart data of a coin within certain time range in UNIX along with price, market cap and 24hrs volume based on particular coin ID. |
| [/coins/\{id}/contract/\{contract\_address}/market\_chart](/reference/contract-address-market-chart) | Get the historical chart data of a coin including time in UNIX, price, market cap and 24hrs volume based on token contract address. |
| [/coins/\{id}/contract/\{contract\_address}/market\_chart/range](/reference/contract-address-market-chart-range) | Get the historical chart data of a coin within certain time range in UNIX along with price, market cap and 24hrs volume based on token contract address. |
### **Notes**
The data granularity (interval) for [/market\_chart](/reference/coins-id-market-chart) and [/market\_chart/range](/reference/coins-id-market-chart-range) endpoints is automatic and based on the date range:
* 1 day from current time = 5-minutely data
* 1 day from anytime (except from current time) = hourly data
* 2-90 days from current time or anytime = hourly data
* above 90 days from current time or anytime = daily data (00:00 UTC)
# 3. Get Exchanges & NFT Data
Source: https://docs.coingecko.com/docs/3-get-exchanges-nft-data
You can get Exchange and NFT data just like how you get the coins data:
1. Get the ID (exchange or NFT) from `/list` endpoint.
2. Use the ID to query latest or historical market data
| Type | Coins | NFTs | Exchanges | Derivatives |
| ---------------------- | -------------------------------------------------------------- | -------------------------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- |
| Get Full List with IDs | [/coins/list](/reference/coins-list) | [/nfts/list](/reference/nfts-list) | [/exchanges/list](/reference/exchanges-list) | [/derivatives/exchanges/list](/reference/derivatives-exchanges-list) |
| Get latest market data | [/coins/\{id}](/reference/coins-id) | [/nfts/\{id}](/reference/nfts-id) | [/exchanges/\{id}](/reference/exchanges-id) | [/derivatives/exchanges/\{id}](/reference/derivatives-exchanges-id) |
| Get Historical Data | [/coins/\{id}/market\_chart](/reference/coins-id-market-chart) | [/nfts/\{id}/market\_chart](https://docs.coingecko.com/reference/nfts-id-market-chart) | [/exchanges/\{id}/volume\_chart](/reference/exchanges-id-volume-chart) | [/exchanges/\{id}/volume\_chart](/reference/exchanges-id-volume-chart) |
# 4. Get On-chain Data
Source: https://docs.coingecko.com/docs/4-get-on-chain-data
Here are some of the important parameters to take note while using Onchain DEX API Endpoints:
* Blockchain Networks
* DEXs
* Pool Contract Address
* Token Contract Address
## Blockchain Networks
### Notes
* Please do not use CoinGecko Asset Platform ID as the Network ID in Onchain DEX API Endpoints (CoinGecko Asset Platform ID โ GT Network ID)
* Example:
* Asset Platform on CoinGecko: `ethereum`
* Onchain Network ID: `eth`
**How to obtain Network ID?**
* Use [/onchain/networks](/reference/networks-list) endpoint, example of response:
```json JSON
{
"data": [
{
"id": "eth", ๐ Network ID
"type": "network",
"attributes": {
"name": "Ethereum",
"coingecko_asset_platform_id": "ethereum" ๐ CoinGecko Asset Platform ID
}
},
......
]
}
```
* Go to [GeckoTerminal](https://www.geckoterminal.com/)
1. Select or search for a blockchain network.
2. Copy the slug from the URL:
## DEXs
Some of the pools endpoints require you to provide DEX ID along with Network ID to query the pools on a particular DEX (Decentralized Exchange).
Using [/onchain/networks/\{network}/dexes/\{dex}/pools](/reference/top-pools-dex) as example:
* `https://pro-api.coingecko.com/api/v3/onchain/networks/eth/dexes/uniswap_v3/pools?x_cg_pro_api_key=YOUR_API_KEY`
There are 2 parameter values required to apply for this endpoint:
* `network`: `eth` (network ID)
* `dex`: `uniswap_v3` (DEX ID)
**How to obtain DEX ID?**
* Use [/onchain/networks/\{network}/dexes](/reference/dexes-list) endpoint, example of response:
```json JSON
{
"data": [
{
"id": "uniswap_v2", ๐ DEX ID
"type": "dex",
"attributes": {
"name": "Uniswap V2"
}
},
......
]
}
```
* Go to [GeckoTerminal](https://www.geckoterminal.com/)
1. Select or search for a blockchain network.
2. Choose the DEX from the DEXs List on the top (e.g. Uniswap V3).
3. Copy the slug from the URL:
## Methods to query Onchain Data
### a. Pool Contract Address
Most of the time, you will need a pool contract address along with Network ID to query the onchain data, especially when using the Pools Endpoints.
Using [/onchain/networks/\{network}/pools/\{address}](/reference/pool-address) as example:
* `https://pro-api.coingecko.com/api/v3/onchain/networks/eth/pools/0xb4e16d0168e52d35cacd2c6185b44281ec28c9dc?x_cg_pro_api_key=YOUR_API_KEY`
There are 2 parameter values required to apply for this endpoint:
* `network`: `eth` (network ID)
* `address`: `0xb4e16d0168e52d35cacd2c6185b44281ec28c9dc` (pool contract address)
**How to obtain the pool contract address? (e.g.`WETH/USDC`)**
* Look for the contract address section of pool page on [GeckoTerminal](https://www.geckoterminal.com/eth/pools/0x88e6a0c2ddd26feeb64f039a2c41296fcb3f5640):
* Get the pool contract address from the project website, white-paper, documentation, or block explorer site:
* [Block Explorer (Etherscan)](https://etherscan.io/address/0x88e6a0c2ddd26feeb64f039a2c41296fcb3f5640)
* [DEX (Uniswap)](https://info.uniswap.org/#/pools/0x88e6a0c2ddd26feeb64f039a2c41296fcb3f5640)
### b. Token Contract Address
Apart from the pool contract address, you also have the option to query onchain data by using the token contract address, using [/onchain/networks/\{network}/tokens/\{token\_address}/pools](/reference/top-pools-contract-address) as example:
* `https://pro-api.coingecko.com/api/v3/onchain/networks/eth/tokens/0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48/pools?x_cg_pro_api_key=YOUR_API_KEY`
There are 2 parameter values required to apply for this endpoint:
* `network`: `eth` (network ID)
* `address`: `0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48` (token contract address)
**How to obtain tokens contract address (e.g. UNI):**
* Look for the contract address section of pool page on GeckoTerminal:
* Get the token contract address from the project website, white-paper, documentation, or block explorer site. For example:
* [Uniswap Documentation](https://docs.uniswap.org/protocol/concepts/governance/overview#uni-address)
* [DEX (Uniswap)](https://info.uniswap.org/#/tokens/tokens/0x1f9840a85d5af5bf1d1762f925bdaddc4201f984)
* [Block Explorer (Etherscan)](https://etherscan.io/token/0x1f9840a85d5af5bf1d1762f925bdaddc4201f984)
# AI Prompts
Source: https://docs.coingecko.com/docs/ai-prompts
CoinGecko API AI prompt library
Accelerate your development with CoinGecko's curated AI prompts. These prompts are designed to guide AI-powered coding assistants in correctly implementing our official API SDKs (libraries), helping you spend less time debugging and more time building.
## How to Use Our Prompts
Integrating these prompts into your workflow is simple. Copy the entire markdown prompt for your chosen language and provide it as context to your AI assistant.
1. For **Chat Interfaces (Claude, ChatGPT, etc.)**: Paste the prompt at the beginning of your conversation before asking the AI to write code.
2. For **Cursor IDE**: Add the prompt to your project's `Rules` to enforce the guidelines across all AI interactions.
3. For **GitHub Copilot**: Save the prompt to a file (e.g. `coingecko_rules.md`) and reference it in your chat with `@workspace #coingecko_rules.md`.
## Available Prompts
Select the prompt that matches your project's tech stack.
* ๐ **[Python](https://docs.coingecko.com/docs/python-ai-prompts)**: A complete guide for implementing the CoinGecko API using our official [coingecko-sdk](https://pypi.org/project/coingecko-sdk/).
* ๐ฆ **[TypeScript](https://docs.coingecko.com/docs/typescript-ai-prompts#/)**: The definitive prompt for integrating the CoinGecko API with our official [@coingecko/coingecko-typescript](https://www.npmjs.com/package/@coingecko/coingecko-typescript) package.
## Best Practices
To get the most out of our AI prompts, keep these tips in mind:
* **Be Specific**: After providing the main prompt, give the AI a clear, specific task (e.g. "Write a function to fetch the price of Bitcoin and Ethereum in EUR").
* **Customize**: Feel free to modify the prompts to fit your project's unique requirements or coding standards.
* **Version Control**: Store your customized prompts in your repository to ensure your entire team benefits from consistent AI-generated code.
* **Always Review**: Treat AI-generated code as a starting point. Always review it for security, performance, and correctness.
# API Status
Source: https://docs.coingecko.com/docs/api-status
CoinGecko's API status page provides information on the current status and incident history of CoinGecko API (Public & Pro)
### **Tips**
* You can view our live updates, and subscribe to updates via Email, Slack and Discord.
* Instead of subscribing to all updates, you may click on 'Select services' to subscribe to either Public or Pro API updates.
* CoinGecko API Status โ [https://status.coingecko.com](https://status.coingecko.com)
* Incident & Maintenance History โ [https://status.coingecko.com/incidents](https://status.coingecko.com/incidents)
* Uptime Calendar โ [https://status.coingecko.com/incidents/uptime-calendar](https://status.coingecko.com/incidents/uptime-calendar)
# Best Practices
Source: https://docs.coingecko.com/docs/best-practices
Wonder how to use different endpoints together? This is the perfect place for you
## User Journey for CoinGecko API Endpoints
### "Discovery/Navigational Endpoints"
**Examples:**
* [/coins/list](/reference/coins-list) โ can be used to query all the supported coins on CoinGecko with names, symbols and coin IDs that can be used in other endpoints.
* [/search/trending](/reference/trending-search) โ can be used to query trending search coins, categories and NFTs on CoinGecko.
### "Supporting Endpoints"
**Examples:**
* [/simple/supported\_vs\_currencies](/reference/simple-supported-currencies) โ can be used to query the list of currencies for other endpoints that include parameters like `vs_currencies`, allowing to obtain the corresponding data for those currencies.
* [/asset\_platforms](/reference/asset-platforms-list) โ can be used to query the list of asset platforms for other endpoints that contain parameters like `id` or `ids` (asset platforms), allowing the retrieval of corresponding data for these asset platforms.
### "Data Endpoints"
**Examples:**
* [/simple/price](/reference/simple-price) โ can be used to query the prices of coins using the unique coin IDs that can be obtained from the "Discovery/Navigational Endpoints" mentioned above.
* [/coins/\{id}](/reference/coins-id) โ can be used to query the coin data using the unique coin IDs that can be obtained from the "Discovery/Navigational Endpoints" mentioned above.
## User Journey for Onchain DEX API Endpoints (GeckoTerminal data)
### "Discovery/Navigational Endpoints"
**Examples:**
* [/onchain/trending\_pools](/reference/trending-pools-list) - can be used to query trending pools across all networks on GeckoTerminal.
* [/onchain/search/pools](/reference/search-pools) - can be used to search for any pools on GeckoTerminal.
### "Supporting Endpoints"
**Examples:**
* [/onchain/networks-list](/reference/networks-list) - can be used to query all the supported networks on GeckoTerminal.
* [/onchain/networks/\{network}/dexes](/reference/dexes-list) - can be used to query all the supported decentralized exchanges (DEXs/`dexes`) on GeckoTerminal based on network id that can be obtained from the endpoint mentioned above.
### "Data Endpoints"
**Examples:**
* [/onchain/simple/networks/\{network}/token\_price/\{addresses}](/reference/onchain-simple-price) - can be used to query any token price using the token address and network id that can be obtained from the "Discovery/Navigational Endpoints" and "Supporting Endpoints" mentioned above.
* [/onchain/networks/\{network}/pools/\{address}](/reference/pool-address) - can be used to query the data of a specific pool based on the pool address and network id that can be obtained from the "Discovery/Navigational Endpoints" and "Supporting Endpoints" mentioned above.
# Building with AI
Source: https://docs.coingecko.com/docs/building-with-ai
Quick tips to empower your AI applications with CoinGecko API, and leverage our AI capabilities to help you build better and easier.
CoinGecko provides a powerful suite of AI-native tools to help you integrate real-time, historical, and onchain market data into your applications. Whether you're building a sophisticated trading bot, a market analysis tool, or a simple portfolio tracker, our AI toolkit is here to accelerate your development.
## Using `llms.txt`
To help AI models interact with CoinGecko data effectively, we provide an `llms.txt` file at [/llms-full.txt](/llms-full.txt). This file gives models context on how to best query our API, ensuring more accurate and efficient data retrieval. We recommend utilizing this in your integrations of MCP and AI applications.
## CoinGecko MCP Server
The **MCP (Model-Context-Protocol)** Server is your gateway for connecting AI agents and large language models, like Claude and Gemini, directly to CoinGecko's live data streams. It's ideal for building conversational applications that can perform complex, real-time crypto analysis and answer user queries with up-to-the-minute information. Learn how to connect your AI agent by checking out [docs.coingecko.com/reference/mcp-server](https://docs.coingecko.com/reference/mcp-server)
## Tools for Your Workflow
We've integrated AI assistance directly into our documentation to help you find answers and ship faster.
1. Use the **'Copy page'** button to copy endpoint-specific markdown prompts. You can take these prompts to your favorite LLM chat interface to explore use cases or generate boilerplate code.
2. Stuck on a problem? Click the **'AI Support'** button anywhere in our docs to chat with our AI Assistant. It's trained to resolve your inquiries instantly.
# Clients
Source: https://docs.coingecko.com/docs/clients-unofficial
Explore client resources, including official Swagger JSON and unofficial Python wrapper
## Swagger JSON (OAS) (Official)
### Pro API Swagger JSON
* CoinGecko API Endpoints โ [coingecko-pro-api-v3.json](https://github.com/coingecko/coingecko-api-oas/blob/main/coingecko-pro-api-v3.json)
* Onchain DEX API (GeckoTerminal) Endpoints โ [on-chain-dex-api-beta.json](https://github.com/coingecko/coingecko-api-oas/blob/main/on-chain-dex-api-beta.json)
***
## Official CoinGecko API SDK
**Python and Typescript SDK:**
* [https://docs.coingecko.com/update/reference/sdk](https://docs.coingecko.com/update/reference/sdk)
Want us to support your favorite programming language? Let us know [here](https://forms.gle/JJLH3SXiL2eJaGzBA)!
**Not a developer?** Fred not, check our no-code tutorial for beginners here: [https://docs.coingecko.com/docs/tutorials-beginner-friendly](https://docs.coingecko.com/docs/tutorials-beginner-friendly)
# Common Errors & Rate Limit
Source: https://docs.coingecko.com/docs/common-errors-rate-limit
## Common Errors
The server responds to a userโs request by issuing status codes when the request is made to the server. Kindly refer to the table below to further understand the status codes when indicating the success or failure of an API call.
| Status Codes | Description |
| ----------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `400` (Bad Request) | This is due to an invalid request and the server could not process the user's request |
| `401` (Unauthorized) | This is due to the lack of valid authentication credentials for the requested resource by the user |
| `403` (Forbidden) | This is likely indicating that your access is blocked by our server, and we're unable to authorize your request |
| `429` (Too many requests) | This is likely indicating that the rate limit has reached. The user should reduce the number of calls made, or consider scaling their service plan that has much higher rate limits and call credits |
| `500` (Internal Server Error) | This is a generic error response indicating that the server has encountered an unexpected issue that prevented it from fulfilling the request |
| `503` (Service Unavailable) | The service is currently unavailable. Please check the API status and updates on [https://status.coingecko.com](https://status.coingecko.com) |
| `1020` (Access Denied) | This is due to violation of CDN firewall rule |
| `10005` | You may not have access to this endpoint. e.g. 'This request is limited Pro API subscribers'. You may wanna subscribe to a paid plan [here](https://www.coingecko.com/en/api/pricing) |
| `10002` (Missing API Key) | API Key Missing. Please make sure you're using the right authentication method. For Pro API, ensure you pass in `x_cg_pro_api_key` parameter with a Pro Key. For Demo API, ensure you pass in `x_cg_demo_api_key` parameter with a Demo Key. |
| `10010` (Invalid API Key) | You have provided incorrect API key credentials. If you are using Pro API key, please change your root URL from `api.coingecko.com` to `pro-api.coingecko.com` |
| `10011` (Invalid API Key) | You have provided incorrect API key credentials. If you are using Demo API key, please change your root URL from `pro-api.coingecko.com` to `api.coingecko.com` |
| CORS error | Occurs when the server doesn't return the CORS headers required. You may learn more and attempt the recommended solutions [here](https://www.bannerbear.com/blog/what-is-a-cors-error-and-how-to-fix-it-3-ways/#how-to-fix-a-cors-error) |
## Rate Limit
### **Notes**
* If you're using the Public API with Google Sheet and got hit with error, this is due to the IP sharing among Google Sheet users, and we have no control over this.
* If you need reliable performance, please **register for a demo account** or **subscribe to a paid plan** that comes with dedicated infra (API key) to prevent rate limit issues.
* For more details, please go to the page [here](https://www.coingecko.com/en/api/pricing).
* For Public API user (Demo plan), the rate limit is \~30 calls per minutes and it varies depending on the traffic size.
* If you're Pro API user (any paid plan), the rate limit is depending on the paid plan that you're subscribed to.
* Regardless of the HTTP status code returned (including `4xx` and `5xx` errors), all API requests will count towards your **minute rate limit**.
# Common Use Cases
Source: https://docs.coingecko.com/docs/common-use-cases
Discover the common use cases of CoinGecko API by our users
## 1. Get Coins Logo Images
* Use [/coins/id](/reference/coins-id) endpoint.
* This endpoint can be used to query other coin's metadata like: links, categories, contract address, community, description in different languages and many more.
* Coin descriptions may include newline characters represented as `\r\n` (escape sequences), which may require processing for proper formatting.
* Use [Token Info by Token Address](/reference/token-info-contract-address) endpoint to get metadata of tokens listed on GeckoTerminal.com.
## 2. Best Endpoint for Latest Crypto Price
* Use [/simple/price](/reference/simple-price) endpoint.
* This endpoint can be used to query other market data like market cap, 24-hour trading volume and 24-hour price change percentage.
## 3. Get All Trading Pairs (Tickers) of a Coin
* Use [/coins/id/tickers](/reference/coins-id-tickers) endpoint.
## 4. Get Trading Pairs of Specific Coins from a Specific Exchange
* Use[ /coins/id/tickers](/reference/coins-id-tickers) endpoint by supplying specific exchange ID.
## 5. Building Telegram Bot for Latest Coin Listings
* Use [/coins/list/new](/reference/coins-list-new) endpoint.
## 6. Get List of Coins Under Specific Category
* For CoinGecko [categories](https://www.coingecko.com/en/categories), use [/coins/markets](/reference/coins-markets) endpoint by supplying specific category.
* For GeckoTerminal [categories](https://www.geckoterminal.com/category), use [Pools by Category ID](/reference/pools-category) endpoint by supplying specific category.
## 7. Identify DEX Decentralized Exchanges
* Use [/exchanges/list](/reference/exchanges-list) endpoint to get full list of exchanges with ID on CoinGecko.
* Use [/exchanges/id](/reference/exchanges-id) to find out whether the exchange is centralized or decentralized.
* Example of responses (using Uniswap V3 as example) :
Since Uniswap is a DEX, therefore it shows `"centralized": false`
```json JSON
{
"name": "Uniswap V3 (Ethereum)",
......
"centralized": false, ๐
......
"tickers": [],
"status_updates": []
}
```
## 8. Get Bitcoin Dominance Data (BTC.D)
* Use [/global ](/reference/crypto-global)endpoint.
* Example of responses:
```json JSON
{
"data": {
"active_cryptocurrencies": 12414,
......
"market_cap_percentage": { ๐
"btc": 47.82057011844006,๐
"eth": 16.943340351591583,
......
},
"market_cap_change_percentage_24h_usd": -5.032104325648996,
"updated_at": 1706002730
}
}
```
## 9. Get Market Cap or Dominance of a Specific Ecosystem
* Use [/coins/categories](/reference/coins-categories).
* The endpoint also returns the 24-hour percentage change, offering insights into the traction of different categories or ecosystems.
## 10. Get Token Lists of a Specific Blockchain Network
* Use [/token\_lists/asset\_platforms\_id/all.json](/reference/token-lists) endpoint.
* Supply asset platform id to the endpoint.
## 11. Get 7-Day Sparkline Price Data of a Coin
* Use [/coins/id](/reference/coins-id) or [/coins/markets](/reference/coins-markets) endpoints by flagging `sparkline = true`.
## 12. Get Link to Individual CoinGecko Coin Page
* Use [/coins/list](/reference/coins-list) endpoint to get the coin **`{ID}`**.
* Supply API ID in this URL path format: `www.coingecko.com/en/coins/{ID}`
* If you wish to the obtain the URL slug of a specific CoinGecko Coin Page, e.g. `www.coingecko.com/en/coins/{web_slug}` you may use [/coin/id](/reference/coins-id) endpoint and obtain the **`{web_slug}`** value.
## 13. Check Coin Status and Stale Price Updates
* Active: use [/coins/list](/reference/coins-list) endpoint, only active coins will be shown by default. You may also flag **`status=inactive`** to get a list of inactive coins.
* Price Stale: use [/simple/price](/reference/simple-price) endpoint, flag `include_last_updated_at=true` to check latest update time.
## 14. Get Real-Time and Historical Exchange of BTC in USD
* Current exchange rate: use [/exchange\_rates](/reference/exchange-rates) endpoint.
* Historical exchange rate: use [/coins/id/history](/reference/coins-id-history) or [/coins/id/market\_chart](/reference/coins-id-market-chart) endpoints.
## 15. Get Watchlist Portfolio Data of a Coin
* Use [/coins/id](/reference/coins-id) endpoint by supplying coin ID.
* Example of responses:
```json JSON
{
"id": "bitcoin",
......
"watchlist_portfolio_users": 1487932, ๐
"market_cap_rank": 1,
......
}
```
## 16. Get Historical Data for Inactive Coins
**Note**: This is available for paid plan subscribers only.
* Use [/coins/list](/reference/coins-list) endpoint, specifying the status param as `inactive`.
* Example of endpoint request: `https://pro-api.coingecko.com/api/v3/coins/list?include_platform=false&status=inactive&x_cg_pro_api_key=YOUR_API_KEY`
* Retrieve the coin's ID from the endpoint mentioned above and use it to access historical data via the following endpoints:
* [/coins/id/history](/reference/coins-id-history)
* [/coins/id/market\_chart](/reference/coins-id-market-chart)
* [/coins/id/market\_chart/range](/reference/coins-id-market-chart-range)
* [/coins/id/contract/contract\_address/market\_chart](/reference/contract-address-market-chart)
* [/coins/id/contract/contract\_address/market\_chart/range](/reference/contract-address-market-chart-range)
## 17. Get TVL (Total Value Locked) data of a Coin
* Use [/coins/id](/reference/coins-id) endpoint by supplying coin ID.
* Example of responses:
```json JSON
"total_value_locked":
{
"btc": 72324,
"usd": 4591842314
}
```
## 18. Query Search for Coins, Categories, NFTs, Exchanges, and Pools
We have 2 Search endpoints:
* [/search](/reference/search-data) endpoint allows you to search for coins, categories, exchanges (markets), and NFTs listed on CoinGecko.com. You may query by name or symbol.
* [/search-pools](/reference/search-pools) endpoint allows you to search for pools listed on GeckoTerminal.com. You may query by pool contract address, token contract address, or token symbol.
## 19. Get List of Blockchain Networks supported on CoinGecko and GeckoTerminal.
CoinGecko and GeckoTerminal support different sets of blockchain networks. You can use the following endpoints to find the list of supported networks and their respective IDs:
* CoinGecko: [/asset-platform-list](/reference/asset-platform-list)
* GeckoTerminal ([onchain endpoints](/reference/endpoint-overview#-onchain-dex-endpoints-geckoterminal)): [/networks-list](/reference/networks-list)
## 20. Get Native Coin of a Blockchain Network (Asset Platform)
You may use the [/asset-platform-list](/reference/asset-platform-list) endpoint to obtain the native coin ID of all networks (asset platforms) listed on [www.coingecko.com](http://www.coingecko.com.).
## 21. Get Liquidity data of a Liquidity Pool or Token
There are multiple onchain endpoints that provide the liquidity data (`reserve_in_usd`) of a pool, for example: [Specific Pool Data by Pool Address](/reference/pool-address). You may also get liquidity data (`total_reserve_in_usd`) of a token, using endpoints like: [Token Data by Token Address](/reference/token-data-contract-address).
Note: `reserve_in_usd` (pool) represents the total liquidity of all tokens within a specific pool, whereas `total_reserve_in_usd` (token) refers to the total liquidity portion attributable to a specific token across all available pools.
## 22. Get list of onchain DEX pools based on specific criteria
* Use [/pools/megafilter](/reference/pools-megafilter) to retrieve data for onchain DEX pools that match a given set of filters.
* Example of use cases:
* Custom filtering:ย Combine multiple params โ like liquidity thresholds, FDV ranges, 24-hour volume, and more โย to extract the precise datasets you need.
* Risk and Quality checks: Apply fraud filters to weed out risky projects.
* For more details on examples and available filters, refer to:
* [Changelog โ New Megafilter Endpoint](https://docs.coingecko.com/changelog/new-megafilter-endpoint)
* [Live Filtering on GeckoTerminal](https://www.geckoterminal.com/)
## 23. Get List of Trending Coins
* Use the following endpoints to get trending coins and pools:
* [Trending Search List](/reference/trending-search/) โ Trending Coins, NFTs, Categories on CoinGecko.com, based on user searches.
* [Trending Search Pools](/reference/trending-search-pools/) โ Trending Pools and Tokens on GeckoTerminal.com, based on user searches.
* Other useful endpoints:
* [Top Gainers & Losers](/reference/coins-top-gainers-losers) on CoinGecko.com, by specific time duration.
* [Trending Pools List](/reference/trending-pools-list) and [Trending Pools by Network](/reference/trending-pools-network) on GeckoTerminal.com, by specific time duration.
## 24. Get Security Info of Tokens
* By using [Token Info by Token Address](/reference/token-info-contract-address) endpoint, you can obtain the following security related data:
* GeckoTerminal Score (Pool, Transaction, Creation, Info, Holders)
* Holders count and distribution percentage
* Mint and Freeze Authority
## 25. Get Latest Token/Pool Data from Launchpad
* Use [megafilter](/reference/pools-megafilter) endpoint to retrieve latest launchpad data, by flagging `sort=pool_created_at_desc`. Learn more on [changelog](https://docs.coingecko.com/changelog/launchpad-data-support-honeypot-improvement#/).
* **Request example (Get latest pools on Pump.fun)**:
```bash Bash
https://pro-api.coingecko.com/api/v3/onchain/pools/megafilter?page=1&networks=solana&dexes=pump-fun&sort=pool_created_at_desc&x_cg_pro_api_key=YOUR_API_KEY
```
# Endpoint Showcase
Source: https://docs.coingecko.com/docs/endpoint-showcase
Discover how CoinGecko API is used at CoinGecko.com and GeckoTerminal.com
## CoinGecko
### [Home Page](https://www.coingecko.com)
1. [/global](/reference/crypto-global) โ Display global crypto data such as number of active cryptocurrencies, exchanges and etc.
2. [/search/trending](/reference/trending-search) โ Display trending search coins, NFTs and categories.
3. [/coins/top\_gainers\_losers](/reference/coins-top-gainers-losers) โ Display the largest gainers in 24hr.
4. [/coins/categories](/reference/coins-categories) โ Display all the categories list.
5. [/coins/markets](/reference/coins-markets) โ Display all the supported coins with market related data.
### [Coin Page](https://www.coingecko.com/en/coins/bitcoin)
1. [/coins/\{id} ](/reference/coins-id)โ Display all the coin data including name, price, market related data, website, explorers and etc.
2. [/simple/price](/reference/simple-price) โ Display data such as latest coin price, market cap and 24hr trading volume.
3. * [/coins/\{id}/history](/reference/coins-id-history) โ Display the historical price data.
* [/coins/\{id}/market\_chart](/reference/coins-id-market-chart) โ Display the historical data in line chart.
* [/coins/\{id}/ohlc](/reference/coins-id-ohlc) โ Display the historical data in candlestick chart.
### [Exchanges Page](https://www.coingecko.com/en/exchanges/hyperliquid-spot)
1. [/exchanges/\{id}](/reference/exchanges-id) โ Display the exchange information such as name, type, market related data such as trading volume and etc.
2. [/exchanges/\{id}/volume\_chart](/reference/exchanges-id-volume-chart) โ Display the historical volume chart data.
3. [/exchanges/\{id}/tickers](/reference/exchanges-id-tickers) โ Display the exchange's tickers.
### [NFTs Page](https://www.coingecko.com/en/nft/pudgy-penguins)
1. [/nfts/\{id}](/reference/nfts-id) โ Display NFT data such as name, contract address, website, market related data such as floor price, market cap, volume and etc.
2. [/nfts/\{id}/market\_chart](/reference/nfts-id-market-chart) โ Display the historical market data in chart.
3. [/nfts/\{id}](/reference/nfts-id) โ Display the description of the NFT collection.
4. [/nfts/\{id}/tickers](/reference/nfts-id-tickers) โ Display the tickers of the NFT collection on different NFT marketplace.
## GeckoTerminal
### [Home Page](https://www.geckoterminal.com/)
1. [/onchain/search/pools ](/reference/search-pools)โ Allow users to search for pools on GeckoTerminal.
2. [/onchain/networks](/reference/networks-list) โ Display a list of supported networks on GeckoTerminal.
3. [/onchain/networks/trending\_pools](/reference/trending-pools-list) โ Display a list of trending pools across all networks on GeckoTerminal.
4. [/onchain/networks/new\_pools](/reference/latest-pools-list) โ Display all the latest pools across all networks on GeckoTerminal.
5. [/onchain/categories](/reference/categories-list) โ Display all the onchain categories on GeckoTerminal.
### [Chain Page](https://www.geckoterminal.com/eth/pools)
1. [/onchain/networks/\{network}/dexes](/reference/dexes-list) โ Display all the supported dex on a network on GeckoTerminal.
2. [/onchain/networks/\{network}/trending\_pools](/reference/trending-pools-network) โ Display a list of trending pools on a network on GeckoTerminal.
3. [/onchain/networks/\{network}/new\_pools](/reference/latest-pools-network) โ Display a list of new pools on a network on GeckoTerminal.
4. [/onchain/networks/\{network}/pools](/reference/top-pools-network) โ Display all the top pools on a network on GeckoTerminal.
5. [/onchain/categories/\{category\_id}/pools](/reference/pools-category) โ Display all the pools under a specific onchain category on GeckoTerminal.
### [Pool Page](https://www.geckoterminal.com/eth/pools/0x88e6a0c2ddd26feeb64f039a2c41296fcb3f5640)
1. * [/onchain/networks/\{network}/pools/\{address}](/reference/pool-address) โ Display pool data such as price, transactions, volume and etc.
* [/onchain/networks/\{network}/pools/\{pool\_address}/info](/reference/pool-token-info-contract-address) โ Display pool information such as name, symbol, image URL, description and etc.
2. [/onchain/networks/\{network}/pools/\{pool\_address}/ohlcv/\{timeframe}](/reference/pool-ohlcv-contract-address) โ Display the OHLCV chart of the pool.
3. [/onchain/networks/\{network}/pools/\{pool\_address}/trades](/reference/pool-trades-contract-address) โ Display the trades of the pool in the past 24 hours.
### [Categories Page](https://www.geckoterminal.com/category)
1. [/onchain/categories](https://docs.coingecko.com/reference/categories-list) โ Display list of onchain categories with market data.
2. [/onchain/categories/\{id}/pools](https://docs.coingecko.com/reference/pools-category) โ Display list of pools with market data of a specific onchain category.
# CoinGecko MCP Server (Beta)
Source: https://docs.coingecko.com/docs/mcp-server
MCP Server for Crypto Price & Market Data. MCP (Model Context Protocol) is an open standard that allows Large Language Model (LLM) and other AI agents to securely and intelligently interact with external data sources and tools.
### Welcome to the CoinGecko MCP Server!
**CoinGecko MCP Server is currently in Beta.** We're constantly improving, and your feedback is crucial. Please share any thoughts or suggestions via [this feedback form](https://docs.google.com/forms/d/e/1FAIpQLSf06DOBauiZ8XS6NwWXUUwhFluH7jKHOAa3y4VsrkyGbLKyfA/viewform).
# ๐ Overview
The official CoinGecko MCP Server is now live, making CoinGecko data readily available to your AI models and applications. With the CoinGecko MCP, you can empower your agents to:
* **Access real-time market data**: Get aggregated prices, market cap, and trading volume for over 15k+ coins on CoinGecko, integrated across 1,000+ exchanges.
* **Dive into onchain analytics**: Query onchain DEX price and liquidity data for more than 8M tokens across 200+ networks via GeckoTerminal.
* **Discover market trends**: Instantly find trending coins, new token listings, top gainers/losers, and popular NFT collections.
* **Retrieve rich metadata**: Pull essential details like project descriptions, logos, social links, contract addresses, security info, and more.
* **Analyze historical performance**: Access historical price, market data, and OHLCV for any cryptocurrency.
* **Explore crypto categories**: Effortlessly list coins within specific sectors like Meme, DeFi, Layer 1, AI agent, and more.
# ๐ฅ Getting Started
Connecting your AI to CoinGecko is simple. We offer several MCP server options to fit your needs, from keyless access for testing to authenticated connections for production applications.
Most MCP-compatible clients, like Claude Desktop, Gemini CLI, and Cursor, can be configured using a simple JSON file (e.g., `claude_desktop_config.json`)
### Prerequisites
* Make sure your device has `node` installed. You can download it from [nodejs.org/download](https://nodejs.org/en/download)
## Which MCP Server Should You Use?
Here's a breakdown of the available options to help you choose the right one:
| MCP Server Type | Best For | Setup Details |
| ------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------- |
| Remote Server (Public, Keyless) | - First-time users, quick tests, and basic queries - Connect instantly without any registration - Subject to shared rate limits, not for heavy use | [mcp.api.coingecko.com](https://mcp.api.coingecko.com/) |
| Remote Server (Authenticated) | - Scalable apps, AI agent integrations - Unlocks all tools available under your Demo/Pro plan - Higher, reliable rate limits. Get your API key [here](https://www.coingecko.com/en/api/pricing) | [mcp.pro-api.coingecko.com](https://mcp.pro-api.coingecko.com/) |
| Local Server | - Ideal for local development, desktop AI apps - Build/test your AI app even without an active internet connection - Demo/Pro API key to access more tools. Get your API key [here](https://www.coingecko.com/en/api/pricing) | [npmjs/coingecko-mcp](https://www.npmjs.com/package/@coingecko/coingecko-mcp) |
## Remote Server (Public, Keyless)
The easiest way to get started. Just add the following to your client's `mcp_config.json` file.
### Client-Specific Config
The file name and location depend on your client. Find your config file here: [modelcontextprotocol.io/quickstart](https://modelcontextprotocol.io/quickstart/user#2-add-the-filesystem-mcp-server)
Add the following configuration to your `mcp_config.json`:
```json JSON
{
"mcpServers": {
"coingecko_mcp": {
"command": "npx",
"args": [
"mcp-remote",
"https://mcp.api.coingecko.com/sse"
]
}
}
}
```
Here's a quick 2-minute tutorial for setting up the public server with Claude Desktop:
## Remote Server (Authenticated)
To access more tools and higher rate limits, use your CoinGecko API key with our hosted "Bring Your Own Key" (BYOK) server. Get your API key [here](https://www.coingecko.com/en/api/pricing)
### Step 1: Add the configuration
Add the following configuration to your `mcp_config.json`:
```json JSON
{
"mcpServers": {
"coingecko_mcp": {
"command": "npx",
"args": [
"mcp-remote",
"https://mcp.pro-api.coingecko.com/sse"
]
}
}
}
```
### Step 2: Authorize your MCP access
After adding the config, the first time your client tries to use the CoinGecko MCP, a new browser tab will open, redirecting you to our authentication page:
* Simply paste in your CoinGecko API key, and authorize to link your key to the MCP session.
โจ Don't have an API key yet? Upgrade to Pro today! Read more [here](https://www.coingecko.com/en/api/pricing).
* You can also toggle between dynamic/static tools here. Learn more about [Dynamic Tools](https://docs.coingecko.com/reference/mcp-server#dynamic-vs-static-tools).
## Local Server (API Key Required)
For local development and maximum control, run the MCP server directly on your machine. This method offers the rate limits based on your API plan.
```json JSON
{
"mcpServers": {
"coingecko_mcp_local": {
"command": "npx",
"args": [
"-y",
"@coingecko/coingecko-mcp"
],
"env": {
"COINGECKO_PRO_API_KEY": "YOUR_PRO_API_KEY",
"COINGECKO_ENVIRONMENT": "pro"
}
}
}
}
```
โจ Don't have an API key yet? Get your free Demo key or upgrade to Pro! Read more [here](https://www.coingecko.com/en/api/pricing).
* Configure the `env` based on your API key tier:
* Pro API access:
```json JSON
...
"env": {
"COINGECKO_PRO_API_KEY": "YOUR_PRO_API_KEY",
"COINGECKO_ENVIRONMENT": "pro"
}
...
```
* Demo API access:
```json JSON
...
"env": {
"COINGECKO_DEMO_API_KEY": "YOUR_DEMO_API_KEY",
"COINGECKO_ENVIRONMENT": "demo"
}
...
```
# ๐ Connecting with Claude
Connecting CoinGecko MCP to Claude is straightforward. The method varies slightly depending on your Claude plan.
## For Claude Free Users (via Claude Desktop)
You **must use the Claude Desktop app** and modify the configuration file.
1. **Locate`claude_desktop_config.json`**: Follow the instructions [here](https://modelcontextprotocol.io/quickstart/user) to find the file on your system.
2. **Add a server config**: Copy and paste one of the server configs above that matches your use case.
3. **Restart Claude Desktop**: Close and reopen the app for the changes to take effect.
## For Claude Pro Users
### Tips
You can also follow the same steps as the Free users by modifying the `claude_desktop_config.json` file.
1. In Claude ([claude.ai](https://claude.ai/) or the Desktop app), click on 'Add connectors' in your chat.
2. Click on 'Add custom connector'
3. Remote MCP server URL:
* Keyless access: `https://mcp.api.coingecko.com/sse`
* Authenticated access (BYOK): `https://mcp.pro-api.coingecko.com/sse`
4. Click on 'Add', and you're ready to go!
# ๐ก Example Prompts
Tap into the full potential of CoinGecko data โย use these prompts to kickstart your next AI build.
### Simple Queries
> * What is the current price of Bitcoin in USD?
> * What is the market cap of Ethereum?
> * What are the top 3 trending coins on CoinGecko right now?
> * What are the top AI coins on GeckoTerminal now?
> * What is the floor price of the Pudgy Penguins NFT collection?
### Advanced Queries
> * Show me the current top 10 cryptocurrencies by market cap. Include their price, 24h change, and total volume. Display this in an interactive table.
>
>
>
> * Generate a 30-day price chart for Ethereum (ETH) against USD, showing both price and trading volume.
>
>
### Creative and Fun Ideas
> * Create a quiz to tell me which cryptocurrency I am based on my personality.
>
>
>
> Try it here: [claude.ai/public/artifacts](https://claude.ai/public/artifacts/586275b9-9ff8-4d9f-9b43-0c080f6e9c80)
>
> * Build a Wordle-style game where the answer is a crypto asset's name or symbol, like 'BITCOIN' or 'SHIBA'.
>
>
>
> Try it here: [claude.ai/public/artifacts](https://claude.ai/public/artifacts/41efabb7-76b9-43c7-8349-cbbe1d52a022)
# โ๏ธ Tips
## API Key Differences (Demo vs. Pro)
Choosing between a Demo and Pro key for your MCP server impacts your access to data and tools.
| Feature | Demo ([Guide here](https://support.coingecko.com/hc/en-us/articles/21880397454233-User-Guide-How-to-sign-up-for-CoinGecko-Demo-API-and-generate-an-API-key)) | Pro |
| ------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **Rate Limit** | 30 calls/min | Starts at 500 calls/min |
| **Monthly Credits** | 10,000 | Starts at 500,000 |
| **Historical Data** | Past 1 year | From 2013 until now |
| **MCP Tools** | Limited access | Full access, including exclusive tools: - [Top Gainers & Losers](https://docs.coingecko.com/reference/coins-top-gainers-losers) - [NFTs Collection Historical Chart](https://docs.coingecko.com/reference/nfts-id-market-chart) - [๐ฅ Megafilter for Pools](https://docs.coingecko.com/reference/pools-megafilter) - [Pools by Category ID](https://docs.coingecko.com/reference/pools-category) |
๐ฅ Ready to upgrade? Explore [our API plans](https://www.coingecko.com/en/api/pricing).
## Dynamic vs. Static Tools
When running our CoinGecko MCP server, you can choose how the LLM client discovers tools.
* **Static (Default)**: The AI is given a complete list of tools and their functions upfront. This is faster for specific, known tasks.
* **Dynamic**: The AI first asks the server for available tools based on a keyword search, then learns how to use them. This is flexible but can be slower.
For a deeper dive, read the [official documentation](https://www.stainless.com/changelog/mcp-dynamic-tools) from Stainless.
## Using `llms.txt`
To help AI models interact with CoinGecko data effectively, we provide an `llms.txt` file at [/llms-full.txt](/llms-full.txt). This file gives models context on how to best query our API, ensuring more accurate and efficient data retrieval. We recommend utilizing this in your integrations.
***
CoinGecko MCP Server is powered by [Stainless](https://www.stainless.com/) โฑ
Have feedback, a cool idea, or need help? Reach out to `soonaik@coingecko[dot]com` or fill in [this feedback form](https://docs.google.com/forms/d/e/1FAIpQLSf06DOBauiZ8XS6NwWXUUwhFluH7jKHOAa3y4VsrkyGbLKyfA/viewform).
# Python AI Prompts
Source: https://docs.coingecko.com/docs/python-ai-prompts
A comprehensive AI prompt to guide coding assistants in correctly implementing the official CoinGecko Python SDK () for reliable API integration.
## How to Use Our Prompts
Integrating these prompts into your workflow is simple. Copy the entire markdown prompt for your chosen language and provide it as context to your AI assistant.
1. For **Chat Interfaces (Claude, ChatGPT, etc.)**: Paste the prompt at the beginning of your conversation before asking the AI to write code.
2. For **Cursor IDE**: Add the prompt to your project's `Rules` to enforce the guidelines across all AI interactions.
3. For **GitHub Copilot**: Save the prompt to a file (e.g. `coingecko_rules.md`) and reference it in your chat with `@workspace #coingecko_rules.md`.
````markdown Markdown
# Goal: Generate Python code for the CoinGecko API using ONLY the official `coingecko_sdk`.
## ๐จ Critical Rules
1. **SDK Exclusivity**:
- **ALWAYS** use the official `coingecko_sdk` package.
- **NEVER** use the old `pycoingecko` library or make direct HTTP requests with `requests`, `httpx`, or `urllib`.
2. **Authentication**:
- **ALWAYS** load the API key from environment variables (`os.environ.get("COINGECKO_PRO_API_KEY")`).
- **NEVER** hardcode API keys or any other credentials in the source code.
3. **Client Implementation**:
- **ALWAYS** initialize a single, reusable client instance (`Coingecko` or `AsyncCoingecko`) for the application.
- **ALWAYS** configure automatic retries by setting the `max_retries` parameter on the client.
- **NEVER** implement manual retry loops using `time.sleep()`. The SDK handles this internally.
4. **Error Handling**:
- **ALWAYS** catch specific SDK exceptions (e.g., `coingecko_sdk.RateLimitError`, `coingecko_sdk.NotFoundError`).
- **NEVER** use a generic `except Exception:` block to catch known API errors.
## โ Correct Implementation Example
This is the standard for all generated code.
```python
# src/api/client.py
import os
from coingecko_sdk import Coingecko, AsyncCoingecko
# Initialize a single, reusable client. This should be imported and used application-wide.
client = Coingecko(
pro_api_key=os.environ.get("COINGECKO_PRO_API_KEY"),
environment="pro",
max_retries=3, # Rely on the SDK's built-in retry mechanism.
)
# Optional: Initialize a single async client for concurrent applications.
async_client = AsyncCoingecko(
pro_api_key=os.environ.get("COINGECKO_PRO_API_KEY"),
environment="pro",
max_retries=3,
)
# src/main.py
from api.client import client
from coingecko_sdk import RateLimitError, APIError
def get_bitcoin_price():
try:
price_data = client.simple.price.get(
ids="bitcoin",
vs_currencies="usd",
)
# Access data using Pydantic models or dictionary keys
return price_data['bitcoin'].usd
except RateLimitError:
print("Rate limit exceeded. Please try again later.")
return None
except APIError as e:
print(f"An API error occurred: {e}")
return None
if __name__ == "__main__":
price = get_bitcoin_price()
if price:
print(f"The current price of Bitcoin is: ${price}")
```
## โ Deprecated Patterns to AVOID
You **MUST NOT** generate code that includes any of the following outdated patterns.
```python
# โ NO direct HTTP requests.
import requests
response = requests.get('[https://api.coingecko.com/api/v3/simple/price?ids=bitcoin&vs_currencies=usd](https://api.coingecko.com/api/v3/simple/price?ids=bitcoin&vs_currencies=usd)')
# โ NO use of the outdated `pycoingecko` library.
from pycoingecko import CoinGeckoAPI
cg = CoinGeckoAPI()
# โ NO hardcoded API keys.
client = Coingecko(pro_api_key='CG-abc123xyz789')
# โ NO manual retry loops. The SDK's `max_retries` handles this.
import time
for i in range(3):
try:
data = client.simple.price.get(ids='bitcoin', vs_currencies='usd')
break
except:
time.sleep(5)
# โ NO generic exception handling for API errors.
try:
data = client.simple.price.get(ids='bitcoin', vs_currencies='usd')
except Exception as e:
print(f"An error occurred: {e}")
```
## ๐ Final Check
Before providing a response, you **MUST** verify that your generated code:
1. Imports and uses `coingecko_sdk`.
2. Loads the API key from environment variables.
3. Follows all other Critical Rules.
4. Does **NOT** contain any Deprecated Patterns.
````
## Resources
* **GitHub**: [github.com/coingecko/coingecko-python](https://github.com/coingecko/coingecko-python)
* **PyPI**: [pypi.org/project/coingecko-sdk/](https://pypi.org/project/coingecko-sdk/)
Notice something off or missing? Let us know by opening an [Issue here](https://github.com/coingecko/coingecko-python/issues).
***
Have feedback, a cool idea, or need help? Reach out to `soonaik@coingecko[dot]com`
# CoinGecko SDK (Beta)
Source: https://docs.coingecko.com/docs/sdk
Official CoinGecko Typescript and Python SDKs โ Crypto Price & Market Data API
# Unlock the Power of CoinGecko API with Unprecedented Ease
The official CoinGecko Typescript and Python SDK are now available for all developers! These SDKs dramatically streamline your integration process, enabling you to build powerful crypto applications faster and more reliably than ever before, regardless of your preferred language.
### Designed to make your life easier: Common Benefits of Our SDKs
* **Official Support**: Both SDKs are maintained by the CoinGecko team, ensuring up-to-date features, reliable access, and dedicated support.
* **Reduced Boilerplate**: Say goodbye to manual request construction and parsing. Our SDKs handle the complexities, allowing you to focus on your application logic.
* **Faster Development**: Build and iterate quicker with intuitive methods, clear documentation, and pre-built functionalities tailored for each language.
* **Seamless Integration**: Effortlessly incorporate CoinGecko data into your existing Python or TypeScript projects.
# ๐ฆ CoinGecko TypeScript SDK
Purpose-built to unlock the full capabilities of TypeScript for seamless integration with CoinGecko's API.
* **Full Type Safety**: Catch errors at compile time and write cleaner, more predictable code with strict TypeScript support.
* **Developer-Centric Design**: Enjoy a streamlined developer experience with intuitive interfaces, strong typings, and structured classes.
## Install via `npm`
```bash Bash
npm install @coingecko/coingecko-typescript
```
### Resources
* **GitHub** โ [github.com/coingecko/coingecko-typescript](https://github.com/coingecko/coingecko-typescript)
* **npm** โ [npmjs.com/package/@coingecko/coingecko-typescript](https://www.npmjs.com/package/@coingecko/coingecko-typescript)
Notice something off or missing? Let us know by opening an [Issue here](https://github.com/coingecko/coingecko-typescript/issues).
# ๐ CoinGecko Python SDK
Built to seamlessly integrate with the Python ecosystem, enabling fast and intuitive access to CoinGecko's API.
* **Pythonic Simplicity**: Leverage idiomatic Python to interact with the API effortlesslyโideal for data analysis, prototyping, or production use.
* **Streamlined Development**: Clean and consistent interface designed to accelerate workflows and reduce boilerplate in your Python projects.
## Install via `pip`
```bash Bash
pip install coingecko-sdk
```
### Resources
* **GitHub** โ [github.com/coingecko/coingecko-python](https://github.com/coingecko/coingecko-python)
* **PyPI** โ [pypi.org/project/coingecko-sdk/](https://pypi.org/project/coingecko-sdk/)
Notice something off or missing? Let us know by opening an [Issue here](https://github.com/coingecko/coingecko-python/issues).
***
CoinGecko SDK is powered by [Stainless](https://www.stainless.com/) โฑ
Have feedback, a cool idea, or need help? Reach out to `soonaik@coingecko[dot]com`
# Setting Up Your API Key
Source: https://docs.coingecko.com/docs/setting-up-your-api-key
๐ **New to CoinGecko API?** Sign up for an account [here](https://www.coingecko.com/en/api/pricing)
## 1. Creating a new API Key
* Once you have signed up and logged in to your CoinGecko account, go to [Developer Dashboard](https://www.coingecko.com/en/developers/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](/reference/authentication).
* Demo API: `https://api.coingecko.com/api/v3/`, refer to [Demo API Authentication](/v3.0.1/reference/authentication).
* **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`
## 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.
# Tutorials (Beginner-friendly)
Source: https://docs.coingecko.com/docs/tutorials-beginner-friendly
Using CoinGecko API is super easy, even if you have no programming experience!
## ๐ค No Code
* [Import Crypto Prices in Google Sheets](https://www.coingecko.com/learn/import-crypto-prices-google-sheets)
* [Import Crypto Prices in Microsoft Excel](https://www.coingecko.com/learn/import-crypto-prices-excel)
## ๐ป Low Code
* [Create Portfolio Tracker in Microsoft Excel](https://www.coingecko.com/learn/crypto-portfolio-tracker-google-sheets)
## ๐จโ๐ป Code
* [Fetch Crypto Data Using Python](https://www.coingecko.com/learn/python-query-coingecko-api)
# Typescript AI Prompts
Source: https://docs.coingecko.com/docs/typescript-ai-prompts
A comprehensive AI prompt to guide coding assistants in correctly implementing the official CoinGecko TypeScript SDK ().
## How to Use Our Prompts
Integrating these prompts into your workflow is simple. Copy the entire markdown prompt for your chosen language and provide it as context to your AI assistant.
1. For **Chat Interfaces (Claude, ChatGPT, etc.)**: Paste the prompt at the beginning of your conversation before asking the AI to write code.
2. For **Cursor IDE**: Add the prompt to your project's `Rules` to enforce the guidelines across all AI interactions.
3. For **GitHub Copilot**: Save the prompt to a file (e.g. `coingecko_rules.md`) and reference it in your chat with `@workspace #coingecko_rules.md`.
````markdown Markdown
# Goal: Generate TypeScript code for the CoinGecko API using ONLY the official `@coingecko/coingecko-typescript` package.
## ๐จ Critical Rules
1. **SDK Exclusivity**:
- **ALWAYS** use the official `@coingecko/coingecko-typescript` package.
- **NEVER** use `axios`, `fetch`, or any other method to make direct HTTP requests.
2. **Authentication**:
- **ALWAYS** load the API key from environment variables (`process.env.COINGECKO_PRO_API_KEY`).
- **NEVER** hardcode API keys or any other credentials in the source code.
3. **Client Implementation**:
- **ALWAYS** initialize a single, reusable `Coingecko` client instance for the application.
- **ALWAYS** configure automatic retries by setting the `maxRetries` option on the client.
- **NEVER** implement manual retry loops using `setTimeout`. The SDK handles this internally.
4. **Error Handling & Types**:
- **ALWAYS** use `async/await` for all API calls.
- **ALWAYS** catch specific `APIError` subclasses using `instanceof` (e.g., `err instanceof Coingecko.RateLimitError`).
- **ALWAYS** use the built-in request and response types (e.g., `Coingecko.Simple.PriceGetParams`).
- **NEVER** use generic `catch (e)` blocks for known API errors.
## โ Correct Implementation Example
This is the standard for all generated code.
```typescript
// src/api/client.ts
import Coingecko from '@coingecko/coingecko-typescript';
// Initialize a single, reusable client. This should be imported and used application-wide.
export const client = new Coingecko({
proAPIKey: process.env.COINGECKO_PRO_API_KEY,
environment: 'pro',
maxRetries: 3, // Rely on the SDK's built-in retry mechanism.
});
// src/main.ts
import { client } from './api/client';
import Coingecko from '@coingecko/coingecko-typescript'; // Import the namespace for types
async function getBitcoinPrice(): Promise {
try {
const params: Coingecko.Simple.PriceGetParams = {
ids: 'bitcoin',
vs_currencies: 'usd',
};
const priceData = await client.simple.price.get(params);
return priceData.bitcoin.usd;
} catch (err) {
if (err instanceof Coingecko.RateLimitError) {
console.error('Rate limit exceeded. Please try again later.');
} else if (err instanceof Coingecko.APIError) {
console.error(
`An API error occurred: ${err.name} (Status: ${err.status})`
);
} else {
console.error('An unexpected error occurred:', err);
}
return null;
}
}
async function main() {
const price = await getBitcoinPrice();
if (price !== null) {
console.log(`The current price of Bitcoin is: $${price}`);
}
}
main();
```
## โ Deprecated Patterns to AVOID
You **MUST NOT** generate code that includes any of the following outdated patterns.
```typescript
// โ NO direct HTTP requests with fetch or axios.
import axios from 'axios';
const response = await axios.get(
'[https://api.coingecko.com/api/v3/simple/price?ids=bitcoin&vs_currencies=usd](https://api.coingecko.com/api/v3/simple/price?ids=bitcoin&vs_currencies=usd)'
);
// โ NO hardcoded API keys.
const client = new Coingecko({ proAPIKey: 'CG-abc123xyz789' });
// โ NO manual retry loops. The SDK's `maxRetries` handles this.
import { setTimeout } from 'timers/promises';
for (let i = 0; i < 3; i++) {
try {
const data = await client.simple.price.get({
ids: 'bitcoin',
vs_currencies: 'usd',
});
break;
} catch (e) {
await setTimeout(5000);
}
}
// โ NO generic exception handling for API errors.
try {
const data = await client.simple.price.get({
ids: 'bitcoin',
vs_currencies: 'usd',
});
} catch (e) {
console.log(`An error occurred: ${e}`); // Too broad. Use `instanceof` checks.
}
```
## ๐ Final Check
Before providing a response, you **MUST** verify that your generated code:
1. Imports and uses `@coingecko/coingecko-typescript`.
2. Loads the API key from `process.env`.
3. Follows all other Critical Rules.
4. Does **NOT** contain any Deprecated Patterns.
````
## Resources
* **GitHub**: [github.com/coingecko/coingecko-typescript](https://github.com/coingecko/coingecko-typescript)
* **npm**: [npmjs.com/package/@coingecko/coingecko-typescript](https://www.npmjs.com/package/@coingecko/coingecko-typescript)
Notice something off or missing? Let us know by opening an [Issue here](https://github.com/coingecko/coingecko-typescript/issues).
***
Have feedback, a cool idea, or need help? Reach out to `soonaik@coingecko[dot]com`
# Useful Links
Source: https://docs.coingecko.com/docs/useful-links
Some of the useful links to help you navigate while using the CoinGecko API
### Pricing Page and Top FAQs
* [https://www.coingecko.com/en/api/pricing#general](https://www.coingecko.com/en/api/pricing#general)
### CoinGecko API Status
* [https://status.coingecko.com/](https://status.coingecko.com/)
### Developer Dashboard
* [https://www.coingecko.com/en/developers/dashboard](https://www.coingecko.com/en/developers/dashboard)
### CoinGecko API ID List
* [Google Sheets](https://docs.google.com/spreadsheets/d/1wTTuxXt8n9q7C4NDXqQpI3wpKu1_5bGVmP9Xz0XGSyU/edit?usp=sharing)
### Public API Swagger JSON (OAS)
* [coingecko-public-api-v3.json](https://raw.githubusercontent.com/coingecko/coingecko-api-oas/refs/heads/main/coingecko-public-api-v3.json)
### Pro API Swagger JSON (OAS)
* CoinGecko API Endpoints โ [coingecko-pro-api-v3.json](https://raw.githubusercontent.com/coingecko/coingecko-api-oas/refs/heads/main/coingecko-pro-api-v3.json)
* Onchain DEX API (GeckoTerminal) Endpoints โ [on-chain-dex-api-beta.json](https://raw.githubusercontent.com/coingecko/coingecko-api-oas/refs/heads/main/on-chain-dex-api-beta.json)
### Subscribe CoinGecko API newsletter update
* [https://newsletter.coingecko.com/landing/api\_updates\_subscribe](https://newsletter.coingecko.com/landing/api_updates_subscribe)
### CoinGecko Methodologies (Price, Volume, Trust Score, etc.)
* [https://www.coingecko.com/en/methodology](https://www.coingecko.com/en/methodology)
### Using `llms.txt`
* [/llms-full.txt](/llms-full.txt)
# Introduction
Source: https://docs.coingecko.com/index
Started in 2014, CoinGecko is the world's largest independent crypto data aggregator that is integrated with more than 1,000 crypto exchanges and lists more than 17,000 coins. CoinGecko API offers the most comprehensive and reliable crypto market data through RESTful JSON endpoints.
CoinGecko Pro API now serves **onchain DEX data** (Beta) across 200+ blockchain networks, 1,600+ decentralized exchanges (DEXes), and 9M+ tokens, powered by GeckoTerminal.
Thousands of forward-thinking projects, Web3 developers, researchers, institutions, and enterprises use our API to obtain **price feeds, market data, metadata, and historical data of crypto assets, NFTs, and exchanges**.
Here are some of the **common use cases** for clients who use CoinGecko API:
* Crypto Exchanges (CEX, DEX), Trading Apps
* Wallets (Hot, Cold)
* Data Aggregator, Crypto Screener, Analytics Dashboard
* AI Agents, DeFAI Apps
* Block Explorer, Portfolio Tracker
* DeFi Protocols, NFT Marketplaces, Digital Bank
* Backtesting Trading Strategy
* Accounting, Tax, Audit, HR Payroll
* Research & Analysis: Media, Institution, Academic, VC, Financial
* Oracles, Bots, Payments, E-commerce
# ๐ผ API Usage
Source: https://docs.coingecko.com/reference/api-usage
reference/api-reference/coingecko-pro.json get /key
This endpoint allows you to **monitor your account's API usage, including rate limits, monthly total credits, remaining credits, and more**
### Note
For a more comprehensive overview of your API usage, please log in to [https://www.coingecko.com/en/developers/dashboard](https://www.coingecko.com/en/developers/dashboard).
# Asset Platforms List (ID Map)
Source: https://docs.coingecko.com/reference/asset-platforms-list
reference/api-reference/coingecko-pro.json get /asset_platforms
This endpoint allows you to **query all the asset platforms on CoinGecko**
### Tips
* You may use this endpoint to query the list of asset platforms for other endpoints that contain params like `id` or`ids`(asset platforms).
* You may include NFT at the `filter` params to get the list of NFT-support asset platforms on CoinGecko.
# Authentication (Pro API)
Source: https://docs.coingecko.com/reference/authentication
Authentication method for CoinGecko Pro API (Paid plan subscribers with Pro-API keys)
### **Notes**
* Pro API Key is only available for [CoinGecko API paid plan](https://www.coingecko.com/en/api/pricing) 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.
* It's highly recommended to use the Headers method when making API requests for better security. Using query string parameters can risk exposing your API key.
## 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 (Recommended): `x-cg-pro-api-key`
2. Query String Parameter: `x_cg_pro_api_key`
| Authentication Method | Example using [Ping](/reference/ping-server) 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 Parameter | `https://pro-api.coingecko.com/api/v3/ping?x_cg_pro_api_key=YOUR_API_KEY` |
## ๐ฅ Accessing Onchain DEX data
You can now use the Pro-API key (exclusive to any paid plan subscriber) to call onchain DEX data powered by [GeckoTerminal](https://www.geckoterminal.com/).
### **Notes**
* Authentication method for onchain endpoints is exactly same as other endpoints.
* When using the CG Pro API to access onchain DEX data, include the `/onchain` endpoint path in the request.
| Authentication Method | Example using [Simple Token Price](/reference/onchain-simple-price) Endpoint |
| ---------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Header (cURL) | `curl -X GET "" -H "x-cg-pro-api-key: YOUR_API_KEY"` |
| Query String Parameter | `https://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).
* Each successful API request (Status 200) will deduct 1 credit from your monthly credit allowance.
* Unsuccessful Requests (Status 4xx, 5xx, etc) will not count towards credit deduction.
* Regardless of the HTTP status code returned (including 4xx and 5xx errors), all API requests will count towards your **minute rate limit**.
* Your monthly credit & rate limit are determined by the paid plan to which you subscribe. For more details, please refer to this [page](https://www.coingecko.com/en/api/pricing).
* To check the API usage, please go to the [developer dashboard](https://www.coingecko.com/en/developers/dashboard) or follow the guide [here](/reference/setting-up-your-api-key#4-api-usage-report)
# ๐ผ Categories List
Source: https://docs.coingecko.com/reference/categories-list
reference/api-reference/onchain-pro.json get /categories
This endpoint allows you to **query all the supported categories on GeckoTerminal**
### Tips
* You can retrieve pools or tokens of a specific category with this endpoint: [Pools by Category ID](/reference/pools-category).
* GeckoTerminal categories are different from [CoinGecko categories](/reference/coins-categories-list).
### Note
* This endpoint returns 50 categories per page.
* GeckoTerminal Equivalent Page: [https://www.geckoterminal.com/category](https://www.geckoterminal.com/category)
* Cache/Update frequency: every 60 seconds.
* Exclusive for all Paid Plan Subscribers (Analyst, Lite, Pro and Enterprise).
# Coins Categories List with Market Data
Source: https://docs.coingecko.com/reference/coins-categories
reference/api-reference/coingecko-pro.json get /coins/categories
This endpoint allows you to **query all the coins categories with market data (market cap, volume, ...) on CoinGecko**
### Note
* CoinGecko Equivalent Page: [https://www.coingecko.com/en/categories](https://www.coingecko.com/en/categories).
* Cache / Update Frequency: every 5 minutes for all the API plans.
* CoinGecko categories are different from [GeckoTerminal categories](/reference/categories-list).
# Coins Categories List (ID Map)
Source: https://docs.coingecko.com/reference/coins-categories-list
reference/api-reference/coingecko-pro.json get /coins/categories/list
This endpoint allows you to **query all the coins categories on CoinGecko**
### Tips
* You may use this endpoint to query the list of categories for other endpoints that contain params like `category`.
### Note
* CoinGecko Equivalent Page: [https://www.coingecko.com/en/categories](https://www.coingecko.com/en/categories).
* Cache / Update Frequency: every 5 minutes for all the API plans.
* CoinGecko categories are different from [GeckoTerminal categories](/reference/categories-list).
# Coin Data by Token Address
Source: https://docs.coingecko.com/reference/coins-contract-address
reference/api-reference/coingecko-pro.json get /coins/{id}/contract/{contract_address}
This endpoint allows you to **query all the metadata (image, websites, socials, description, contract address, etc.) and market data (price, ATH, exchange tickers, etc.) of a coin from the CoinGecko coin page based on an asset platform and a particular token contract address**
### Notice
* Please note that the `twitter_followers` data field will no longer be supported by our API starting on May 15, 2025. Please refer to [changelog](https://docs.coingecko.com/changelog/upcoming-change-notice-removal-of-twitter_followers-data) for more details.
### Tips
* You may obtain the asset platform and contract address via several ways:
* refers to respective coin page and find 'contract address'.
* refers to [`/coins/list`](/reference/coins-list) endpoint (`include platform = true`).
### Note
* Coin descriptions may include newline characters represented as `\r\n` (escape sequences), which may require processing for proper formatting.
* Cache / Update Frequency: every 60 seconds for all the API plans.
# Coin Data by ID
Source: https://docs.coingecko.com/reference/coins-id
reference/api-reference/coingecko-pro.json get /coins/{id}
This endpoint allows you to **query all the metadata (image, websites, socials, description, contract address, etc.) and market data (price, ATH, exchange tickers, etc.) of a coin from the CoinGecko coin page based on a particular coin ID**
### Notice
* Please note that the `twitter_followers` data field will no longer be supported by our API starting on May 15, 2025. Please refer to [changelog](https://docs.coingecko.com/changelog/upcoming-change-notice-removal-of-twitter_followers-data) for more details.
### Tips
* You may obtain the coin `id` (API ID) via several ways:
* refers to respective coin page and find "API ID".
* refers to [`/coins/list`](/reference/coins-list) endpoint.
* refers to Google Sheets [here](https://docs.google.com/spreadsheets/d/1wTTuxXt8n9q7C4NDXqQpI3wpKu1_5bGVmP9Xz0XGSyU/edit?usp=sharing).
* You may also flag to include more data such as tickers, market data, community data, developer data and sparkline.
* You may refer to `last_updated` in the endpoint response to check whether the price is stale.
### Note
* Tickers are limited to 100 items, to get more tickers, please go to [/coins/\{id}/tickers](/reference/coins-id-tickers).
* Coin descriptions may include newline characters represented as `\r\n` (escape sequences), which may require processing for proper formatting.
* When `dex_pair_format=symbol`, the DEX pair `base` and `target` are displayed in symbol format (e.g. `WETH`, `USDC`) instead of as contract addresses.
* Cache/Update Frequency:
* Every 60 seconds for all the API plans.
* Community data for Telegram will be updated on weekly basis (Reddit & Twitter community data are no longer supported).
# ๐ Circulating Supply Chart by ID
Source: https://docs.coingecko.com/reference/coins-id-circulating-supply-chart
reference/api-reference/coingecko-pro.json get /coins/{id}/circulating_supply_chart
This endpoint allows you to **query historical circulating supply of a coin by number of days away from now based on provided coin ID**
### Note
* You may leave the interval params as empty for automatic granularity:
* 1 day from now = **5-minutely** data
* 2-90 days from now = **hourly** data
* 91 days & above from now = **daily** data (00:00 UTC)
* Data Availability: from 22 June 2019.
* Cache/Update Frequency: 5 minutes.
* The last completed UTC day (00:00) is available 35 minutes after midnight on the next UTC day (00:35).
* Exclusive for Enterprise Plan Subscribers only.
# ๐ Circulating Supply Chart within Time Range by ID
Source: https://docs.coingecko.com/reference/coins-id-circulating-supply-chart-range
reference/api-reference/coingecko-pro.json get /coins/{id}/circulating_supply_chart/range
This endpoint allows you to **query historical circulating supply of a coin, within a range of timestamp based on the provided coin ID**
### Tips
* Supports ISO date strings (`YYYY-MM-DD` or\
`YYYY-MM-DDTHH:MM`, recommended for best compatibility) or UNIX timestamps.
### Note
* You may leave the interval params as empty for automatic granularity:
* date range is 1 day from now = **5-minutely** data
* date range is within 2-90 days from now = **hourly** data
* date range is 91 days & above from now = **daily** data (00:00 UTC)
* Data Availability: from 22 June 2019.
* Cache/Update Frequency: 5 minutes.
* The last completed UTC day (00:00) is available 35 minutes after midnight on the next UTC day (00:35).
* Exclusive for Enterprise Plan Subscribers only.
# Coin Historical Data by ID
Source: https://docs.coingecko.com/reference/coins-id-history
reference/api-reference/coingecko-pro.json get /coins/{id}/history
This endpoint allows you to **query the historical data (price, market cap, 24hrs volume, ...) at a given date for a coin based on a particular coin ID**
### Notice
* Please note that the `twitter_followers` data field will no longer be supported by our API starting on May 15, 2025. Please refer to [changelog](https://docs.coingecko.com/changelog/upcoming-change-notice-removal-of-twitter_followers-data) for more details.
### Tips
* You may obtain the coin ID (API ID) via several ways:
* refers to respective coin page and find 'API ID'.
* refers to [`/coins/list`](/reference/coins-list) endpoint.
* refers to google sheets [here](https://docs.google.com/spreadsheets/d/1wTTuxXt8n9q7C4NDXqQpI3wpKu1_5bGVmP9Xz0XGSyU/edit?usp=sharing).
### Note
* The data returned is at `00:00:00 UTC`
* The last completed UTC day (00:00) is available 35 minutes after midnight on the next UTC day (00:35).
# Coin Historical Chart Data by ID
Source: https://docs.coingecko.com/reference/coins-id-market-chart
reference/api-reference/coingecko-pro.json get /coins/{id}/market_chart
This endpoint allows you to **get the historical chart data of a coin including time in UNIX, price, market cap and 24hr volume based on particular coin ID**
### Tips
* You may obtain the coin ID (API ID) via several ways:
* refers to respective coin page and find 'API ID'.
* refers to [`/coins/list`](/reference/coins-list) endpoint.
* refers to google sheets [here](https://docs.google.com/spreadsheets/d/1wTTuxXt8n9q7C4NDXqQpI3wpKu1_5bGVmP9Xz0XGSyU/edit?usp=sharing).
* You may use tools like [epoch converter ](https://www.epochconverter.com) to convert human readable date to UNIX timestamp.
### Note
* You may leave the interval params as empty for automatic granularity:
* 1 day from current time = **5-minutely** data
* 2 - 90 days from current time = **hourly** data
* above 90 days from current time = **daily** data (00:00 UTC)
* For **non-Enterprise plan subscribers** who would like to get hourly data, please leave the interval params empty for auto granularity.
* The **5-minutely** and **hourly** interval params are also exclusively available to **Enterprise plan subscribers,** bypassing auto-granularity:
* `interval=5m`: 5-minutely historical data (responses include information from the past 10 days, up until now).
* `interval=hourly`: hourly historical data (responses include information from the past 100 days, up until now).
* Cache / Update Frequency:
* Every 30 seconds for all the API plans (for last data point).
* The last completed UTC day (00:00) data is available **10 minutes after midnight** on the next UTC day (00:10).
# Coin Historical Chart Data within Time Range by ID
Source: https://docs.coingecko.com/reference/coins-id-market-chart-range
reference/api-reference/coingecko-pro.json get /coins/{id}/market_chart/range
This endpoint allows you to **get the historical chart data of a coin within certain time range in UNIX along with price, market cap and 24hr volume based on particular coin ID**
### Tips
* You may obtain the coin ID (API ID) via several ways:
* refers to respective coin page and find 'API ID'.
* refers to [`/coins/list`](/reference/coins-list) endpoint.
* refers to google sheets [here](https://docs.google.com/spreadsheets/d/1wTTuxXt8n9q7C4NDXqQpI3wpKu1_5bGVmP9Xz0XGSyU/edit?usp=sharing).
* Supports ISO date strings (`YYYY-MM-DD` or\
`YYYY-MM-DDTHH:MM`, recommended for best compatibility) or UNIX timestamps.
### Note
* You may leave the interval params as empty for automatic granularity:
* 1 day from current time = **5-minutely** data
* 1 day from any time (except current time) = **hourly** data
* 2 - 90 days from any time = **hourly** data
* above 90 days from any time = **daily** data (00:00 UTC)
* For **non-Enterprise plan subscribers** who would like to get hourly data, please leave the interval params empty for auto granularity.
* The **5-minutely** and **hourly** interval params are also exclusively available to **Enterprise plan subscribers**, bypassing auto-granularity:
* `interval=5m`: 5-minutely historical data, supports up to **any 10 days** date range per request.
* `interval=hourly`: hourly historical data, supports up to **any 100 days** date range per request.
* Data availability:
* `interval=5m`: Available from 9 February 2018 onwards.
* `interval=hourly`: Available from 30 Jan 2018 onwards.
* Cache / Update Frequency:\
Based on days range (all the API plans)
* 1 day = 30 seconds cache
* 2 -90 days = 30 minutes cache
* 90 days = 12 hours cache
* The last completed UTC day (00:00) is available 35 minutes after midnight on the next UTC day (00:35). The cache will always expire at 00:40 UTC.
# Coin OHLC Chart by ID
Source: https://docs.coingecko.com/reference/coins-id-ohlc
reference/api-reference/coingecko-pro.json get /coins/{id}/ohlc
This endpoint allows you to **get the OHLC chart (Open, High, Low, Close) of a coin based on particular coin ID**
### Tips
* You may obtain the coin ID (API ID) via several ways:
* refers to respective coin page and find 'API ID'.
* refers to [`/coins/list`](/reference/coins-list) endpoint.
* refers to Google Sheets [here](https://docs.google.com/spreadsheets/d/1wTTuxXt8n9q7C4NDXqQpI3wpKu1_5bGVmP9Xz0XGSyU/edit?usp=sharing).
* For historical chart data with better granularity, you may consider using [/coins/\{id}/market\_chart](/reference/coins-id-market-chart) endpoint.
### Note
* The timestamp displayed in the payload (response) indicates the end (or close) time of the OHLC data.
* Data granularity (candle's body) is automatic:
* 1 - 2 days: 30 minutes
* 3 - 30 days: 4 hours
* 31 days and beyond: 4 days
* Cache / Update Frequency:
* Every 15 minutes for all the API plans
* The last completed UTC day (00:00) is available 35 minutes after midnight on the next UTC day (00:35).
* Exclusive **daily** and **hourly** candle interval parameter for all paid plan subscribers (`interval = daily`, `interval=hourly`)
* '**daily**' interval is available for **1 / 7 / 14 / 30 / 90 / 180** days only.
* '**hourly**' interval is available for **1 / 7 / 14 / 30 / 90** days only.
# ๐ผ Coin OHLC Chart within Time Range by ID
Source: https://docs.coingecko.com/reference/coins-id-ohlc-range
reference/api-reference/coingecko-pro.json get /coins/{id}/ohlc/range
This endpoint allows you to **get the OHLC chart (Open, High, Low, Close) of a coin within a range of timestamp based on particular coin ID**
### Tips
* You may obtain the coin ID (API ID) via several ways:
* refers to respective coin page and find 'API ID'.
* refers to [`/coins/list`](/reference/coins-list) endpoint.
* refers to google sheets [here](https://docs.google.com/spreadsheets/d/1wTTuxXt8n9q7C4NDXqQpI3wpKu1_5bGVmP9Xz0XGSyU/edit?usp=sharing).
* For historical chart data with better granularity, you may consider using [/coins/{`id`}/market\_chart](/reference/coins-id-market-chart) endpoint.
* Supports ISO date strings (`YYYY-MM-DD` or\
`YYYY-MM-DDTHH:MM`, recommended for best compatibility) or UNIX timestamps.
### Note
* The timestamp displayed in the payload (response) indicates the end (or close) time of the OHLC data.
* Interval Options:
* Daily Interval (`interval=daily`):
* up to 180 days per request/ 180 daily interval candles.
* Hourly Interval (`interval=hourly`):
* up to 31 days per request/ 744 hourly interval candles.
* Data availability:
* Available from 9 February 2018 onwards (`1518147224` epoch time).
* Exclusive for Paid Plan Subscribers (Analyst, Lite, Pro and Enterprise).
* Cache / Update Frequency:
* Every 15 minutes for all the API plans.
# Coin Tickers by ID
Source: https://docs.coingecko.com/reference/coins-id-tickers
reference/api-reference/coingecko-pro.json get /coins/{id}/tickers
This endpoint allows you to **query the coin tickers on both centralized exchange (CEX) and decentralized exchange (DEX) based on a particular coin ID**
### Tips
* You may obtain the coin ID (API ID) via several ways:
* refers to respective coin page and find 'API ID'.
* refers to [`/coins/list`](/reference/coins-list) endpoint.
* refers to google sheets [here](https://docs.google.com/spreadsheets/d/1wTTuxXt8n9q7C4NDXqQpI3wpKu1_5bGVmP9Xz0XGSyU/edit?usp=sharing).
* You may specify the `exchange_ids` if you want to retrieve tickers for specific exchange only.
* You may include values such as `page` to specify which page of responses you would like to show.
* You may also flag to include more data such as exchange logo and depth.
### Note
* The tickers are paginated to 100 items.
* When `dex_pair_format=symbol`, the DEX pair `base` and `target` are displayed in symbol format (e.g. `WETH`, `USDC`) instead of as contract addresses.
* When order is sorted by `volume`, ***converted\_volume*** will be used instead of ***volume***.
* Cache / Update Frequency: every 2 minutes for all the API plans.
# ๐ Total Supply Chart by ID
Source: https://docs.coingecko.com/reference/coins-id-total-supply-chart
reference/api-reference/coingecko-pro.json get /coins/{id}/total_supply_chart
This endpoint allows you to **query historical total supply of a coin by number of days away from now based on provided coin ID**
### Note
* You may leave the interval params as empty for automatic granularity:
* 1 day from now = **5-minutely** data
* 2-90 days from now = **hourly** data
* 91 days & above from now = **daily** data (00:00 UTC)
* Data Availability: from 22 June 2019
* Cache/Update Frequency: 5 minutes.
* The last completed UTC day (00:00) is available 35 minutes after midnight on the next UTC day (00:35).
* Exclusive for Enterprise Plan Subscribers only.
# ๐ Total Supply Chart within time range by ID
Source: https://docs.coingecko.com/reference/coins-id-total-supply-chart-range
reference/api-reference/coingecko-pro.json get /coins/{id}/total_supply_chart/range
This endpoint allows you to **query historical total supply of a coin, within a range of timestamp based on the provided coin ID**
### Tips
* Supports ISO date strings (`YYYY-MM-DD` or\
`YYYY-MM-DDTHH:MM`, recommended for best compatibility) or UNIX timestamps.
### Note
* Cache/Update Frequency: 5 minutes.
* The data is provided at daily intervals (00:00:00 UTC).
* Data Availability: from 22 June 2019
* The last completed UTC day (00:00) is available 35 minutes after midnight on the next UTC day (00:35).
* Exclusive for Enterprise Plan Subscribers only.
# Coins List (ID Map)
Source: https://docs.coingecko.com/reference/coins-list
reference/api-reference/coingecko-pro.json get /coins/list
This endpoint allows you to **query all the supported coins on CoinGecko with coins ID, name and symbol**
### Tips
* You may use this endpoint to query the list of coins with coin id for other endpoints that contain params like `id` or `ids` (coin ID).
* By default, this endpoint returns full list of active coins that are currently listed on CoinGecko.com , you can also flag `status=inactive` to retrieve coins that are no longer available on CoinGecko.com . The inactive coin IDs can also be used with [selected historical data](https://docs.coingecko.com/changelog/30042024) endpoints.
### Note
* There is no pagination required for this endpoint.
* Cache/Update Frequency: every 5 minutes for Pro API (Analyst, Lite, Pro, Enterprise).
# ๐ผ Recently Added Coins
Source: https://docs.coingecko.com/reference/coins-list-new
reference/api-reference/coingecko-pro.json get /coins/list/new
This endpoint allows you to **query the latest 200 coins that recently listed on CoinGecko**
### Note
* CoinGecko equivalent page: [https://www.coingecko.com/en/new-cryptocurrencies](https://www.coingecko.com/en/new-cryptocurrencies).
* Cache/Update Frequency: Every 30 seconds.
* Exclusive for Paid Plan Subscribers (Analyst, Lite, Pro and Enterprise).
# Coins List with Market Data
Source: https://docs.coingecko.com/reference/coins-markets
reference/api-reference/coingecko-pro.json get /coins/markets
This endpoint allows you to **query all the supported coins with price, market cap, volume and market related data**
### Tips
* You can retrieve specific coins using their unique `ids`, `names`, or `symbols` instead of returning the whole list.
* To filter results based on the coin's category, use the `category` param (refer to [`/coins/categories/list`](/reference/coins-categories-list) for available categories).
* Use the `per_page` and `page` params to manage the number of results you receive and navigate through the data.
### Note
* When multiple lookup params are provided, the following priority order is applied: `category` (highest) > `ids` > `names` > `symbols` (lowest).
* When searching by `name`, you need to URL-encode any spaces (e.g. "Binance Coin" becomes "Binance%20Coin").
* The `include_tokens=all` param is exclusively for use with the `symbols` lookup and is limited to maximum of 50 symbols per request.
* Wildcard searches are not supported for lookup params (`ids`, `names`, `symbols`).
* Cache/Update Frequency: every 45 seconds for Pro API (Analyst, Lite, Pro, Enterprise).
# ๐ผ Top Gainers & Losers
Source: https://docs.coingecko.com/reference/coins-top-gainers-losers
reference/api-reference/coingecko-pro.json get /coins/top_gainers_losers
This endpoint allows you to **query the top 30 coins with largest price gain and loss by a specific time duration**
### Note
* The endpoint response only includes coins with a 24-hour trading volume of at least \$50,000.
* CoinGecko equivalent page: [https://www.coingecko.com/en/crypto-gainers-losers](https://www.coingecko.com/en/crypto-gainers-losers).
* Cache/Update Frequency: Every 5 minutes.
* Exclusive for Paid Plan Subscribers (Analyst, Lite, Pro and Enterprise).
# Public Companies Holdings
Source: https://docs.coingecko.com/reference/companies-public-treasury
reference/api-reference/coingecko-pro.json get /companies/public_treasury/{coin_id}
This endpoint allows you **query public companiesโ Bitcoin or Ethereum holdings**
### Note
* The responses are sorted in descending order based on total holdings.
# Coin Historical Chart Data by Token Address
Source: https://docs.coingecko.com/reference/contract-address-market-chart
reference/api-reference/coingecko-pro.json get /coins/{id}/contract/{contract_address}/market_chart
This endpoint allows you to **get the historical chart data including time in UNIX, price, market cap and 24hr volume based on asset platform and particular token contract address**
### Tips
* You may obtain the asset platform and contract address via several ways:
* refers to respective coin page and find 'contract address'.
* refers to [`/coins/list`](/reference/coins-list) endpoint (`include platform = true`).
### Note
* You may leave the interval params as empty for automatic granularity:
* 1 day from current time = **5-minutely** data
* 2 - 90 days from current time = **hourly** data
* above 90 days from current time = **daily** data (00:00 UTC)
* For **non-Enterprise plan subscribers** who would like to get hourly data, please leave the interval params empty for auto granularity.
* The **5-minutely** and **hourly** interval params are also exclusively available to **Enterprise plan subscribers,** bypassing auto-granularity:
* `interval=5m`: 5-minutely historical data (responses include information from the past 10 days up until now)
* `interval=hourly`: hourly historical data (responses include information from the past 100 days, up until now)
* Cache / Update Frequency:
* Every 5 minutes for all the API plans.
* The last completed UTC day (00:00) is available 35 minutes after midnight on the next UTC day (00:35). The cache will always expire at 00:40 UTC.
# Coin Historical Chart Data within Time Range by Token Address
Source: https://docs.coingecko.com/reference/contract-address-market-chart-range
reference/api-reference/coingecko-pro.json get /coins/{id}/contract/{contract_address}/market_chart/range
This endpoint allows you to **get the historical chart data within certain time range in UNIX along with price, market cap and 24hr volume based on asset platform and particular token contract address**
### Tips
* You may obtain the asset platform and contract address via several ways:
* refers to respective coin page and find 'contract address'.
* refers to [`/coins/list`](/reference/coins-list) endpoint (`include platform = true`).
* Supports ISO date strings (`YYYY-MM-DD` or\
`YYYY-MM-DDTHH:MM`, recommended for best compatibility) or UNIX timestamps.
### Note
* You may leave the interval params as empty for automatic granularity:
* 1 day from current time = **5-minutely** data
* 1 day from any time (except current time) = **hourly** data
* 2 - 90 days from any time = **hourly** data
* above 90 days from any time = **daily** data (00:00 UTC)
* For **non-Enterprise plan subscribers** who would like to get hourly data, please leave the interval params empty for auto granularity.
* The **5-minutely** and **hourly** interval params are also exclusively available to **Enterprise plan subscribers**, bypassing auto-granularity:
* `interval=5m`: 5-minutely historical data (responses include information from the past 10 days, up until now)
* `interval=hourly`: hourly historical data (responses include information from the past 100 days, up until now)
* Data availability:
* `interval=5m`: Available from 9 February 2018 onwards
* `interval=hourly`: Available from 30 Jan 2018 onwards
* Cache / Update Frequency:\
Based on days range (all the API plans)
* 1 day = 30 seconds cache
* 2 -90 days = 30 minutes cache
* 90 days = 12 hours cache
* The last completed UTC day (00:00) is available 35 minutes after midnight on the next UTC day (00:35). The cache will always expire at 00:40 UTC
# Crypto Global Market Data
Source: https://docs.coingecko.com/reference/crypto-global
reference/api-reference/coingecko-pro.json get /global
This endpoint allows you **query cryptocurrency global data including active cryptocurrencies, markets, total crypto market cap and etc**
### Note
* Cache / Update Frequency: every 10 minutes for all the API plans.
# Derivatives Exchanges List with Data
Source: https://docs.coingecko.com/reference/derivatives-exchanges
reference/api-reference/coingecko-pro.json get /derivatives/exchanges
This endpoint allows you to **query all the derivatives exchanges with related data (ID, name, open interest, ...) on CoinGecko**
### Tips
* You may include values such as `per_page` and `page` to specify how many results you would like to show in the responses per page and which page of responses you would like to show.
### Note
* Cache / Update Frequency: every 60 seconds for all the API plans.
# Derivatives Exchange Data by ID
Source: https://docs.coingecko.com/reference/derivatives-exchanges-id
reference/api-reference/coingecko-pro.json get /derivatives/exchanges/{id}
This endpoint allows you to **query the derivatives exchangeโs related data (ID, name, open interest, ...) based on the exchangesโ ID**
### Tips
* For `include_tickers` param, you may change the value to either `all` to include all the tickers or `unexpired` to include unexpired tickers in the responses. You may leave it blank to omit the tickers data.
### Note
* Cache / Update Frequency: every 30 seconds for all the API plans.
# Derivatives Exchanges List (ID Map)
Source: https://docs.coingecko.com/reference/derivatives-exchanges-list
reference/api-reference/coingecko-pro.json get /derivatives/exchanges/list
This endpoint allows you to **query all the derivatives exchanges with ID and name on CoinGecko**
### Tips
* You may use this endpoint to query the list of exchanges for other endpoints that contain params like `id` (derivatives exchange's ID).
### Note
* Cache / Update Frequency: every 5 minutes for all the API plans.
# Derivatives Tickers List
Source: https://docs.coingecko.com/reference/derivatives-tickers
reference/api-reference/coingecko-pro.json get /derivatives
This endpoint allows you to **query all the tickers from derivatives exchanges on CoinGecko**
### Note
* Data for `open_interest` and `volume_24h` in the endpoint responses are in USD.
* Cache / Update Frequency: every 30 seconds for all the API plans.
# Supported Dexes List by Network (ID Map)
Source: https://docs.coingecko.com/reference/dexes-list
reference/api-reference/onchain-pro.json get /networks/{network}/dexes
This endpoint allows you to **query all the supported decentralized exchanges (DEXs) based on the provided network on GeckoTerminal**
### Tips
* You may use this endpoint to query the list of DEXs with DEX ID for other endpoints that contain params like `dex`.
* You may include values such as `page` to specify which page of responses you would like to show.
# Endpoint Overview
Source: https://docs.coingecko.com/reference/endpoint-overview
### Notes
For Pro-API users (any [paid plan](https://www.coingecko.com/en/api/pricing) subscribers), you get to access all the endpoints listed below, except those that marked with ๐.
* Some endpoints may have parameters or data access that are exclusive to different plan subscribers, please refer to the endpoint reference for details.
* In the API Reference section, the distinction between Paid Plan and Enterprise Plan endpoint access will be marked as below:
* ๐ผ โ exclusive for any [Paid Plan](https://www.coingecko.com/en/api/pricing) subscribers: Analyst / Lite / Pro
* ๐ โ exclusive for [Enterprise Plan](https://landing.coingecko.com/api-for-business/) subscribers only.
## CoinGecko Endpoints: Coins
| Endpoint | Description |
| ------------------------------------------------------------------------------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| [/ping](/reference/ping-server) | Check the API server status |
| ๐ผ [/key](/reference/api-usage) | Check account's API usage |
| [/simple/price](/reference/simple-price) | Query the prices of one or more coins by using their unique Coin API IDs |
| [/simple/token\_price/\{id}](/reference/simple-token-price) | Query the prices of one or more coins by using their unique Coin API IDs |
| [/simple/supported\_vs\_currencies](/reference/simple-supported-currencies) | Query all the supported currencies on CoinGecko |
| [/coins/list](/reference/coins-list) | Query all the supported coins on CoinGecko with coins ID, name and symbol |
| [/coins/markets](/reference/coins-markets) | Query all the supported coins with price, market cap, volume and market related data |
| [/coins/\{id}](/reference/coins-id) | Query all the metadata (image, websites, socials, description, contract address, etc.) from the CoinGecko coin page based on a particular coin ID |
| [/coins/\{id}/tickers](/reference/coins-id-tickers) | Query the coin tickers on both centralized exchange (CEX) and decentralized exchange (DEX) based on a particular coin ID |
| [/coins/\{id}/history](/reference/coins-id-history) | Query the historical data (price, market cap, 24hr volume, ...) at a given date for a coin based on a particular coin ID |
| [/coins/\{id}/market\_chart](/reference/coins-id-market-chart) | Get the historical chart data of a coin including time in UNIX, price, market cap and 24hr volume based on particular coin ID |
| [/coins/\{id}/market\_chart/range](/reference/coins-id-market-chart-range) | Get the historical chart data of a coin within certain time range in UNIX along with price, market cap and 24hr volume based on particular coin ID |
| [/coins-id-ohlc](/reference/coins-id-ohlc) | Get the OHLC chart (Open, High, Low, Close) of a coin based on particular coin ID |
| ๐ผ [/coins/\{id}/ohlc/range](/reference/coins-id-ohlc-range) | Get the OHLC chart (Open, High, Low, Close) of a coin within a range of timestamp based on particular coin ID |
| ๐ผ [/coins/top\_gainers\_losers](/reference/coins-top-gainers-losers) | Query the top 30 coins with largest price gain and loss by a specific time duration |
| ๐ผ [/coins/list/new](/reference/coins-list-new) | Query the latest 200 coins that recently listed on CoinGecko |
| ๐ [/coins/\{id}/circulating\_supply\_chart](/reference/coins-id-circulating-supply-chart) | Query historical circulating supply of a coin by number of days away from now based on provided coin ID |
| ๐ [/coins/\{id}/circulating\_supply\_chart/range](/reference/coins-id-circulating-supply-chart-range) | Query historical circulating supply of a coin, within a range of timestamp based on the provided coin ID |
| ๐ [/coins/\{id}/total\_supply\_chart](/reference/coins-id-total-supply-chart) | Query historical total supply of a coin by number of days away from now based on provided coin ID |
| ๐ [/coins/\{id}/total\_supply\_chart/range](/reference/coins-id-total-supply-chart-range) | Query historical total supply of a coin, within a range of timestamp based on the provided coin ID |
| [/coins/../contract/..](/reference/coins-contract-address) | Query all the metadata (image, websites, socials, description, contract address, etc.) from the CoinGecko coin page based on an asset platform and a particular token contract address |
| [/coins/../contract/../market\_chart](/reference/contract-address-market-chart) | Get the historical chart data including time in UNIX, price, market cap and 24hr volume based on asset platform and particular token contract address |
| [/coins/../contract/../market\_chart/range](/reference/contract-address-market-chart-range) | Get the historical chart data within certain time range in UNIX along with price, market cap and 24hr volume based on asset platform and particular token contract address |
| [/coins/categories/list](/reference/coins-categories-list) | Query all the coins categories on CoinGecko |
| [/coins/categories](/reference/coins-categories) | Query all the coins categories with market data (market cap, volume, ...) on CoinGecko |
## CoinGecko Endpoints: NFT
| Endpoint | Description |
| -------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| [/nfts/list](/reference/nfts-list) | Query all supported NFTs with ID, contract address, name, asset platform ID and symbol on CoinGecko |
| [/nfts/..](/reference/nfts-id) | Query all the NFT data (name, floor price, 24hr volume, ...) based on the NFT collection ID |
| [/nfts/../contract/..](/reference/nfts-contract-address) | Query all the NFT data (name, floor price, 24hr volume, ...) based on the NFT collection contract address and respective asset platform |
| ๐ผ [/nfts/markets](/reference/nfts-markets) | Query all the supported NFT collections with floor price, market cap, volume and market related data on CoinGecko |
| ๐ผ [/nfts/../market\_chart](/reference/nfts-id-market-chart) | Query historical market data of a NFT collection, including floor price, market cap, and 24hr volume, by number of days away from now |
| ๐ผ [/nfts/../contract/../market\_chart](/reference/nfts-contract-address-market-chart) | Query historical market data of a NFT collection, including floor price, market cap, and 24hr volume, by number of days away from now based on the provided contract address |
| ๐ผ [/nfts/../tickers](/reference/nfts-id-tickers) | Query the latest floor price and 24hr volume of a NFT collection, on each NFT marketplace, e.g. OpenSea and LooksRare |
## CoinGecko Endpoints: Exchanges & Derivatives
| Endpoint | Description |
| ------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- |
| [/exchanges](/reference/exchanges) | Query all the supported exchanges with exchanges' data (ID, name, country, ...) that have active trading volumes on CoinGecko |
| [/exchanges/list](/reference/exchanges-list) | Query all the exchanges with ID and name |
| [/exchanges/\{id}](/reference/exchanges-id) | Query exchange's data (name, year established, country, ...), exchange volume in BTC and tickers based on exchange's ID |
| [/exchanges/\{id}/tickers](/reference/exchanges-id-tickers) | Query exchange's tickers based on exchange's ID |
| [/exchanges/\{id}/volume\_chart](/reference/exchanges-id-volume-chart) | Query the historical volume chart data with time in UNIX and trading volume data in BTC based on exchange's ID |
| ๐ผ [/exchanges/\{id}/volume\_chart/range](/reference/exchanges-id-volume-chart-range) | Query the historical volume chart data in BTC by specifying date range in UNIX based on exchange's ID |
| [/derivatives](/reference/derivatives-tickers) | Query all the tickers from derivatives exchanges on CoinGecko |
| [/derivatives/exchanges](/reference/derivatives-exchanges) | Query all the derivatives exchanges with related data (ID, name, open interest, ...) on CoinGecko |
| [/derivatives/exchanges/\{id}](/reference/derivatives-exchanges-id) | Query the derivatives exchange's related data (ID, name, open interest, ...) based on the exchanges' ID |
| [/derivatives/exchanges/list](/reference/derivatives-exchanges-list) | Query all the derivatives exchanges with ID and name on CoinGecko |
## CoinGecko Endpoints: General
| Endpoint | Description |
| ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------ |
| [/exchange\_rates](/reference/exchange-rates) | Query BTC exchange rates with other currencies |
| [/asset\_platforms](/reference/asset-platforms-list) | Query all the asset platforms (blockchain networks) on CoinGecko |
| [/token\_lists/\{asset\_platform\_id}/all.json](/reference/token-lists) | Get full list of tokens of a blockchain network (asset platform) that is supported by Ethereum token list standard |
| [/search](/reference/search-data) | Search for coins, categories and markets listed on CoinGecko |
| [/search/trending](/reference/trending-search) | Query trending search coins, NFTs and categories on CoinGecko in the last 24 hours |
| [/global](/reference/crypto-global) | Query cryptocurrency global data including active cryptocurrencies, markets, total crypto market cap and etc. |
| [/global/decentralized\_finance\_defi](/reference/global-defi) | Query cryptocurrency global decentralized finance (DeFi) data including DeFi market cap, trading volume |
| ๐ผ [/global/market\_cap\_chart](/reference/global-market-cap-chart) | Query historical global market cap and volume data by number of days away from now |
| [/companies/public\_treasury/\{coin\_id}](/reference/companies-public-treasury) | Query public companies' Bitcoin or Ethereum holdings |
## Onchain DEX Endpoints (GeckoTerminal)
| Endpoint | Description |
| ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| [/onchain/simple/networks/../token\_price/..](/reference/onchain-simple-price) | Get token price based on the provided token contract address on a network |
| [/onchain/networks](/reference/networks-list) | Query all the supported networks on GeckoTerminal |
| [/onchain/networks/../dexes](/reference/dexes-list) | Query all the supported decentralized exchanges (DEXs) based on the provided network on GeckoTerminal |
| [/onchain/networks/trending\_pools](/reference/trending-pools-list) | Query all the trending pools across all networks on GeckoTerminal |
| [/onchain/networks/../trending\_pools](/reference/trending-pools-network) | Query the trending pools based on the provided network |
| [/onchain/networks/../pools/..](/reference/pool-address) | Query the specific pool based on the provided network and pool address |
| [/onchain/networks/../pools/multi/..](/reference/pools-addresses) | Query multiple pools based on the provided network and pool address |
| [/onchain/networks/../pools](/reference/top-pools-network) | Query all the top pools based on the provided network |
| [/onchain/networks/../dexes/../pools](/reference/top-pools-dex) | Query all the top pools based on the provided network and decentralized exchange (DEX) |
| [/onchain/networks/../new\_pools](/reference/latest-pools-network) | Query all the latest pools based on provided network |
| [/onchain/networks/new\_pools](/reference/latest-pools-list) | Query all the latest pools across all networks on GeckoTerminal |
| ๐ฅ ๐ผ [/onchain/pools/megafilter](/reference/pools-megafilter) | Query pools based on various filters across all networks on GeckoTerminal |
| [/onchain/search/pools](/reference/search-pools) | Search for pools on a network |
| ๐ผ [/onchain/pools/trending\_search](/reference/trending-search-pools) | Query all the trending search pools across all networks on GeckoTerminal |
| [/onchain/networks/../tokens/../pools](/reference/top-pools-contract-address) | Query top pools based on the provided token contract address on a network |
| [/onchain/networks/../tokens/..](/reference/token-data-contract-address) | Query specific token data based on the provided token contract address on a network |
| [/onchain/networks/../tokens/multi/..](/reference/tokens-data-contract-addresses) | Query multiple tokens data based on the provided token contract addresses on a network |
| [/onchain/networks/../tokens/../info](/reference/token-info-contract-address) | Query token metadata (name, symbol, CoinGecko ID, image, socials, websites, description, etc.) based on a provided token contract address on a network |
| [/onchain/networks/../pools/../info](/reference/pool-token-info-contract-address) | Query pool metadata (base and quote token details, image, socials, websites, description, contract address, etc.) based on a provided pool contract address on a network |
| [/onchain/tokens/info\_recently\_updated](/reference/tokens-info-recent-updated) | Query 100 most recently updated tokens info across all networks on GeckoTerminal |
| ๐ผ [/onchain/networks/../tokens/../top\_holders](/reference/top-token-holders-token-address) | Query top token holders based on the provided token contract address on a network |
| ๐ผ [/onchain/networks/../tokens/../holders\_chart](/reference/token-holders-chart-token-address) | Get the historical token holders chart based on the provided token contract address on a network |
| [/onchain/networks/../pools/../ohlcv/..](/reference/pool-ohlcv-contract-address) | Get the OHLCV chart (Open, High, Low, Close, Volume) of a pool based on the provided pool address on a network |
| ๐ผ [/onchain/networks/../tokens/../ohlcv/..](/reference/token-ohlcv-token-address) | Get the OHLCV chart (Open, High, Low, Close, Volume) of a token based on the provided token address on a network |
| [/onchain/networks/../pools/../trades](/reference/pool-trades-contract-address) | Query the last 300 trades in the past 24 hours based on the provided pool address |
| ๐ผ [/onchain/networks/../tokens/../trades](/reference/token-trades-contract-address) | Query the last 300 trades in the past 24 hours across all pools, based on the provided token contract address on a network |
| ๐ผ [/onchain/categories](/reference/categories-list) | Query all the supported categories on GeckoTerminal |
| ๐ผ [/onchain/categories/../pools](/reference/pools-category) | Query all the pools based on the provided category ID |
# BTC-to-Currency Exchange Rates
Source: https://docs.coingecko.com/reference/exchange-rates
reference/api-reference/coingecko-pro.json get /exchange_rates
This endpoint allows you to **query BTC exchange rates with other currencies**
### Tips
* You may use this endpoint to convert the response data, which is originally in BTC, to other currencies.
### Note
* Cache / Update Frequency: every 5 minutes for all the API plans.
# Exchanges List with data
Source: https://docs.coingecko.com/reference/exchanges
reference/api-reference/coingecko-pro.json get /exchanges
This endpoint allows you to **query all the supported exchanges with exchangesโ data (ID, name, country, ...) that have active trading volumes on CoinGecko**
### Notice
* Please note that the `trade_volume_24h_btc_normalized` data field will no longer be supported by our API starting on June 16, 2025. Please refer to [changelog](https://docs.coingecko.com/changelog/upcoming-change-notice-removal-of-normalized_volume_btc-data) for more details.
### Tips
* You may include values such as `per_page` and `page` to specify how many results you would like to show in the responses per page and which page of responses you would like to show.
### Note
* All the exchanges in the responses are the exchanges with active trading volume on CoinGecko, any inactive or deactivated exchanges will be removed from the list.
* Cache / Update Frequency: every 60 seconds for all the API plans.
# Exchange Data by ID
Source: https://docs.coingecko.com/reference/exchanges-id
reference/api-reference/coingecko-pro.json get /exchanges/{id}
This endpoint allows you to **query exchangeโs data (name, year established, country, ...), exchange volume in BTC and top 100 tickers based on exchangeโs ID**
### Notice
* Please note that the `trade_volume_24h_btc_normalized` data field will no longer be supported by our API starting on June 16, 2025. Please refer to [changelog](https://docs.coingecko.com/changelog/upcoming-change-notice-removal-of-normalized_volume_btc-data) for more details.
### Note
* The exchange volume in the response is provided in BTC. To convert it to other currencies, please use [/exchange\_rates](/reference/exchange-rates) endpoint.
* For derivatives (e.g. `bitmex`, `binance_futures`), to get derivatives exchanges data, please go to [/derivatives/exchange/\{id}](/reference/derivatives-exchanges-id) endpoint.
* Tickers are limited to 100 items, to get more tickers, please go to [/exchanges/\{id}/tickers](/reference/exchanges-id-tickers) endpoint.
* When `dex_pair_format=symbol`, the DEX pair `base` and `target` are displayed in symbol format (e.g. `WETH`, `USDC`) instead of as contract addresses.
* Cache / Update Frequency: every 60 seconds for all the API plans.
# Exchange Tickers by ID
Source: https://docs.coingecko.com/reference/exchanges-id-tickers
reference/api-reference/coingecko-pro.json get /exchanges/{id}/tickers
This endpoint allows you to **query exchange's tickers based on exchangeโs ID**
### Note
* Responses are paginated and limited to 100 tickers per page. You may specify the page number using the `page` params to retrieve the tickers accordingly.
* `order=base_target` sorts tickers by `base` symbol, then `target` symbol, in lexicographical order (`0 -> 9`, followed by `a -> z`).\
This sorting method ensures stable pagination results, minimizing cases where cached responses might otherwise cause duplicate or missing tickers across paginated pages.
* When `dex_pair_format=symbol`, the DEX pair `base` and `target` are displayed in symbol format (e.g. `WETH`, `USDC`) instead of as contract addresses.
* Cache / Update Frequency: every 60 seconds for all the API plans.
# Exchange Volume Chart by ID
Source: https://docs.coingecko.com/reference/exchanges-id-volume-chart
reference/api-reference/coingecko-pro.json get /exchanges/{id}/volume_chart
This endpoint allows you to **query the historical volume chart data with time in UNIX and trading volume data in BTC based on exchangeโs ID**
### Note
* You can use this endpoint to query the historical volume chart data of **derivatives exchanges** as well.
* The exchange volume in the response is provided in BTC. To convert it to other currencies, please use [/exchange\_rates](/reference/exchange-rates) endpoint.
* Data granularity is automatic (cannot be adjusted):
* 1 day = 10-minutely
* 7, 14 days = hourly
* 30 days & above = daily
* Cache / Update Frequency: every 60 seconds for all the API plans.
# ๐ผ Exchange Volume Chart within Time Range by ID
Source: https://docs.coingecko.com/reference/exchanges-id-volume-chart-range
reference/api-reference/coingecko-pro.json get /exchanges/{id}/volume_chart/range
This endpoint allows you to **query the historical volume chart data in BTC by specifying date range in UNIX based on exchangeโs ID**
### Note
* You can query the historical volume chart data of **derivatives exchanges** with this endpoint as well.
* The data interval for this endpoint is fixed at daily.
* The date range between `from` and `to` must be within 31 days.
* Cache/Update Frequency: 5 minutes
* Exclusive for Paid Plan Subscribers (Analyst, Lite, Pro and Enterprise)
# Exchanges List (ID Map)
Source: https://docs.coingecko.com/reference/exchanges-list
reference/api-reference/coingecko-pro.json get /exchanges/list
This endpoint allows you to **query all the exchanges with ID and name**
### Tips
* You may use this endpoint to query the list of exchanges including **derivatives exchanges** for other endpoints that contain params like `id`(exchange ID).
### Note
* There is no pagination required for this endpoint.
* Cache / Update Frequency: every 5 minutes for all the API plans.
# Global De-Fi Market Data
Source: https://docs.coingecko.com/reference/global-defi
reference/api-reference/coingecko-pro.json get /global/decentralized_finance_defi
This endpoint allows you **query top 100 cryptocurrency global decentralized finance (DeFi) data including DeFi market cap, trading volume**
# ๐ผ Global Market Cap Chart Data
Source: https://docs.coingecko.com/reference/global-market-cap-chart
reference/api-reference/coingecko-pro.json get /global/market_cap_chart
This endpoint allows you to **query historical global market cap and volume data by number of days away from now**
### Note
* CoinGecko equivalent page: [https://www.coingecko.com/en/global-charts](https://www.coingecko.com/en/global-charts).
* Data Granularity (auto):
* 1 day from now = **hourly** data
* 2 days & above from now = **daily** data
* Exclusive for all Paid Plan Subscribers (Analyst, Lite, Pro and Enterprise).
* The last completed UTC day (00:00) is available 5 minutes after midnight on the next UTC day (00:05). The cache will **always expire at 00:05 UTC**. If you wish to get the latest daily data (00:00 UTC), you can make request at 00:05 UTC or later.
* Cache / Update Frequency: every 1 minute.
# New Pools List
Source: https://docs.coingecko.com/reference/latest-pools-list
reference/api-reference/onchain-pro.json get /networks/new_pools
This endpoint allows you to **query all the latest pools across all networks on GeckoTerminal**
### Tips
* You may include values such as `page` to specify which page of responses you would like to show.
### Note
* If the token's market cap is not verified by the team, the API response will return `null` for its market cap value, even though it has a displayed value on GeckoTerminal, which might not be accurate as it often matches the Fully Diluted Valuation (FDV).
* Attributes specified in the `include` param will be returned under the top-level "included" key.
* This endpoint returns up to 20 pools per page. Use the `page` param to navigate more results.
* `page`: Pagination beyond 10 pages is available for [Paid Plan](https://www.coingecko.com/en/api/pricing) subscribers (Analyst plan or above).
* Cache/Update frequency: every 30 seconds.
* GeckoTerminal equivalent page (example): [https://www.geckoterminal.com/explore/new-crypto-pools](https://www.geckoterminal.com/explore/new-crypto-pools)
# New Pools by Network
Source: https://docs.coingecko.com/reference/latest-pools-network
reference/api-reference/onchain-pro.json get /networks/{network}/new_pools
This endpoint allows you to **query all the latest pools based on provided network**
### Tips
* You may include values such as `page` to specify which page of responses you would like to show.
### Note
* This endpoint includes the newly created pools in the past 48 hours.
* If the token's market cap is not verified by the team, the API response will return `null` for its market cap value, even though it has a displayed value on GeckoTerminal, which might not be accurate as it often matches the Fully Diluted Valuation (FDV).
* Attributes specified in the `include` param will be returned under the top-level "included" key.
* This endpoint returns up to 20 pools per page. Use the `page` param to navigate more results.
* `page`: Pagination beyond 10 pages is available for [Paid Plan](https://www.coingecko.com/en/api/pricing) subscribers (Analyst plan or above).
* Cache/Update frequency: every 30 seconds.
* GeckoTerminal equivalent page (example): [https://www.geckoterminal.com/explore/new-crypto-pools/solana](https://www.geckoterminal.com/explore/new-crypto-pools/solana)
# Supported Networks List (ID Map)
Source: https://docs.coingecko.com/reference/networks-list
reference/api-reference/onchain-pro.json get /networks
This endpoint allows you to **query all the supported networks on GeckoTerminal**
### Tips
* You may use this endpoint to query the list of networks with network ID for other endpoints that contain params like `network`.
* You may include values such as `page` to specify which page of responses you would like to show.
# NFTs Collection Data by Contract Address
Source: https://docs.coingecko.com/reference/nfts-contract-address
reference/api-reference/coingecko-pro.json get /nfts/{asset_platform_id}/contract/{contract_address}
This endpoint allows you to **query all the NFT data (name, floor price, 24hr volume ...) based on the NFT collection contract address and respective asset platform**
### Tips
* You may also obtain the asset platform ID and contract address through [/nfts/list](/reference/nfts-list) endpoint.
### Note
* Solana NFT & Art Blocks are not supported for this endpoint, please use [/nfts/\{id}](/reference/nfts-id) endpoint instead.
* Cache / Update Frequency: every 60 seconds for all the API plans.
# ๐ผ NFTs Collection Historical Chart Data by Contract Address
Source: https://docs.coingecko.com/reference/nfts-contract-address-market-chart
reference/api-reference/coingecko-pro.json get /nfts/{asset_platform_id}/contract/{contract_address}/market_chart
This endpoint allows you **query historical market data of a NFT collection, including floor price, market cap, and 24hr volume, by number of days away from now based on the provided contract address**
### Note
* This endpoint doesn't support Solana NFT and Art Blocks, please use [/nfts/\{id}/market\_chart](/reference/nfts-id-market-chart) endpoint instead.
* Data Granularity (auto):
* 1-14 days from now = **5-minutely** data
* 15 days & above from now = **daily** data (00:00 UTC)
* Cache/Update Frequency: every 5 minutes
* The last completed UTC day (00:00) is available 5 minutes after midnight on the next UTC day (00:05).
* Exclusive for Paid Plan Subscribers (Analyst, Lite, Pro and Enterprise).
# NFTs Collection Data by ID
Source: https://docs.coingecko.com/reference/nfts-id
reference/api-reference/coingecko-pro.json get /nfts/{id}
This endpoint allows you to **query all the NFT data (name, floor price, 24hr volume ...) based on the NFT collection ID**
### Note
* Cache / Update Frequency: every 60 seconds for all the API plans.
# ๐ผ NFTs Collection Historical Chart Data by ID
Source: https://docs.coingecko.com/reference/nfts-id-market-chart
reference/api-reference/coingecko-pro.json get /nfts/{id}/market_chart
This endpoint allows you **query historical market data of a NFT collection, including floor price, market cap, and 24hr volume, by number of days away from now**
### Note
* Data Granularity (auto):
* 1-14 days from now = **5-minutely** data
* 15 days & above from now = **daily** data (00:00 UTC)
* Cache/Update Frequency: every 5 minutes
* The last completed UTC day (00:00) is available 5 minutes after midnight on the next UTC day (00:05).
* Exclusive for Paid Plan Subscribers (Analyst, Lite, Pro and Enterprise).
# ๐ผ NFTs Collection Tickers by ID
Source: https://docs.coingecko.com/reference/nfts-id-tickers
reference/api-reference/coingecko-pro.json get /nfts/{id}/tickers
This endpoint allows you to **query the latest floor price and 24hr volume of a NFT collection, on each NFT marketplace, e.g. OpenSea and LooksRare**
### Note
* Cache/Update Frequency: every 30 seconds.
* Exclusive for Paid Plan Subscribers (Analyst, Lite, Pro and Enterprise).
# NFTs List (ID Map)
Source: https://docs.coingecko.com/reference/nfts-list
reference/api-reference/coingecko-pro.json get /nfts/list
This endpoint allows you to **query all supported NFTs with ID, contract address, name, asset platform ID and symbol on CoinGecko**
### Tips
* You may use this endpoint to query the list of nfts for other endpoints that contain params like `id` (NFT collection's ID) as well as `asset_platform_id` and `contract_address`.
* You may include values such as `per_page` and `page` to specify how many results you would like to show in the responses per page and which page of responses you would like to show.
### Note
* The responses are paginated to 100 items.
* Cache / Update Frequency: every 5 minutes for all the API plans.
# ๐ผ NFTs List with Market Data
Source: https://docs.coingecko.com/reference/nfts-markets
reference/api-reference/coingecko-pro.json get /nfts/markets
This endpoint allows you to **query all the supported NFT collections with floor price, market cap, volume and market related data on CoinGecko**
### Tips
* You may include values such as `per_page` and `page` to specify how many results you would like to show in the responses per page and which page of responses you would like to show.
### Note
* Cache / Update Frequency: every 5 minutes.
* Exclusive for Paid Plan Subscribers (Analyst, Lite, Pro and Enterprise).
* CoinGecko equivalent page: [https://www.coingecko.com/en/nft](https://www.coingecko.com/en/nft).
* Some collection with low liquidity may not be ranked by Market Cap value, learn more [here](https://support.coingecko.com/hc/en-us/articles/37226121227545-What-is-NFT-Market-Cap). Sorting by Mcap ranking will first prioritise Market Cap value of liquid NFT collections, then followed by trading volume of illiquid NFT collections.
# Token Price by Token Addresses
Source: https://docs.coingecko.com/reference/onchain-simple-price
reference/api-reference/onchain-pro.json get /simple/networks/{network}/token_price/{addresses}
This endpoint allows you to **get token price based on the provided token contract address on a network**
### Note
* If the token's market cap is not verified by the team, the API response will return `null` for its market cap value, even though it has a displayed value on GeckoTerminal, which might not be accurate as it often matches the Fully Diluted Valuation (FDV).
* If you require `market_cap_usd` to return FDV value (as seen in [GeckoTerminal.com](https://www.geckoterminal.com/)) when market cap data is unavailable, please specify this parameter `mcap_fdv_fallback=true`.
* The returned price currency is in USD.
* Addresses not found in GeckoTerminal will be ignored.
* This endpoint allows querying **up to 100 contract addresses** per request. This limit is exclusive for [paid plan](https://www.coingecko.com/en/api/pricing) subscribers (Analyst plan & above).
* When using this endpoint, GeckoTerminal's routing decides the best pool for token price. The price source may change based on liquidity and pool activity. For full control over the price, you may use [`/networks/{network}/pools/{address}`](/reference/pool-address) endpoint by providing a specific pool address.
* Cache/Update Frequency: every 30 seconds for Pro API (Analyst, Lite, Pro, Enterprise).
# Check API server status
Source: https://docs.coingecko.com/reference/ping-server
reference/api-reference/coingecko-pro.json get /ping
This endpoint allows you to **check the API server status**
### Note
* You can also go to [status.coingecko.com](https://status.coingecko.com/) to check the API server status and further maintenance notices.
# Specific Pool Data by Pool Address
Source: https://docs.coingecko.com/reference/pool-address
reference/api-reference/onchain-pro.json get /networks/{network}/pools/{address}
This endpoint allows you to **query the specific pool based on the provided network and pool address**
### Note
* Address not found in GeckoTerminal will be ignored.
* If the token's market cap is not verified by the team, the API response will return `null` for its market cap value, even though it has a displayed value on GeckoTerminal, which might not be accurate as it often matches the Fully Diluted Valuation (FDV).
* Market Cap can be verified by and sourced from CoinGecko, and the number may be higher than FDV as it may include Market Cap of tokens issued on other blockchain network.
* Attributes specified in the `include` param will be returned under the top-level "included" key.
* `locked_liquidity_percentage` will be updated on daily basis.
* Cache/Update Frequency: every 30 seconds for Pro API (Analyst, Lite, Pro, Enterprise).
# Pool OHLCV chart by Pool Address
Source: https://docs.coingecko.com/reference/pool-ohlcv-contract-address
reference/api-reference/onchain-pro.json get /networks/{network}/pools/{pool_address}/ohlcv/{timeframe}
This endpoint allows you to **get the OHLCV chart (Open, High, Low, Close, Volume) of a pool based on the provided pool address on a network**
### Tips
* You may use this endpoint to query the historical price and volume of a token.
* You may select the timeframe with its respective aggregate to get the intended OHLCV data (e.g. `minute?aggregate=15` for 15 minutes OHLCV).
### Note
* This endpoint uses epoch/unix format for its timestamp. Example: `1708850449`.
* [Paid plan](https://www.coingecko.com/en/api/pricing) subscribers (Analyst plan & above) can access data from **September 2021 to the present**, depending on when the pool started tracking on GeckoTerminal.
* If no earlier data is available, an empty response will be returned.
* Each API call can only retrieve data for a **maximum range of 6 months**. To fetch older data, use the `before_timestamp` parameter to query in multiple requests.
* Pools with more than 2 tokens are not yet supported for this endpoint.
* Each OHLCV array (under "ohlcv\_list") consists of 6 elements in the following order:
* Timestamp: The epoch/unix timestamp representing the start of the time interval.
* Open: The opening price of the asset at the beginning of the interval.
* High: The highest price reached during the interval.
* Low: The lowest price reached during the interval.
* Close: The price of the asset at the end of the interval.
* Volume: The total trading volume of the asset during the interval.
* **Skipped Intervals**: To ensure concise and relevant data, specific timeframe intervals (e.g. minutely) with no recorded swaps are **excluded** from the response.
* Higher granularity timeframes (e.g. 1 minute) are more likely to skip intervals due to periods of inactivity, while lower granularity timeframes (e.g. daily) are less affected.
* For `include_empty_intervals` param:
* When `false` (default): Only intervals with trade data are returned.
* When `true`: All requested intervals are returned, those with no trade data are populated as follows:
* OHLC (Open, High, Low, Close) are all set to the Close price of the previous interval.
* *O = H = L = C = previous Close*
* Volume (V) is set to 0, reflecting no trade activity.
* Cache/Update frequency: every 30 seconds.
# Pool Tokens Info by Pool Address
Source: https://docs.coingecko.com/reference/pool-token-info-contract-address
reference/api-reference/onchain-pro.json get /networks/{network}/pools/{pool_address}/info
This endpoint allows you to **query pool metadata (base and quote token details, image, socials, websites, description, contract address, etc.) based on a provided pool contract address on a network**
### Tips
* If you would like to query pool data such as price, transactions, volume and etc. You can go to this endpoint [`/networks/{network}/pools/{address}`](/reference/pool-address) instead.
* Cache/Update frequency: every 60 seconds.
* Learn more about GT score [here](https://support.coingecko.com/hc/en-us/articles/38381394237593-What-is-GT-Score-How-is-GT-Score-calculated).
* Metadata (image, websites, description, socials) may be sourced on-chain and is not vetted by the CoinGecko team. If you wish to get metadata reviewed by CoinGecko team, you may use the following endpoints:
* [Coin Data by ID](/reference/coins-id)
* [Coin Data by Token Address](/reference/coins-contract-address)
### Note
* `holders` data is currently in Beta, with ongoing improvements to data quality, coverage, and update frequency.
* Supported chains include: Solana, EVM (Ethereum, Polygon, BNB, Arbitrum, Optimism, Base), Sui, TON, and Ronin.
* `distribution_percentage` coverage:
* Solana: `top_10`, `11_20`, `21_40`, `rest`
* Other chains: `top_10`, `11_30`, `31_50`, `rest`
# Past 24 Hour Trades by Pool Address
Source: https://docs.coingecko.com/reference/pool-trades-contract-address
reference/api-reference/onchain-pro.json get /networks/{network}/pools/{pool_address}/trades
This endpoint allows you to **query the last 300 trades in the past 24 hours based on the provided pool address**
### Note
* Cache/Update Frequency: every 30 seconds for Pro API (Analyst, Lite, Pro, Enterprise).
# Multiple Pools Data by Pool Addresses
Source: https://docs.coingecko.com/reference/pools-addresses
reference/api-reference/onchain-pro.json get /networks/{network}/pools/multi/{addresses}
This endpoint allows you to **query multiple pools based on the provided network and pool address**
### Note
* Addresses not found in GeckoTerminal will be ignored.
* If the token's market cap is not verified by the team, the API response will return `null` for its market cap value, even though it has a displayed value on GeckoTerminal, which might not be accurate as it often matches the Fully Diluted Valuation (FDV).
* This endpoint allows querying **up to 50 contract addresses** per request. This limit is exclusive for [paid plan](https://www.coingecko.com/en/api/pricing) subscribers (Analyst plan & above).
* Market Cap can be verified by and sourced from CoinGecko, and the number may be higher than FDV as it may include Market Cap of tokens issued on other blockchain network.
* Attributes specified in the `include ` params will be included under the "included" key at the top level.
* `locked_liquidity_percentage` will be updated on daily basis.
* Cache/Update Frequency: every 30 seconds for Pro API (Analyst, Lite, Pro, Enterprise).
# ๐ผ Pools by Category ID
Source: https://docs.coingecko.com/reference/pools-category
reference/api-reference/onchain-pro.json get /categories/{category_id}/pools
This endpoint allows you to **query all the pools based on the provided category ID**
### Tips
* You can retrieve full list of categories id via this endpoint: [Categories List](/reference/categories-list).
* You can retrieve tokens of a specific category, by flagging `include=base_token`.
* GeckoTerminal categories are different from [CoinGecko categories](/reference/coins-categories-list).
### Note
* This endpoint returns up to 20 pools per page. Use the `page` param to navigate more results.
* `page`: Pagination beyond 10 pages is available for [Paid Plan](https://www.coingecko.com/en/api/pricing) subscribers (Analyst plan or above).
* GeckoTerminal equivalent page example: [https://www.geckoterminal.com/category/pump-fun](https://www.geckoterminal.com/category/pump-fun)
* Cache/Update frequency: every 30 seconds.
* Exclusive for all Paid Plan Subscribers (Analyst, Lite, Pro and Enterprise).
# ๐ฅ Megafilter for Pools
Source: https://docs.coingecko.com/reference/pools-megafilter
reference/api-reference/onchain-pro.json get /pools/megafilter
This endpoint allows you to **query pools based on various filters across all networks on GeckoTerminal**
### Tips
* Using `checks` param to filter pools based on various checks:
* `checks=no_honeypot` โ Filter out Honeypot pools, using GoPlus Token Security and De.Fi Scanner.
* `checks=good_gt_score` โ Show only pools with a GT Score of at least 75.
* `checks=on_coingecko` โ Show only pools with tokens that are listed on CoinGecko.
* `checks=has_social` โ Show only pools with their social links and token information updated.
* You may include values such as `page` to specify which page of responses you would like to show.
### Note
* `dexes` param can only be used when **only 1`networks`** is specified.
* If the token's market cap is not verified by the team, the API response will return `null` for its market cap value, even though it has a displayed value on GeckoTerminal, which might not be accurate as it often matches the Fully Diluted Valuation (FDV).
* Attributes specified in the `include` param will be returned under the top-level "included" key.
* This endpoint returns up to 20 pools per page. Use the `page` param to navigate more results.
* Setting `include_unknown_honeypot_tokens=true` will include tokens with an 'unknown' honeypot status.
* Please note that this param only takes effect when `checks=no_honeypot` is specified.
* Cache/Update frequency: every 30 seconds.
* ๐ผ Exclusive for [Paid Plan](https://www.coingecko.com/en/api/pricing) subscribers (Analyst plan or above).
# Search Queries
Source: https://docs.coingecko.com/reference/search-data
reference/api-reference/coingecko-pro.json get /search
This endpoint allows you to **search for coins, categories and markets listed on CoinGecko**
### Note
* The responses are sorted in descending order by market cap.
* Cache / Update Frequency: every 15 minutes for all the API plans.
# Search Pools
Source: https://docs.coingecko.com/reference/search-pools
reference/api-reference/onchain-pro.json get /search/pools
This endpoint allows you to **search for pools on a network**
### Tips
* You may use this endpoint to search for query such as pool contract address, token contract address or token symbol. The endpoint will return matching pools as response.
* You may include values such as `page` to specify which page of responses you would like to show.
### Note
* If the token's market cap is not verified by the team, the API response will return `null` for its market cap value, even though it has a displayed value on GeckoTerminal, which might not be accurate as it often matches the Fully Diluted Valuation (FDV).
* Attributes specified in the `include` param will be returned under the top-level "included" key.
* This endpoint returns up to 20 pools per page. Use the `page` param to navigate more results.
* `page`: Pagination beyond 10 pages is available for [Paid Plan](https://www.coingecko.com/en/api/pricing) subscribers (Analyst plan or above).
* Cache/Update frequency: every 30 seconds.
# Coin Price by IDs
Source: https://docs.coingecko.com/reference/simple-price
reference/api-reference/coingecko-pro.json get /simple/price
This endpoint allows you to **query the prices of one or more coins by using their unique Coin API IDs**
### Tips
* You may obtain the coin ID (API ID) via several ways:
* refers to respective coin page and find 'API ID'.
* refers to [`/coins/list`](/reference/coins-list) endpoint.
* refers to Google Sheets [here](https://docs.google.com/spreadsheets/d/1wTTuxXt8n9q7C4NDXqQpI3wpKu1_5bGVmP9Xz0XGSyU/edit?usp=sharing).
* You can retrieve specific coins using their unique `ids`, `names`, or `symbols`.
* You may flag to include more data such as market cap, 24hr volume, 24hr change, last updated time etc.
* To verify if a price is stale, you may flag `include_last_updated_at=true` in your request to obtain the latest updated time. Alternatively, you may flag `include_24hr_change=true` to determine if it returns a `null` value.
### Note
* You may cross-check the price on [CoinGecko](https://www.coingecko.com) and learn more about our price methodology [here](https://www.coingecko.com/en/methodology).
* When multiple lookup params are provided, the following priority order is applied: `ids` (highest) > `names` > `symbols` (lowest).
* When searching by `name`, you need to URL-encode any spaces (e.g. "Binance Coin" becomes "Binance%20Coin").
* The `include_tokens=all` param is exclusively for use with the `symbols` lookup and is limited to maximum of 50 symbols per request.
* Wildcard searches are not supported for lookup params (`ids`, `names`, `symbols`).
* Cache/Update Frequency: every 20 seconds for Pro API (Analyst, Lite, Pro, Enterprise).
# Supported Currencies List
Source: https://docs.coingecko.com/reference/simple-supported-currencies
reference/api-reference/coingecko-pro.json get /simple/supported_vs_currencies
This endpoint allows you to **query all the supported currencies on CoinGecko**
### Tips
* You may use this endpoint to query the list of currencies for other endpoints that contain params like `vs_currencies`.
### Note
* Cache/Update Frequency: every 30 seconds for Pro API (Analyst, Lite, Pro, Enterprise).
# Coin Price by Token Addresses
Source: https://docs.coingecko.com/reference/simple-token-price
reference/api-reference/coingecko-pro.json get /simple/token_price/{id}
This endpoint allows you to **query one or more token prices using their token contract addresses**
### Tips
* You may obtain the asset platform and contract address via several ways:
* refers to respective coin page and find 'contract address'.
* refers to [`/coins/list`](/reference/coins-list) endpoint (`include platform = true`).
* You may flag to include more data such as market cap, 24hr volume, 24hr change, last updated time etc.
### Note
* The endpoint returns the global average price of the coin that is aggregated across all active exchanges on CoinGecko.
* You may cross-check the price on [CoinGecko](https://www.coingecko.com) and learn more about our price methodology [here](https://www.coingecko.com/en/methodology).
* Cache/Update Frequency: every 20 seconds for Pro API (Analyst, Lite, Pro, Enterprise).
# Token Data by Token Address
Source: https://docs.coingecko.com/reference/token-data-contract-address
reference/api-reference/onchain-pro.json get /networks/{network}/tokens/{address}
This endpoint allows you to **query specific token data based on the provided token contract address on a network**
### Tips
* You may add values such as `top_pools` in the include param to include top pools along with the pools information.
* If you would like to query token information such as socials, websites, description and etc. You can go to this endpoint [`/networks/{network}/tokens/{address}/info`](/reference/token-info-contract-address) instead.
### Note
* Address not found in GeckoTerminal.com will be ignored.
* The endpoint will only return the first top most liquid pool for each token. The top pool is determined through a combination of two key factors: liquidity (`reserve_in_usd`) and 24-Hour Trading Volume (`volume_usd`)
* If the token's market cap is not verified by the team, the API response will return `null` for its market cap value, even though it has a displayed value on GeckoTerminal, which might not be accurate as it often matches the Fully Diluted Valuation (FDV).
* Market Cap can be verified by and sourced from CoinGecko, and the number may be higher than FDV as it may include Market Cap of tokens issued on other blockchain network.
* Attributes specified in the `include` param will be returned under the top-level "included" key.
* Cache/Update frequency: every 30 seconds.
# ๐ผ Historical Token Holders Chart by Token Address
Source: https://docs.coingecko.com/reference/token-holders-chart-token-address
reference/api-reference/onchain-pro.json get /networks/{network}/tokens/{token_address}/holders_chart
This endpoint allows you to **get the historical token holders chart based on the provided token contract address on a network**
### Note
* The historical token holders chart data is currently in Beta, with ongoing improvements to data quality, coverage, and update frequency.
* Supported chains include: Solana, EVM (Ethereum, Polygon, BNB, Arbitrum, Optimism, Base), Sui, TON, and Ronin.
* `days` param provides the following automatic granularity:
* `days=7` = **all data** (without fixed intervals)
* `days=30` = **daily data** (30 daily intervals)
* `days=max` = **weekly data**
* ๐ผ Exclusive for Paid Plan subscribers (Analyst plan or above).
* Cache/Update frequency: every 60 seconds.
# Token Info by Token Address
Source: https://docs.coingecko.com/reference/token-info-contract-address
reference/api-reference/onchain-pro.json get /networks/{network}/tokens/{address}/info
This endpoint allows you to **query token metadata (name, symbol, CoinGecko ID, image, socials, websites, description, etc.) based on a provided token contract address on a network**
### Tips
* If you would like to query token data such as decimals, total supply, price and etc. You can go to this endpoint [`/networks/{network}/tokens/{address}`](/reference/token-data-contract-address) instead.
* Cache/Update frequency: every 60 seconds.
* Learn more about GT score [here](https://support.coingecko.com/hc/en-us/articles/38381394237593-What-is-GT-Score-How-is-GT-Score-calculated).
* Metadata (image, websites, description, socials) may be sourced on-chain and is not vetted by the CoinGecko team. If you wish to get metadata reviewed by CoinGecko team, you may use the following endpoints:
* [Coin Data by ID](/reference/coins-id)
* [Coin Data by Token Address](/reference/coins-contract-address)
### Note
* `holders` data is currently in Beta, with ongoing improvements to data quality, coverage, and update frequency.
* Supported chains include: Solana, EVM (Ethereum, Polygon, BNB, Arbitrum, Optimism, Base), Sui, TON, and Ronin.
* `distribution_percentage` coverage:
* Solana: `top_10`, `11_20`, `21_40`, `rest`
* Other chains: `top_10`, `11_30`, `31_50`, `rest`
# Token Lists by Asset Platform ID
Source: https://docs.coingecko.com/reference/token-lists
reference/api-reference/coingecko-pro.json get /token_lists/{asset_platform_id}/all.json
This endpoint allows you to **get full list of tokens of a blockchain network (asset platform) that is supported by [Ethereum token list standard](https://tokenlists.org/)**
### Note
* Cache/Update Frequency: 5 minutes.
* A token will only be included in the list if the contract address is added by CoinGecko team. If you identified any missing token, you may submit a request [here](https://support.coingecko.com/hc/en-us/requests/new).
# ๐ผ Token OHLCV chart by Token Address
Source: https://docs.coingecko.com/reference/token-ohlcv-token-address
reference/api-reference/onchain-pro.json get /networks/{network}/tokens/{token_address}/ohlcv/{timeframe}
This endpoint allows you to **get the OHLCV chart (Open, High, Low, Close, Volume) of a token based on the provided token address on a network**
### Note
* This endpoint will return OHLCV data of the **most liquid pool** of the specified token. You may use this endpoint [Top Pools by Token Address](https://docs.coingecko.com/update/reference/top-pools-contract-address#/) to check the top pools of a token.
* This endpoint uses epoch/unix format for its timestamp. Example: `1708850449`.
* [Paid plan](https://www.coingecko.com/en/api/pricing) subscribers (Analyst plan & above) can access data from **September 2021 to the present**, depending on when the pool started tracking on GeckoTerminal.
* If no earlier data is available, an empty response will be returned.
* Each API call can only retrieve data for a **maximum range of 6 months**. To fetch older data, use the `before_timestamp` parameter to query in multiple requests.
* Pools with more than 2 tokens are not yet supported for this endpoint.
* Each OHLCV array (under "ohlcv\_list") consists of 6 elements in the following order:
* Timestamp: The epoch/unix timestamp representing the start of the time interval.
* Open: The opening price of the asset at the beginning of the interval.
* High: The highest price reached during the interval.
* Low: The lowest price reached during the interval.
* Close: The price of the asset at the end of the interval.
* Volume: The total trading volume of the asset during the interval.
* **Skipped Intervals**: To ensure concise and relevant data, specific timeframe intervals (e.g. minutely) with no recorded swaps are **excluded** from the response.
* Higher granularity timeframes (e.g. 1 minute) are more likely to skip intervals due to periods of inactivity, while lower granularity timeframes (e.g. daily) are less affected.
* For `include_empty_intervals` param:
* When `false` (default): Only intervals with trade data are returned.
* When `true`: All requested intervals are returned, those with no trade data are populated as follows:
* OHLC (Open, High, Low, Close) are all set to the Close price of the previous interval.
* *O = H = L = C = previous Close*
* Volume (V) is set to 0, reflecting no trade activity.
* Cache/Update frequency: every 30 seconds.
# ๐ผ Past 24 Hour Trades by Token Address
Source: https://docs.coingecko.com/reference/token-trades-contract-address
reference/api-reference/onchain-pro.json get /networks/{network}/tokens/{token_address}/trades
This endpoint allows you to **query the last 300 trades in the past 24 hours, across all pools, based on the provided token contract address on a network**
### Note
* Exclusive for all [Paid Plan](https://www.coingecko.com/en/api/pricing) Subscribers (Analyst, Lite, Pro and Enterprise).
* Cache/Update Frequency: every 30 seconds for Pro API (Analyst, Lite, Pro, Enterprise).
# Tokens Data by Token Addresses
Source: https://docs.coingecko.com/reference/tokens-data-contract-addresses
reference/api-reference/onchain-pro.json get /networks/{network}/tokens/multi/{addresses}
This endpoint allows you to **query multiple tokens data based on the provided token contract addresses on a network**
### Tips
* You may add values such as `top_pools` in the include param to include top pools along with the pools information.
* If you would like to query token information such as socials, websites, description and etc. You can go to this endpoint [`/networks/{network}/tokens/{address}/info`](/reference/token-info-contract-address) instead.
### Note
* Addresses not found in GeckoTerminal.com will be ignored.
* This endpoint allows querying **up to 50 contract addresses** per request. This limit is exclusive for [paid plan](https://www.coingecko.com/en/api/pricing) subscribers (Analyst plan & above).
* The endpoint will only return the first top most liquid pool for each token. The top pool is determined through a combination of two key factors: liquidity (`reserve_in_usd`) and 24-Hour Trading Volume (`volume_usd`).
* If the token's market cap is not verified by the team, the API response will return `null` for its market cap value, even though it has a displayed value on GeckoTerminal, which might not be accurate as it often matches the Fully Diluted Valuation (FDV).
* Market Cap can be verified by and sourced from CoinGecko, and the number may be higher than FDV as it may include Market Cap of tokens issued on other blockchain network.
* Attributes specified in the `include` param will be returned under the top-level "included" key.
* Cache/Update frequency: every 30 seconds.
# Most Recently Updated Tokens List
Source: https://docs.coingecko.com/reference/tokens-info-recent-updated
reference/api-reference/onchain-pro.json get /tokens/info_recently_updated
This endpoint allows you to **query 100 most recently updated tokens info of a specific network or across all networks on GeckoTerminal**
### Tips
* You may add values such as network in the include param to include network along with the updated tokens list.
### Note
* Attributes specified in the `include` param will be returned under the top-level "included" key.
* Cache/Update frequency: every 30 seconds.
# Top Pools by Token Address
Source: https://docs.coingecko.com/reference/top-pools-contract-address
reference/api-reference/onchain-pro.json get /networks/{network}/tokens/{token_address}/pools
This endpoint allows you to **query top pools based on the provided token contract address on a network**
### Tips
* You may include values such as `page` to specify which page of responses you would like to show.
### Note
* The ranking of the top 20 pools is established by evaluating their liquidity and trading activity to identify the most liquid ones. This ranking is determined through a combination of two key factors: liquidity (`reserve_in_usd`) and 24-Hour Trading Volume (`volume_usd`).
* If the token's market cap is not verified by the team, the API response will return `null` for its market cap value, even though it has a displayed value on GeckoTerminal, which might not be accurate as it often matches the Fully Diluted Valuation (FDV).
* Attributes specified in the `include` param will be returned under the top-level "included" key.
* This endpoint returns up to 20 pools per page. Use the `page` param to navigate more results.
* `page`: Pagination beyond 10 pages is available for [Paid Plan](https://www.coingecko.com/en/api/pricing) subscribers (Analyst plan or above).
* Cache/Update frequency: every 30 seconds.
# Top Pools by Dex
Source: https://docs.coingecko.com/reference/top-pools-dex
reference/api-reference/onchain-pro.json get /networks/{network}/dexes/{dex}/pools
This endpoint allows you to **query all the top pools based on the provided network and decentralized exchange (DEX)**
### Tips
* You may include values such as `page` to specify which page of responses you would like to show.
* For more flexibility in retrieving an exact list of pools that match your specific needs, consider using the [/pools/megafilter](/reference/pools-megafilter) endpoint.
### Note
* If the token's market cap is not verified by the team, the API response will return `null` for its market cap value, even though it has a displayed value on GeckoTerminal, which might not be accurate as it often matches the Fully Diluted Valuation (FDV).
* Attributes specified in the `include` param will be returned under the top-level "included" key.
* This endpoint returns up to 20 pools per page. Use the `page` param to navigate more results.
* `page`: Pagination beyond 10 pages is available for [Paid Plan](https://www.coingecko.com/en/api/pricing) subscribers (Analyst plan or above).
* Cache/Update frequency: every 30 seconds.
* GeckoTerminal equivalent page (example): [https://www.geckoterminal.com/base/uniswap-v3-base/pools?sort=-24h\_transactions](https://www.geckoterminal.com/base/uniswap-v3-base/pools?sort=-24h_transactions)
# Top Pools by Network
Source: https://docs.coingecko.com/reference/top-pools-network
reference/api-reference/onchain-pro.json get /networks/{network}/pools
This endpoint allows you to **query all the top pools based on the provided network**
### Tips
* You may include values such as `page` to specify which page of responses you would like to show.
* For more flexibility in retrieving an exact list of pools that match your specific needs, consider using the [/pools/megafilter](/reference/pools-megafilter) endpoint.
### Note
* If the token's market cap is not verified by the team, the API response will return `null` for its market cap value, even though it has a displayed value on GeckoTerminal, which might not be accurate as it often matches the Fully Diluted Valuation (FDV).
* Attributes specified in the `include` param will be returned under the top-level "included" key.
* This endpoint returns up to 20 pools per page. Use the `page` param to navigate more results.
* `page`: Pagination beyond 10 pages is available for [Paid Plan](https://www.coingecko.com/en/api/pricing) subscribers (Analyst plan or above).
* Cache/Update frequency: every 30 seconds.
* GeckoTerminal equivalent page (example): [https://www.geckoterminal.com/solana/pools?sort=-24h\_transactions](https://www.geckoterminal.com/solana/pools?sort=-24h_transactions)
# ๐ผ Top Token Holders by Token Address
Source: https://docs.coingecko.com/reference/top-token-holders-token-address
reference/api-reference/onchain-pro.json get /networks/{network}/tokens/{address}/top_holders
This endpoint allows you to **query top token holders based on the provided token contract address on a network**
### Note
* The top holders data is currently in **Beta**, with ongoing improvements to data quality, coverage, and update frequency.
* **Supported chains include**: Solana, EVM (Ethereum, Polygon, BNB, Arbitrum, Optimism, Base), Sui, TON, and Ronin.
* Max `holders` value:
* Maximum 50 for non-Solana networks, 40 for Solana network.
* ๐ผ Exclusive for [Paid Plan](https://www.coingecko.com/en/api/pricing) subscribers (Analyst plan or above).
* Cache/Update frequency: every 60 seconds.
# Trending Pools List
Source: https://docs.coingecko.com/reference/trending-pools-list
reference/api-reference/onchain-pro.json get /networks/trending_pools
This endpoint allows you to **query all the trending pools across all networks on GeckoTerminal**
### Tips
* You may include values such as `page` to specify which page of responses you would like to show.
* For more flexibility in retrieving an exact list of pools that match your specific needs, consider using the [/pools/megafilter](/reference/pools-megafilter) endpoint.
### Note
* Trending rankings are determined by a combination of factors:
* User engagement on geckoterminal.com
* Market activity, such as trading volume and transactions
* Pool security and credibility, including liquidity and honeypot checks
* If the token's market cap is not verified by the team, the API response will return `null` for its market cap value, even though it has a displayed value on GeckoTerminal, which might not be accurate as it often matches the Fully Diluted Valuation (FDV).
* Attributes specified in the `include` param will be returned under the top-level "included" key.
* This endpoint returns up to 20 pools per page. Use the `page` param to navigate more results.
* `page`: Pagination beyond 10 pages is available for [Paid Plan](https://www.coingecko.com/en/api/pricing) subscribers (Analyst plan or above).
* Cache/Update frequency: every 30 seconds.
* GeckoTerminal equivalent page (example): [https://www.geckoterminal.com](https://www.geckoterminal.com)
# Trending Pools by Network
Source: https://docs.coingecko.com/reference/trending-pools-network
reference/api-reference/onchain-pro.json get /networks/{network}/trending_pools
This endpoint allows you to **query the trending pools based on the provided network**
### Tips
* You may include values such as `page` to specify which page of responses you would like to show.
* For more flexibility in retrieving an exact list of pools that match your specific needs, consider using the [/pools/megafilter](/reference/pools-megafilter) endpoint.
### Note
* Trending rankings are determined by a combination of factors:
* User engagement on geckoterminal.com
* Market activity, such as trading volume and transactions
* Pool security and credibility, including liquidity and honeypot checks
* If the token's market cap is not verified by the team, the API response will return `null` for its market cap value, even though it has a displayed value on GeckoTerminal, which might not be accurate as it often matches the Fully Diluted Valuation (FDV).
* Attributes specified in the `include` param will be returned under the top-level "included" key.
* This endpoint returns up to 20 pools per page. Use the `page` param to navigate more results.
* `page`: Pagination beyond 10 pages is available for [Paid Plan](https://www.coingecko.com/en/api/pricing) subscribers (Analyst plan or above).
* Cache/Update frequency: every 30 seconds.
* GeckoTerminal equivalent page (example): [https://www.geckoterminal.com/base/pools](https://www.geckoterminal.com/base/pools)
# Trending Search List
Source: https://docs.coingecko.com/reference/trending-search
reference/api-reference/coingecko-pro.json get /search/trending
This endpoint allows you **query trending search coins, NFTs and categories on CoinGecko in the last 24 hours**
### Note
* The endpoint currently supports:
* Top 15 trending coins (sorted by the most popular user searches).
* Top 7 trending NFTs (sorted by the highest percentage change in floor prices).
* Top 6 trending categories (sorted by the most popular user searches).
* [Paid plan](https://www.coingecko.com/en/api/pricing) subscribers (Analyst plan & above) can use `show_max` param to retrieve maximum 30 coins, 10 NFTs, and 10 categories.
* Cache / Update Frequency: every 10 minutes for all the API plans.
# ๐ผ Trending Search Pools
Source: https://docs.coingecko.com/reference/trending-search-pools
reference/api-reference/onchain-pro.json get /pools/trending_search
This endpoint allows you to **query all the trending search pools across all networks on GeckoTerminal**
### Note
* If the token's market cap is not verified by the team, the API response will return `null` for its market cap value, even though it has a displayed value on GeckoTerminal, which might not be accurate as it often matches the Fully Diluted Valuation (FDV).
* Attributes specified in the `include` param will be returned under the top-level "included" key.
* Cache/Update frequency: every 60 seconds.
* ๐ผ Exclusive for [Paid Plan](https://www.coingecko.com/en/api/pricing) subscribers (Analyst plan or above).
# Asset Platforms List (ID Map)
Source: https://docs.coingecko.com/v3.0.1/reference/asset-platforms-list
v3.0.1/reference/api-reference/coingecko-demo.json get /asset_platforms
This endpoint allows you to **query all the asset platforms on CoinGecko**
### Tips
* You may use this endpoint to query the list of asset platforms for other endpoints that contain params like `id` or`ids`(asset platforms).
* You may include NFT at the `filter` params to get the list of NFT-support asset platforms on CoinGecko.
# Authentication (Public/Demo)
Source: https://docs.coingecko.com/v3.0.1/reference/authentication
Authentication method for CoinGecko Public API (Demo plan users)
### **Notes**
* Demo API Key is only available for CoinGecko Public Demo API Plan, the root URL for CoinGecko Public Demo API must be `https://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.
* The authentication method below is for CoinGecko Public Demo API only. For **paid plan users with Pro-API key**, please refer to [this page](/v3.0.1/reference/authentication) instead.
* User Guide: [How to sign up for CoinGecko Demo API and generate an API key?](https://support.coingecko.com/hc/en-us/articles/21880397454233)
* It's highly recommended to use the **Headers method** when making API requests for better security. Using query string parameters can risk exposing your API key.
## CoinGecko API Authentication Method
If this is your first time using the Demo API key, you can supply API Key to the root URL using one of these ways:
1. Header (Recommended): `x-cg-demo-api-key`
2. Query String Parameter: `x_cg_demo_api_key`
| Authentication Method | Example using [Ping](/v3.0.1/reference/ping-server) Endpoint |
| ---------------------- | ------------------------------------------------------------------------------------------ |
| Header (cURL) | `curl -X GET "https://api.coingecko.com/api/v3/ping" -H "x-cg-demo-api-key: YOUR_API_KEY"` |
| Query String Parameter | `https://api.coingecko.com/api/v3/ping?x_cg_demo_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](https://www.coingecko.com/en/api/pricing).
* To check the API usage, please go to the [developer dashboard](https://www.coingecko.com/en/developers/dashboard) or follow the guide [here](/v3.0.1/reference/setting-up-your-api-key#4-api-usage-report).
# Coins Categories List with Market Data
Source: https://docs.coingecko.com/v3.0.1/reference/coins-categories
v3.0.1/reference/api-reference/coingecko-demo.json get /coins/categories
This endpoint allows you to **query all the coins categories with market data (market cap, volume, ...) on CoinGecko**
### Note
* CoinGecko Equivalent Page: [https://www.coingecko.com/en/categories](https://www.coingecko.com/en/categories)
* Cache / Update Frequency: every 5 minutes for all the API plans.
# Coins Categories List (ID Map)
Source: https://docs.coingecko.com/v3.0.1/reference/coins-categories-list
v3.0.1/reference/api-reference/coingecko-demo.json get /coins/categories/list
This endpoint allows you to **query all the coins categories on CoinGecko**
### Tips
* You may use this endpoint to query the list of categories for other endpoints that contain params like `category`.
### Note
* CoinGecko Equivalent Page: [https://www.coingecko.com/en/categories](https://www.coingecko.com/en/categories)
* Cache / Update Frequency: every 5 minutes for all the API plans.
# Coin Data by Token Address
Source: https://docs.coingecko.com/v3.0.1/reference/coins-contract-address
v3.0.1/reference/api-reference/coingecko-demo.json get /coins/{id}/contract/{contract_address}
This endpoint allows you to **query all the metadata (image, websites, socials, description, contract address, etc.) and market data (price, ATH, exchange tickers, etc.) of a coin from the CoinGecko coin page based on an asset platform and a particular token contract address**
### Notice
* Please note that the `twitter_followers` data field will no longer be supported by our API starting on May 15, 2025. Please refer to [changelog](https://docs.coingecko.com/changelog/upcoming-change-notice-removal-of-twitter_followers-data) for more details.
### Tips
* You may obtain the asset platform and contract address via several ways:
* refers to respective coin page and find 'contract address'.
* refers to [`/coins/list`](/v3.0.1/reference/coins-list) endpoint (`include platform = true`).
### Note
* Coin descriptions may include newline characters represented as `\r\n` (escape sequences), which may require processing for proper formatting.
* Cache / Update Frequency: every 60 seconds for all the API plans.
# Coin Data by ID
Source: https://docs.coingecko.com/v3.0.1/reference/coins-id
v3.0.1/reference/api-reference/coingecko-demo.json get /coins/{id}
This endpoint allows you to **query all the metadata (image, websites, socials, description, contract address, etc.) and market data (price, ATH, exchange tickers, etc.) of a coin from the CoinGecko coin page based on a particular coin ID**
### Notice
* Please note that the `twitter_followers` data field will no longer be supported by our API starting on May 15, 2025. Please refer to [changelog](https://docs.coingecko.com/changelog/upcoming-change-notice-removal-of-twitter_followers-data) for more details.
### Tips
* You may obtain the coin `id` (API ID) via several ways:
* refers to respective coin page and find "API ID".
* refers to [`/coins/list`](/v3.0.1/reference/coins-list) endpoint.
* refers to Google Sheets [here](https://docs.google.com/spreadsheets/d/1wTTuxXt8n9q7C4NDXqQpI3wpKu1_5bGVmP9Xz0XGSyU/edit?usp=sharing).
* You may also flag to include more data such as tickers, market data, community data, developer data and sparkline.
* You may refer to `last_updated` in the endpoint response to check whether the price is stale.
### Note
* Tickers are limited to 100 items, to get more tickers, please go to [/coins/\{id}/tickers](/v3.0.1/reference/coins-id-tickers).
* Coin descriptions may include newline characters represented as `\r\n` (escape sequences), which may require processing for proper formatting.
* When `dex_pair_format=symbol`, the DEX pair `base` and `target` are displayed in symbol format (e.g. `WETH`, `USDC`) instead of as contract addresses.
* Cache/Update Frequency:
* Every 60 seconds for all the API plans.
* Community data for Telegram will be updated on weekly basis (Reddit & Twitter community data are no longer supported).
# Coin Historical Data by ID
Source: https://docs.coingecko.com/v3.0.1/reference/coins-id-history
v3.0.1/reference/api-reference/coingecko-demo.json get /coins/{id}/history
This endpoint allows you to **query the historical data (price, market cap, 24hrs volume, ...) at a given date for a coin based on a particular coin ID**
### Notice
* Please note that the `twitter_followers` data field will no longer be supported by our API starting on May 15, 2025. Please refer to [changelog](https://docs.coingecko.com/changelog/upcoming-change-notice-removal-of-twitter_followers-data) for more details.
### Tips
* You may obtain the coin ID (API ID) via several ways:
* refers to respective coin page and find 'API ID'.
* refers to [`/coins/list`](/v3.0.1/reference/coins-list) endpoint.
* refers to Google Sheets [here](https://docs.google.com/spreadsheets/d/1wTTuxXt8n9q7C4NDXqQpI3wpKu1_5bGVmP9Xz0XGSyU/edit?usp=sharing).
### Note
* The data returned is at `00:00:00 UTC`.
* The last completed UTC day (00:00) is available 35 minutes after midnight on the next UTC day (00:35).
* Access to historical data via the Public API (Demo plan) is **restricted to the past 365 days** only. To access the complete range of historical data, please subscribe to one of our [paid plans](https://www.coingecko.com/en/api/pricing) to obtain a Pro-API key.
# Coin Historical Chart Data by ID
Source: https://docs.coingecko.com/v3.0.1/reference/coins-id-market-chart
v3.0.1/reference/api-reference/coingecko-demo.json get /coins/{id}/market_chart
This endpoint allows you to **get the historical chart data of a coin including time in UNIX, price, market cap and 24hr volume based on particular coin ID**
### Tips
* You may obtain the coin ID (API ID) via several ways:
* refers to respective coin page and find 'API ID'.
* refers to [`/coins/list`](/v3.0.1/reference/coins-list) endpoint.
* refers to google sheets [here](https://docs.google.com/spreadsheets/d/1wTTuxXt8n9q7C4NDXqQpI3wpKu1_5bGVmP9Xz0XGSyU/edit?usp=sharing).
* You may use tools like [epoch converter ](https://www.epochconverter.com) to convert human readable date to UNIX timestamp.
### Note
* You may leave the interval as empty for automatic granularity:
* 1 day from current time = **5-minutely** data
* 2 - 90 days from current time = **hourly** data
* above 90 days from current time = **daily** data (00:00 UTC)
* Cache / Update Frequency:
* Every 30 seconds for all the API plans (for last data point).
* The last completed UTC day (00:00) data is now available **10 minutes after midnight** on the next UTC day (00:10).
* Access to historical data via the Public API (Demo plan) is **restricted to the past 365 days** only. To access the complete range of historical data, please subscribe to one of our [paid plans](https://www.coingecko.com/en/api/pricing) to obtain a Pro-API key.
# Coin Historical Chart Data within Time Range by ID
Source: https://docs.coingecko.com/v3.0.1/reference/coins-id-market-chart-range
v3.0.1/reference/api-reference/coingecko-demo.json get /coins/{id}/market_chart/range
This endpoint allows you to **get the historical chart data of a coin within certain time range in UNIX along with price, market cap and 24hr volume based on particular coin ID**
### Tips
* You may obtain the coin ID (API ID) via several ways:
* refers to respective coin page and find 'API ID'.
* refers to [`/coins/list`](/v3.0.1/reference/coins-list) endpoint.
* refers to google sheets [here](https://docs.google.com/spreadsheets/d/1wTTuxXt8n9q7C4NDXqQpI3wpKu1_5bGVmP9Xz0XGSyU/edit?usp=sharing).
### Note
* You may leave the interval params as empty for automatic granularity:
* 1 day from current time = **5-minutely** data
* 1 day from any time (except current time) = **hourly** data
* 2 - 90 days from any time = **hourly** data
* above 90 days from any time = **daily** data (00:00 UTC)
* Cache / Update Frequency:\
Based on days range (all the API plans)
* 1 day = 30 seconds cache
* 2 -90 days = 30 minutes cache
* 90 days = 12 hours cache
* The last completed UTC day (00:00) is available 35 minutes after midnight on the next UTC day (00:35). The cache will always expire at 00:40 UTC.
* Access to historical data via the Public API (Demo plan) is **restricted to the past 365 days** only. To access the complete range of historical data, please subscribe to one of our [paid plans](https://www.coingecko.com/en/api/pricing) to obtain a Pro-API key.
# Coin OHLC Chart by ID
Source: https://docs.coingecko.com/v3.0.1/reference/coins-id-ohlc
v3.0.1/reference/api-reference/coingecko-demo.json get /coins/{id}/ohlc
This endpoint allows you to **get the OHLC chart (Open, High, Low, Close) of a coin based on particular coin ID**
### Tips
* You may obtain the coin ID (API ID) via several ways:
* refers to respective coin page and find 'API ID'.
* refers to [`/coins/list`](/v3.0.1/reference/coins-list) endpoint.
* refers to google sheets [here](https://docs.google.com/spreadsheets/d/1wTTuxXt8n9q7C4NDXqQpI3wpKu1_5bGVmP9Xz0XGSyU/edit?usp=sharing).
* For historical chart data with better granularity, you may consider using [/coins/\{id}/market\_chart](/v3.0.1/reference/coins-id-market-chart) endpoint.
### Note
* The timestamp displayed in the payload (response) indicates the end (or close) time of the OHLC data.
* Data granularity (candle's body) is automatic:
* 1 - 2 days: 30 minutes
* 3 - 30 days: 4 hours
* 31 days and beyond: 4 days
* Cache / Update Frequency:
* Every 15 minutes for all the API plans.
* The last completed UTC day (00:00) is available 35 minutes after midnight on the next UTC day (00:35).
* Access to historical data via the Public API (Demo plan) is **restricted to the past 365 days** only. To access the complete range of historical data, please subscribe to one of our [paid plans](https://www.coingecko.com/en/api/pricing) to obtain a Pro-API key.
# Coin Tickers by ID
Source: https://docs.coingecko.com/v3.0.1/reference/coins-id-tickers
v3.0.1/reference/api-reference/coingecko-demo.json get /coins/{id}/tickers
This endpoint allows you to **query the coin tickers on both centralized exchange (CEX) and decentralized exchange (DEX) based on a particular coin ID**
### Tips
* You may obtain the coin ID (API ID) via several ways:
* refers to respective coin page and find 'API ID'.
* refers to [`/coins/list`](/v3.0.1/reference/coins-list) endpoint.
* refers to google sheets [here](https://docs.google.com/spreadsheets/d/1wTTuxXt8n9q7C4NDXqQpI3wpKu1_5bGVmP9Xz0XGSyU/edit?usp=sharing).
* You may specify the `exchange_ids` if you want to retrieve tickers for specific exchange only.
* You may include values such as `page` to specify which page of responses you would like to show.
* You may also flag to include more data such as exchange logo and depth.
### Note
* The tickers are paginated to 100 items.
* When `dex_pair_format=symbol`, the DEX pair `base` and `target` are displayed in symbol format (e.g. `WETH`, `USDC`) instead of as contract addresses.
* When order is sorted by `volume`, ***converted\_volume*** will be used instead of ***volume***.
* Cache / Update Frequency: every 2 minutes for all the API plans.
# Coins List (ID Map)
Source: https://docs.coingecko.com/v3.0.1/reference/coins-list
v3.0.1/reference/api-reference/coingecko-demo.json get /coins/list
This endpoint allows you to **query all the supported coins on CoinGecko with coins ID, name and symbol**
### Tips
* You may use this endpoint to query the list of coins with coin ID for other endpoints that contain params like `id` or `ids` (coin ID).
### Note
* There is no pagination required for this endpoint.
* Access to inactive coins via the Public API (Demo plan) is restricted. To access them, please subscribe to one of our paid plans to obtain a Pro-API key.
* Cache/Update Frequency:
* Every 30 minutes for Public API.
* Every 5 minutes for Pro API (Analyst, Lite, Pro, Enterprise).
# Coins List with Market Data
Source: https://docs.coingecko.com/v3.0.1/reference/coins-markets
v3.0.1/reference/api-reference/coingecko-demo.json get /coins/markets
This endpoint allows you to **query all the supported coins with price, market cap, volume and market related data**
### Tips
* You can retrieve specific coins using their unique `ids`, `names`, or `symbols` instead of returning the whole list.
* To filter results based on the coin's category, use the `category` param (refer to [`/coins/categories/list`](/v3.0.1/reference/coins-categories-list) for available categories).
* Use the `per_page` and `page` params to manage the number of results you receive and navigate through the data.
### Note
* When multiple lookup params are provided, the following priority order is applied: `category` (highest) > `ids` > `names` > `symbols` (lowest).
* When searching by `name`, you need to URL-encode any spaces (e.g. "Binance Coin" becomes "Binance%20Coin").
* The `include_tokens=all` param is exclusively for use with the `symbols` lookup and is limited to maximum of 50 symbols per request.
* Wildcard searches are not supported for lookup params (`ids`, `names`, `symbols`).
* Cache/Update Frequency:
* Every 60 seconds for Public API.
* Every 45 seconds for Pro API (Analyst, Lite, Pro, Enterprise).
# Public Companies Holdings
Source: https://docs.coingecko.com/v3.0.1/reference/companies-public-treasury
v3.0.1/reference/api-reference/coingecko-demo.json get /companies/public_treasury/{coin_id}
This endpoint allows you **query public companiesโ Bitcoin or Ethereum holdings**
### Note
* The responses are sorted in descending order based on total holdings.
# Coin Historical Chart Data by Token Address
Source: https://docs.coingecko.com/v3.0.1/reference/contract-address-market-chart
v3.0.1/reference/api-reference/coingecko-demo.json get /coins/{id}/contract/{contract_address}/market_chart
This endpoint allows you to **get the historical chart data including time in UNIX, price, market cap and 24hr volume based on asset platform and particular token contract address**
### Tips
* You may obtain the asset platform and contract address via several ways:
* refers to respective coin page and find 'contract address'.
* refers to [`/coins/list`](/v3.0.1/reference/coins-list) endpoint (`include platform = true`).
### Note
* You may leave the interval as empty for automatic granularity:
* 1 day from current time = **5-minutely** data
* 2 - 90 days from current time = **hourly** data
* above 90 days from current time = **daily** data (00:00 UTC)
* Cache / Update Frequency:
* Every 5 minutes for all the API plans.
* The last completed UTC day (00:00) is available 35 minutes after midnight on the next UTC day (00:35). The cache will always expire at 00:40 UTC.
* Access to historical data via the Public API (Demo plan) is **restricted to the past 365 days** only. To access the complete range of historical data, please subscribe to one of our [paid plans](https://www.coingecko.com/en/api/pricing) to obtain a Pro-API key.
# Coin Historical Chart Data within Time Range by Token Address
Source: https://docs.coingecko.com/v3.0.1/reference/contract-address-market-chart-range
v3.0.1/reference/api-reference/coingecko-demo.json get /coins/{id}/contract/{contract_address}/market_chart/range
This endpoint allows you to **get the historical chart data within certain time range in UNIX along with price, market cap and 24hr volume based on asset platform and particular token contract address**
### Tips
* You may obtain the asset platform and contract address via several ways:
* refers to respective coin page and find 'contract address'.
* refers to [`/coins/list`](/v3.0.1/reference/coins-list) endpoint (`include platform = true`).
### Note
* You may leave the interval params as empty for automatic granularity:
* 1 day from current time = **5-minutely** data
* 1 day from any time (except current time) = **hourly** data
* 2 - 90 days from any time = **hourly** data
* above 90 days from any time = **daily** data (00:00 UTC)
* Cache / Update Frequency:\
Based on days range (all the API plans)
* 1 day = 30 seconds cache
* 2 -90 days = 30 minutes cache
* 90 days = 12 hours cache
* The last completed UTC day (00:00) is available 35 minutes after midnight on the next UTC day (00:35). The cache will always expire at 00:40 UTC.
* Access to historical data via the Public API (Demo plan) is **restricted to the past 365 days** only. To access the complete range of historical data, please subscribe to one of our [paid plans](https://www.coingecko.com/en/api/pricing) to obtain a Pro-API key.
# Crypto Global Market Data
Source: https://docs.coingecko.com/v3.0.1/reference/crypto-global
v3.0.1/reference/api-reference/coingecko-demo.json get /global
This endpoint allows you **query cryptocurrency global data including active cryptocurrencies, markets, total crypto market cap and etc**
### Note
* Cache / Update Frequency: every 10 minutes for all the API plans.
# Derivatives Exchanges List with Data
Source: https://docs.coingecko.com/v3.0.1/reference/derivatives-exchanges
v3.0.1/reference/api-reference/coingecko-demo.json get /derivatives/exchanges
This endpoint allows you to **query all the derivatives exchanges with related data (ID, name, open interest, ...) on CoinGecko**
### Tips
* You may include values such as `per_page` and `page` to specify how many results you would like to show in the responses per page and which page of responses you would like to show.
### Note
* Cache / Update Frequency: every 60 seconds for all the API plans.
# Derivatives Exchange Data by ID
Source: https://docs.coingecko.com/v3.0.1/reference/derivatives-exchanges-id
v3.0.1/reference/api-reference/coingecko-demo.json get /derivatives/exchanges/{id}
This endpoint allows you to **query the derivatives exchangeโs related data (ID, name, open interest, ...) based on the exchangesโ ID**
### Tips
* For `include_tickers` param, you may change the value to either `all` to include all the tickers or `unexpired` to include unexpired tickers in the responses. You may leave it blank to omit the tickers data.
### Note
* Cache / Update Frequency: every 30 seconds for all the API plans.
# Derivatives Exchanges List (ID Map)
Source: https://docs.coingecko.com/v3.0.1/reference/derivatives-exchanges-list
v3.0.1/reference/api-reference/coingecko-demo.json get /derivatives/exchanges/list
This endpoint allows you to **query all the derivatives exchanges with ID and name on CoinGecko**
### Tips
* You may use this endpoint to query the list of exchanges for other endpoints that contain params like `id` (derivatives exchange's ID)
### Note
* Cache / Update Frequency: every 5 minutes for all the API plans.
# Derivatives Tickers List
Source: https://docs.coingecko.com/v3.0.1/reference/derivatives-tickers
v3.0.1/reference/api-reference/coingecko-demo.json get /derivatives
This endpoint allows you to **query all the tickers from derivatives exchanges on CoinGecko**
### Note
* Data for `open_interest` and `volume_24h` in the endpoint responses are in USD.
* Cache / Update Frequency: every 30 seconds for all the API plans.
# Supported Dexes List by Network (ID Map)
Source: https://docs.coingecko.com/v3.0.1/reference/dexes-list
v3.0.1/reference/api-reference/onchain-demo.json get /networks/{network}/dexes
This endpoint allows you to **query all the supported decentralized exchanges (DEXs) based on the provided network on GeckoTerminal**
### Tips
* You may use this endpoint to query the list of DEXs with DEX ID for other endpoints that contain params like `dex`.
* You may include values such as `page` to specify which page of responses you would like to show.
# Endpoint Overview
Source: https://docs.coingecko.com/v3.0.1/reference/endpoint-overview
### Notes
Any exclusive endpoints for Pro-API users (any paid plan subscribers) will not be included here.
For a full list of endpoints, please visit [Pro API Documentation](/reference/endpoint-overview) instead.
## CoinGecko Endpoints: Coins
| Endpoint | Description |
| -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| [/ping](/v3.0.1/reference/ping-server) | Check the API server status |
| [/simple/price](/v3.0.1/reference/simple-price) | Query the prices of one or more coins by using their unique Coin API IDs |
| [/simple/token\_price/\{id}](/v3.0.1/reference/simple-token-price) | Query the prices of one or more coins by using their unique Coin API IDs |
| [/simple/supported\_vs\_currencies](/v3.0.1/reference/simple-supported-currencies) | Query all the supported currencies on CoinGecko |
| [/coins/list](/v3.0.1/reference/coins-list) | Query all the supported coins on CoinGecko with coins ID, name and symbol |
| [/coins/markets](/v3.0.1/reference/coins-markets) | Query all the supported coins with price, market cap, volume and market related data |
| [/coins/\{id}](/v3.0.1/reference/coins-id) | Query all the metadata (image, websites, socials, description, contract address, etc.) from the CoinGecko coin page based on a particular coin ID |
| [/coins/\{id}/tickers](/v3.0.1/reference/coins-id-tickers) | Query the coin tickers on both centralized exchange (CEX) and decentralized exchange (DEX) based on a particular coin ID |
| [/coins/\{id}/history](/v3.0.1/reference/coins-id-history) | Query the historical data (price, market cap, 24hr volume, ...) at a given date for a coin based on a particular coin ID |
| [/coins/\{id}/market\_chart](/v3.0.1/reference/coins-id-market-chart) | Get the historical chart data of a coin including time in UNIX, price, market cap and 24hr volume based on particular coin ID |
| [/coins/\{id}/market\_chart/range](/v3.0.1/reference/coins-id-market-chart-range) | Get the historical chart data of a coin within certain time range in UNIX along with price, market cap and 24hr volume based on particular coin ID |
| [/coins-id-ohlc](/v3.0.1/reference/coins-id-ohlc) | Get the OHLC chart (Open, High, Low, Close) of a coin based on particular coin ID |
| [/coins/../contract/..](/v3.0.1/reference/coins-contract-address) | Query all the metadata (image, websites, socials, description, contract address, etc.) from the CoinGecko coin page based on an asset platform and a particular token contract address |
| [/coins/../contract/../market\_chart](/v3.0.1/reference/contract-address-market-chart) | Get the historical chart data including time in UNIX, price, market cap and 24hr volume based on asset platform and particular token contract address |
| [/coins/../contract/../market\_chart/range](/v3.0.1/reference/contract-address-market-chart-range) | Get the historical chart data within certain time range in UNIX along with price, market cap and 24hr volume based on asset platform and particular token contract address |
| [/coins/categories/list](/v3.0.1/reference/coins-categories-list) | Query all the coins categories on CoinGecko |
| [/coins/categories](/v3.0.1/reference/coins-categories) | Query all the coins categories with market data (market cap, volume, ...) on CoinGecko |
## CoinGecko Endpoints: NFT
| Endpoint | Description |
| --------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------- |
| [/nfts/list](/v3.0.1/reference/nfts-list) | Query all supported NFTs with ID, contract address, name, asset platform ID and symbol on CoinGecko |
| [/nfts/..](/v3.0.1/reference/nfts-id) | Query all the NFT data (name, floor price, 24hr volume, ...) based on the NFT collection ID |
| [/nfts/../contract/..](/v3.0.1/reference/nfts-contract-address) | Query all the NFT data (name, floor price, 24hr volume, ...) based on the NFT collection contract address and respective asset platform |
## CoinGecko Endpoints: Exchanges & Derivatives
| Endpoint | Description |
| ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- |
| [/exchanges](/v3.0.1/reference/exchanges) | Query all the supported exchanges with exchanges' data (ID, name, country, ...) that have active trading volumes on CoinGecko |
| [/exchanges/list](/v3.0.1/reference/exchanges-list) | Query all the exchanges with ID and name |
| [/exchanges/\{id}](/v3.0.1/reference/exchanges-id) | Query exchange's data (name, year established, country, ...), exchange volume in BTC and tickers based on exchange's ID |
| [/exchanges/\{id}/tickers](/v3.0.1/reference/exchanges-id-tickers) | Query exchange's tickers based on exchange's ID |
| [/exchanges/\{id}/volume\_chart](/v3.0.1/reference/exchanges-id-volume-chart) | Query the historical volume chart data with time in UNIX and trading volume data in BTC based on exchange's ID |
| [/derivatives](/v3.0.1/reference/derivatives-tickers) | Query all the tickers from derivatives exchanges on CoinGecko |
| [/derivatives/exchanges](/v3.0.1/reference/derivatives-exchanges) | Query all the derivatives exchanges with related data (ID, name, open interest, ...) on CoinGecko |
| [/derivatives/exchanges/\{id}](/v3.0.1/reference/derivatives-exchanges-id) | Query the derivatives exchange's related data (ID, name, open interest, ...) based on the exchanges' ID |
| [/derivatives/exchanges/list](/v3.0.1/reference/derivatives-exchanges-list) | Query all the derivatives exchanges with ID and name on CoinGecko |
## CoinGecko Endpoints: General
| Endpoint | Description |
| -------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------ |
| [/exchange\_rates](/v3.0.1/reference/exchange-rates) | Query BTC exchange rates with other currencies |
| [/asset\_platforms](/v3.0.1/reference/asset-platforms-list) | Query all the asset platforms (blockchain networks) on CoinGecko |
| [/token\_lists/\{asset\_platform\_id}/all.json](/v3.0.1/reference/token-lists) | Get full list of tokens of a blockchain network (asset platform) that is supported by Ethereum token list standard |
| [/search](/v3.0.1/reference/search-data) | Search for coins, categories and markets listed on CoinGecko |
| [/search/trending](/v3.0.1/reference/trending-search) | Query trending search coins, NFTs and categories on CoinGecko in the last 24 hours |
| [/global](/v3.0.1/reference/crypto-global) | Query cryptocurrency global data including active cryptocurrencies, markets, total crypto market cap and etc. |
| [/global/decentralized\_finance\_defi](/v3.0.1/reference/global-defi) | Query cryptocurrency global decentralized finance (DeFi) data including DeFi market cap, trading volume |
| [/companies/public\_treasury/\{coin\_id}](/v3.0.1/reference/companies-public-treasury) | Query public companies' Bitcoin or Ethereum holdings |
## Onchain DEX Endpoints (GeckoTerminal)
| Endpoint | Description |
| ---------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| [/onchain/simple/networks/../token\_price/..](/v3.0.1/reference/onchain-simple-price) | Get token price based on the provided token contract address on a network |
| [/onchain/networks](/v3.0.1/reference/networks-list) | Query all the supported networks on GeckoTerminal |
| [/onchain/networks/../dexes](/v3.0.1/reference/dexes-list) | Query all the supported decentralized exchanges (DEXs) based on the provided network on GeckoTerminal |
| [/onchain/networks/trending\_pools](/v3.0.1/reference/trending-pools-list) | Query all the trending pools across all networks on GeckoTerminal |
| [/onchain/networks/../trending\_pools](/v3.0.1/reference/trending-pools-network) | Query the trending pools based on the provided network |
| [/onchain/networks/../pools/..](/v3.0.1/reference/pool-address) | Query the specific pool based on the provided network and pool address |
| [/onchain/networks/../pools/multi/..](/v3.0.1/reference/pools-addresses) | Query multiple pools based on the provided network and pool address |
| [/onchain/networks/../pools](/v3.0.1/reference/top-pools-network) | Query all the top pools based on the provided network |
| [/onchain/networks/../dexes/../pools](/v3.0.1/reference/top-pools-dex) | Query all the top pools based on the provided network and decentralized exchange (DEX) |
| [/onchain/networks/../new\_pools](/v3.0.1/reference/latest-pools-network) | Query all the latest pools based on provided network |
| [/onchain/networks/new\_pools](/v3.0.1/reference/latest-pools-list) | Query all the latest pools across all networks on GeckoTerminal |
| [/onchain/search/pools](/v3.0.1/reference/search-pools) | Search for pools on a network |
| [/onchain/networks/../tokens/../pools](/v3.0.1/reference/top-pools-contract-address) | Query top pools based on the provided token contract address on a network |
| [/onchain/networks/../tokens/..](/v3.0.1/reference/token-data-contract-address) | Query specific token data based on the provided token contract address on a network |
| [/onchain/networks/../tokens/multi/..](/v3.0.1/reference/tokens-data-contract-addresses) | Query multiple tokens data based on the provided token contract addresses on a network |
| [/onchain/networks/../tokens/../info](/v3.0.1/reference/token-info-contract-address) | Query token metadata (name, symbol, CoinGecko ID, image, socials, websites, description, etc.) based on a provided token contract address on a network |
| [/onchain/networks/../pools/../info](/v3.0.1/reference/pool-token-info-contract-address) | Query pool metadata (base and quote token details, image, socials, websites, description, contract address, etc.) based on a provided pool contract address on a network |
| [/onchain/tokens/info\_recently\_updated](/v3.0.1/reference/tokens-info-recent-updated) | Query 100 most recently updated tokens info across all networks on GeckoTerminal |
| [/onchain/networks/../pools/../ohlcv/..](/v3.0.1/reference/pool-ohlcv-contract-address) | Get the OHLCV chart (Open, High, Low, Close, Volume) of a pool based on the provided pool address on a network |
| [/onchain/networks/../pools/../trades](/v3.0.1/reference/pool-trades-contract-address) | Query the last 300 trades in the past 24 hours based on the provided pool address |
# BTC-to-Currency Exchange Rates
Source: https://docs.coingecko.com/v3.0.1/reference/exchange-rates
v3.0.1/reference/api-reference/coingecko-demo.json get /exchange_rates
This endpoint allows you to **query BTC exchange rates with other currencies**
### Tips
* You may use this endpoint to convert the response data, which is originally in BTC, to other currencies.
### Note
* Cache / Update Frequency: every 5 minutes for all the API plans.
# Exchanges List with data
Source: https://docs.coingecko.com/v3.0.1/reference/exchanges
v3.0.1/reference/api-reference/coingecko-demo.json get /exchanges
This endpoint allows you to **query all the supported exchanges with exchangesโ data (ID, name, country, ...) that have active trading volumes on CoinGecko**
### Notice
* Please note that the `trade_volume_24h_btc_normalized` data field will no longer be supported by our API starting on June 15, 2025. Please refer to [changelog](https://docs.coingecko.com/changelog/upcoming-change-notice-removal-of-normalized_volume_btc-data) for more details.
### Tips
* You may include values such as `per_page` and `page` to specify how many results you would like to show in the responses per page and which page of responses you would like to show.
### Note
* All the exchanges in the responses are the exchanges with active trading volume on CoinGecko, any inactive or deactivated exchanges will be removed from the list.
* Cache / Update Frequency: every 60 seconds for all the API plans.
# Exchange Data by ID
Source: https://docs.coingecko.com/v3.0.1/reference/exchanges-id
v3.0.1/reference/api-reference/coingecko-demo.json get /exchanges/{id}
This endpoint allows you to **query exchangeโs data (name, year established, country, ...), exchange volume in BTC and top 100 tickers based on exchangeโs ID**
### Notice
* Please note that the `trade_volume_24h_btc_normalized` data field will no longer be supported by our API starting on June 15, 2025. Please refer to [changelog](https://docs.coingecko.com/changelog/upcoming-change-notice-removal-of-normalized_volume_btc-data) for more details.
### Note
* The exchange volume in the response is provided in BTC. To convert it to other currencies, please use [/exchange\_rates](/v3.0.1/reference/exchange-rates) endpoint.
* For derivatives (e.g. bitmex, binance\_futures), to get derivatives exchanges data, please go to [/derivatives/exchange/\{id}](/v3.0.1/reference/derivatives-exchanges-id) endpoint.
* Tickers are limited to 100 items, to get more tickers, please go to [/exchanges/\{id}/tickers](/v3.0.1/reference/exchanges-id-tickers) endpoint.
* When `dex_pair_format=symbol`, the DEX pair `base` and `target` are displayed in symbol format (e.g. `WETH`, `USDC`) instead of as contract addresses.
* Cache / Update Frequency: every 60 seconds for all the API plans.
# Exchange Tickers by ID
Source: https://docs.coingecko.com/v3.0.1/reference/exchanges-id-tickers
v3.0.1/reference/api-reference/coingecko-demo.json get /exchanges/{id}/tickers
This endpoint allows you to **query exchange's tickers based on exchangeโs ID**
### Note
* Responses are paginated and limited to 100 tickers per page. You may specify the page number using the `page` params to retrieve the tickers accordingly.
* `order=base_target` sorts tickers by `base` symbol, then `target` symbol, in lexicographical order (`0 -> 9`, followed by `a -> z`).\
This sorting method ensures stable pagination results, minimizing cases where cached responses might otherwise cause duplicate or missing tickers across paginated pages.
* When `dex_pair_format=symbol`, the DEX pair `base` and `target` are displayed in symbol format (e.g. `WETH`, `USDC`) instead of as contract addresses.
* Cache / Update Frequency: every 60 seconds for all the API plans.
# Exchange Volume Chart by ID
Source: https://docs.coingecko.com/v3.0.1/reference/exchanges-id-volume-chart
v3.0.1/reference/api-reference/coingecko-demo.json get /exchanges/{id}/volume_chart
This endpoint allows you to **query the historical volume chart data with time in UNIX and trading volume data in BTC based on exchangeโs ID**
### Note
* You can use this endpoint to query the historical volume chart data of **derivatives exchanges** as well.
* The exchange volume in the response is provided in BTC. To convert it to other currencies, please use [/exchange\_rates](/v3.0.1/reference/exchange-rates) endpoint.
* Data granularity is automatic (cannot be adjusted):
* 1 day = 10-minutely
* 7, 14 days = hourly
* 30 days & above = daily
* Cache / Update Frequency: every 60 seconds for all the API plans.
# Exchanges List (ID Map)
Source: https://docs.coingecko.com/v3.0.1/reference/exchanges-list
v3.0.1/reference/api-reference/coingecko-demo.json get /exchanges/list
This endpoint allows you to **query all the exchanges with ID and name**
### Tips
* You may use this endpoint to query the list of exchanges including **derivatives exchanges** for other endpoints that contain params like `id`(exchange ID).
### Note
* There is no pagination required for this endpoint.
* Cache / Update Frequency: every 5 minutes for all the API plans.
# Global De-Fi Market Data
Source: https://docs.coingecko.com/v3.0.1/reference/global-defi
v3.0.1/reference/api-reference/coingecko-demo.json get /global/decentralized_finance_defi
This endpoint allows you **query top 100 cryptocurrency global decentralized finance (DeFi) data including DeFi market cap, trading volume**
# New Pools List
Source: https://docs.coingecko.com/v3.0.1/reference/latest-pools-list
v3.0.1/reference/api-reference/onchain-demo.json get /networks/new_pools
This endpoint allows you to **query all the latest pools across all networks on GeckoTerminal**
### Tips
* You may include values such as `page` to specify which page of responses you would like to show.
### Note
* If the token's market cap is not verified by the team, the API response will return `null` for its market cap value, even though it has a displayed value on GeckoTerminal, which might not be accurate as it often matches the Fully Diluted Valuation (FDV).
* Attributes specified in the `include` param will be returned under the top-level "included" key.
* This endpoint returns up to 20 pools per page. Use the `page` param to navigate more results.
* `page`: Pagination beyond 10 pages is available for [Paid Plan](https://www.coingecko.com/en/api/pricing) subscribers (Analyst plan or above).
* Cache/Update frequency: every 60 seconds.
* GeckoTerminal equivalent page (example): [https://www.geckoterminal.com/explore/new-crypto-pools](https://www.geckoterminal.com/explore/new-crypto-pools)
# New Pools by Network
Source: https://docs.coingecko.com/v3.0.1/reference/latest-pools-network
v3.0.1/reference/api-reference/onchain-demo.json get /networks/{network}/new_pools
This endpoint allows you to **query all the latest pools based on provided network**
### Tips
* You may include values such as `page` to specify which page of responses you would like to show.
### Note
* This endpoint includes the newly created pools in the past 48 hours.
* If the token's market cap is not verified by the team, the API response will return `null` for its market cap value, even though it has a displayed value on GeckoTerminal, which might not be accurate as it often matches the Fully Diluted Valuation (FDV).
* Attributes specified in the `include` param will be returned under the top-level "included" key.
* This endpoint returns up to 20 pools per page. Use the `page` param to navigate more results.
* `page`: Pagination beyond 10 pages is available for [Paid Plan](https://www.coingecko.com/en/api/pricing) subscribers (Analyst plan or above).
* Cache/Update frequency: every 60 seconds.
* GeckoTerminal equivalent page (example): [https://www.geckoterminal.com/explore/new-crypto-pools/solana](https://www.geckoterminal.com/explore/new-crypto-pools/solana)
# Supported Networks List (ID Map)
Source: https://docs.coingecko.com/v3.0.1/reference/networks-list
v3.0.1/reference/api-reference/onchain-demo.json get /networks
This endpoint allows you to **query all the supported networks on GeckoTerminal**
### Tips
* You may use this endpoint to query the list of networks with network ID for other endpoints that contain params like `network`.
* You may include values such as `page` to specify which page of responses you would like to show.
# NFTs Collection Data by Contract Address
Source: https://docs.coingecko.com/v3.0.1/reference/nfts-contract-address
v3.0.1/reference/api-reference/coingecko-demo.json get /nfts/{asset_platform_id}/contract/{contract_address}
This endpoint allows you to **query all the NFT data (name, floor price, 24hr volume ...) based on the NFT collection contract address and respective asset platform**
### Tips
* You may also obtain the asset platform id and contract address through [/nfts/list](/v3.0.1/reference/nfts-list) endpoint.
### Note
* Solana NFT & Art Blocks are not supported for this endpoint, please use [/nfts/\{id}](/v3.0.1/reference/nfts-id) endpoint instead.
* Cache / Update Frequency: every 60 seconds for all the API plans.
# NFTs Collection Data by ID
Source: https://docs.coingecko.com/v3.0.1/reference/nfts-id
v3.0.1/reference/api-reference/coingecko-demo.json get /nfts/{id}
This endpoint allows you to **query all the NFT data (name, floor price, 24hr volume ...) based on the NFT collection ID**
### Note
* Cache / Update Frequency: every 60 seconds for all the API plans.
# NFTs List (ID Map)
Source: https://docs.coingecko.com/v3.0.1/reference/nfts-list
v3.0.1/reference/api-reference/coingecko-demo.json get /nfts/list
This endpoint allows you to **query all supported NFTs with ID, contract address, name, asset platform ID and symbol on CoinGecko**
### Tips
* You may use this endpoint to query the list of NFTs for other endpoints that contain params like `id` (NFT collection's id) as well as `asset_platform_id` and `contract_address`.
* You may include values such as `per_page` and `page` to specify how many results you would like to show in the responses per page and which page of responses you would like to show.
### Note
* The responses are paginated to 100 items.
* Cache / Update Frequency: every 5 minutes for all the API plans.
# Token Price by Token Addresses
Source: https://docs.coingecko.com/v3.0.1/reference/onchain-simple-price
v3.0.1/reference/api-reference/onchain-demo.json get /simple/networks/{network}/token_price/{addresses}
This endpoint allows you to **get token price based on the provided token contract address on a network**
### Note
* If the token's market cap is not verified by the team, the API response will return `null` for its market cap value, even though it has a displayed value on GeckoTerminal, which might not be accurate as it often matches the Fully Diluted Valuation (FDV).
* If you require `market_cap_usd` to return FDV value (as seen in [GeckoTerminal.com](https://www.geckoterminal.com/)) when market cap data is unavailable, please specify this parameter `mcap_fdv_fallback=true`.
* The returned price currency is in USD.
* Addresses not found in GeckoTerminal will be ignored.
* This endpoint allows querying **up to 30 contract addresses** per request.
* When using this endpoint, GeckoTerminal's routing decides the best pool for token price. The price source may change based on liquidity and pool activity. For full control over the price, you may use [`/networks/{network}/pools/{address}`](/v3.0.1/reference/pool-address) endpoint by providing a specific pool address.
* Cache/Update Frequency: every 60 seconds.
# Check API server status
Source: https://docs.coingecko.com/v3.0.1/reference/ping-server
v3.0.1/reference/api-reference/coingecko-demo.json get /ping
This endpoint allows you to **check the API server status**
### Note
* You can also go to [status.coingecko.com](https://status.coingecko.com/) to check the API server status and further maintenance notices.
# Specific Pool Data by Pool Address
Source: https://docs.coingecko.com/v3.0.1/reference/pool-address
v3.0.1/reference/api-reference/onchain-demo.json get /networks/{network}/pools/{address}
This endpoint allows you to **query the specific pool based on the provided network and pool address**
### Note
* Address not found in GeckoTerminal will be ignored.
* If the token's market cap is not verified by the team, the API response will return `null` for its market cap value, even though it has a displayed value on GeckoTerminal, which might not be accurate as it often matches the Fully Diluted Valuation (FDV).
* Market Cap can be verified by and sourced from CoinGecko, and the number may be higher than FDV as it may include Market Cap of tokens issued on other blockchain network.
* Attributes specified in the `include` param will be returned under the top-level "included" key.
* `locked_liquidity_percentage` will be updated on daily basis.
* Cache/Update Frequency: every 60 seconds.
# Pool OHLCV chart by Pool Address
Source: https://docs.coingecko.com/v3.0.1/reference/pool-ohlcv-contract-address
v3.0.1/reference/api-reference/onchain-demo.json get /networks/{network}/pools/{pool_address}/ohlcv/{timeframe}
This endpoint allows you to **get the OHLCV chart (Open, High, Low, Close, Volume) of a pool based on the provided pool address on a network**
### Tips
* You may use this endpoint to query the historical price and volume of a token.
* You may select the timeframe with its respective aggregate to get the intended OHLCV data (e.g. `minute?aggregate=15` for 15 minutes OHLCV).
### Note
* This endpoint uses epoch/unix format for its timestamp. Example: `1708850449`.
* [Paid plan](https://www.coingecko.com/en/api/pricing) subscribers (Analyst plan & above) can access data from **September 2021 to the present**, depending on when the pool started tracking on GeckoTerminal.
* If no earlier data is available, an empty response will be returned.
* Each API call can only retrieve data for a **maximum range of 6 months**. To fetch older data, use the `before_timestamp` parameter to query in multiple requests.
* Pools with more than 2 tokens are not yet supported for this endpoint.
* Each OHLCV array (under "ohlcv\_list") consists of 6 elements in the following order:
* Timestamp: The epoch/unix timestamp representing the start of the time interval.
* Open: The opening price of the asset at the beginning of the interval.
* High: The highest price reached during the interval.
* Low: The lowest price reached during the interval.
* Close: The price of the asset at the end of the interval.
* Volume: The total trading volume of the asset during the interval.
* **Skipped Intervals**: To ensure concise and relevant data, specific timeframe intervals (e.g. minutely) with no recorded swaps are **excluded** from the response.
* Higher granularity timeframes (e.g. 1 minute) are more likely to skip intervals due to periods of inactivity, while lower granularity timeframes (e.g. daily) are less affected.
* For `include_empty_intervals` param:
* When `false` (default): Only intervals with trade data are returned.
* When `true`: All requested intervals are returned, those with no trade data are populated as follows:
* OHLC (Open, High, Low, Close) are all set to the Close price of the previous interval.
* *O = H = L = C = previous Close*
* Volume (V) is set to 0, reflecting no trade activity.
* Cache/Update frequency: every 60 seconds.
# Pool Tokens Info by Pool Address
Source: https://docs.coingecko.com/v3.0.1/reference/pool-token-info-contract-address
v3.0.1/reference/api-reference/onchain-demo.json get /networks/{network}/pools/{pool_address}/info
This endpoint allows you to **query pool metadata (base and quote token details, image, socials, websites, description, contract address, etc.) based on a provided pool contract address on a network**
### Tips
* If you would like to query pool data such as price, transactions, volume and etc. You can go to this endpoint [`/networks/{network}/pools/{address}`](/v3.0.1/reference/pool-address) instead.
* Cache/Update frequency: every 60 seconds.
* Learn more about GT score [here](https://support.coingecko.com/hc/en-us/articles/38381394237593-What-is-GT-Score-How-is-GT-Score-calculated).
* Metadata (image, websites, description, socials) may be sourced on-chain and is not vetted by the CoinGecko team. If you wish to get metadata reviewed by CoinGecko team, you may use the following endpoints:
* [Coin Data by ID](/v3.0.1/reference/coins-id)
* [Coin Data by Token Address](/v3.0.1/reference/coins-contract-address)
### Note
* `holders` data is currently in Beta, with ongoing improvements to data quality, coverage, and update frequency.
* Supported chains include: Solana, EVM (Ethereum, Polygon, BNB, Arbitrum, Optimism, Base), Sui, TON, and Ronin.
* `distribution_percentage` coverage:
* Solana: `top_10`, `11_20`, `21_40`, `rest`
* Other chains: `top_10`, `11_30`, `31_50`, `rest`
# Past 24 Hour Trades by Pool Address
Source: https://docs.coingecko.com/v3.0.1/reference/pool-trades-contract-address
v3.0.1/reference/api-reference/onchain-demo.json get /networks/{network}/pools/{pool_address}/trades
This endpoint allows you to **query the last 300 trades in the past 24 hours based on the provided pool address**
### Note
* Cache/Update Frequency: every 60 seconds.
# Multiple Pools Data by Pool Addresses
Source: https://docs.coingecko.com/v3.0.1/reference/pools-addresses
v3.0.1/reference/api-reference/onchain-demo.json get /networks/{network}/pools/multi/{addresses}
This endpoint allows you to **query multiple pools based on the provided network and pool address**
### Note
* Addresses not found in GeckoTerminal will be ignored.
* If the token's market cap is not verified by the team, the API response will return `null` for its market cap value, even though it has a displayed value on GeckoTerminal, which might not be accurate as it often matches the Fully Diluted Valuation (FDV).
* This endpoint allows querying **up to 30 contract addresses** per request.
* Market Cap can be verified by and sourced from CoinGecko, and the number may be higher than FDV as it may include Market Cap of tokens issued on other blockchain network.
* Attributes specified in the `include ` params will be included under the "included" key at the top level.
* `locked_liquidity_percentage` will be updated on daily basis.
* Cache/Update Frequency: every 60 seconds.
# Search Queries
Source: https://docs.coingecko.com/v3.0.1/reference/search-data
v3.0.1/reference/api-reference/coingecko-demo.json get /search
This endpoint allows you to **search for coins, categories and markets listed on CoinGecko**
### Note
* The responses are sorted in descending order by market cap.
* Cache / Update Frequency: every 15 minutes for all the API plans.
# Search Pools
Source: https://docs.coingecko.com/v3.0.1/reference/search-pools
v3.0.1/reference/api-reference/onchain-demo.json get /search/pools
This endpoint allows you to **search for pools on a network**
### Tips
* You may use this endpoint to search for query such as pool contract address, token contract address or token symbol. The endpoint will return matching pools as response.
* You may include values such as `page` to specify which page of responses you would like to show.
### Note
* If the token's market cap is not verified by the team, the API response will return `null` for its market cap value, even though it has a displayed value on GeckoTerminal, which might not be accurate as it often matches the Fully Diluted Valuation (FDV).
* Attributes specified in the `include` param will be returned under the top-level "included" key.
* This endpoint returns up to 20 pools per page. Use the `page` param to navigate more results.
* `page`: Pagination beyond 10 pages is available for [Paid Plan](https://www.coingecko.com/en/api/pricing) subscribers (Analyst plan or above).
* Cache/Update frequency: every 60 seconds.
# Coin Price by IDs
Source: https://docs.coingecko.com/v3.0.1/reference/simple-price
v3.0.1/reference/api-reference/coingecko-demo.json get /simple/price
This endpoint allows you to **query the prices of one or more coins by using their unique Coin API IDs**
### Tips
* You may obtain the coin ID (API ID) via several ways:
* refers to respective coin page and find 'API ID'.
* refers to [`/coins/list`](/v3.0.1/reference/coins-list) endpoint.
* refers to Google Sheets [here](https://docs.google.com/spreadsheets/d/1wTTuxXt8n9q7C4NDXqQpI3wpKu1_5bGVmP9Xz0XGSyU/edit?usp=sharing).
* You can retrieve specific coins using their unique `ids`, `names`, or `symbols`.
* You may flag to include more data such as market cap, 24hr volume, 24hr change, last updated time etc.
* To verify if a price is stale, you may flag `include_last_updated_at=true` in your request to obtain the latest updated time. Alternatively, you may flag `include_24hr_change=true` to determine if it returns a `null` value.
### Note
* You may cross-check the price on [CoinGecko](https://www.coingecko.com) and learn more about our price methodology [here](https://www.coingecko.com/en/methodology).
* When multiple lookup params are provided, the following priority order is applied: `ids` (highest) > `names` > `symbols` (lowest).
* When searching by `name`, you need to URL-encode any spaces (e.g. "Binance Coin" becomes "Binance%20Coin").
* The `include_tokens=all` param is exclusively for use with the `symbols` lookup and is limited to maximum of 50 symbols per request.
* Wildcard searches are not supported for lookup params (`ids`, `names`, `symbols`).
* Cache/Update Frequency: every 60 seconds for Public API.
* Every 20 seconds for [Pro-API](https://www.coingecko.com/en/api/pricing) (Analyst, Lite, Pro, Enterprise).
# Supported Currencies List
Source: https://docs.coingecko.com/v3.0.1/reference/simple-supported-currencies
v3.0.1/reference/api-reference/coingecko-demo.json get /simple/supported_vs_currencies
This endpoint allows you to **query all the supported currencies on CoinGecko**
### Tips
* You may use this endpoint to query the list of currencies for other endpoints that contain params like `vs_currencies`.
### Note
* Cache/Update Frequency: every 60 seconds for Public API.
# Coin Price by Token Addresses
Source: https://docs.coingecko.com/v3.0.1/reference/simple-token-price
v3.0.1/reference/api-reference/coingecko-demo.json get /simple/token_price/{id}
This endpoint allows you to **query one or more token prices using their token contract addresses**
### Tips
* You may obtain the asset platform and contract address via several ways:
* refers to respective coin page and find 'contract address'.
* refers to [`/coins/list`](/v3.0.1/reference/coins-list) endpoint (`include platform = true`).
* You may flag to include more data such as market cap, 24hr volume, 24hr change, last updated time etc.
### Note
* The endpoint returns the global average price of the coin that is aggregated across all active exchanges on CoinGecko.
* You may cross-check the price on [CoinGecko](https://www.coingecko.com) and learn more about our price methodology [here](https://www.coingecko.com/en/methodology).
* Cache/Update Frequency: every 60 seconds for Public API.
* Every 20 seconds for [Pro-API](https://www.coingecko.com/en/api/pricing) (Analyst, Lite, Pro, Enterprise).
# Token Data by Token Address
Source: https://docs.coingecko.com/v3.0.1/reference/token-data-contract-address
v3.0.1/reference/api-reference/onchain-demo.json get /networks/{network}/tokens/{address}
This endpoint allows you to **query specific token data based on the provided token contract address on a network**
### Tips
* You may add values such as `top_pools` in the include param to include top pools along with the pools information.
* If you would like to query token information such as socials, websites, description and etc. You can go to this endpoint [`/networks/{network}/tokens/{address}/info`](/v3.0.1/reference/token-info-contract-address) instead.
### Note
* If the token's market cap is not verified by the team, the API response will return `null` for its market cap value, even though it has a displayed value on GeckoTerminal, which might not be accurate as it often matches the Fully Diluted Valuation (FDV).
* Market Cap can be verified by and sourced from CoinGecko, and the number may be higher than FDV as it may include Market Cap of tokens issued on other blockchain network.
* Attributes specified in the `include` param will be returned under the top-level "included" key.
* Cache/Update frequency: every 60 seconds.
# Token Info by Token Address
Source: https://docs.coingecko.com/v3.0.1/reference/token-info-contract-address
v3.0.1/reference/api-reference/onchain-demo.json get /networks/{network}/tokens/{address}/info
This endpoint allows you to **query token metadata (name, symbol, CoinGecko ID, image, socials, websites, description, etc.) based on a provided token contract address on a network**
### Tips
* If you would like to query token data such as decimals, total supply, price and etc. You can go to this endpoint [`/networks/{network}/tokens/{address}`](/v3.0.1/reference/token-data-contract-address) instead.
* Cache/Update frequency: every 60 seconds.
* Learn more about GT score [here](https://support.coingecko.com/hc/en-us/articles/38381394237593-What-is-GT-Score-How-is-GT-Score-calculated).
* Metadata (image, websites, description, socials) may be sourced on-chain and is not vetted by the CoinGecko team. If you wish to get metadata reviewed by CoinGecko team, you may use the following endpoints:
* [Coin Data by ID](/v3.0.1/reference/coins-id)
* [Coin Data by Token Address](/v3.0.1/reference/coins-contract-address)
### Note
* `holders` data is currently in Beta, with ongoing improvements to data quality, coverage, and update frequency.
* Supported chains include: Solana, EVM (Ethereum, Polygon, BNB, Arbitrum, Optimism, Base), Sui, TON, and Ronin.
* `distribution_percentage` coverage:
* Solana: `top_10`, `11_20`, `21_40`, `rest`
* Other chains: `top_10`, `11_30`, `31_50`, `rest`
# Token Lists by Asset Platform ID
Source: https://docs.coingecko.com/v3.0.1/reference/token-lists
v3.0.1/reference/api-reference/coingecko-demo.json get /token_lists/{asset_platform_id}/all.json
This endpoint allows you to **get full list of tokens of a blockchain network (asset platform) that is supported by [Ethereum token list standard](https://tokenlists.org/)**
### Note
* Cache/Update Frequency: 5 minutes.
* A token will only be included in the list if the contract address is added by CoinGecko team. If you identified any missing token, you may submit a request [here](https://support.coingecko.com/hc/en-us/requests/new).
# Tokens Data by Token Addresses
Source: https://docs.coingecko.com/v3.0.1/reference/tokens-data-contract-addresses
v3.0.1/reference/api-reference/onchain-demo.json get /networks/{network}/tokens/multi/{addresses}
This endpoint allows you to **query multiple tokens data based on the provided token contract addresses on a network**
### Tips
* You may add values such as `top_pools` in the include param to include top pools along with the pools information.
* If you would like to query token information such as socials, websites, description and etc. You can go to this endpoint [`/networks/{network}/tokens/{address}/info`](/v3.0.1/reference/token-info-contract-address) instead.
### Note
* Addresses not found in GeckoTerminal.com will be ignored.
* This endpoint allows querying **up to 30 contract addresses** per request.
* The endpoint will only return the first top pool for each token.
* If the token's market cap is not verified by the team, the API response will return `null` for its market cap value, even though it has a displayed value on GeckoTerminal, which might not be accurate as it often matches the Fully Diluted Valuation (FDV).
* Market Cap can be verified by and sourced from CoinGecko, and the number may be higher than FDV as it may include Market Cap of tokens issued on other blockchain network.
* Attributes specified in the `include` param will be returned under the top-level "included" key.
* Cache/Update frequency: every 60 seconds.
# Most Recently Updated Tokens List
Source: https://docs.coingecko.com/v3.0.1/reference/tokens-info-recent-updated
v3.0.1/reference/api-reference/onchain-demo.json get /tokens/info_recently_updated
This endpoint allows you to **query 100 most recently updated tokens info of a specific network or across all networks on GeckoTerminal**
### Tips
* You may add values such as network in the include param to include network along with the updated tokens list.
### Note
* Attributes specified in the `include` param will be returned under the top-level "included" key.
* Cache/Update frequency: every 60 seconds.
# Top Pools by Token Address
Source: https://docs.coingecko.com/v3.0.1/reference/top-pools-contract-address
v3.0.1/reference/api-reference/onchain-demo.json get /networks/{network}/tokens/{token_address}/pools
This endpoint allows you to **query top pools based on the provided token contract address on a network**
### Tips
* You may include values such as `page` to specify which page of responses you would like to show.
### Note
* The ranking of the top 20 pools is established by evaluating their liquidity and trading activity to identify the most liquid ones. This ranking is determined through a combination of two key factors: liquidity (`reserve_in_usd`) and 24-Hour Trading Volume (`volume_usd`).
* If the token's market cap is not verified by the team, the API response will return `null` for its market cap value, even though it has a displayed value on GeckoTerminal, which might not be accurate as it often matches the Fully Diluted Valuation (FDV).
* Attributes specified in the `include` param will be returned under the top-level "included" key.
* This endpoint returns up to 20 pools per page. Use the `page` param to navigate more results.
* `page`: Pagination beyond 10 pages is available for [Paid Plan](https://www.coingecko.com/en/api/pricing) subscribers (Analyst plan or above).
* Cache/Update frequency: every 60 seconds.
# Top Pools by Dex
Source: https://docs.coingecko.com/v3.0.1/reference/top-pools-dex
v3.0.1/reference/api-reference/onchain-demo.json get /networks/{network}/dexes/{dex}/pools
This endpoint allows you to **query all the top pools based on the provided network and decentralized exchange (DEX)**
### Tips
* You may include values such as `page` to specify which page of responses you would like to show.
* For more flexibility in retrieving an exact list of pools that match your specific needs, consider using the /pools/megafilter endpoint (available for [Paid Plan](https://www.coingecko.com/en/api/pricing) subscribers \[Analyst plan or above].)
### Note
* If the token's market cap is not verified by the team, the API response will return `null` for its market cap value, even though it has a displayed value on GeckoTerminal, which might not be accurate as it often matches the Fully Diluted Valuation (FDV).
* Attributes specified in the `include` param will be returned under the top-level "included" key.
* This endpoint returns up to 20 pools per page. Use the `page` param to navigate more results.
* `page`: Pagination beyond 10 pages is available for [Paid Plan](https://www.coingecko.com/en/api/pricing) subscribers (Analyst plan or above).
* Cache/Update frequency: every 60 seconds.
* GeckoTerminal equivalent page (example): [https://www.geckoterminal.com/base/uniswap-v3-base/pools?sort=-24h\_transactions](https://www.geckoterminal.com/base/uniswap-v3-base/pools?sort=-24h_transactions)
# Top Pools by Network
Source: https://docs.coingecko.com/v3.0.1/reference/top-pools-network
v3.0.1/reference/api-reference/onchain-demo.json get /networks/{network}/pools
This endpoint allows you to **query all the top pools based on the provided network**
### Tips
* You may include values such as `page` to specify which page of responses you would like to show.
* For more flexibility in retrieving an exact list of pools that match your specific needs, consider using the /pools/megafilter endpoint (available for [Paid Plan](https://www.coingecko.com/en/api/pricing) subscribers \[Analyst plan or above].)
### Note
* If the token's market cap is not verified by the team, the API response will return `null` for its market cap value, even though it has a displayed value on GeckoTerminal, which might not be accurate as it often matches the Fully Diluted Valuation (FDV).
* Attributes specified in the `include` param will be returned under the top-level "included" key.
* This endpoint returns up to 20 pools per page. Use the `page` param to navigate more results.
* `page`: Pagination beyond 10 pages is available for [Paid Plan](https://www.coingecko.com/en/api/pricing) subscribers (Analyst plan or above).
* Cache/Update frequency: every 60 seconds.
* GeckoTerminal equivalent page (example): [https://www.geckoterminal.com/solana/pools?sort=-24h\_transactions](https://www.geckoterminal.com/solana/pools?sort=-24h_transactions)
# Trending Pools List
Source: https://docs.coingecko.com/v3.0.1/reference/trending-pools-list
v3.0.1/reference/api-reference/onchain-demo.json get /networks/trending_pools
This endpoint allows you to **query all the trending pools across all networks on GeckoTerminal**
### Tips
* You may include values such as `page` to specify which page of responses you would like to show.
* For more flexibility in retrieving an exact list of pools that match your specific needs, consider using the /pools/megafilter endpoint (available for [Paid Plan](https://www.coingecko.com/en/api/pricing) subscribers \[Analyst plan or above].)
### Note
* If the token's market cap is not verified by the team, the API response will return `null` for its market cap value, even though it has a displayed value on GeckoTerminal, which might not be accurate as it often matches the Fully Diluted Valuation (FDV).
* Attributes specified in the `include` param will be returned under the top-level "included" key.
* This endpoint returns up to 20 pools per page. Use the `page` param to navigate more results.
* `page`: Pagination beyond 10 pages is available for [Paid Plan](https://www.coingecko.com/en/api/pricing) subscribers (Analyst plan or above).
* Cache/Update frequency: every 60 seconds.
* GeckoTerminal equivalent page (example): [https://www.geckoterminal.com](https://www.geckoterminal.com)
# Trending Pools by Network
Source: https://docs.coingecko.com/v3.0.1/reference/trending-pools-network
v3.0.1/reference/api-reference/onchain-demo.json get /networks/{network}/trending_pools
This endpoint allows you to **query the trending pools based on the provided network**
### Tips
* You may include values such as `page` to specify which page of responses you would like to show.
* For more flexibility in retrieving an exact list of pools that match your specific needs, consider using the /pools/megafilter endpoint (available for [Paid Plan](https://www.coingecko.com/en/api/pricing) subscribers \[Analyst plan or above].)
### Note
* If the token's market cap is not verified by the team, the API response will return `null` for its market cap value, even though it has a displayed value on GeckoTerminal, which might not be accurate as it often matches the Fully Diluted Valuation (FDV).
* Attributes specified in the `include` param will be returned under the top-level "included" key.
* This endpoint returns up to 20 pools per page. Use the `page` param to navigate more results.
* `page`: Pagination beyond 10 pages is available for [Paid Plan](https://www.coingecko.com/en/api/pricing) subscribers (Analyst plan or above).
* Cache/Update frequency: every 60 seconds.
* GeckoTerminal equivalent page (example): [https://www.geckoterminal.com/base/pools](https://www.geckoterminal.com/base/pools)
# Trending Search List
Source: https://docs.coingecko.com/v3.0.1/reference/trending-search
v3.0.1/reference/api-reference/coingecko-demo.json get /search/trending
This endpoint allows you **query trending search coins, NFTs and categories on CoinGecko in the last 24 hours**
### Note
* The endpoint currently supports:
* Top 15 trending coins (sorted by the most popular user searches)
* Top 7 trending NFTs (sorted by the highest percentage change in floor prices)
* Top 5 trending categories (sorted by the most popular user searches)
* Cache / Update Frequency: every 10 minutes for all the API plans.
# WSS:CGSimplePrice
Source: https://docs.coingecko.com/websocket/cgsimpleprice
Subscribe to receive real-time price updates for tokens, as seen on CoinGecko.com
This Websocket channel allows you to subscribe to real-time updates of price changes for token.
* Lookup by Coin ID
* It will return price & market data of the top pool of the specified token
**Update Frequency**: as fast as 8s, for large cap and actively traded coins.
### Data Payload
| | Field | Type | Description | Example |
| ---- | --------------------------------- | ------- | ---------------------------------------------------------------------------------------------------- | ---------------------- |
| `c` | `channel_type` | string | Indicates the type of channel subscribed to. | C1 |
| `i` | `coin_id` | string | Identifier of the coins. Check full list of IDs [here](https://api.coingecko.com/api/v3/coins/list). | `ethereum`, `usd-coin` |
| `p` | `usd_price` | string | Current token price in USD. | 3639.78228844745 |
| `pp` | `usd_price_24h_change_percentage` | float | Percentage change in token price over the last 24 hours. | 3.566 |
| `m` | `usd_market_cap` | float | Market capitalization in USD. | 123 |
| `v` | `usd_24h_vol` | float | 24-hour trading volume in USD. | 31233333.33 |
| `t` | `last_updated_at` | integer | Timestamp of the last data update in UNIX time. | 1709542750 |
**Tips**: The Websocket payload will use the value `null` when specific data is unavailable. Ensure your application is capable of handling null values for fields that may not always have data.
***
## 1. Establish Connection to Websocket
```bash Bash
wss://stream.coingecko.com/v1?x_cg_pro_api_key=YOUR_KEY
OR
wss://stream.coingecko.com/v1
x-cg-pro-api-key: YOUR_KEY
```
## 2. Subscribe to a specific channel - CGSimplePrice
**Input Example:**
```json JSON
{"command":"subscribe","identifier":"{\"channel\":\"CGSimplePrice\"}"}
```
**Output Example**:
```json JSON
{"type":"confirm_subscription","identifier":"{\"channel\":\"CGSimplePrice\"}"}
```
## 3. Stream CGSimplePrice
**Input Example:**
```json JSON
{"command":"message","identifier":"{\"channel\":\"CGSimplePrice\"}","data":"{\"coin_id\":[\"ethereum\",\"bitcoin\"],\"action\":\"set_tokens\"}"}
```
**Output Example**:
```json JSON
{
"code": 2000,
"message": "Subscription is successful for ethereum"
}
```
**Output Example**:
```json JSON
{
"c": "C1",
"i": "ethereum",
"m": 312938652962.8005,
"p": 2591.080889351465,
"pp": 1.3763793110454519,
"t": 1747808150.269067,
"v": 20460612214.801384
}
```
The output keys will be in random order.
## Tips:
### Un-subscribe to stop streaming CGSimplePrice data
**Input Example:** Unsubscribe for 1 specific token data:
```json JSON
{"command":"message","identifier":"{\"channel\":\"CGSimplePrice\"}","data":"{\"coin_id\":[\"ethereum\"],\"action\":\"unset_tokens\"}"}
```
**Output Example**:
```json JSON
{
"code": 2000,
"message": "Unsubscription is successful for ethereum"
}
```
**Input Example:** Unsubscribe from CGSimplePrice channel and all token data:
```json JSON
{"command":"unsubscribe","identifier":"{\"channel\":\"CGSimplePrice\"}"}
```
**Output Example**:
```json JSON
{
"code": 2000,
"message": "Unsubscription is successful for all tokens"
}
```
# WebSocket (Beta)
Source: https://docs.coingecko.com/websocket/index
CoinGecko API: Real-Time Crypto Data with WebSockets
## Access Real-Time Crypto Data Instantly with CoinGecko WebSockets
In the fast-paced world of cryptocurrency, speed matters. Our official CoinGecko WebSocket API provides a dedicated, persistent connection for real-time data streaming, ensuring you receive critical market updates the moment they happen.
Move beyond traditional polling and embrace the power of instant data delivery for your trading bots, dashboards, and analytical applications.
* CoinGecko Websocket is now **exclusively available as optional add-ons** for [Enterprise plan](https://www.coingecko.com/en/api/pricing) clients only.
* For existing Enterprise plan clients, kindly contact the CoinGecko team to confirm your Websocket access, maximum limits for socket connections, and subscriptions per socket.
* If you're interested to join Websocket trial, please submit your interest [here](https://docs.google.com/forms/d/e/1FAIpQLSf33wT9liXr7hfx3IPKnHs4zBR61zLv0rart6s27_6HND8Uwg/viewform). You may reach out to soonaik\@coingecko\[dot]com for feedback & suggestions.
### Channel & Data Support
| Websocket Channel | Channel Code | Details |
| ------------------------------------------------------------- | ------------ | ------------------------------------------------------------------------------------------------------------- |
| [OnchainSimpleTokenPrice](/websocket/onchainsimpletokenprice) | G1 | Subscribe to receive real-time price updates for tokens, as seen on GeckoTerminal.com |
| [CGSimplePrice](/websocket/cgsimpleprice) | C1 | Subscribe to receive real-time price updates for tokens, as seen on CoinGecko.com |
| [OnchainTrade](/websocket/wss-onchain-trade) | G2 | Subscribe to receive real-time transaction updates for pools, as seen on GeckoTerminal.com |
| [\[OnchainOHLCV\]](/websocket/wssonchainohlcv/) | G3 | Subscribe to receive real-time OHLCV (Open, High, Low, Close, Volume) for pools, as seen on GeckoTerminal.com |
| (More coming soon!) | | |
### **Notes**
* **Real-Time Data**: Once subscribed, you will start receiving real-time data updates based on your subscriptions. The received data will be in JSON format and will contain the relevant information for the subscribed event.
* **Close Connection:** When you're done receiving updates or want to close the WebSocket connection, you can gracefully close the connection.
* **Security Considerations:** Ensure that you keep your Pro-API key secure and do not expose it publicly in your code or any public repositories.
### Connection Handling
To provide you with the most reliable and efficient experience, please be aware of the following regarding our WebSocket connections:
1. **Connection Liveliness (Ping/Pong Mechanism):**
* To ensure your connection remains active and healthy, we send a **"ping" signal every 10 seconds**.
* If we **do not receive a "pong" response from your client within 20 seconds** of sending a ping, we will automatically disconnect the connection.
* **Action Required (Client-Side)**: Your WebSocket client must be configured to respond to our ping messages with a pong. Most WebSocket libraries handle this automatically, but please verify your implementation to ensure it's sending pong responses. This is critical for maintaining your connection.
2. **Planned Disconnections (Deployments & Reboots):**
* **Purpose**: From time to time, we will perform system reboots or deploy new versions of our service to implement updates, bug fixes, and improvements. These actions require a graceful restart of our servers.
* **Impact**: During these periods, your active WebSocket connections might be temporarily disconnected.
* **Action Required (Client-Side)**: It is essential that your application is designed to automatically attempt to re-establish the WebSocket connection if it detects a disconnection. Implementing an exponential backoff strategy for reconnection attempts is highly recommended to avoid overwhelming our servers during a widespread disconnection event.
# WSS:OnchainSimpleTokenPrice
Source: https://docs.coingecko.com/websocket/onchainsimpletokenprice
Subscribe to receive real-time price updates for tokens, as seen on GeckoTerminal.com
This Websocket channel allows you to subscribe to real-time updates of price changes for token.
* Lookup by Network + Token Address
* It will return price and market data of the top pool of the specified token
**Update Frequency**: as fast as 1s, for actively traded tokens.
### Data Payload
| | Field | Type | Description | Example |
| ---- | --------------------------------- | ------- | -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------- |
| `c` | `channel_type` | string | Indicates the type of channel subscribed to. | G1 |
| `n` | `network_id` | string | Identifier of the blockchain network. Check full list of IDs [here](https://api.geckoterminal.com/api/v2/networks?page=1). | `eth` |
| `ta` | `token_address` | string | Contract address of the token on the blockchain. | `0xc02aaa39b223fe8d0a0e5c4f27ead9083c756cc2` |
| `p` | `usd_price` | float | Current token price in USD. | 3639.78228844745 |
| `pp` | `usd_price_24h_change_percentage` | float | Percentage change in token price over the last 24 hours. | 3.566 |
| `m` | `usd_market_cap` | float | Market capitalization in USD. | 123 |
| `v` | `usd_24h_vol` | float | 24-hour trading volume in USD. | 31233333.33 |
| `t` | `last_updated_at` | integer | Timestamp of the last data update in UNIX time. | 1709542750 |
**Tips**: The Websocket payload will use the value `null` when specific data is unavailable. Ensure your application is capable of handling null values for fields that may not always have data.
***
## 1. Establish Connection to Websocket
```bash Bash
wss://stream.coingecko.com/v1?x_cg_pro_api_key=YOUR_KEY
OR
wss://stream.coingecko.com/v1
x-cg-pro-api-key: YOUR_KEY
```
## 2. Subscribe to a specific channel - OnchainSimpleTokenPrice
**Input Example:**
```json JSON
{"command":"subscribe","identifier":"{\"channel\":\"OnchainSimpleTokenPrice\"}"}
```
**Output Example**:
```json JSON
{"type":"confirm_subscription","identifier":"{\"channel\":\"OnchainSimpleTokenPrice\"}"}
```
## 3. Stream OnchainSimpleTokenPrice data
**Input Example:**
```json JSON
{"command":"message","identifier":"{\"channel\":\"OnchainSimpleTokenPrice\"}","data":"{\"network_id:token_addresses\":[\"bsc:0x55d398326f99059ff775485246999027b3197955\"],\"action\":\"set_tokens\"}"}
```
**Output Example**:
```json JSON
{
"code": 2000,
"message": "Subscription successful for bsc:0x55d398326f99059ff775485246999027b3197955"
}
```
**Output Example**:
```json JSON
{
"c": "G1",
"n": "bsc",
"ta": "0x55d398326f99059ff775485246999027b3197955",
"p": 0.999457718373347,
"pp": -0.009028866490825653,
"m": 1317802988326.25,
"v": 1476864199.38384,
"t": 1737427063
}
```
The output keys will be in random order.
## Tips:
### Un-subscribe to stop streaming OnchainSimpleTokenPrice data
**Input Example:** Unsubscribe for 1 specific token data:
```json JSON
{"command":"message","identifier":"{\"channel\":\"OnchainSimpleTokenPrice\"}","data":"{\"network_id:token_addresses\":[\"bsc:0x55d398326f99059ff775485246999027b3197955\"],\"action\":\"unset_tokens\"}"}
```
**Output Example**:
```json JSON
{
"code":2000,
"message":"Unsubscription is successful for bsc:0x55d398326f99059ff775485246999027b3197955"
}
```
**Input Example:** Unsubscribe from OnchainSimpleTokenPrice channel and all token data:
```json JSON
{"command":"unsubscribe","identifier":"{\"channel\":\"OnchainSimpleTokenPrice\"}"}
```
**Output Example**:
```json JSON
{
"code":2000,
"message":"Unsubscription is successful for all tokens"
}
```
# WSS:OnchainTrade
Source: https://docs.coingecko.com/websocket/wss-onchain-trade
Subscribe to receive real-time transaction (trade/swap) updates for pools, as seen on GeckoTerminal.com
This Websocket channel allows you to subscribe to real-time updates of token trades of a pool.
* Lookup by Network + Pool Address
* It will return transaction type (buy/sell), tx hash, amount of token transacted, volume, and current price data of the specified pool.
**Update Frequency**: as fast as 0.1s, for actively traded pools.
**Tips**: use this Rest API endpoint [Top Pools by Token Address](/reference/top-pools-contract-address) to obtain contract address of the most liquid pool.
### Data Payload
| | Field | Type | Description | Example |
| ---- | ------------------------- | ------- | -------------------------------------------------------------------------------------------------------------------------- | -------------------------- |
| `ch` | `channel_type` | string | Indicates the type of channel subscribed to. | G2 |
| `n` | `network_id` | string | Identifier of the blockchain network. Check full list of IDs [here](https://api.geckoterminal.com/api/v2/networks?page=1). | eth |
| `pa` | `pool_address` | string | Contract address of the pool. | `0x88e6a0c2dd6fcb..3f5640` |
| `tx` | `tx_hash` | string | transaction hash | `0x0b8ac5a16c2d5a..4d422` |
| `ty` | `type` | string | type of transaction (`b` for buy or `s` for sell) | b |
| `to` | `token_amount` | float | Amount of token transacted. | 100 |
| `vo` | `volume_in_usd` | float | The transaction value in USD. | 1000 |
| `pc` | `price_in_token_currency` | float | Current token price in target token currency | 3639.78228844745 |
| `pu` | `price_in_usd` | float | Current token price in USD | 3.566 |
| `t` | `last_updated_at` | integer | Timestamp of the last data update in UNIX time. | 1752072129000 |
**Tips**: The Websocket payload will use the value `null` when specific data is unavailable. Ensure your application is capable of handling null values for fields that may not always have data.
***
## 1. Establish Connection to Websocket
```bash Bash
wss://stream.coingecko.com/v1?x_cg_pro_api_key=YOUR_KEY
OR
wss://stream.coingecko.com/v1
x-cg-pro-api-key: YOUR_KEY
```
## 2. Subscribe to a specific channel - OnchainTrade
**Input Example:**
```json JSON
{"command":"subscribe","identifier":"{\"channel\":\"OnchainTrade\"}"}
```
**Output Example**:
```json JSON
{"type":"confirm_subscription","identifier":"{\"channel\":\"OnchainTrade\"}"}
```
## 3. Stream OnchainTrade data
**Input Example:**
```json JSON
{"command":"message","identifier":"{\"channel\":\"OnchainTrade\"}","data":"{\"network_id:pool_addresses\":[\"bsc:0x172fcd41e0913e95784454622d1c3724f546f849\"],\"action\":\"set_pools\"}"}
```
**Output Example**:
```json JSON
{
"code": 2000,
"message": "Subscription successful for bsc:0x172fcd41e0913e95784454622d1c3724f546f849"
}
```
**Output Example**:
```json JSON
{
"c": "G2",
"n": "bsc",
"pa": "0x172fcd41e0913e95784454622d1c3724f546f849",
"tx": "0x3e71ee7da66000a5a92f13abd2ae95e0abc0bc828087d8dd210338fd262cf6c9",
"ty": "b",
"to": "1.51717616246451",
"vo": "2.75413132131313",
"pc": "0.000274100995437363"
"pu": "3656.8970003075",
"t": 1724927796000
}
```
The output keys will be in random order.
## Tips:
### Un-subscribe to stop streaming OnchainTrade data
**Input Example:** Unsubscribe for 1 specific pool data:
```json JSON
{"command":"message","identifier":"{\"channel\":\"OnchainTrade\"}","data":"{\"network_id:pool_addresses\":[\"bsc:0x172fcd41e0913e95784454622d1c3724f546f849\"],\"action\":\"unset_pools\"}"}
```
**Output Example**:
```json JSON
{
"code":2000,
"message":"Unsubscription is successful for bsc:0x172fcd41e0913e95784454622d1c3724f546f849"
}
```
**Input Example:** Unsubscribe from OnchainTrade channel and all pools data:
```json JSON
{"command":"unsubscribe","identifier":"{\"channel\":\"OnchainTrade\"}"}
```
**Output Example**:
```json JSON
{
"code":2000,
"message":"Unsubscription is successful for all pools"
}
```
# WSS:OnchainOHLCV
Source: https://docs.coingecko.com/websocket/wssonchainohlcv
Subscribe to receive real-time OHLCV updates for pools, as seen on GeckoTerminal.com
This Websocket channel allows you to subscribe to real-time OHLCV updates of a pool.
* Lookup by Network + Pool Address
* It will return **O**pen, **H**igh, **L**ow, **C**lose price and **V**olume data the specified pool.
**Update Frequency**: as fast as 1s, for actively traded pools.
**Tips**: use this Rest API endpoint [Top Pools by Token Address](https://docs.coingecko.com/reference/top-pools-contract-address#/) to obtain contract address of the most liquid pool.
### **Notes**
* Interval options: 1s / 1m / 5m / 1h / 2h / 4h / 8h
* You may stream the pool ohlcv data based on `base` or `quote` token of a pool.
* Please note that your subscription quota is based on the number of **unique data streams** you request. Each unique combination of an interval and token for a given pool is considered a **distinct subscription** and will count towards your max subscription limit.
### Data Payload
| | Field | Type | Description | Example |
| ---- | -------------- | ------- | -------------------------------------------------------------------------------------------------------------------------- | -------------------------- |
| `ch` | `channel_type` | string | Indicates the type of channel subscribed to. | G3 |
| `n` | `network_id` | string | Identifier of the blockchain network. Check full list of IDs [here](https://api.geckoterminal.com/api/v2/networks?page=1). | eth |
| `pa` | `pool_address` | string | Contract address of the pool. | `0x88e6a0c2dd6fcb..3f5640` |
| `to` | `token` | string | `base` or `quote` token | `base` |
| `i` | `interval` | string | Interval or resolution of the candle: 1s / 1m / 5m / 1h / 2h / 4h / 8h | 1m |
| `o` | `open` | float | Open price in USD | 3539 |
| `h` | `high` | float | High price in USD | 3541 |
| `l` | `low` | float | Low price in USD | 3530 |
| `c` | `close` | float | Close price in USD | 3531 |
| `v` | `volume` | float | Volume in USD | 323333 |
| `t` | `timestamp` | integer | Opening timestamp of candle interval | 1753803600 |
**Tips**: The Websocket payload will use the value `null` when specific data is unavailable. Ensure your application is capable of handling null values for fields that may not always have data.
***
## 1. Establish Connection to Websocket
```bash Bash
wss://stream.coingecko.com/v1?x_cg_pro_api_key=YOUR_KEY
OR
wss://stream.coingecko.com/v1
x-cg-pro-api-key: YOUR_KEY
```
## 2. Subscribe to a specific channel - OnchainOHLCV
**Input Example:**
```json JSON
{"command":"subscribe","identifier":"{\"channel\":\"OnchainOHLCV\"}"}
```
**Output Example**:
```json JSON
{"type":"confirm_subscription","identifier":"{\"channel\":\"OnchainOHLCV\"}"}
```
## 3. Stream OnchainOHLCV data
**Input Example:** (1 minute interval and base token of a pool)
* `Interval` options: 1s / 1m / 5m / 1h / 2h / 4h / 8h
* You may stream the pool ohlcv data of 'base' or 'quote' `token`.
```json JSON
{"command":"message","identifier":"{\"channel\":\"OnchainOHLCV\"}","data":"{\"network_id:pool_addresses\":[\"bsc:0x172fcd41e0913e95784454622d1c3724f546f849\"],\"interval\":\"1m\",\"token\":\"base\",\"action\":\"set_pools\"}"}
```
**Output Example**:
```json JSON
{
"code": 2000,
"message": "Subscription successful for bsc:0x172fcd41e0913e95784454622d1c3724f546f849:1m:base"
}
```
**Output Example**:
```json JSON
{
"c": 0.999727235252031,
"ch": "G3",
"h": 0.999974654065411,
"i": "1m",
"l": 0.999353212178554,
"n": "bsc",
"o": 0.999570907451071,
"pa": "0x172fcd41e0913e95784454622d1c3724f546f849",
"t": 1753886760,
"to": "base",
"v": 63932.29404921795
}
```
The output keys will be in random order.
## Tips:
### Un-subscribe to stop streaming OnchainOHLCV data
**Input Example:** Unsubscribe for 1 specific pool data:
```json JSON
{"command":"message","identifier":"{\"channel\":\"OnchainOHLCV\"}","data":"{\"network_id:pool_addresses\":[\"eth:0xc7bbec68d12a0d1830360f8ec58fa599ba1b0e9b\"],\"interval\":\"1m\",\"token\":\"base\",\"action\":\"unset_pools\"}"}
```
**Output Example**:
```json JSON
{
"code":2000,
"message":"Unsubscription is successful for eth:0xc7bbec68d12a0d1830360f8ec58fa599ba1b0e9b:1m:base"
}
```
**Input Example:** Unsubscribe from OnchainOHLCV channel and all pools data:
```json JSON
{"command":"unsubscribe","identifier":"{\"channel\":\"OnchainOHLCV\"}"}
```
**Output Example**:
```json JSON
{
"code":2000,
"message":"Unsubscription is successful for all pools"
}
```