Coins
1. Search Coins
Description:
Search coins by optional filters: name, symbol, category, chain, and contract_address. If all filters are None, returns all coins sorted by market cap rank.
Parameters:
name(string, optional): Filter by coin name (case-insensitive).symbol(string, optional): Filter by coin symbol (case-insensitive).category(string, optional): Filter by coin category (case-insensitive).chain(string, optional): Filter by blockchain platform (e.g., ethereum, binance-smart-chain).contract_address(string, optional): Filter by contract address (works across all platforms).
Example request:
Response:
Response Fields:
id(string): Unique identifier for the coin, typically matching the Coingecko ID.name(string): Full name of the cryptocurrency (e.g., "Bitcoin", "Ethereum").symbol(string): Trading symbol of the cryptocurrency (e.g., "BTC", "ETH").market_cap_rank(integer): Market capitalization rank among all cryptocurrencies.contract_address(string or null): The primary blockchain contract address if the coin is a token. Null for native blockchain coins like Bitcoin.platforms(array of strings): List of blockchain platforms where this coin/token is available.categories(array of strings): Categories that describe the coin's use case or technology (e.g., "Layer 1", "DeFi", "Smart Contract Platform").image(object): URLs to various sizes of the coin's logo image.thumb(string): URL to thumbnail-sized image.small(string): URL to small-sized image.large(string): URL to large-sized image.
market_data(object): Current market information about the coin.current_price(object): Current trading price in different currencies.usd(number): Price in US dollars.Additional currencies may be included.
market_cap(object): Total market capitalization in different currencies.usd(number): Market cap in US dollars.Additional currencies may be included.
total_volume(object): Trading volume in different currencies.usd(number): 24-hour trading volume in US dollars.Additional currencies may be included.
price_change_percentage_24h(number): Price change percentage in the last 24 hours.price_change_percentage_7d(number): Price change percentage in the last 7 days.Additional time periods may be included.
description(object): Textual descriptions of the cryptocurrency.en(string): English description of the coin, its technology, and use cases.Additional languages may be included.
links(object): Various web links related to the project.homepage(array of strings): Official website URLs.blockchain_site(array of strings): Block explorer URLs.twitter_screen_name(string): Twitter handle without the @ symbol.telegram_channel_identifier(string): Telegram channel name.subreddit_url(string): URL to the project's subreddit.Additional social media and community links may be included.
contracts(object, optional): Detailed contract addresses across multiple platforms.Each key is a platform name (e.g., "ethereum", "binance-smart-chain").
Each value is the corresponding contract address on that platform.
community_data(object, optional): Statistics about the project's community.twitter_followers(integer): Number of Twitter followers.telegram_channel_user_count(integer): Number of Telegram channel members.reddit_subscribers(integer): Number of subreddit subscribers.Additional community metrics may be included.
developer_data(object, optional): Statistics about development activity.github_stats(object): GitHub repository statistics.commit_count_4_weeks(integer): Number of commits in the last 4 weeks.Additional development metrics may be included.
Note: Some fields may be null or missing if the data is not available for a particular coin.
2. Get Platforms
Description:
Get a list of all blockchain platforms that have coins in the index. This can be used to populate dropdown menus for the chain parameter in the search endpoint.
Example request:
Example Response:
Telegram-related metrics:
hour_social_perc_diff: Percentage change in social mentions over the last hour in Telegram groupsday_social_perc_diff: Percentage change in social mentions over the last 24 hours in Telegram groupssentiment_score: Aggregated sentiment analysis score from Telegram messages (0-1, where 1 is most positive)symbol_count: Number of times the coin's symbol was mentioned in Telegramname_count: Number of times the coin's name was mentioned in Telegramsocial_mentions: Total number of mentions (both symbol and name) in Telegramsocial_dominance: Percentage of all crypto discussions that mention this coin (0-1)relative_social_dominance: Social dominance compared to the average of all tracked coins
LunarCrush metrics (prefixed with lc_):
lc_posts_created: Number of new social media posts about the coinlc_posts_active: Number of active discussions about the coinlc_interactions: Total social media engagements (likes, comments, shares)lc_contributors_created: Number of unique users creating content about the coinlc_contributors_active: Number of unique users engaging with content about the coinlc_sentiment: LunarCrush's sentiment analysis score (0-1)lc_social_dominance: LunarCrush's social dominance metriclc_social_volume_24h: Total social media volume in the last 24 hourslc_galaxy_score: LunarCrush's proprietary scoring (0-100)lc_galaxy_score_previous: Previous period's galaxy scorelc_alt_rank: Alternative ranking based on social metricslc_alt_rank_previous: Previous period's alt rank
3. Get Coin Details
Description:
Retrieves comprehensive information about a specific cryptocurrency or token. This endpoint provides detailed data including market statistics, social metrics, project description, and links to relevant resources. You can identify the coin using one of several identifiers, with the system trying them in order of specificity.
Parameters:
contract_address(string, optional): The blockchain contract address of the token. This is the most specific identifier for tokens and works across all supported platforms.coin_id(string, optional): The Coingecko coin ID. This is a very specific identifier that uniquely identifies a coin in the database.symbol(string, optional): The trading symbol of the coin (e.g., BTC, ETH). Note that symbols are not always unique; if multiple coins share the same symbol, the endpoint will return the one with the highest market cap.project_name(string, optional): The full name of the project (e.g., Bitcoin, Ethereum). This is the least specific identifier.
Note: At least one of these parameters must be provided.
Example request:
Response:
Last updated