llms.md 35 KB

CoinGecko API

Docs

  • Changelog: Product updates and announcements
  • 1. Get data by ID or Address
  • 10-mins Tutorial Guide: New to CoinGecko API? Fret not. Whether you're a programmer or someone with zero coding experience, we've got you covered!
  • 2. Get Historical Data
  • 3. Get Exchanges & NFT Data
  • 4. Get On-chain Data
  • AI Prompts: CoinGecko API AI prompt library
  • API Status: CoinGecko's API status page provides information on the current status and incident history of CoinGecko API (Public & Pro)
  • Best Practices: Wonder how to use different endpoints together? This is the perfect place for you
  • Building with AI: Quick tips to empower your AI applications with CoinGecko API, and leverage our AI capabilities to help you build better and easier.
  • Clients: Explore client resources, including official Swagger JSON and unofficial Python wrapper
  • Common Errors & Rate Limit
  • Common Use Cases: Discover the common use cases of CoinGecko API by our users
  • Endpoint Showcase: Discover how CoinGecko API is used at CoinGecko.com and GeckoTerminal.com
  • CoinGecko MCP Server (Beta): 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.
  • Python AI Prompts: A comprehensive AI prompt to guide coding assistants in correctly implementing the official CoinGecko Python SDK for reliable API integration.
  • CoinGecko SDK (Beta): Official CoinGecko Typescript and Python SDKs — Crypto Price & Market Data API
  • Setting Up Your API Key
  • Tutorials (Beginner-friendly): Using CoinGecko API is super easy, even if you have no programming experience!
  • TypeScript AI Prompts: A comprehensive AI prompt to guide coding assistants in correctly implementing the official CoinGecko TypeScript SDK.
  • Useful Links: Some of the useful links to help you navigate while using the CoinGecko API
  • Introduction
  • 💼 API Usage: This endpoint allows you to monitor your account's API usage, including rate limits, monthly total credits, remaining credits, and more
  • Asset Platforms List (ID Map): This endpoint allows you to query all the asset platforms on CoinGecko
  • Authentication (Pro API): Authentication method for CoinGecko Pro API (Paid plan subscribers with Pro-API keys)
  • 💼 Categories List: This endpoint allows you to query all the supported categories on GeckoTerminal
  • Coins Categories List with Market Data: This endpoint allows you to query all the coins categories with market data (market cap, volume, ...) on CoinGecko
  • Coins Categories List (ID Map): This endpoint allows you to query all the coins categories on CoinGecko
  • Coin Data by Token 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
  • Coin Data by 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
  • 👑 Circulating Supply Chart by ID: This endpoint allows you to query historical circulating supply of a coin by number of days away from now based on provided coin ID
  • 👑 Circulating Supply Chart within Time Range by ID: This endpoint allows you to query historical circulating supply of a coin, within a range of timestamp based on the provided coin ID
  • Coin Historical Data by ID: 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
  • Coin Historical Chart Data by ID: 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
  • Coin Historical Chart Data within Time Range by ID: 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
  • Coin OHLC Chart by ID: This endpoint allows you to get the OHLC chart (Open, High, Low, Close) of a coin based on particular coin ID
  • 💼 Coin OHLC Chart within Time Range by ID: 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
  • Coin Tickers by ID: This endpoint allows you to query the coin tickers on both centralized exchange (CEX) and decentralized exchange (DEX) based on a particular coin ID
  • 👑 Total Supply Chart by ID: This endpoint allows you to query historical total supply of a coin by number of days away from now based on provided coin ID
  • 👑 Total Supply Chart within time range by ID: This endpoint allows you to query historical total supply of a coin, within a range of timestamp based on the provided coin ID
  • Coins List (ID Map): This endpoint allows you to query all the supported coins on CoinGecko with coins ID, name and symbol
  • 💼 Recently Added Coins: This endpoint allows you to query the latest 200 coins that recently listed on CoinGecko
  • Coins List with Market Data: This endpoint allows you to query all the supported coins with price, market cap, volume and market related data
  • 💼 Top Gainers & Losers: This endpoint allows you to query the top 30 coins with largest price gain and loss by a specific time duration
  • Crypto Treasury Holdings by Coin ID: This endpoint allows you query public companies & governments' cryptocurrency holdings by Coin ID
  • Coin Historical Chart Data by Token Address: 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
  • Coin Historical Chart Data within Time Range by Token Address: 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
  • Crypto Global Market Data: This endpoint allows you query cryptocurrency global data including active cryptocurrencies, markets, total crypto market cap and etc
  • Derivatives Exchanges List with Data: This endpoint allows you to query all the derivatives exchanges with related data (ID, name, open interest, ...) on CoinGecko
  • Derivatives Exchange Data by ID: This endpoint allows you to query the derivatives exchange's related data (ID, name, open interest, ...) based on the exchanges' ID
  • Derivatives Exchanges List (ID Map): This endpoint allows you to query all the derivatives exchanges with ID and name on CoinGecko
  • Derivatives Tickers List: This endpoint allows you to query all the tickers from derivatives exchanges on CoinGecko
  • Supported Dexes List by Network (ID Map): This endpoint allows you to query all the supported decentralized exchanges (DEXs) based on the provided network on GeckoTerminal
  • Endpoint Overview
  • Entities List (ID Map): This endpoint allows you to query all the supported entities on CoinGecko with entities ID, name, symbol, and country
  • BTC-to-Currency Exchange Rates: This endpoint allows you to query BTC exchange rates with other currencies
  • Exchanges List with data: This endpoint allows you to query all the supported exchanges with exchanges' data (ID, name, country, ...) that have active trading volumes on CoinGecko
  • Exchange Data by ID: This endpoint allows you to query exchange's data (name, year established, country, ...), exchange volume in BTC and top 100 tickers based on exchange's ID
  • Exchange Tickers by ID: This endpoint allows you to query exchange's tickers based on exchange's ID
  • Exchange Volume Chart by ID: This endpoint allows you to query the historical volume chart data with time in UNIX and trading volume data in BTC based on exchange's ID
  • 💼 Exchange Volume Chart within Time Range by ID: This endpoint allows you to query the historical volume chart data in BTC by specifying date range in UNIX based on exchange's ID
  • Exchanges List (ID Map): This endpoint allows you to query all the exchanges with ID and name
  • Global DeFi Market Data: This endpoint allows you query top 100 cryptocurrency global decentralized finance (DeFi) data including DeFi market cap, trading volume
  • 💼 Global Market Cap Chart Data: This endpoint allows you to query historical global market cap and volume data by number of days away from now
  • New Pools List: This endpoint allows you to query all the latest pools across all networks on GeckoTerminal
  • New Pools by Network: This endpoint allows you to query all the latest pools based on provided network
  • Supported Networks List (ID Map): This endpoint allows you to query all the supported networks on GeckoTerminal
  • NFTs Collection Data by Contract Address: This endpoint allows you to query all the NFT data (name, floor price, 24hr volume ...) based on the NFT collection contract address and respective asset platform
  • 💼 NFTs Collection Historical Chart Data by Contract Address: This endpoint allows you query historical market data of a NFT collection, including floor price, market cap, and 24hr volume, by number of days away from now based on the provided contract address
  • NFTs Collection Data by ID: This endpoint allows you to query all the NFT data (name, floor price, 24hr volume ...) based on the NFT collection ID
  • 💼 NFTs Collection Historical Chart Data by ID: This endpoint allows you query historical market data of a NFT collection, including floor price, market cap, and 24hr volume, by number of days away from now
  • 💼 NFTs Collection Tickers by ID: This endpoint allows you to query the latest floor price and 24hr volume of a NFT collection, on each NFT marketplace, e.g. OpenSea and LooksRare
  • NFTs List (ID Map): This endpoint allows you to query all supported NFTs with ID, contract address, name, asset platform ID and symbol on CoinGecko
  • 💼 NFTs List with Market Data: This endpoint allows you to query all the supported NFT collections with floor price, market cap, volume and market related data on CoinGecko
  • Token Price by Token Addresses: This endpoint allows you to get token price based on the provided token contract address on a network
  • Check API server status: This endpoint allows you to check the API server status
  • Specific Pool Data by Pool Address: This endpoint allows you to query the specific pool based on the provided network and pool address
  • Pool OHLCV chart by Pool Address: 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
  • Pool Tokens Info by Pool Address: 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
  • Past 24 Hour Trades by Pool Address: This endpoint allows you to query the last 300 trades in the past 24 hours based on the provided pool address
  • Multiple Pools Data by Pool Addresses: This endpoint allows you to query multiple pools based on the provided network and pool address
  • 💼 Pools by Category ID: This endpoint allows you to query all the pools based on the provided category ID
  • 🔥 Megafilter for Pools: This endpoint allows you to query pools based on various filters across all networks on GeckoTerminal
  • Crypto Treasury Holdings by Entity ID: This endpoint allows you query public companies & governments' cryptocurrency holdings by Entity ID
  • Search Queries: This endpoint allows you to search for coins, categories and markets listed on CoinGecko
  • Search Pools: This endpoint allows you to search for pools on a network
  • Coin Price by IDs: This endpoint allows you to query the prices of one or more coins by using their unique Coin API IDs
  • Supported Currencies List: This endpoint allows you to query all the supported currencies on CoinGecko
  • Coin Price by Token Addresses: This endpoint allows you to query one or more token prices using their token contract addresses
  • Token Data by Token Address: This endpoint allows you to query specific token data based on the provided token contract address on a network
  • 💼 Historical Token Holders Chart by Token Address: This endpoint allows you to get the historical token holders chart based on the provided token contract address on a network
  • Token Info by Token Address: 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
  • Token Lists by Asset Platform ID: This endpoint allows you to get full list of tokens of a blockchain network (asset platform) that is supported by Ethereum token list standard
  • 💼 Token OHLCV chart by Token Address: This endpoint allows you to get the OHLCV chart (Open, High, Low, Close, Volume) of a token based on the provided token address on a network
  • 💼 Past 24 Hour Trades by Token Address: 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
  • Tokens Data by Token Addresses: This endpoint allows you to query multiple tokens data based on the provided token contract addresses on a network
  • Most Recently Updated Tokens List: This endpoint allows you to query 100 most recently updated tokens info of a specific network or across all networks on GeckoTerminal
  • Top Pools by Token Address: This endpoint allows you to query top pools based on the provided token contract address on a network
  • Top Pools by Dex: This endpoint allows you to query all the top pools based on the provided network and decentralized exchange (DEX)
  • Top Pools by Network: This endpoint allows you to query all the top pools based on the provided network
  • 💼 Top Token Holders by Token Address: This endpoint allows you to query top token holders based on the provided token contract address on a network
  • Trending Pools List: This endpoint allows you to query all the trending pools across all networks on GeckoTerminal
  • Trending Pools by Network: This endpoint allows you to query the trending pools based on the provided network
  • Trending Search List: This endpoint allows you query trending search coins, NFTs and categories on CoinGecko in the last 24 hours
  • 💼 Trending Search Pools: This endpoint allows you to query all the trending search pools across all networks on GeckoTerminal
  • Asset Platforms List (ID Map): This endpoint allows you to query all the asset platforms on CoinGecko
  • Authentication (Public/Demo): Authentication method for CoinGecko Public API (Demo plan users)
  • Coins Categories List with Market Data: This endpoint allows you to query all the coins categories with market data (market cap, volume, ...) on CoinGecko
  • Coins Categories List (ID Map): This endpoint allows you to query all the coins categories on CoinGecko
  • Coin Data by Token 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
  • Coin Data by 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
  • Coin Historical Data by ID: 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
  • Coin Historical Chart Data by ID: 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
  • Coin Historical Chart Data within Time Range by ID: 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
  • Coin OHLC Chart by ID: This endpoint allows you to get the OHLC chart (Open, High, Low, Close) of a coin based on particular coin ID
  • Coin Tickers by ID: This endpoint allows you to query the coin tickers on both centralized exchange (CEX) and decentralized exchange (DEX) based on a particular coin ID
  • Coins List (ID Map): This endpoint allows you to query all the supported coins on CoinGecko with coins ID, name and symbol
  • Coins List with Market Data: This endpoint allows you to query all the supported coins with price, market cap, volume and market related data
  • Crypto Treasury Holdings by Coin ID: This endpoint allows you query public companies & governments' cryptocurrency holdings by Coin ID
  • Coin Historical Chart Data by Token Address: 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
  • Coin Historical Chart Data within Time Range by Token Address: 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
  • Crypto Global Market Data: This endpoint allows you query cryptocurrency global data including active cryptocurrencies, markets, total crypto market cap and etc
  • Derivatives Exchanges List with Data: This endpoint allows you to query all the derivatives exchanges with related data (ID, name, open interest, ...) on CoinGecko
  • Derivatives Exchange Data by ID: This endpoint allows you to query the derivatives exchange's related data (ID, name, open interest, ...) based on the exchanges' ID
  • Derivatives Exchanges List (ID Map): This endpoint allows you to query all the derivatives exchanges with ID and name on CoinGecko
  • Derivatives Tickers List: This endpoint allows you to query all the tickers from derivatives exchanges on CoinGecko
  • Supported Dexes List by Network (ID Map): This endpoint allows you to query all the supported decentralized exchanges (DEXs) based on the provided network on GeckoTerminal
  • Endpoint Overview
  • Entities List (ID Map): This endpoint allows you to query all the supported entities on CoinGecko with entities ID, name, symbol, and country
  • BTC-to-Currency Exchange Rates: This endpoint allows you to query BTC exchange rates with other currencies
  • Exchanges List with data: This endpoint allows you to query all the supported exchanges with exchanges' data (ID, name, country, ...) that have active trading volumes on CoinGecko
  • Exchange Data by ID: This endpoint allows you to query exchange's data (name, year established, country, ...), exchange volume in BTC and top 100 tickers based on exchange's ID
  • Exchange Tickers by ID: This endpoint allows you to query exchange's tickers based on exchange's ID
  • Exchange Volume Chart by ID: This endpoint allows you to query the historical volume chart data with time in UNIX and trading volume data in BTC based on exchange's ID
  • Exchanges List (ID Map): This endpoint allows you to query all the exchanges with ID and name
  • Global DeFi Market Data: This endpoint allows you query top 100 cryptocurrency global decentralized finance (DeFi) data including DeFi market cap, trading volume
  • New Pools List: This endpoint allows you to query all the latest pools across all networks on GeckoTerminal
  • New Pools by Network: This endpoint allows you to query all the latest pools based on provided network
  • Supported Networks List (ID Map): This endpoint allows you to query all the supported networks on GeckoTerminal
  • NFTs Collection Data by Contract Address: This endpoint allows you to query all the NFT data (name, floor price, 24hr volume ...) based on the NFT collection contract address and respective asset platform
  • NFTs Collection Data by ID: This endpoint allows you to query all the NFT data (name, floor price, 24hr volume ...) based on the NFT collection ID
  • NFTs List (ID Map): This endpoint allows you to query all supported NFTs with ID, contract address, name, asset platform ID and symbol on CoinGecko
  • Token Price by Token Addresses: This endpoint allows you to get token price based on the provided token contract address on a network
  • Check API server status: This endpoint allows you to check the API server status
  • Specific Pool Data by Pool Address: This endpoint allows you to query the specific pool based on the provided network and pool address
  • Pool OHLCV chart by Pool Address: 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
  • Pool Tokens Info by Pool Address: 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
  • Past 24 Hour Trades by Pool Address: This endpoint allows you to query the last 300 trades in the past 24 hours based on the provided pool address
  • Multiple Pools Data by Pool Addresses: This endpoint allows you to query multiple pools based on the provided network and pool address
  • Crypto Treasury Holdings by Entity ID: This endpoint allows you query public companies & governments' cryptocurrency holdings by Entity ID
  • Search Queries: This endpoint allows you to search for coins, categories and markets listed on CoinGecko
  • Search Pools: This endpoint allows you to search for pools on a network
  • Coin Price by IDs: This endpoint allows you to query the prices of one or more coins by using their unique Coin API IDs
  • Supported Currencies List: This endpoint allows you to query all the supported currencies on CoinGecko
  • Coin Price by Token Addresses: This endpoint allows you to query one or more token prices using their token contract addresses
  • Token Data by Token Address: This endpoint allows you to query specific token data based on the provided token contract address on a network
  • Token Info by Token Address: 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
  • Token Lists by Asset Platform ID: This endpoint allows you to get full list of tokens of a blockchain network (asset platform) that is supported by Ethereum token list standard
  • Tokens Data by Token Addresses: This endpoint allows you to query multiple tokens data based on the provided token contract addresses on a network
  • Most Recently Updated Tokens List: This endpoint allows you to query 100 most recently updated tokens info of a specific network or across all networks on GeckoTerminal
  • Top Pools by Token Address: This endpoint allows you to query top pools based on the provided token contract address on a network
  • Top Pools by Dex: This endpoint allows you to query all the top pools based on the provided network and decentralized exchange (DEX)
  • Top Pools by Network: This endpoint allows you to query all the top pools based on the provided network
  • Trending Pools List: This endpoint allows you to query all the trending pools across all networks on GeckoTerminal
  • Trending Pools by Network: This endpoint allows you to query the trending pools based on the provided network
  • Trending Search List: This endpoint allows you query trending search coins, NFTs and categories on CoinGecko in the last 24 hours
  • CGSimplePrice: Subscribe to receive real-time price updates for tokens, as seen on CoinGecko.com
  • WebSocket (Beta): CoinGecko API: Stream Real-Time Crypto Data with WebSockets
  • OnchainSimpleTokenPrice: Subscribe to receive real-time price updates for tokens, as seen on GeckoTerminal.com
  • OnchainTrade: Subscribe to receive real-time transaction (trade/swap) updates for pools, as seen on GeckoTerminal.com
  • OnchainOHLCV: Subscribe to receive real-time OHLCV updates for pools, as seen on GeckoTerminal.com

Optional