charieswei
/
vibe-coding-cn
mirror of https://github.com/tukuaiai/vibe-coding-cn.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
vibe-coding-cn/assets/skills/coingecko/references/coins.md

2597 lines
140 KiB
Markdown
Raw Blame History

# Coingecko - Coins
**Pages:** 65
---
## 👑 Total Supply Chart by ID
**URL:** llms-txt#👑-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**
* 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.
</Note>
---
## Trending Search List
**URL:** llms-txt#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**
* 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.
</Note>
---
## Coins List with Market Data
**URL:** llms-txt#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**
* 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`](https://docs.coingecko.com/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.
</Tip>
* 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).
</Note>
---
## Coin Historical Chart Data within Time Range by Token Address
**URL:** llms-txt#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**
* 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`](https://docs.coingecko.com/v3.0.1/reference/coins-list) endpoint (`include platform = true`).
</Tip>
* 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.
</Note>
---
## 💼 Categories List
**URL:** llms-txt#💼-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**
* You can retrieve pools or tokens of a specific category with this endpoint: [Pools by Category ID](https://docs.coingecko.com/reference/pools-category).
* GeckoTerminal categories are different from [CoinGecko categories](https://docs.coingecko.com/reference/coins-categories-list).
</Tip>
* 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).
</Note>
---
## Search Pools
**URL:** llms-txt#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**
* 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.
</Tip>
* 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.
</Note>
---
## Crypto Treasury Holdings by Entity ID
**URL:** llms-txt#crypto-treasury-holdings-by-entity-id
Source: https://docs.coingecko.com/v3.0.1/reference/public-treasury-entity
v3.0.1/reference/api-reference/coingecko-demo.json get /public_treasury/{entity_id}
This endpoint allows you **query public companies & governments' cryptocurrency holdings** by Entity ID
* CoinGecko equivalent page: [https://www.coingecko.com/en/treasuries/bitcoin](https://www.coingecko.com/en/treasuries/bitcoin)
* Cache / Update Frequency: every 5 minutes for all the API plans.
</Note>
---
## Coins Categories List with Market Data
**URL:** llms-txt#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**
* 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.
</Note>
---
## OnchainSimpleTokenPrice
**URL:** llms-txt#onchainsimpletokenprice
**Contents:**
- Data Payload
- 1. Establish Connection to Websocket
- 2. Subscribe to a specific channel - OnchainSimpleTokenPrice
- 3. Stream OnchainSimpleTokenPrice data
- Tips:
- Un-subscribe to stop streaming OnchainSimpleTokenPrice data
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.
| | 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
<CodeGroup>
</CodeGroup>
## 2. Subscribe to a specific channel - OnchainSimpleTokenPrice
<CodeGroup>
</CodeGroup>
<CodeGroup>
</CodeGroup>
## 3. Stream OnchainSimpleTokenPrice data
<CodeGroup>
</CodeGroup>
<CodeGroup>
</CodeGroup>
<CodeGroup>
</CodeGroup>
The output keys will be in random order.
### Un-subscribe to stop streaming OnchainSimpleTokenPrice data
**Input Example:** Unsubscribe for 1 specific token data:
<CodeGroup>
</CodeGroup>
<CodeGroup>
</CodeGroup>
**Input Example:** Unsubscribe from OnchainSimpleTokenPrice channel and all token data:
<CodeGroup>
</CodeGroup>
<CodeGroup>
</CodeGroup>
**Examples:**
Example 1 (unknown):
```unknown
</CodeGroup>
## 2. Subscribe to a specific channel - OnchainSimpleTokenPrice
**Input Example:**
<CodeGroup>
```
Example 2 (unknown):
```unknown
</CodeGroup>
**Output Example**:
<CodeGroup>
```
Example 3 (unknown):
```unknown
</CodeGroup>
## 3. Stream OnchainSimpleTokenPrice data
**Input Example:**
<CodeGroup>
```
Example 4 (unknown):
```unknown
</CodeGroup>
**Output Example**:
<CodeGroup>
```
---
## OnchainOHLCV
**URL:** llms-txt#onchainohlcv
**Contents:**
- Data Payload
- 1. Establish Connection to Websocket
- 2. Subscribe to a specific channel - OnchainOHLCV
- 3. Stream OnchainOHLCV data
- Tips:
- Un-subscribe to stop streaming OnchainOHLCV data
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.
<Note>
### **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.
</Note>
| | 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
<CodeGroup>
</CodeGroup>
## 2. Subscribe to a specific channel - OnchainOHLCV
<CodeGroup>
</CodeGroup>
<CodeGroup>
</CodeGroup>
## 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`.
<CodeGroup>
</CodeGroup>
<CodeGroup>
</CodeGroup>
<CodeGroup>
</CodeGroup>
The output keys will be in random order.
### Un-subscribe to stop streaming OnchainOHLCV data
**Input Example:** Unsubscribe for 1 specific pool data:
<CodeGroup>
</CodeGroup>
<CodeGroup>
</CodeGroup>
**Input Example:** Unsubscribe from OnchainOHLCV channel and all pools data:
<CodeGroup>
</CodeGroup>
<CodeGroup>
</CodeGroup>
**Examples:**
Example 1 (unknown):
```unknown
</CodeGroup>
## 2. Subscribe to a specific channel - OnchainOHLCV
**Input Example:**
<CodeGroup>
```
Example 2 (unknown):
```unknown
</CodeGroup>
**Output Example**:
<CodeGroup>
```
Example 3 (unknown):
```unknown
</CodeGroup>
## 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`.
<CodeGroup>
```
Example 4 (unknown):
```unknown
</CodeGroup>
**Output Example**:
<CodeGroup>
```
---
## Coin Historical Data by ID
**URL:** llms-txt#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**
* You may obtain the coin ID (API ID) via several ways:
* refers to respective coin page and find 'API ID'.
* refers to [`/coins/list`](https://docs.coingecko.com/v3.0.1/reference/coins-list) endpoint.
* refers to Google Sheets [here](https://docs.google.com/spreadsheets/d/1wTTuxXt8n9q7C4NDXqQpI3wpKu1_5bGVmP9Xz0XGSyU/edit?usp=sharing).
</Tip>
* 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.
</Note>
---
## Coin Historical Chart Data by Token Address
**URL:** llms-txt#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**
* 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`](https://docs.coingecko.com/v3.0.1/reference/coins-list) endpoint (`include platform = true`).
</Tip>
* 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.
</Note>
---
## CoinGecko MCP Server (Beta)
**URL:** llms-txt#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.
<img src="https://mintcdn.com/coingecko/b3Fla9Sm0TsVrJN4/images/reference/63500e3-image.png?fit=max&auto=format&n=b3Fla9Sm0TsVrJN4&q=85&s=02ca3c105f2e635a6f2c7d055295f0d0" alt="" data-og-width="1200" width="1200" data-og-height="628" height="628" data-path="images/reference/63500e3-image.png" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/coingecko/b3Fla9Sm0TsVrJN4/images/reference/63500e3-image.png?w=280&fit=max&auto=format&n=b3Fla9Sm0TsVrJN4&q=85&s=1720600784a5461c52e10e227df80b7c 280w, https://mintcdn.com/coingecko/b3Fla9Sm0TsVrJN4/images/reference/63500e3-image.png?w=560&fit=max&auto=format&n=b3Fla9Sm0TsVrJN4&q=85&s=293707f46e3f25f53958009a55744b3b 560w, https://mintcdn.com/coingecko/b3Fla9Sm0TsVrJN4/images/reference/63500e3-image.png?w=840&fit=max&auto=format&n=b3Fla9Sm0TsVrJN4&q=85&s=f4ace3ad35e9091f9e89a9d24dd1f169 840w, https://mintcdn.com/coingecko/b3Fla9Sm0TsVrJN4/images/reference/63500e3-image.png?w=1100&fit=max&auto=format&n=b3Fla9Sm0TsVrJN4&q=85&s=c904edee1f977ba97e1e659498da6daa 1100w, https://mintcdn.com/coingecko/b3Fla9Sm0TsVrJN4/images/reference/63500e3-image.png?w=1650&fit=max&auto=format&n=b3Fla9Sm0TsVrJN4&q=85&s=cad8e9cba2ce58e6142c92359fefa25a 1650w, https://mintcdn.com/coingecko/b3Fla9Sm0TsVrJN4/images/reference/63500e3-image.png?w=2500&fit=max&auto=format&n=b3Fla9Sm0TsVrJN4&q=85&s=a7b36813341277fed347efe5b18b7967 2500w" />
<Warning>
### 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).
</Warning>
---
## Token Data by Token Address
**URL:** llms-txt#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**
* 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`](https://docs.coingecko.com/v3.0.1/reference/token-info-contract-address) instead.
</Tip>
* 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.
* Set `include_composition=true` to surface the balance and liquidity value of the pool's base and quote tokens. (requires `include=top_pools`)
* For tokens on a bonding curve (i.e. non-graduated tokens from launchpads), the response will include a `launchpad_details` object containing their graduation status and details.
* Cache/Update frequency: every 60 seconds.
</Note>
---
## Crypto Global Market Data
**URL:** llms-txt#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**
* Cache / Update Frequency: every 10 minutes for all the API plans.
</Note>
---
## Pool Tokens Info by Pool Address
**URL:** llms-txt#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**
* 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}`](https://docs.coingecko.com/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](https://docs.coingecko.com/v3.0.1/reference/coins-id)
* [Coin Data by Token Address](https://docs.coingecko.com/v3.0.1/reference/coins-contract-address)
</Tip>
* `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`
* For tokens on a bonding curve (i.e. non-graduated tokens from launchpads), the response will include a `launchpad_details` object containing their graduation status and details.
</Note>
---
## Search Queries
**URL:** llms-txt#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**
* The responses are sorted in descending order by market cap.
* Cache / Update Frequency: every 15 minutes for all the API plans.
</Note>
---
## Unlock the Power of CoinGecko API with Unprecedented Ease
**URL:** llms-txt#unlock-the-power-of-coingecko-api-with-unprecedented-ease
**Contents:**
- Designed to make your life easier: Common Benefits of Our SDKs
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.
---
## Coin Historical Chart Data by ID
**URL:** llms-txt#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**
* You may obtain the coin ID (API ID) via several ways:
* refers to respective coin page and find 'API ID'.
* refers to [`/coins/list`](https://docs.coingecko.com/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.
</Tip>
* 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.
</Note>
---
## Coin Price by IDs
**URL:** llms-txt#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**
* You may obtain the coin ID (API ID) via several ways:
* refers to respective coin page and find 'API ID'.
* refers to [`/coins/list`](https://docs.coingecko.com/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.
</Tip>
* 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).
</Note>
---
## Specific Pool Data by Pool Address
**URL:** llms-txt#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**
* 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.
* Set `include_composition=true` to surface the balance and liquidity value of the pool's base and quote tokens.
* Pools on a bonding curve (e.g. non-graduated pools from launchpads) will return `launchpad_details` object with their graduation status and migration details.
* Cache/Update Frequency: every 60 seconds.
</Note>
---
## Coin Data by Token Address
**URL:** llms-txt#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**
<Warning>
### 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%3A-removal-of-twitter-followers-data) for more details.
</Warning>
* 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`](https://docs.coingecko.com/v3.0.1/reference/coins-list) endpoint (`include platform = true`).
</Tip>
* 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.
</Note>
---
## Coin Data by ID
**URL:** llms-txt#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**
* You may obtain the coin `id` (API ID) via several ways:
* refers to respective coin page and find "API ID".
* refers to [`/coins/list`](https://docs.coingecko.com/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.
</Tip>
* Tickers are limited to 100 items, to get more tickers, please go to [/coins/{id}/tickers](https://docs.coingecko.com/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).
</Note>
---
## 1. Get data by ID or Address
**URL:** llms-txt#1.-get-data-by-id-or-address
**Contents:**
- Methods to query price & market data of coins
- a. Coin ID
- b. Contract Address
- Specify target currency to return
- Other way to obtain coin prices & market data
Source: https://docs.coingecko.com/docs/1-get-data-by-id-or-address
## Methods to query price & market data of coins
Using [/simple/price](https://docs.coingecko.com/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](https://docs.coingecko.com/reference/coins-list) endpoint, example of responses:
<CodeGroup>
</CodeGroup>
* 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:
<Frame>
<img src="https://mintcdn.com/coingecko/a7cplMjqO5fc2v5e/images/docs/7bf604e-image.png?fit=max&auto=format&n=a7cplMjqO5fc2v5e&q=85&s=ca1093ad1577a2160c53ee6ea3c9de8c" data-og-width="2122" width="2122" data-og-height="1256" height="1256" data-path="images/docs/7bf604e-image.png" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/coingecko/a7cplMjqO5fc2v5e/images/docs/7bf604e-image.png?w=280&fit=max&auto=format&n=a7cplMjqO5fc2v5e&q=85&s=58b6818eb39f1cc1cb13bfb1b827e9ef 280w, https://mintcdn.com/coingecko/a7cplMjqO5fc2v5e/images/docs/7bf604e-image.png?w=560&fit=max&auto=format&n=a7cplMjqO5fc2v5e&q=85&s=debd856f53bd0349a94586da15246140 560w, https://mintcdn.com/coingecko/a7cplMjqO5fc2v5e/images/docs/7bf604e-image.png?w=840&fit=max&auto=format&n=a7cplMjqO5fc2v5e&q=85&s=4995bc412246ed062435c7700fce33b0 840w, https://mintcdn.com/coingecko/a7cplMjqO5fc2v5e/images/docs/7bf604e-image.png?w=1100&fit=max&auto=format&n=a7cplMjqO5fc2v5e&q=85&s=54503566448e1f70bfd6e3938ff18830 1100w, https://mintcdn.com/coingecko/a7cplMjqO5fc2v5e/images/docs/7bf604e-image.png?w=1650&fit=max&auto=format&n=a7cplMjqO5fc2v5e&q=85&s=45f0c1afb1803886ff058fe7682a3a2a 1650w, https://mintcdn.com/coingecko/a7cplMjqO5fc2v5e/images/docs/7bf604e-image.png?w=2500&fit=max&auto=format&n=a7cplMjqO5fc2v5e&q=85&s=f3d3d13f19af39c3c2918e06f9552bd6 2500w" />
</Frame>
### 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](https://docs.coingecko.com/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](https://docs.coingecko.com/reference/coins-list) endpoint (`include_platform=true`), example of responses:
<CodeGroup>
</CodeGroup>
* Look for the "Contract“ by visiting the info section of a coin page on CoinGecko.
* 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.
</Note>
<Frame>
<img src="https://mintcdn.com/coingecko/a7cplMjqO5fc2v5e/images/docs/576675c-image.png?fit=max&auto=format&n=a7cplMjqO5fc2v5e&q=85&s=d16b2cfd819ece1c689f6595081edcad" data-og-width="2096" width="2096" data-og-height="1484" height="1484" data-path="images/docs/576675c-image.png" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/coingecko/a7cplMjqO5fc2v5e/images/docs/576675c-image.png?w=280&fit=max&auto=format&n=a7cplMjqO5fc2v5e&q=85&s=2e16c3e076d1cd3f43af7fb949d2382a 280w, https://mintcdn.com/coingecko/a7cplMjqO5fc2v5e/images/docs/576675c-image.png?w=560&fit=max&auto=format&n=a7cplMjqO5fc2v5e&q=85&s=e46ee9cc8a1f9be560c3ea1940695a02 560w, https://mintcdn.com/coingecko/a7cplMjqO5fc2v5e/images/docs/576675c-image.png?w=840&fit=max&auto=format&n=a7cplMjqO5fc2v5e&q=85&s=c19faccaebd60eeeb79e8305ca20c609 840w, https://mintcdn.com/coingecko/a7cplMjqO5fc2v5e/images/docs/576675c-image.png?w=1100&fit=max&auto=format&n=a7cplMjqO5fc2v5e&q=85&s=68ad652fdbc4fc6739daaf8f0121a548 1100w, https://mintcdn.com/coingecko/a7cplMjqO5fc2v5e/images/docs/576675c-image.png?w=1650&fit=max&auto=format&n=a7cplMjqO5fc2v5e&q=85&s=330f42772de72f72af2759e0c417db30 1650w, https://mintcdn.com/coingecko/a7cplMjqO5fc2v5e/images/docs/576675c-image.png?w=2500&fit=max&auto=format&n=a7cplMjqO5fc2v5e&q=85&s=d9a988b003d06757a4f9886a9e047d58 2500w" />
</Frame>
* 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](https://docs.coingecko.com/reference/simple-supported-currencies) endpoint
## Other way to obtain coin prices & market data
Using [/coins/market ](https://docs.coingecko.com/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.
**Examples:**
Example 1 (unknown):
```unknown
</CodeGroup>
* 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:
<Frame>
<img src="https://mintcdn.com/coingecko/a7cplMjqO5fc2v5e/images/docs/7bf604e-image.png?fit=max&auto=format&n=a7cplMjqO5fc2v5e&q=85&s=ca1093ad1577a2160c53ee6ea3c9de8c" data-og-width="2122" width="2122" data-og-height="1256" height="1256" data-path="images/docs/7bf604e-image.png" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/coingecko/a7cplMjqO5fc2v5e/images/docs/7bf604e-image.png?w=280&fit=max&auto=format&n=a7cplMjqO5fc2v5e&q=85&s=58b6818eb39f1cc1cb13bfb1b827e9ef 280w, https://mintcdn.com/coingecko/a7cplMjqO5fc2v5e/images/docs/7bf604e-image.png?w=560&fit=max&auto=format&n=a7cplMjqO5fc2v5e&q=85&s=debd856f53bd0349a94586da15246140 560w, https://mintcdn.com/coingecko/a7cplMjqO5fc2v5e/images/docs/7bf604e-image.png?w=840&fit=max&auto=format&n=a7cplMjqO5fc2v5e&q=85&s=4995bc412246ed062435c7700fce33b0 840w, https://mintcdn.com/coingecko/a7cplMjqO5fc2v5e/images/docs/7bf604e-image.png?w=1100&fit=max&auto=format&n=a7cplMjqO5fc2v5e&q=85&s=54503566448e1f70bfd6e3938ff18830 1100w, https://mintcdn.com/coingecko/a7cplMjqO5fc2v5e/images/docs/7bf604e-image.png?w=1650&fit=max&auto=format&n=a7cplMjqO5fc2v5e&q=85&s=45f0c1afb1803886ff058fe7682a3a2a 1650w, https://mintcdn.com/coingecko/a7cplMjqO5fc2v5e/images/docs/7bf604e-image.png?w=2500&fit=max&auto=format&n=a7cplMjqO5fc2v5e&q=85&s=f3d3d13f19af39c3c2918e06f9552bd6 2500w" />
</Frame>
### 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](https://docs.coingecko.com/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](https://docs.coingecko.com/reference/coins-list) endpoint (`include_platform=true`), example of responses:
<CodeGroup>
```
---
## 💼 Top Token Holders by Token Address
**URL:** llms-txt#💼-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**
* 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.
</Note>
---
## 💼 Recently Added Coins
**URL:** llms-txt#💼-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**
* 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).
</Note>
---
## 3. Get Exchanges & NFT Data
**URL:** llms-txt#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](https://docs.coingecko.com/reference/coins-list) | [/nfts/list](https://docs.coingecko.com/reference/nfts-list) | [/exchanges/list](https://docs.coingecko.com/reference/exchanges-list) | [/derivatives/exchanges/list](https://docs.coingecko.com/reference/derivatives-exchanges-list) |
| Get latest market data | [/coins/\{id}](https://docs.coingecko.com/reference/coins-id) | [/nfts/\{id}](https://docs.coingecko.com/reference/nfts-id) | [/exchanges/\{id}](https://docs.coingecko.com/reference/exchanges-id) | [/derivatives/exchanges/\{id}](https://docs.coingecko.com/reference/derivatives-exchanges-id) |
| Get Historical Data | [/coins/\{id}/market\_chart](https://docs.coingecko.com/reference/coins-id-market-chart) | [/nfts/\{id}/market\_chart](https://docs.coingecko.com/reference/nfts-id-market-chart) | [/exchanges/\{id}/volume\_chart](https://docs.coingecko.com/reference/exchanges-id-volume-chart) | [/exchanges/\{id}/volume\_chart](https://docs.coingecko.com/reference/exchanges-id-volume-chart) |
---
## Coin Price by Token Addresses
**URL:** llms-txt#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**
* 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`](https://docs.coingecko.com/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.
</Tip>
* 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).
</Note>
---
## CoinGecko SDK (Beta)
**URL:** llms-txt#coingecko-sdk-(beta)
Source: https://docs.coingecko.com/docs/sdk
Official CoinGecko Typescript and Python SDKs — Crypto Price & Market Data API
<img src="https://mintcdn.com/coingecko/b3Fla9Sm0TsVrJN4/images/reference/581b968-image.png?fit=max&auto=format&n=b3Fla9Sm0TsVrJN4&q=85&s=338cddbf79001fc1af09c231833fb56d" alt="" data-og-width="1200" width="1200" data-og-height="628" height="628" data-path="images/reference/581b968-image.png" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/coingecko/b3Fla9Sm0TsVrJN4/images/reference/581b968-image.png?w=280&fit=max&auto=format&n=b3Fla9Sm0TsVrJN4&q=85&s=b51ad4738654ccfbf6c38d237f2de7fa 280w, https://mintcdn.com/coingecko/b3Fla9Sm0TsVrJN4/images/reference/581b968-image.png?w=560&fit=max&auto=format&n=b3Fla9Sm0TsVrJN4&q=85&s=32948ca8aa6db2f5be8ca04db5f3511e 560w, https://mintcdn.com/coingecko/b3Fla9Sm0TsVrJN4/images/reference/581b968-image.png?w=840&fit=max&auto=format&n=b3Fla9Sm0TsVrJN4&q=85&s=0dff376edd3aa927bc907c3bfec5db7d 840w, https://mintcdn.com/coingecko/b3Fla9Sm0TsVrJN4/images/reference/581b968-image.png?w=1100&fit=max&auto=format&n=b3Fla9Sm0TsVrJN4&q=85&s=235cc041b2c2396788caf8ea7d4b7587 1100w, https://mintcdn.com/coingecko/b3Fla9Sm0TsVrJN4/images/reference/581b968-image.png?w=1650&fit=max&auto=format&n=b3Fla9Sm0TsVrJN4&q=85&s=66081cce71c3a666f7ed69c20bc0ba3b 1650w, https://mintcdn.com/coingecko/b3Fla9Sm0TsVrJN4/images/reference/581b968-image.png?w=2500&fit=max&auto=format&n=b3Fla9Sm0TsVrJN4&q=85&s=03523526d5f8191e167eb9fbc877a1d1 2500w" />
---
## 💼 Top Gainers & Losers
**URL:** llms-txt#💼-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**
* 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).
</Note>
---
## 💼 Pools by Category ID
**URL:** llms-txt#💼-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**
* You can retrieve full list of categories id via this endpoint: [Categories List](https://docs.coingecko.com/reference/categories-list).
* You can retrieve tokens of a specific category, by flagging `include=base_token`.
* GeckoTerminal categories are different from [CoinGecko categories](https://docs.coingecko.com/reference/coins-categories-list).
</Tip>
* 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
* 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).
</Note>
---
## 💡 Example Prompts
**URL:** llms-txt#💡-example-prompts
**Contents:**
- Simple Queries
- Advanced Queries
- Creative and Fun Ideas
Tap into the full potential of CoinGecko data — use these prompts to kickstart your next AI build.
> * 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?
> * Show me the current top 10 cryptocurrencies by market cap. Include their price, 24h change, and total volume. Display this in an interactive table.
>
> <img src="https://mintcdn.com/coingecko/b3Fla9Sm0TsVrJN4/images/reference/9ef35ab-image.png?fit=max&auto=format&n=b3Fla9Sm0TsVrJN4&q=85&s=76c2d6cbda125a20f3d2d4ee8bd5b840" alt="" data-og-width="2915" width="2915" data-og-height="1884" height="1884" data-path="images/reference/9ef35ab-image.png" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/coingecko/b3Fla9Sm0TsVrJN4/images/reference/9ef35ab-image.png?w=280&fit=max&auto=format&n=b3Fla9Sm0TsVrJN4&q=85&s=c48640c27703887235b99f419b09ba12 280w, https://mintcdn.com/coingecko/b3Fla9Sm0TsVrJN4/images/reference/9ef35ab-image.png?w=560&fit=max&auto=format&n=b3Fla9Sm0TsVrJN4&q=85&s=0ae223b5ab2812b2dc516ebea4bad63b 560w, https://mintcdn.com/coingecko/b3Fla9Sm0TsVrJN4/images/reference/9ef35ab-image.png?w=840&fit=max&auto=format&n=b3Fla9Sm0TsVrJN4&q=85&s=50da86d6358bd614574590fec55e69f7 840w, https://mintcdn.com/coingecko/b3Fla9Sm0TsVrJN4/images/reference/9ef35ab-image.png?w=1100&fit=max&auto=format&n=b3Fla9Sm0TsVrJN4&q=85&s=948e0ca92b980bbfe5ba2afb76b3f34f 1100w, https://mintcdn.com/coingecko/b3Fla9Sm0TsVrJN4/images/reference/9ef35ab-image.png?w=1650&fit=max&auto=format&n=b3Fla9Sm0TsVrJN4&q=85&s=9762d7eda6e8d5516b4fdb6f551a0003 1650w, https://mintcdn.com/coingecko/b3Fla9Sm0TsVrJN4/images/reference/9ef35ab-image.png?w=2500&fit=max&auto=format&n=b3Fla9Sm0TsVrJN4&q=85&s=48de11fa6a230658b33645bf771fbabc 2500w" />
>
> * Generate a 30-day price chart for Ethereum (ETH) against USD, showing both price and trading volume.
>
> <img src="https://mintcdn.com/coingecko/b3Fla9Sm0TsVrJN4/images/reference/249fc22-image.png?fit=max&auto=format&n=b3Fla9Sm0TsVrJN4&q=85&s=b92c7f7e4c503e7d5b1e285f0901c850" alt="" data-og-width="2904" width="2904" data-og-height="1886" height="1886" data-path="images/reference/249fc22-image.png" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/coingecko/b3Fla9Sm0TsVrJN4/images/reference/249fc22-image.png?w=280&fit=max&auto=format&n=b3Fla9Sm0TsVrJN4&q=85&s=c3ac5ca1c3f030e3030df10fe6598321 280w, https://mintcdn.com/coingecko/b3Fla9Sm0TsVrJN4/images/reference/249fc22-image.png?w=560&fit=max&auto=format&n=b3Fla9Sm0TsVrJN4&q=85&s=99ba5dee1419b3f6d4a9500554643c7f 560w, https://mintcdn.com/coingecko/b3Fla9Sm0TsVrJN4/images/reference/249fc22-image.png?w=840&fit=max&auto=format&n=b3Fla9Sm0TsVrJN4&q=85&s=d255006760aa0d4c5c625ea1d610cf9c 840w, https://mintcdn.com/coingecko/b3Fla9Sm0TsVrJN4/images/reference/249fc22-image.png?w=1100&fit=max&auto=format&n=b3Fla9Sm0TsVrJN4&q=85&s=a959c53fc30a7ace129534b45d25a8cd 1100w, https://mintcdn.com/coingecko/b3Fla9Sm0TsVrJN4/images/reference/249fc22-image.png?w=1650&fit=max&auto=format&n=b3Fla9Sm0TsVrJN4&q=85&s=0429bc6d59230e2290787c0f7c4ddefb 1650w, https://mintcdn.com/coingecko/b3Fla9Sm0TsVrJN4/images/reference/249fc22-image.png?w=2500&fit=max&auto=format&n=b3Fla9Sm0TsVrJN4&q=85&s=ab3786ea42c1add908c744ca57da4090 2500w" />
### Creative and Fun Ideas
> * Create a quiz to tell me which cryptocurrency I am based on my personality.
>
> <img src="https://mintcdn.com/coingecko/b3Fla9Sm0TsVrJN4/images/reference/fb09018-image.png?fit=max&auto=format&n=b3Fla9Sm0TsVrJN4&q=85&s=9849ef5a53aedccf2ac0c9bc39ee5953" alt="" data-og-width="2909" width="2909" data-og-height="1887" height="1887" data-path="images/reference/fb09018-image.png" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/coingecko/b3Fla9Sm0TsVrJN4/images/reference/fb09018-image.png?w=280&fit=max&auto=format&n=b3Fla9Sm0TsVrJN4&q=85&s=0b256fa8214e83fd391836a3edaeca2f 280w, https://mintcdn.com/coingecko/b3Fla9Sm0TsVrJN4/images/reference/fb09018-image.png?w=560&fit=max&auto=format&n=b3Fla9Sm0TsVrJN4&q=85&s=2d6d0b3bc94f5913bfee1b6096067e1b 560w, https://mintcdn.com/coingecko/b3Fla9Sm0TsVrJN4/images/reference/fb09018-image.png?w=840&fit=max&auto=format&n=b3Fla9Sm0TsVrJN4&q=85&s=6c9ab464d9d3cb1c4b6e2b033182997d 840w, https://mintcdn.com/coingecko/b3Fla9Sm0TsVrJN4/images/reference/fb09018-image.png?w=1100&fit=max&auto=format&n=b3Fla9Sm0TsVrJN4&q=85&s=7af07f3a051caa022ee01f1cd08b8cdc 1100w, https://mintcdn.com/coingecko/b3Fla9Sm0TsVrJN4/images/reference/fb09018-image.png?w=1650&fit=max&auto=format&n=b3Fla9Sm0TsVrJN4&q=85&s=41b58e7270fdddd7ce46030e5a6fa311 1650w, https://mintcdn.com/coingecko/b3Fla9Sm0TsVrJN4/images/reference/fb09018-image.png?w=2500&fit=max&auto=format&n=b3Fla9Sm0TsVrJN4&q=85&s=f6d3bd429fd2255658ee0845295bcd3d 2500w" />
>
> 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'.
>
> <img src="https://mintcdn.com/coingecko/b3Fla9Sm0TsVrJN4/images/reference/911e973-image.png?fit=max&auto=format&n=b3Fla9Sm0TsVrJN4&q=85&s=106f6fba2b90c2264b706535c748f323" alt="" data-og-width="2903" width="2903" data-og-height="1888" height="1888" data-path="images/reference/911e973-image.png" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/coingecko/b3Fla9Sm0TsVrJN4/images/reference/911e973-image.png?w=280&fit=max&auto=format&n=b3Fla9Sm0TsVrJN4&q=85&s=1ef4911c34f869f0ce88e1c751f97b62 280w, https://mintcdn.com/coingecko/b3Fla9Sm0TsVrJN4/images/reference/911e973-image.png?w=560&fit=max&auto=format&n=b3Fla9Sm0TsVrJN4&q=85&s=8e9b8e04582a59bc4a5b1d3cb08db20b 560w, https://mintcdn.com/coingecko/b3Fla9Sm0TsVrJN4/images/reference/911e973-image.png?w=840&fit=max&auto=format&n=b3Fla9Sm0TsVrJN4&q=85&s=01cee4ef35038e639b98e5d6045f429e 840w, https://mintcdn.com/coingecko/b3Fla9Sm0TsVrJN4/images/reference/911e973-image.png?w=1100&fit=max&auto=format&n=b3Fla9Sm0TsVrJN4&q=85&s=324593d255be68d2b9490d3c1ac1693f 1100w, https://mintcdn.com/coingecko/b3Fla9Sm0TsVrJN4/images/reference/911e973-image.png?w=1650&fit=max&auto=format&n=b3Fla9Sm0TsVrJN4&q=85&s=e44e29bae06803537b3d92d461d5ed8b 1650w, https://mintcdn.com/coingecko/b3Fla9Sm0TsVrJN4/images/reference/911e973-image.png?w=2500&fit=max&auto=format&n=b3Fla9Sm0TsVrJN4&q=85&s=3a668ee396e7599271d861a2f70f7943 2500w" />
>
> Try it here: [claude.ai/public/artifacts](https://claude.ai/public/artifacts/41efabb7-76b9-43c7-8349-cbbe1d52a022)
---
## WebSocket (Beta)
**URL:** llms-txt#websocket-(beta)
**Contents:**
- Access Real-Time Crypto Data Instantly with CoinGecko WebSockets
- Channel & Data Support
- Connection Handling
Source: https://docs.coingecko.com/websocket/index
CoinGecko API: Stream 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.
<Tip>
CoinGecko Websocket (Beta) is now available for [paid plan ](https://www.coingecko.com/en/api/pricing)customers (Analyst plan & above)!
* For Analyst, Lite, Pro, and Pro+ self-serve customers, you will be eligible to access the following features, and stream real-time data by utilising your monthly API plan credits:
* Max connections: 10 concurrent socket connections
* Max subscriptions: 100 token or pool data subscription per channel, per socket
* Channel Access: all 4 channels
* Credit charge: 0.1 credit per response returned, deducting from monthly API plan credits
We will gradually improve the Websocket and expand the feature limits. Please share your feedback and suggestion via this [survey form](https://forms.gle/gNE1Txc9FCV55s7ZA), or email soonaik\@coingecko\[dot]com
</Tip>
* For existing **Enterprise plan** clients who wish to unlock higher limits (max connections, max subscriptions, and lower credit charge), please contact your Customer Success Manager.
### Channel & Data Support
| Websocket Channel | Channel Code | Details |
| ------------------------------------------------------------- | ------------ | ------------------------------------------------------------------------------------------------------------- |
| [OnchainSimpleTokenPrice](https://docs.coingecko.com/websocket/onchainsimpletokenprice) | G1 | Subscribe to receive real-time price updates for tokens, as seen on GeckoTerminal.com |
| [CGSimplePrice](https://docs.coingecko.com/websocket/cgsimpleprice) | C1 | Subscribe to receive real-time price updates for tokens, as seen on CoinGecko.com |
| [OnchainTrade](https://docs.coingecko.com/websocket/wss-onchain-trade) | G2 | Subscribe to receive real-time transaction updates for pools, as seen on GeckoTerminal.com |
| [OnchainOHLCV](https://docs.coingecko.com/websocket/wssonchainohlcv/) | G3 | Subscribe to receive real-time OHLCV (Open, High, Low, Close, Volume) for pools, as seen on GeckoTerminal.com |
| (More coming soon!) | | |
<Note>
### **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.
</Note>
### 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.
---
## Crypto Treasury Holdings by Coin ID
**URL:** llms-txt#crypto-treasury-holdings-by-coin-id
Source: https://docs.coingecko.com/v3.0.1/reference/companies-public-treasury
v3.0.1/reference/api-reference/coingecko-demo.json get /{entity}/public_treasury/{coin_id}
This endpoint allows you **query public companies & governments' cryptocurrency holdings** by Coin ID
* The responses are sorted in descending order based on total holdings.
* CoinGecko equivalent page: [https://www.coingecko.com/en/treasuries/bitcoin](https://www.coingecko.com/en/treasuries/bitcoin)
* Cache / Update Frequency: every 5 minutes for all the API plans.
</Note>
---
## OnchainTrade
**URL:** llms-txt#onchaintrade
**Contents:**
- Data Payload
- 1. Establish Connection to Websocket
- 2. Subscribe to a specific channel - OnchainTrade
- 3. Stream OnchainTrade data
- Tips:
- Un-subscribe to stop streaming OnchainTrade data
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](https://docs.coingecko.com/reference/top-pools-contract-address) to obtain contract address of the most liquid pool.
| | 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
<CodeGroup>
</CodeGroup>
## 2. Subscribe to a specific channel - OnchainTrade
<CodeGroup>
</CodeGroup>
<CodeGroup>
</CodeGroup>
## 3. Stream OnchainTrade data
<CodeGroup>
</CodeGroup>
<CodeGroup>
</CodeGroup>
<CodeGroup>
</CodeGroup>
The output keys will be in random order.
### Un-subscribe to stop streaming OnchainTrade data
**Input Example:** Unsubscribe for 1 specific pool data:
<CodeGroup>
</CodeGroup>
<CodeGroup>
</CodeGroup>
**Input Example:** Unsubscribe from OnchainTrade channel and all pools data:
<CodeGroup>
</CodeGroup>
<CodeGroup>
</CodeGroup>
**Examples:**
Example 1 (unknown):
```unknown
</CodeGroup>
## 2. Subscribe to a specific channel - OnchainTrade
**Input Example:**
<CodeGroup>
```
Example 2 (unknown):
```unknown
</CodeGroup>
**Output Example**:
<CodeGroup>
```
Example 3 (unknown):
```unknown
</CodeGroup>
## 3. Stream OnchainTrade data
**Input Example:**
<CodeGroup>
```
Example 4 (unknown):
```unknown
</CodeGroup>
**Output Example**:
<CodeGroup>
```
---
## 💼 Historical Token Holders Chart by Token Address
**URL:** llms-txt#💼-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**
* 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.
</Note>
---
## Coin OHLC Chart by ID
**URL:** llms-txt#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**
* You may obtain the coin ID (API ID) via several ways:
* refers to respective coin page and find 'API ID'.
* refers to [`/coins/list`](https://docs.coingecko.com/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](https://docs.coingecko.com/v3.0.1/reference/coins-id-market-chart) endpoint.
</Tip>
* 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.
</Note>
---
## 🐍 CoinGecko Python SDK
**URL:** llms-txt#🐍-coingecko-python-sdk
**Contents:**
- Install via `pip`
- Resources
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.
<CodeGroup>
</CodeGroup>
* **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`
---
## New Pools by Network
**URL:** llms-txt#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**
* You may include values such as `page` to specify which page of responses you would like to show.
</Tip>
* 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)
</Note>
---
## Most Recently Updated Tokens List
**URL:** llms-txt#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**
* You may add values such as network in the include param to include network along with the updated tokens list.
</Tip>
* Attributes specified in the `include` param will be returned under the top-level "included" key.
* Cache/Update frequency: every 60 seconds.
</Note>
---
## New Pools List
**URL:** llms-txt#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**
* You may include values such as `page` to specify which page of responses you would like to show.
</Tip>
* 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)
</Note>
---
## Pool OHLCV chart by Pool Address
**URL:** llms-txt#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**
* 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).
</Tip>
* 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.
</Note>
---
## 💼 Trending Search Pools
**URL:** llms-txt#💼-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**
* 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).
</Note>
---
## Coins Categories List (ID Map)
**URL:** llms-txt#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**
* You may use this endpoint to query the list of categories for other endpoints that contain params like `category`.
</Tip>
* 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.
</Note>
---
## Common Use Cases
**URL:** llms-txt#common-use-cases
**Contents:**
- 1. Get Coins Logo Images
- 2. Best Endpoint for Latest Crypto Price
- 3. Get All Trading Pairs (Tickers) of a Coin
- 4. Get Trading Pairs of Specific Coins from a Specific Exchange
- 5. Building Telegram Bot for Latest Coin Listings
- 6. Get List of Coins Under Specific Category
- 7. Identify DEX Decentralized Exchanges
- 8. Get Bitcoin Dominance Data (BTC.D)
- 9. Get Market Cap or Dominance of a Specific Ecosystem
- 10. Get Token Lists of a Specific Blockchain Network
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](https://docs.coingecko.com/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](https://docs.coingecko.com/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](https://docs.coingecko.com/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](https://docs.coingecko.com/reference/coins-id-tickers) endpoint.
## 4. Get Trading Pairs of Specific Coins from a Specific Exchange
* Use[ /coins/id/tickers](https://docs.coingecko.com/reference/coins-id-tickers) endpoint by supplying specific exchange ID.
## 5. Building Telegram Bot for Latest Coin Listings
* Use [/coins/list/new](https://docs.coingecko.com/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](https://docs.coingecko.com/reference/coins-markets) endpoint by supplying specific category.
* For GeckoTerminal [categories](https://www.geckoterminal.com/category), use [Pools by Category ID](https://docs.coingecko.com/reference/pools-category) endpoint by supplying specific category.
## 7. Identify DEX Decentralized Exchanges
* Use [/exchanges/list](https://docs.coingecko.com/reference/exchanges-list) endpoint to get full list of exchanges with ID on CoinGecko.
* Use [/exchanges/id](https://docs.coingecko.com/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`
<CodeGroup>
</CodeGroup>
## 8. Get Bitcoin Dominance Data (BTC.D)
* Use [/global ](https://docs.coingecko.com/reference/crypto-global)endpoint.
* Example of responses:
<CodeGroup>
</CodeGroup>
## 9. Get Market Cap or Dominance of a Specific Ecosystem
* Use [/coins/categories](https://docs.coingecko.com/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](https://docs.coingecko.com/reference/token-lists) endpoint.
* Supply asset platform id to the endpoint.
## 11. Get 7-Day Sparkline Price Data of a Coin
* Use [/coins/id](https://docs.coingecko.com/reference/coins-id) or [/coins/markets](https://docs.coingecko.com/reference/coins-markets) endpoints by flagging `sparkline = true`.
## 12. Get Link to Individual CoinGecko Coin Page
* Use [/coins/list](https://docs.coingecko.com/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](https://docs.coingecko.com/reference/coins-id) endpoint and obtain the **`{web_slug}`** value.
## 13. Check Coin Status and Stale Price Updates
* Active: use [/coins/list](https://docs.coingecko.com/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](https://docs.coingecko.com/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](https://docs.coingecko.com/reference/exchange-rates) endpoint.
* Historical exchange rate: use [/coins/id/history](https://docs.coingecko.com/reference/coins-id-history) or [/coins/id/market\_chart](https://docs.coingecko.com/reference/coins-id-market-chart) endpoints.
## 15. Get Watchlist Portfolio Data of a Coin
* Use [/coins/id](https://docs.coingecko.com/reference/coins-id) endpoint by supplying coin ID.
* Example of responses:
<CodeGroup>
</CodeGroup>
## 16. Get Historical Data for Inactive Coins
**Note**: This is available for paid plan subscribers only.
* Use [/coins/list](https://docs.coingecko.com/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](https://docs.coingecko.com/reference/coins-id-history)
* [/coins/id/market\_chart](https://docs.coingecko.com/reference/coins-id-market-chart)
* [/coins/id/market\_chart/range](https://docs.coingecko.com/reference/coins-id-market-chart-range)
* [/coins/id/contract/contract\_address/market\_chart](https://docs.coingecko.com/reference/contract-address-market-chart)
* [/coins/id/contract/contract\_address/market\_chart/range](https://docs.coingecko.com/reference/contract-address-market-chart-range)
## 17. Get TVL (Total Value Locked) data of a Coin
* Use [/coins/id](https://docs.coingecko.com/reference/coins-id) endpoint by supplying coin ID.
* Example of responses:
<CodeGroup>
</CodeGroup>
## 18. Query Search for Coins, Categories, NFTs, Exchanges, and Pools
We have 2 Search endpoints:
* [/search](https://docs.coingecko.com/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](https://docs.coingecko.com/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-platforms-list](https://docs.coingecko.com/reference/asset-platforms-list)
* GeckoTerminal ([onchain endpoints](https://docs.coingecko.com/reference/endpoint-overview#-onchain-dex-endpoints-geckoterminal)): [/networks-list](https://docs.coingecko.com/reference/networks-list)
## 20. Get Native Coin of a Blockchain Network (Asset Platform)
You may use the [/asset-platforms-list](https://docs.coingecko.com/reference/asset-platforms-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](https://docs.coingecko.com/reference/pool-address). You may also get liquidity data (`total_reserve_in_usd`) of a token, using endpoints like: [Token Data by Token Address](https://docs.coingecko.com/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](https://docs.coingecko.com/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#february-2025)
* [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](https://docs.coingecko.com/reference/trending-search/) — Trending Coins, NFTs, Categories on CoinGecko.com, based on user searches.
* [Trending Search Pools](https://docs.coingecko.com/reference/trending-search-pools/) — Trending Pools and Tokens on GeckoTerminal.com, based on user searches.
* Other useful endpoints:
* [Top Gainers & Losers](https://docs.coingecko.com/reference/coins-top-gainers-losers) on CoinGecko.com, by specific time duration.
* [Trending Pools List](https://docs.coingecko.com/reference/trending-pools-list) and [Trending Pools by Network](https://docs.coingecko.com/reference/trending-pools-network) on GeckoTerminal.com, by specific time duration.
## 24. Get Security Info of Tokens
* By using [Token Info by Token Address](https://docs.coingecko.com/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](https://docs.coingecko.com/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#now-supported%3A-launchpad-data-pump-fun-%26-more-%2C-granular-ohlcv%2C-and-honeypot-info).
* **Request example (Get latest pools on Pump.fun)**:
<CodeGroup>
</CodeGroup>
⚡️ Need Real-time Data Streams? Try [WebSocket API](https://docs.coingecko.com/websocket)
<a href="/websocket">
<Frame>
<img src="https://mintcdn.com/coingecko/Vs362t2sI6OcYG2J/images/wss-banner-3.png?fit=max&auto=format&n=Vs362t2sI6OcYG2J&q=85&s=0100cf5563559f9abaa820953d7b51d1" noZoom data-og-width="2400" width="2400" data-og-height="470" height="470" data-path="images/wss-banner-3.png" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/coingecko/Vs362t2sI6OcYG2J/images/wss-banner-3.png?w=280&fit=max&auto=format&n=Vs362t2sI6OcYG2J&q=85&s=7af476c453eac401449894b2082e1e51 280w, https://mintcdn.com/coingecko/Vs362t2sI6OcYG2J/images/wss-banner-3.png?w=560&fit=max&auto=format&n=Vs362t2sI6OcYG2J&q=85&s=24e14a72713ad27eab213dbd12095087 560w, https://mintcdn.com/coingecko/Vs362t2sI6OcYG2J/images/wss-banner-3.png?w=840&fit=max&auto=format&n=Vs362t2sI6OcYG2J&q=85&s=55c681e36c2e8a23b6560b650ddc76b7 840w, https://mintcdn.com/coingecko/Vs362t2sI6OcYG2J/images/wss-banner-3.png?w=1100&fit=max&auto=format&n=Vs362t2sI6OcYG2J&q=85&s=c57736ebd1362301406aa43788b31f92 1100w, https://mintcdn.com/coingecko/Vs362t2sI6OcYG2J/images/wss-banner-3.png?w=1650&fit=max&auto=format&n=Vs362t2sI6OcYG2J&q=85&s=02e2f731fde9f613e7c701ad78ac898f 1650w, https://mintcdn.com/coingecko/Vs362t2sI6OcYG2J/images/wss-banner-3.png?w=2500&fit=max&auto=format&n=Vs362t2sI6OcYG2J&q=85&s=66df269e8b922a799737ec64b66268d1 2500w" />
</Frame>
</a>
With WebSocket, you can now stream ultra-low latency, real-time prices, trades, and OHLCV chart data. <br />
Subscribe to our [paid API plan](https://www.coingecko.com/en/api/pricing) (Analyst plan & above) to access WebSocket and REST API data delivery methods.
**Examples:**
Example 1 (unknown):
```unknown
</CodeGroup>
## 8. Get Bitcoin Dominance Data (BTC.D)
* Use [/global ](https://docs.coingecko.com/reference/crypto-global)endpoint.
* Example of responses:
<CodeGroup>
```
Example 2 (unknown):
```unknown
</CodeGroup>
## 9. Get Market Cap or Dominance of a Specific Ecosystem
* Use [/coins/categories](https://docs.coingecko.com/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](https://docs.coingecko.com/reference/token-lists) endpoint.
* Supply asset platform id to the endpoint.
## 11. Get 7-Day Sparkline Price Data of a Coin
* Use [/coins/id](https://docs.coingecko.com/reference/coins-id) or [/coins/markets](https://docs.coingecko.com/reference/coins-markets) endpoints by flagging `sparkline = true`.
## 12. Get Link to Individual CoinGecko Coin Page
* Use [/coins/list](https://docs.coingecko.com/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](https://docs.coingecko.com/reference/coins-id) endpoint and obtain the **`{web_slug}`** value.
## 13. Check Coin Status and Stale Price Updates
* Active: use [/coins/list](https://docs.coingecko.com/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](https://docs.coingecko.com/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](https://docs.coingecko.com/reference/exchange-rates) endpoint.
* Historical exchange rate: use [/coins/id/history](https://docs.coingecko.com/reference/coins-id-history) or [/coins/id/market\_chart](https://docs.coingecko.com/reference/coins-id-market-chart) endpoints.
## 15. Get Watchlist Portfolio Data of a Coin
* Use [/coins/id](https://docs.coingecko.com/reference/coins-id) endpoint by supplying coin ID.
* Example of responses:
<CodeGroup>
```
Example 3 (unknown):
```unknown
</CodeGroup>
## 16. Get Historical Data for Inactive Coins
**Note**: This is available for paid plan subscribers only.
* Use [/coins/list](https://docs.coingecko.com/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](https://docs.coingecko.com/reference/coins-id-history)
* [/coins/id/market\_chart](https://docs.coingecko.com/reference/coins-id-market-chart)
* [/coins/id/market\_chart/range](https://docs.coingecko.com/reference/coins-id-market-chart-range)
* [/coins/id/contract/contract\_address/market\_chart](https://docs.coingecko.com/reference/contract-address-market-chart)
* [/coins/id/contract/contract\_address/market\_chart/range](https://docs.coingecko.com/reference/contract-address-market-chart-range)
## 17. Get TVL (Total Value Locked) data of a Coin
* Use [/coins/id](https://docs.coingecko.com/reference/coins-id) endpoint by supplying coin ID.
* Example of responses:
<CodeGroup>
```
Example 4 (unknown):
```unknown
</CodeGroup>
## 18. Query Search for Coins, Categories, NFTs, Exchanges, and Pools
We have 2 Search endpoints:
* [/search](https://docs.coingecko.com/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](https://docs.coingecko.com/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-platforms-list](https://docs.coingecko.com/reference/asset-platforms-list)
* GeckoTerminal ([onchain endpoints](https://docs.coingecko.com/reference/endpoint-overview#-onchain-dex-endpoints-geckoterminal)): [/networks-list](https://docs.coingecko.com/reference/networks-list)
## 20. Get Native Coin of a Blockchain Network (Asset Platform)
You may use the [/asset-platforms-list](https://docs.coingecko.com/reference/asset-platforms-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](https://docs.coingecko.com/reference/pool-address). You may also get liquidity data (`total_reserve_in_usd`) of a token, using endpoints like: [Token Data by Token Address](https://docs.coingecko.com/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](https://docs.coingecko.com/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#february-2025)
* [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](https://docs.coingecko.com/reference/trending-search/) — Trending Coins, NFTs, Categories on CoinGecko.com, based on user searches.
* [Trending Search Pools](https://docs.coingecko.com/reference/trending-search-pools/) — Trending Pools and Tokens on GeckoTerminal.com, based on user searches.
* Other useful endpoints:
* [Top Gainers & Losers](https://docs.coingecko.com/reference/coins-top-gainers-losers) on CoinGecko.com, by specific time duration.
* [Trending Pools List](https://docs.coingecko.com/reference/trending-pools-list) and [Trending Pools by Network](https://docs.coingecko.com/reference/trending-pools-network) on GeckoTerminal.com, by specific time duration.
## 24. Get Security Info of Tokens
* By using [Token Info by Token Address](https://docs.coingecko.com/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](https://docs.coingecko.com/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#now-supported%3A-launchpad-data-pump-fun-%26-more-%2C-granular-ohlcv%2C-and-honeypot-info).
* **Request example (Get latest pools on Pump.fun)**:
<CodeGroup>
```
---
## 🟦 CoinGecko TypeScript SDK
**URL:** llms-txt#🟦-coingecko-typescript-sdk
**Contents:**
- Install via `npm`
- Resources
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.
<CodeGroup>
</CodeGroup>
* **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).
---
## Coin Tickers by ID
**URL:** llms-txt#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**
* You may obtain the coin ID (API ID) via several ways:
* refers to respective coin page and find 'API ID'.
* refers to [`/coins/list`](https://docs.coingecko.com/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.
</Tip>
* 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.
</Note>
---
## 🔥 Megafilter for Pools
**URL:** llms-txt#🔥-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**
* 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.
</Tip>
* 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
* `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).
</Note>
---
## Token Price by Token Addresses
**URL:** llms-txt#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**
* 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}`](https://docs.coingecko.com/v3.0.1/reference/pool-address) endpoint by providing a specific pool address.
* Cache/Update Frequency: every 60 seconds.
</Note>
---
## Tokens Data by Token Addresses
**URL:** llms-txt#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**
* 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`](https://docs.coingecko.com/v3.0.1/reference/token-info-contract-address) instead.
</Tip>
* 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.
* Set `include_composition=true` to surface the balance and liquidity value of the pool's base and quote tokens. (requires `include=top_pools`)
* For tokens on a bonding curve (i.e. non-graduated tokens from launchpads), the response will include a `launchpad_details` object containing their graduation status and details.
* Cache/Update frequency: every 60 seconds.
</Note>
---
## Multiple Pools Data by Pool Addresses
**URL:** llms-txt#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**
* 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.
* Set `include_composition=true` to surface the balance and liquidity value of the pool's base and quote tokens.
* Pools on a bonding curve (e.g. non-graduated pools from launchpads) will return `launchpad_details` object with their graduation status and migration details.
* Cache/Update Frequency: every 60 seconds.
</Note>
---
## 👑 Circulating Supply Chart within Time Range by ID
**URL:** llms-txt#👑-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**
* Supports ISO date strings (`YYYY-MM-DD` or\
`YYYY-MM-DDTHH:MM`, recommended for best compatibility) or UNIX timestamps.
</Tip>
* 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.
</Note>
---
## 👑 Circulating Supply Chart by ID
**URL:** llms-txt#👑-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**
* 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.
</Note>
---
## 💼 Past 24 Hour Trades by Token Address
**URL:** llms-txt#💼-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**
* Exclusive for all [Paid Plan](https://www.coingecko.com/en/api/pricing) Subscribers (Analyst, Lite, Pro and Enterprise).
* Cache/Update Frequency: every 10 seconds for Pro API (Analyst, Lite, Pro, Enterprise).
</Note>
---
## 💼 Coin OHLC Chart within Time Range by ID
**URL:** llms-txt#💼-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**
* You may obtain the coin ID (API ID) via several ways:
* refers to respective coin page and find 'API ID'.
* refers to [`/coins/list`](https://docs.coingecko.com/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](https://docs.coingecko.com/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.
</Tip>
* 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.
</Note>
---
## Token Info by Token Address
**URL:** llms-txt#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**
* 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}`](https://docs.coingecko.com/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](https://docs.coingecko.com/v3.0.1/reference/coins-id)
* [Coin Data by Token Address](https://docs.coingecko.com/v3.0.1/reference/coins-contract-address)
</Tip>
* `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`
* For tokens on a bonding curve (i.e. non-graduated tokens from launchpads), the response will include a `launchpad_details` object containing their graduation status and details.
</Note>
---
## Coins List (ID Map)
**URL:** llms-txt#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**
* 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).
</Tip>
* 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).
</Note>
---
## CGSimplePrice
**URL:** llms-txt#cgsimpleprice
**Contents:**
- Data Payload
- 1. Establish Connection to Websocket
- 2. Subscribe to a specific channel - CGSimplePrice
- 3. Stream CGSimplePrice
- Tips:
- Un-subscribe to stop streaming CGSimplePrice data
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 \~10s, for large cap and actively traded coins.
| | 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
<CodeGroup>
</CodeGroup>
## 2. Subscribe to a specific channel - CGSimplePrice
<CodeGroup>
</CodeGroup>
<CodeGroup>
</CodeGroup>
## 3. Stream CGSimplePrice
<CodeGroup>
</CodeGroup>
<CodeGroup>
</CodeGroup>
<CodeGroup>
</CodeGroup>
The output keys will be in random order.
### Un-subscribe to stop streaming CGSimplePrice data
**Input Example:** Unsubscribe for 1 specific token data:
<CodeGroup>
</CodeGroup>
<CodeGroup>
</CodeGroup>
**Input Example:** Unsubscribe from CGSimplePrice channel and all token data:
<CodeGroup>
</CodeGroup>
<CodeGroup>
</CodeGroup>
**Examples:**
Example 1 (unknown):
```unknown
</CodeGroup>
## 2. Subscribe to a specific channel - CGSimplePrice
**Input Example:**
<CodeGroup>
```
Example 2 (unknown):
```unknown
</CodeGroup>
**Output Example**:
<CodeGroup>
```
Example 3 (unknown):
```unknown
</CodeGroup>
## 3. Stream CGSimplePrice
**Input Example:**
<CodeGroup>
```
Example 4 (unknown):
```unknown
</CodeGroup>
**Output Example**:
<CodeGroup>
```
---
## Global DeFi Market Data
**URL:** llms-txt#global-defi-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**
---
## Top Pools by Token Address
**URL:** llms-txt#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**
* You may include values such as `page` to specify which page of responses you would like to show.
</Tip>
* 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.
</Note>
---
## 4. Get On-chain Data
**URL:** llms-txt#4.-get-on-chain-data
**Contents:**
- Blockchain Networks
- DEXs
- Methods to query Onchain Data
- a. Pool Contract Address
- b. Token Contract Address
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
* Please do not use CoinGecko Asset Platform ID as the Network ID in Onchain DEX API Endpoints (CoinGecko Asset Platform ID ≠ GT Network ID)
* Asset Platform on CoinGecko: `ethereum`
* Onchain Network ID: `eth`
</Note>
**How to obtain Network ID?**
* Use [/onchain/networks](https://docs.coingecko.com/reference/networks-list) endpoint, example of response:
<CodeGroup>
</CodeGroup>
* Go to [GeckoTerminal](https://www.geckoterminal.com/)
1. Select or search for a blockchain network.
2. Copy the slug from the URL:
<img src="https://mintcdn.com/coingecko/a7cplMjqO5fc2v5e/images/docs/5b9a903-image.png?fit=max&auto=format&n=a7cplMjqO5fc2v5e&q=85&s=3d58e3708238e2c869afeb50f36ba74a" alt="" data-og-width="3024" width="3024" data-og-height="1964" height="1964" data-path="images/docs/5b9a903-image.png" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/coingecko/a7cplMjqO5fc2v5e/images/docs/5b9a903-image.png?w=280&fit=max&auto=format&n=a7cplMjqO5fc2v5e&q=85&s=4989c53c98cdf6a3b7e313e6a9804ab0 280w, https://mintcdn.com/coingecko/a7cplMjqO5fc2v5e/images/docs/5b9a903-image.png?w=560&fit=max&auto=format&n=a7cplMjqO5fc2v5e&q=85&s=d969711a6080bed61c7ea74574f8c9c4 560w, https://mintcdn.com/coingecko/a7cplMjqO5fc2v5e/images/docs/5b9a903-image.png?w=840&fit=max&auto=format&n=a7cplMjqO5fc2v5e&q=85&s=00c5bc4b0bddd4b5c2a1db9feccf6cb9 840w, https://mintcdn.com/coingecko/a7cplMjqO5fc2v5e/images/docs/5b9a903-image.png?w=1100&fit=max&auto=format&n=a7cplMjqO5fc2v5e&q=85&s=fae4d183cc2e8adffa335e7fd646f7d0 1100w, https://mintcdn.com/coingecko/a7cplMjqO5fc2v5e/images/docs/5b9a903-image.png?w=1650&fit=max&auto=format&n=a7cplMjqO5fc2v5e&q=85&s=557a46ebb5da439b2f10be9d31b78618 1650w, https://mintcdn.com/coingecko/a7cplMjqO5fc2v5e/images/docs/5b9a903-image.png?w=2500&fit=max&auto=format&n=a7cplMjqO5fc2v5e&q=85&s=c2a5d9ec2a1c59d2479ee38eb887b103 2500w" />
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](https://docs.coingecko.com/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](https://docs.coingecko.com/reference/dexes-list) endpoint, example of response:
<CodeGroup>
</CodeGroup>
* 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:
<img src="https://mintcdn.com/coingecko/a7cplMjqO5fc2v5e/images/docs/f68325c-image.png?fit=max&auto=format&n=a7cplMjqO5fc2v5e&q=85&s=58ed481ea98687173a3cbf9493c73669" alt="" data-og-width="3024" width="3024" data-og-height="1964" height="1964" data-path="images/docs/f68325c-image.png" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/coingecko/a7cplMjqO5fc2v5e/images/docs/f68325c-image.png?w=280&fit=max&auto=format&n=a7cplMjqO5fc2v5e&q=85&s=c65139982268e19bca411599181dc636 280w, https://mintcdn.com/coingecko/a7cplMjqO5fc2v5e/images/docs/f68325c-image.png?w=560&fit=max&auto=format&n=a7cplMjqO5fc2v5e&q=85&s=643f58b710957517ea5bf1f44719c865 560w, https://mintcdn.com/coingecko/a7cplMjqO5fc2v5e/images/docs/f68325c-image.png?w=840&fit=max&auto=format&n=a7cplMjqO5fc2v5e&q=85&s=caf2849ed3d33c014ad8f9ebeb4e5335 840w, https://mintcdn.com/coingecko/a7cplMjqO5fc2v5e/images/docs/f68325c-image.png?w=1100&fit=max&auto=format&n=a7cplMjqO5fc2v5e&q=85&s=053455ede8148791a44e985dfaf9b7ca 1100w, https://mintcdn.com/coingecko/a7cplMjqO5fc2v5e/images/docs/f68325c-image.png?w=1650&fit=max&auto=format&n=a7cplMjqO5fc2v5e&q=85&s=174ed6ec00474abb69e58b1955992896 1650w, https://mintcdn.com/coingecko/a7cplMjqO5fc2v5e/images/docs/f68325c-image.png?w=2500&fit=max&auto=format&n=a7cplMjqO5fc2v5e&q=85&s=ece2e33e95afc4a26ce9632aee91ab09 2500w" />
## 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}](https://docs.coingecko.com/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):
<img src="https://mintcdn.com/coingecko/a7cplMjqO5fc2v5e/images/docs/741fbc7-image.png?fit=max&auto=format&n=a7cplMjqO5fc2v5e&q=85&s=a80b0dafe3d5db5a527e02ea18fcc2ad" alt="" data-og-width="3023" width="3023" data-og-height="1708" height="1708" data-path="images/docs/741fbc7-image.png" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/coingecko/a7cplMjqO5fc2v5e/images/docs/741fbc7-image.png?w=280&fit=max&auto=format&n=a7cplMjqO5fc2v5e&q=85&s=aa93c1116c1d08b205703db5012bab40 280w, https://mintcdn.com/coingecko/a7cplMjqO5fc2v5e/images/docs/741fbc7-image.png?w=560&fit=max&auto=format&n=a7cplMjqO5fc2v5e&q=85&s=3a880e5a52baccf4ba59ebccbe403e0e 560w, https://mintcdn.com/coingecko/a7cplMjqO5fc2v5e/images/docs/741fbc7-image.png?w=840&fit=max&auto=format&n=a7cplMjqO5fc2v5e&q=85&s=3ce6dab28d3f89568ebcb90c06c5b476 840w, https://mintcdn.com/coingecko/a7cplMjqO5fc2v5e/images/docs/741fbc7-image.png?w=1100&fit=max&auto=format&n=a7cplMjqO5fc2v5e&q=85&s=94b5901e74822c87037922b50b6c4502 1100w, https://mintcdn.com/coingecko/a7cplMjqO5fc2v5e/images/docs/741fbc7-image.png?w=1650&fit=max&auto=format&n=a7cplMjqO5fc2v5e&q=85&s=363a6b4dae6ba819ca437b307847bfca 1650w, https://mintcdn.com/coingecko/a7cplMjqO5fc2v5e/images/docs/741fbc7-image.png?w=2500&fit=max&auto=format&n=a7cplMjqO5fc2v5e&q=85&s=094ec22716e968240e77cf49c8a85670 2500w" />
* 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](https://docs.coingecko.com/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:
<img src="https://mintcdn.com/coingecko/a7cplMjqO5fc2v5e/images/docs/56f6c15-image.png?fit=max&auto=format&n=a7cplMjqO5fc2v5e&q=85&s=f889558b4ea90de11cb582a6b7de0abc" alt="" data-og-width="3023" width="3023" data-og-height="1714" height="1714" data-path="images/docs/56f6c15-image.png" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/coingecko/a7cplMjqO5fc2v5e/images/docs/56f6c15-image.png?w=280&fit=max&auto=format&n=a7cplMjqO5fc2v5e&q=85&s=9ce75c1292f0d566078dda3943b1fe7e 280w, https://mintcdn.com/coingecko/a7cplMjqO5fc2v5e/images/docs/56f6c15-image.png?w=560&fit=max&auto=format&n=a7cplMjqO5fc2v5e&q=85&s=4516e149c14a8bdac49d99f6e4915363 560w, https://mintcdn.com/coingecko/a7cplMjqO5fc2v5e/images/docs/56f6c15-image.png?w=840&fit=max&auto=format&n=a7cplMjqO5fc2v5e&q=85&s=d630847a7ee3c65560f8ebb5ad44ad38 840w, https://mintcdn.com/coingecko/a7cplMjqO5fc2v5e/images/docs/56f6c15-image.png?w=1100&fit=max&auto=format&n=a7cplMjqO5fc2v5e&q=85&s=7509e70029974a1eab8c270e88190071 1100w, https://mintcdn.com/coingecko/a7cplMjqO5fc2v5e/images/docs/56f6c15-image.png?w=1650&fit=max&auto=format&n=a7cplMjqO5fc2v5e&q=85&s=598fa1be5c51ab303f7c53b707ea1424 1650w, https://mintcdn.com/coingecko/a7cplMjqO5fc2v5e/images/docs/56f6c15-image.png?w=2500&fit=max&auto=format&n=a7cplMjqO5fc2v5e&q=85&s=1f47293f6b9d8bddb811001f3ff1f65e 2500w" />
* 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)
**Examples:**
Example 1 (unknown):
```unknown
</CodeGroup>
* Go to [GeckoTerminal](https://www.geckoterminal.com/)
1. Select or search for a blockchain network.
2. Copy the slug from the URL:
<img src="https://mintcdn.com/coingecko/a7cplMjqO5fc2v5e/images/docs/5b9a903-image.png?fit=max&auto=format&n=a7cplMjqO5fc2v5e&q=85&s=3d58e3708238e2c869afeb50f36ba74a" alt="" data-og-width="3024" width="3024" data-og-height="1964" height="1964" data-path="images/docs/5b9a903-image.png" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/coingecko/a7cplMjqO5fc2v5e/images/docs/5b9a903-image.png?w=280&fit=max&auto=format&n=a7cplMjqO5fc2v5e&q=85&s=4989c53c98cdf6a3b7e313e6a9804ab0 280w, https://mintcdn.com/coingecko/a7cplMjqO5fc2v5e/images/docs/5b9a903-image.png?w=560&fit=max&auto=format&n=a7cplMjqO5fc2v5e&q=85&s=d969711a6080bed61c7ea74574f8c9c4 560w, https://mintcdn.com/coingecko/a7cplMjqO5fc2v5e/images/docs/5b9a903-image.png?w=840&fit=max&auto=format&n=a7cplMjqO5fc2v5e&q=85&s=00c5bc4b0bddd4b5c2a1db9feccf6cb9 840w, https://mintcdn.com/coingecko/a7cplMjqO5fc2v5e/images/docs/5b9a903-image.png?w=1100&fit=max&auto=format&n=a7cplMjqO5fc2v5e&q=85&s=fae4d183cc2e8adffa335e7fd646f7d0 1100w, https://mintcdn.com/coingecko/a7cplMjqO5fc2v5e/images/docs/5b9a903-image.png?w=1650&fit=max&auto=format&n=a7cplMjqO5fc2v5e&q=85&s=557a46ebb5da439b2f10be9d31b78618 1650w, https://mintcdn.com/coingecko/a7cplMjqO5fc2v5e/images/docs/5b9a903-image.png?w=2500&fit=max&auto=format&n=a7cplMjqO5fc2v5e&q=85&s=c2a5d9ec2a1c59d2479ee38eb887b103 2500w" />
## 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](https://docs.coingecko.com/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](https://docs.coingecko.com/reference/dexes-list) endpoint, example of response:
<CodeGroup>
```
---
## 👑 Total Supply Chart within time range by ID
**URL:** llms-txt#👑-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**
* Supports ISO date strings (`YYYY-MM-DD` or\
`YYYY-MM-DDTHH:MM`, recommended for best compatibility) or UNIX timestamps.
</Tip>
* 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.
</Note>
---
## Coin Historical Chart Data within Time Range by ID
**URL:** llms-txt#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**
* You may obtain the coin ID (API ID) via several ways:
* refers to respective coin page and find 'API ID'.
* refers to [`/coins/list`](https://docs.coingecko.com/v3.0.1/reference/coins-list) endpoint.
* refers to google sheets [here](https://docs.google.com/spreadsheets/d/1wTTuxXt8n9q7C4NDXqQpI3wpKu1_5bGVmP9Xz0XGSyU/edit?usp=sharing).
</Tip>
* 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.
</Note>
---
## 💼 Token OHLCV chart by Token Address
**URL:** llms-txt#💼-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**
* 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 10 seconds for Pro API (Analyst, Lite, Pro, Enterprise).
</Note>
---
## Token Lists by Asset Platform ID
**URL:** llms-txt#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/)**
* 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).
</Note>
---
Reference in New Issue View Git Blame Copy Permalink