mcp server
@miridar/coingecko-mcp-server
Your AI doesn't just know about crypto – it lives in it. Real-time prices become as natural as asking the time. Historical charts appear with a thought. Market analysis flows like conversation.
Connect
Create a key, paste the endpoint into your MCP client, then run a quick probe to confirm the connection works end-to-end.
https://miridar.mcp.dock0.dev/coingecko-mcp-server/mcphttps://miridar.mcp.dock0.dev/coingecko-mcp-server/mcpcurl -sS \
-H 'Authorization: Bearer <YOUR_MCP_KEY>' \
-H 'Content-Type: application/json' \
-d '{"jsonrpc":"2.0","id":"1","method":"tools/list","params":{}}' \
https://miridar.mcp.dock0.dev/coingecko-mcp-server/mcpBefore you start
This server is currently free to use.
You can still create a key and connect it the same way as any paid server.
Step 1: sign in. Step 2: create a key. Step 3: paste the generated client config into Claude, Cursor, or Claude Code.
Dock0 generates a buyer-scoped key and a ready-to-paste client guide after sign-in.
Sign in to create keypricing
Free
Free to use
total calls
2
Lifetime traffic
success rate
100.0%
0 non-success calls
p95 latency
1000ms
Lifetime p95
stars
0
Community saves
50 tools • 0 prompts • 0 resources
Refreshed 3/10/2026, 8:54:50 PM
get_asset_platforms
When using this tool, always use the `jq_filter` parameter to reduce the response size and improve performance. Only omit if you're sure you don't need the data. This endpoint allows you to **query all the asset platforms on CoinGecko** # Response Schema ```json { $ref: '#/$defs/asset_platform_get_response', $defs: { asset_platform_get_response: { type: 'array', items: { type: 'object', properties: { id: { type: 'string', description: 'asset platform ID' }, chain_identifier: { type: 'number', description: 'chainlist\'s chain ID' }, image: { type: 'object', description: 'image of the asset platform', properties: { large: { type: 'string' }, small: { type: 'string' }, thumb: { type: 'string' } } }, name: { type: 'string', description: 'chain name' }, native_coin_id: { type: 'string', description: 'chain native coin ID' }, shortname: { type: 'string', description: 'chain shortname' } } } } } } ```
{
"type": "object",
"required": [],
"properties": {
"filter": {
"enum": [
"nft"
],
"type": "string",
"description": "apply relevant filters to results"
},
"jq_filter": {
"type": "string",
"title": "jq Filter",
"description": "A jq filter to apply to the response to include certain fields. Consult the output schema in the tool description to see the fields that are available.\n\nFor example: to include only the `name` field in every object of a results array, you can provide \".results[].name\".\n\nFor more information, see the [jq documentation](https://jqlang.org/manual/)."
}
}
}get_id_coins
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**
{
"type": "object",
"required": [
"id"
],
"properties": {
"id": {
"type": "string"
},
"tickers": {
"type": "boolean",
"description": "include tickers data, default: true"
},
"sparkline": {
"type": "boolean",
"description": "include sparkline 7 days data, default: false"
},
"market_data": {
"type": "boolean",
"description": "include market data, default: true"
},
"localization": {
"type": "boolean",
"description": "include all the localized languages in the response, default: true"
},
"community_data": {
"type": "boolean",
"description": "include community data, default: true"
},
"developer_data": {
"type": "boolean",
"description": "include developer data, default: true"
},
"dex_pair_format": {
"enum": [
"contract_address",
"symbol"
],
"type": "string",
"description": "set to `symbol` to display DEX pair base and target as symbols, default: `contract_address`"
},
"include_categories_details": {
"type": "boolean",
"description": "include categories details, default: false"
}
}
}get_list_coins_categories
When using this tool, always use the `jq_filter` parameter to reduce the response size and improve performance. Only omit if you're sure you don't need the data. This endpoint allows you to **query all the coins categories on CoinGecko** # Response Schema ```json { $ref: '#/$defs/category_get_list_response', $defs: { category_get_list_response: { type: 'object', properties: { category_id: { type: 'string', description: 'category ID' }, name: { type: 'string', description: 'category name' } } } } } ```
{
"type": "object",
"required": [],
"properties": {
"jq_filter": {
"type": "string",
"title": "jq Filter",
"description": "A jq filter to apply to the response to include certain fields. Consult the output schema in the tool description to see the fields that are available.\n\nFor example: to include only the `name` field in every object of a results array, you can provide \".results[].name\".\n\nFor more information, see the [jq documentation](https://jqlang.org/manual/)."
}
}
}get_new_coins_list
When using this tool, always use the `jq_filter` parameter to reduce the response size and improve performance. Only omit if you're sure you don't need the data. This endpoint allows you to **query the latest 200 coins that recently listed on CoinGecko** # Response Schema ```json { $ref: '#/$defs/list_get_new_response', $defs: { list_get_new_response: { type: 'array', items: { type: 'object', properties: { id: { type: 'string', description: 'coin ID' }, activated_at: { type: 'number', description: 'timestamp when coin was activated on CoinGecko' }, name: { type: 'string', description: 'coin name' }, symbol: { type: 'string', description: 'coin symbol' } } } } } } ```
{
"type": "object",
"required": [],
"properties": {
"jq_filter": {
"type": "string",
"title": "jq Filter",
"description": "A jq filter to apply to the response to include certain fields. Consult the output schema in the tool description to see the fields that are available.\n\nFor example: to include only the `name` field in every object of a results array, you can provide \".results[].name\".\n\nFor more information, see the [jq documentation](https://jqlang.org/manual/)."
}
}
}get_coins_markets
When using this tool, always use the `jq_filter` parameter to reduce the response size and improve performance. Only omit if you're sure you don't need the data. This endpoint allows you to **query all the supported coins with price, market cap, volume and market related data** # Response Schema ```json { $ref: '#/$defs/market_get_response', $defs: { market_get_response: { type: 'array', items: { type: 'object', properties: { id: { type: 'string', description: 'coin ID' }, ath: { type: 'number', description: 'coin all time high (ATH) in currency' }, ath_change_percentage: { type: 'number', description: 'coin all time high (ATH) change in percentage' }, ath_date: { type: 'string', description: 'coin all time high (ATH) date', format: 'date-time' }, atl: { type: 'number', description: 'coin all time low (atl) in currency' }, atl_change_percentage: { type: 'number', description: 'coin all time low (atl) change in percentage' }, atl_date: { type: 'string', description: 'coin all time low (atl) date', format: 'date-time' }, circulating_supply: { type: 'number', description: 'coin circulating supply' }, current_price: { type: 'number', description: 'coin current price in currency' }, fully_diluted_valuation: { type: 'number', description: 'coin fully diluted valuation (fdv) in currency' }, high_24h: { type: 'number', description: 'coin 24hr price high in currency' }, image: { type: 'string', description: 'coin image url' }, last_updated: { type: 'string', description: 'coin last updated timestamp', format: 'date-time' }, low_24h: { type: 'number', description: 'coin 24hr price low in currency' }, market_cap: { type: 'number', description: 'coin market cap in currency' }, market_cap_change_24h: { type: 'number', description: 'coin 24hr market cap change in currency' }, market_cap_change_percentage_24h: { type: 'number', description: 'coin 24hr market cap change in percentage' }, market_cap_rank: { type: 'number', description: 'coin rank by market cap' }, max_supply: { type: 'number', description: 'coin max supply' }, name: { type: 'string', description: 'coin name' }, price_change_24h: { type: 'number', description: 'coin 24hr price change in currency' }, price_change_percentage_24h: { type: 'number', description: 'coin 24hr price change in percentage' }, roi: { type: 'object', description: 'return on investment data', properties: { currency: { type: 'string', description: 'ROI currency' }, percentage: { type: 'number', description: 'ROI percentage' }, times: { type: 'number', description: 'ROI multiplier' } }, required: [ 'currency', 'percentage', 'times' ] }, symbol: { type: 'string', description: 'coin symbol' }, total_supply: { type: 'number', description: 'coin total supply' }, total_volume: { type: 'number', description: 'coin total trading volume in currency' } } } } } } ```
{
"type": "object",
"required": [
"vs_currency"
],
"properties": {
"ids": {
"type": "string",
"description": "coins' IDs, comma-separated if querying more than 1 coin. \n *refers to [`/coins/list`](/reference/coins-list)."
},
"page": {
"type": "number",
"description": "page through results, default: 1"
},
"names": {
"type": "string",
"description": "coins' names, comma-separated if querying more than 1 coin."
},
"order": {
"enum": [
"market_cap_asc",
"market_cap_desc",
"volume_asc",
"volume_desc",
"id_asc",
"id_desc"
],
"type": "string",
"description": "sort result by field, default: market_cap_desc"
},
"locale": {
"enum": [
"ar",
"bg",
"cs",
"da",
"de",
"el",
"en",
"es",
"fi",
"fr",
"he",
"hi",
"hr",
"hu",
"id",
"it",
"ja",
"ko",
"lt",
"nl",
"no",
"pl",
"pt",
"ro",
"ru",
"sk",
"sl",
"sv",
"th",
"tr",
"uk",
"vi",
"zh",
"zh-tw"
],
"type": "string",
"description": "language background, default: en"
},
"symbols": {
"type": "string",
"description": "coins' symbols, comma-separated if querying more than 1 coin."
},
"category": {
"type": "string",
"description": "filter based on coins' category \n *refers to [`/coins/categories/list`](/reference/coins-categories-list)."
},
"per_page": {
"type": "number",
"description": "total results per page, default: 100 \n Valid values: 1...250"
},
"jq_filter": {
"type": "string",
"title": "jq Filter",
"description": "A jq filter to apply to the response to include certain fields. Consult the output schema in the tool description to see the fields that are available.\n\nFor example: to include only the `name` field in every object of a results array, you can provide \".results[].name\".\n\nFor more information, see the [jq documentation](https://jqlang.org/manual/)."
},
"precision": {
"enum": [
"full",
"0",
"1",
"2",
"3",
"4",
"5",
"6",
"7",
"8",
"9",
"10",
"11",
"12",
"13",
"14",
"15",
"16",
"17",
"18"
],
"type": "string",
"description": "decimal place for currency price value"
},
"sparkline": {
"type": "boolean",
"description": "include sparkline 7 days data, default: false"
},
"vs_currency": {
"type": "string",
"description": "target currency of coins and market data \n *refers to [`/simple/supported_vs_currencies`](/reference/simple-supported-currencies)."
},
"include_tokens": {
"enum": [
"top",
"all"
],
"type": "string",
"description": "for `symbols` lookups, specify `all` to include all matching tokens \n Default `top` returns top-ranked tokens (by market cap or volume)"
},
"price_change_percentage": {
"type": "string",
"description": "include price change percentage timeframe, comma-separated if query more than 1 timeframe \n Valid values: 1h, 24h, 7d, 14d, 30d, 200d, 1y"
}
}
}get_coins_top_gainers_losers
When using this tool, always use the `jq_filter` parameter to reduce the response size and improve performance. Only omit if you're sure you don't need the data. This endpoint allows you to **query the top 30 coins with largest price gain and loss by a specific time duration** # Response Schema ```json { $ref: '#/$defs/top_gainers_loser_get_response', $defs: { top_gainers_loser_get_response: { type: 'object', properties: { top_gainers: { type: 'array', items: { type: 'object', properties: { id: { type: 'string', description: 'coin ID' }, image: { type: 'string', description: 'coin image url' }, market_cap_rank: { type: 'number', description: 'coin rank by market cap' }, name: { type: 'string', description: 'coin name' }, symbol: { type: 'string', description: 'coin symbol' }, usd: { type: 'number', description: 'coin price in USD' }, usd_14d_change: { type: 'number', description: 'coin 14 day change percentage in USD' }, usd_1h_change: { type: 'number', description: 'coin 1hr change percentage in USD' }, usd_1y_change: { type: 'number', description: 'coin 1 year change percentage in USD' }, usd_200d_change: { type: 'number', description: 'coin 200 day change percentage in USD' }, usd_24h_change: { type: 'number', description: 'coin 24hr change percentage in USD' }, usd_24h_vol: { type: 'number', description: 'coin 24hr volume in USD' }, usd_30d_change: { type: 'number', description: 'coin 30 day change percentage in USD' }, usd_7d_change: { type: 'number', description: 'coin 7 day change percentage in USD' } } } }, top_losers: { type: 'array', items: { type: 'object', properties: { id: { type: 'string', description: 'coin ID' }, image: { type: 'string', description: 'coin image url' }, market_cap_rank: { type: 'number', description: 'coin rank by market cap' }, name: { type: 'string', description: 'coin name' }, symbol: { type: 'string', description: 'coin symbol' }, usd: { type: 'number', description: 'coin price in USD' }, usd_14d_change: { type: 'number', description: 'coin 14 day change percentage in USD' }, usd_1h_change: { type: 'number', description: 'coin 1hr change percentage in USD' }, usd_1y_change: { type: 'number', description: 'coin 1 year change percentage in USD' }, usd_200d_change: { type: 'number', description: 'coin 200 day change percentage in USD' }, usd_24h_change: { type: 'number', description: 'coin 24hr change percentage in USD' }, usd_24h_vol: { type: 'number', description: 'coin 24hr volume in USD' }, usd_30d_change: { type: 'number', description: 'coin 30 day change percentage in USD' }, usd_7d_change: { type: 'number', description: 'coin 7 day change percentage in USD' } } } } } } } } ```
{
"type": "object",
"required": [
"vs_currency"
],
"properties": {
"duration": {
"enum": [
"1h",
"24h",
"7d",
"14d",
"30d",
"60d",
"1y"
],
"type": "string",
"description": "filter result by time range \n Default value: `24h`"
},
"jq_filter": {
"type": "string",
"title": "jq Filter",
"description": "A jq filter to apply to the response to include certain fields. Consult the output schema in the tool description to see the fields that are available.\n\nFor example: to include only the `name` field in every object of a results array, you can provide \".results[].name\".\n\nFor more information, see the [jq documentation](https://jqlang.org/manual/)."
},
"top_coins": {
"enum": [
"300",
"500",
"1000",
"all"
],
"type": "string",
"description": "filter result by market cap ranking (top 300 to 1000) or all coins (including coins that do not have market cap) \n Default value: `1000`"
},
"vs_currency": {
"type": "string",
"description": "target currency of coins \n *refers to [`/simple/supported_vs_currencies`](/reference/simple-supported-currencies)."
},
"price_change_percentage": {
"type": "string",
"description": "include price change percentage timeframe, comma-separated if query more than 1 price change percentage timeframe \n Valid values: 1h, 24h, 7d, 14d, 30d, 200d, 1y"
}
}
}get_coins_contract
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**
{
"type": "object",
"required": [
"id",
"contract_address"
],
"properties": {
"id": {
"type": "string"
},
"contract_address": {
"type": "string"
}
}
}get_range_contract_coins_market_chart
When using this tool, always use the `jq_filter` parameter to reduce the response size and improve performance. Only omit if you're sure you don't need the data. 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** # Response Schema ```json { $ref: '#/$defs/market_chart_get_range_response', $defs: { market_chart_get_range_response: { type: 'object', properties: { market_caps: { type: 'array', items: { type: 'array', items: { type: 'number' } } }, prices: { type: 'array', items: { type: 'array', items: { type: 'number' } } }, total_volumes: { type: 'array', items: { type: 'array', items: { type: 'number' } } } } } } } ```
{
"type": "object",
"required": [
"id",
"contract_address",
"from",
"to",
"vs_currency"
],
"properties": {
"id": {
"type": "string"
},
"to": {
"type": "string",
"description": "ending date in ISO date string (`YYYY-MM-DD` or `YYYY-MM-DDTHH:MM`) or UNIX timestamp. \n **use ISO date string for best compatibility**"
},
"from": {
"type": "string",
"description": "starting date in ISO date string (`YYYY-MM-DD` or `YYYY-MM-DDTHH:MM`) or UNIX timestamp. \n **use ISO date string for best compatibility**"
},
"interval": {
"enum": [
"5m",
"hourly",
"daily"
],
"type": "string",
"description": "data interval, leave empty for auto granularity"
},
"jq_filter": {
"type": "string",
"title": "jq Filter",
"description": "A jq filter to apply to the response to include certain fields. Consult the output schema in the tool description to see the fields that are available.\n\nFor example: to include only the `name` field in every object of a results array, you can provide \".results[].name\".\n\nFor more information, see the [jq documentation](https://jqlang.org/manual/)."
},
"precision": {
"enum": [
"full",
"0",
"1",
"2",
"3",
"4",
"5",
"6",
"7",
"8",
"9",
"10",
"11",
"12",
"13",
"14",
"15",
"16",
"17",
"18"
],
"type": "string",
"description": "decimal place for currency price value"
},
"vs_currency": {
"type": "string",
"description": "target currency of market data \n *refers to [`/simple/supported_vs_currencies`](/reference/simple-supported-currencies)."
},
"contract_address": {
"type": "string"
}
}
}get_coins_history
When using this tool, always use the `jq_filter` parameter to reduce the response size and improve performance. Only omit if you're sure you don't need the data. 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** # Response Schema ```json { $ref: '#/$defs/history_get_response', $defs: { history_get_response: { type: 'object', properties: { id: { type: 'string', description: 'coin ID' }, community_data: { type: 'object', description: 'coin community data', properties: { facebook_likes: { type: 'number', description: 'coin facebook likes' }, reddit_accounts_active_48h: { type: 'number', description: 'coin reddit accounts active 48h' }, reddit_average_comments_48h: { type: 'number', description: 'coin reddit average comments 48h' }, reddit_average_posts_48h: { type: 'number', description: 'coin reddit average posts 48h' }, reddit_subscribers: { type: 'number', description: 'coin reddit subscribers' } } }, developer_data: { type: 'object', description: 'coin developer data', properties: { closed_issues: { type: 'number', description: 'coin repository closed issues' }, code_additions_deletions_4_weeks: { type: 'object', description: 'coin code additions deletions 4 weeks', properties: { additions: { type: 'number' }, deletions: { type: 'number' } } }, commit_count_4_weeks: { type: 'number', description: 'coin commit count 4 weeks' }, forks: { type: 'number', description: 'coin repository forks' }, pull_request_contributors: { type: 'number', description: 'coin repository pull request contributors' }, pull_requests_merged: { type: 'number', description: 'coin repository pull requests merged' }, stars: { type: 'number', description: 'coin repository stars' }, subscribers: { type: 'number', description: 'coin repository subscribers' }, total_issues: { type: 'number', description: 'coin repository total issues' } } }, image: { type: 'object', description: 'coin image url', properties: { small: { type: 'string' }, thumb: { type: 'string' } } }, localization: { type: 'object', description: 'coin localization', additionalProperties: true }, market_data: { type: 'object', description: 'coin market data', properties: { current_price: { type: 'object', description: 'coin current price', properties: { btc: { type: 'number' }, eur: { type: 'number' }, usd: { type: 'number' } } }, market_cap: { type: 'object', description: 'coin market cap', properties: { btc: { type: 'number' }, eur: { type: 'number' }, usd: { type: 'number' } } }, total_volume: { type: 'object', description: 'coin total volume', properties: { btc: { type: 'number' }, eur: { type: 'number' }, usd: { type: 'number' } } } } }, name: { type: 'string', description: 'coin name' }, public_interest_stats: { type: 'object', description: 'coin public interest stats', properties: { alexa_rank: { type: 'number', description: 'coin alexa rank' }, bing_matches: { type: 'number', description: 'coin bing matches' } } }, symbol: { type: 'string', description: 'coin symbol' } } } } } ```
{
"type": "object",
"required": [
"id",
"date"
],
"properties": {
"id": {
"type": "string"
},
"date": {
"type": "string",
"description": "date of data snapshot (`YYYY-MM-DD`)"
},
"jq_filter": {
"type": "string",
"title": "jq Filter",
"description": "A jq filter to apply to the response to include certain fields. Consult the output schema in the tool description to see the fields that are available.\n\nFor example: to include only the `name` field in every object of a results array, you can provide \".results[].name\".\n\nFor more information, see the [jq documentation](https://jqlang.org/manual/)."
},
"localization": {
"type": "boolean",
"description": "include all the localized languages in response, default: true"
}
}
}get_range_coins_market_chart
When using this tool, always use the `jq_filter` parameter to reduce the response size and improve performance. Only omit if you're sure you don't need the data. 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** # Response Schema ```json { $ref: '#/$defs/market_chart_get_range_response', $defs: { market_chart_get_range_response: { type: 'object', properties: { market_caps: { type: 'array', items: { type: 'array', items: { type: 'number' } } }, prices: { type: 'array', items: { type: 'array', items: { type: 'number' } } }, total_volumes: { type: 'array', items: { type: 'array', items: { type: 'number' } } } } } } } ```
{
"type": "object",
"required": [
"id",
"from",
"to",
"vs_currency"
],
"properties": {
"id": {
"type": "string"
},
"to": {
"type": "string",
"description": "ending date in ISO date string (`YYYY-MM-DD` or `YYYY-MM-DDTHH:MM`) or UNIX timestamp. \n **use ISO date string for best compatibility**"
},
"from": {
"type": "string",
"description": "starting date in ISO date string (`YYYY-MM-DD` or `YYYY-MM-DDTHH:MM`) or UNIX timestamp. \n **use ISO date string for best compatibility**"
},
"interval": {
"enum": [
"5m",
"hourly",
"daily"
],
"type": "string",
"description": "data interval, leave empty for auto granularity"
},
"jq_filter": {
"type": "string",
"title": "jq Filter",
"description": "A jq filter to apply to the response to include certain fields. Consult the output schema in the tool description to see the fields that are available.\n\nFor example: to include only the `name` field in every object of a results array, you can provide \".results[].name\".\n\nFor more information, see the [jq documentation](https://jqlang.org/manual/)."
},
"precision": {
"enum": [
"full",
"0",
"1",
"2",
"3",
"4",
"5",
"6",
"7",
"8",
"9",
"10",
"11",
"12",
"13",
"14",
"15",
"16",
"17",
"18"
],
"type": "string",
"description": "decimal place for currency price value"
},
"vs_currency": {
"type": "string",
"description": "target currency of market data \n *refers to [`/simple/supported_vs_currencies`](/reference/simple-supported-currencies)."
}
}
}get_range_coins_ohlc
When using this tool, always use the `jq_filter` parameter to reduce the response size and improve performance. Only omit if you're sure you don't need the data. 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** # Response Schema ```json { $ref: '#/$defs/ohlc_get_range_response', $defs: { ohlc_get_range_response: { type: 'array', items: { type: 'array', items: { type: 'number' } } } } } ```
{
"type": "object",
"required": [
"id",
"from",
"interval",
"to",
"vs_currency"
],
"properties": {
"id": {
"type": "string"
},
"to": {
"type": "string",
"description": "ending date in ISO date string (`YYYY-MM-DD` or `YYYY-MM-DDTHH:MM`) or UNIX timestamp. \n **use ISO date string for best compatibility**"
},
"from": {
"type": "string",
"description": "starting date in ISO date string (`YYYY-MM-DD` or `YYYY-MM-DDTHH:MM`) or UNIX timestamp. \n **use ISO date string for best compatibility**"
},
"interval": {
"enum": [
"daily",
"hourly"
],
"type": "string",
"description": "data interval"
},
"jq_filter": {
"type": "string",
"title": "jq Filter",
"description": "A jq filter to apply to the response to include certain fields. Consult the output schema in the tool description to see the fields that are available.\n\nFor example: to include only the `name` field in every object of a results array, you can provide \".results[].name\".\n\nFor more information, see the [jq documentation](https://jqlang.org/manual/)."
},
"vs_currency": {
"type": "string",
"description": "target currency of price data \n *refers to [`/simple/supported_vs_currencies`](/reference/simple-supported-currencies)."
}
}
}get_id_exchanges
When using this tool, always use the `jq_filter` parameter to reduce the response size and improve performance. Only omit if you're sure you don't need the data. 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** # Response Schema ```json { $ref: '#/$defs/exchange_get_id_response', $defs: { exchange_get_id_response: { type: 'object', properties: { alert_notice: { type: 'string', description: 'alert notice for exchange' }, centralized: { type: 'boolean', description: 'exchange type (true for centralized, false for decentralized)' }, coins: { type: 'number', description: 'number of coins listed on the exchange' }, country: { type: 'string', description: 'exchange incorporated country' }, description: { type: 'string', description: 'exchange description' }, facebook_url: { type: 'string', description: 'exchange facebook url' }, has_trading_incentive: { type: 'boolean', description: 'exchange trading incentive' }, image: { type: 'string', description: 'exchange image url' }, name: { type: 'string', description: 'exchange name' }, other_url_1: { type: 'string' }, other_url_2: { type: 'string' }, pairs: { type: 'number', description: 'number of trading pairs on the exchange' }, public_notice: { type: 'string', description: 'public notice for exchange' }, reddit_url: { type: 'string', description: 'exchange reddit url' }, slack_url: { type: 'string', description: 'exchange slack url' }, telegram_url: { type: 'string', description: 'exchange telegram url' }, tickers: { type: 'array', items: { type: 'object', properties: { name: { type: 'string', description: 'coin name' }, tickers: { type: 'array', description: 'list of tickers', items: { type: 'object', properties: { base: { type: 'string', description: 'coin ticker base currency' }, bid_ask_spread_percentage: { type: 'number', description: 'coin ticker bid ask spread percentage' }, coin_id: { type: 'string', description: 'coin ticker base currency coin ID' }, converted_last: { type: 'object', description: 'coin ticker converted last price', properties: { btc: { type: 'number' }, eth: { type: 'number' }, usd: { type: 'number' } } }, converted_volume: { type: 'object', description: 'coin ticker converted volume', properties: { btc: { type: 'number' }, eth: { type: 'number' }, usd: { type: 'number' } } }, cost_to_move_down_usd: { type: 'number', description: 'coin ticker cost to move down in usd' }, cost_to_move_up_usd: { type: 'number', description: 'coin ticker cost to move up in usd' }, is_anomaly: { type: 'boolean', description: 'coin ticker anomaly' }, is_stale: { type: 'boolean', description: 'coin ticker stale' }, last: { type: 'number', description: 'coin ticker last price' }, last_fetch_at: { type: 'string', description: 'coin ticker last fetch timestamp' }, last_traded_at: { type: 'string', description: 'coin ticker last traded timestamp' }, market: { type: 'object', description: 'coin ticker exchange', properties: { has_trading_incentive: { type: 'boolean', description: 'exchange trading incentive' }, identifier: { type: 'string', description: 'exchange identifier' }, name: { type: 'string', description: 'exchange name' }, logo: { type: 'string', description: 'exchange image url' } }, required: [ 'has_trading_incentive', 'identifier', 'name' ] }, target: { type: 'string', description: 'coin ticker target currency' }, target_coin_id: { type: 'string', description: 'coin ticker target currency coin ID' }, timestamp: { type: 'string', description: 'coin ticker timestamp' }, token_info_url: { type: 'string', description: 'coin ticker token info url' }, trade_url: { type: 'string', description: 'coin ticker trade url' }, trust_score: { type: 'string', description: 'coin ticker trust score' }, volume: { type: 'number', description: 'coin ticker volume' } } } } } } }, trade_volume_24h_btc: { type: 'number' }, trust_score: { type: 'number', description: 'exchange trust score' }, trust_score_rank: { type: 'number', description: 'exchange trust score rank' }, twitter_handle: { type: 'string', description: 'exchange twitter handle' }, url: { type: 'string', description: 'exchange website url' }, year_established: { type: 'number', description: 'exchange established year' } } } } } ```
{
"type": "object",
"required": [
"id"
],
"properties": {
"id": {
"type": "string"
},
"jq_filter": {
"type": "string",
"title": "jq Filter",
"description": "A jq filter to apply to the response to include certain fields. Consult the output schema in the tool description to see the fields that are available.\n\nFor example: to include only the `name` field in every object of a results array, you can provide \".results[].name\".\n\nFor more information, see the [jq documentation](https://jqlang.org/manual/)."
},
"dex_pair_format": {
"enum": [
"contract_address",
"symbol"
],
"type": "string",
"description": "set to `symbol` to display DEX pair base and target as symbols, default: `contract_address`"
}
}
}get_list_exchanges
When using this tool, always use the `jq_filter` parameter to reduce the response size and improve performance. Only omit if you're sure you don't need the data. This endpoint allows you to **query all the exchanges with ID and name** # Response Schema ```json { $ref: '#/$defs/exchange_get_list_response', $defs: { exchange_get_list_response: { type: 'array', items: { type: 'object', properties: { id: { type: 'string', description: 'exchange ID' }, name: { type: 'string', description: 'exchange name' } }, required: [ 'id', 'name' ] } } } } ```
{
"type": "object",
"required": [],
"properties": {
"status": {
"enum": [
"active",
"inactive"
],
"type": "string",
"description": "filter by status of exchanges, default: active"
},
"jq_filter": {
"type": "string",
"title": "jq Filter",
"description": "A jq filter to apply to the response to include certain fields. Consult the output schema in the tool description to see the fields that are available.\n\nFor example: to include only the `name` field in every object of a results array, you can provide \".results[].name\".\n\nFor more information, see the [jq documentation](https://jqlang.org/manual/)."
}
}
}get_exchanges_tickers
When using this tool, always use the `jq_filter` parameter to reduce the response size and improve performance. Only omit if you're sure you don't need the data. This endpoint allows you to **query exchange's tickers based on exchange's ID** # Response Schema ```json { $ref: '#/$defs/ticker_get_response', $defs: { ticker_get_response: { type: 'object', properties: { name: { type: 'string', description: 'coin name' }, tickers: { type: 'array', description: 'list of tickers', items: { type: 'object', properties: { base: { type: 'string', description: 'coin ticker base currency' }, bid_ask_spread_percentage: { type: 'number', description: 'coin ticker bid ask spread percentage' }, coin_id: { type: 'string', description: 'coin ticker base currency coin ID' }, converted_last: { type: 'object', description: 'coin ticker converted last price', properties: { btc: { type: 'number' }, eth: { type: 'number' }, usd: { type: 'number' } } }, converted_volume: { type: 'object', description: 'coin ticker converted volume', properties: { btc: { type: 'number' }, eth: { type: 'number' }, usd: { type: 'number' } } }, cost_to_move_down_usd: { type: 'number', description: 'coin ticker cost to move down in usd' }, cost_to_move_up_usd: { type: 'number', description: 'coin ticker cost to move up in usd' }, is_anomaly: { type: 'boolean', description: 'coin ticker anomaly' }, is_stale: { type: 'boolean', description: 'coin ticker stale' }, last: { type: 'number', description: 'coin ticker last price' }, last_fetch_at: { type: 'string', description: 'coin ticker last fetch timestamp' }, last_traded_at: { type: 'string', description: 'coin ticker last traded timestamp' }, market: { type: 'object', description: 'coin ticker exchange', properties: { has_trading_incentive: { type: 'boolean', description: 'exchange trading incentive' }, identifier: { type: 'string', description: 'exchange identifier' }, name: { type: 'string', description: 'exchange name' }, logo: { type: 'string', description: 'exchange image url' } }, required: [ 'has_trading_incentive', 'identifier', 'name' ] }, target: { type: 'string', description: 'coin ticker target currency' }, target_coin_id: { type: 'string', description: 'coin ticker target currency coin ID' }, timestamp: { type: 'string', description: 'coin ticker timestamp' }, token_info_url: { type: 'string', description: 'coin ticker token info url' }, trade_url: { type: 'string', description: 'coin ticker trade url' }, trust_score: { type: 'string', description: 'coin ticker trust score' }, volume: { type: 'number', description: 'coin ticker volume' } } } } } } } } ```
{
"type": "object",
"required": [
"id"
],
"properties": {
"id": {
"type": "string"
},
"page": {
"type": "number",
"description": "page through results"
},
"depth": {
"type": "boolean",
"description": "include 2% orderbook depth (Example: cost_to_move_up_usd & cost_to_move_down_usd),default: false"
},
"order": {
"enum": [
"market_cap_asc",
"market_cap_desc",
"trust_score_desc",
"trust_score_asc",
"volume_desc",
"volume_asc",
"base_target"
],
"type": "string",
"description": "use this to sort the order of responses, default: trust_score_desc"
},
"coin_ids": {
"type": "string",
"description": "filter tickers by coin IDs, comma-separated if querying more than 1 coin \n *refers to [`/coins/list`](/reference/coins-list)."
},
"jq_filter": {
"type": "string",
"title": "jq Filter",
"description": "A jq filter to apply to the response to include certain fields. Consult the output schema in the tool description to see the fields that are available.\n\nFor example: to include only the `name` field in every object of a results array, you can provide \".results[].name\".\n\nFor more information, see the [jq documentation](https://jqlang.org/manual/)."
},
"dex_pair_format": {
"enum": [
"contract_address",
"symbol"
],
"type": "string",
"description": "set to `symbol` to display DEX pair base and target as symbols, default: `contract_address`"
},
"include_exchange_logo": {
"type": "boolean",
"description": "include exchange logo, default: false"
}
}
}get_range_exchanges_volume_chart
When using this tool, always use the `jq_filter` parameter to reduce the response size and improve performance. Only omit if you're sure you don't need the data. This endpoint allows you to **query the historical volume chart data in BTC by specifying date range in UNIX based on exchange's ID** # Response Schema ```json { $ref: '#/$defs/volume_chart_get_range_response', $defs: { volume_chart_get_range_response: { type: 'array', items: { type: 'array', items: { type: 'number' } } } } } ```
{
"type": "object",
"required": [
"id",
"from",
"to"
],
"properties": {
"id": {
"type": "string"
},
"to": {
"type": "number",
"description": "ending date in UNIX timestamp"
},
"from": {
"type": "number",
"description": "starting date in UNIX timestamp "
},
"jq_filter": {
"type": "string",
"title": "jq Filter",
"description": "A jq filter to apply to the response to include certain fields. Consult the output schema in the tool description to see the fields that are available.\n\nFor example: to include only the `name` field in every object of a results array, you can provide \".results[].name\".\n\nFor more information, see the [jq documentation](https://jqlang.org/manual/)."
}
}
}get_global
When using this tool, always use the `jq_filter` parameter to reduce the response size and improve performance. Only omit if you're sure you don't need the data. This endpoint allows you **query cryptocurrency global data including active cryptocurrencies, markets, total crypto market cap and etc** # Response Schema ```json { $ref: '#/$defs/global_get_response', $defs: { global_get_response: { type: 'object', properties: { data: { type: 'object', properties: { active_cryptocurrencies: { type: 'number', description: 'number of active cryptocurrencies' }, ended_icos: { type: 'number', description: 'number of ended icos' }, market_cap_change_percentage_24h_usd: { type: 'number', description: 'cryptocurrencies market cap change percentage in 24 hours in usd' }, market_cap_percentage: { type: 'object', description: 'cryptocurrencies market cap percentage', properties: { btc: { type: 'number' }, eth: { type: 'number' } } }, markets: { type: 'number', description: 'number of exchanges' }, ongoing_icos: { type: 'number', description: 'number of ongoing icos' }, total_market_cap: { type: 'object', description: 'cryptocurrencies total market cap', properties: { btc: { type: 'number' }, eth: { type: 'number' } } }, total_volume: { type: 'object', description: 'cryptocurrencies total volume', properties: { btc: { type: 'number' }, eth: { type: 'number' } } }, upcoming_icos: { type: 'number', description: 'number of upcoming icos' }, updated_at: { type: 'number' } } } } } } } ```
{
"type": "object",
"required": [],
"properties": {
"jq_filter": {
"type": "string",
"title": "jq Filter",
"description": "A jq filter to apply to the response to include certain fields. Consult the output schema in the tool description to see the fields that are available.\n\nFor example: to include only the `name` field in every object of a results array, you can provide \".results[].name\".\n\nFor more information, see the [jq documentation](https://jqlang.org/manual/)."
}
}
}get_id_nfts
When using this tool, always use the `jq_filter` parameter to reduce the response size and improve performance. Only omit if you're sure you don't need the data. This endpoint allows you to **query all the NFT data (name, floor price, 24hr volume ...) based on the NFT collection ID** # Response Schema ```json { $ref: '#/$defs/nft_get_id_response', $defs: { nft_get_id_response: { type: 'object', properties: { id: { type: 'string', description: 'NFT collection ID' }, asset_platform_id: { type: 'string', description: 'NFT collection asset platform ID' }, ath: { type: 'object', description: 'NFT collection all time highs', properties: { native_currency: { type: 'number' }, usd: { type: 'number' } } }, ath_change_percentage: { type: 'object', description: 'NFT collection all time highs change percentage', properties: { native_currency: { type: 'number' }, usd: { type: 'number' } } }, ath_date: { type: 'object', description: 'NFT collection all time highs date', properties: { native_currency: { type: 'string', format: 'date-time' }, usd: { type: 'string', format: 'date-time' } } }, banner_image: { type: 'object', description: 'NFT collection banner image url', properties: { small: { type: 'string' } } }, contract_address: { type: 'string', description: 'NFT collection contract address' }, description: { type: 'string', description: 'NFT collection description' }, explorers: { type: 'array', description: 'NFT collection block explorers links', items: { type: 'object', properties: { link: { type: 'string' }, name: { type: 'string' } } } }, floor_price: { type: 'object', description: 'NFT collection floor price', properties: { native_currency: { type: 'number' }, usd: { type: 'number' } } }, floor_price_14d_percentage_change: { type: 'object', description: 'NFT collection floor price 14 days percentage change', properties: { native_currency: { type: 'number' }, usd: { type: 'number' } } }, floor_price_1y_percentage_change: { type: 'object', description: 'NFT collection floor price 1 year percentage change', properties: { native_currency: { type: 'number' }, usd: { type: 'number' } } }, floor_price_24h_percentage_change: { type: 'object', properties: { native_currency: { type: 'number' }, usd: { type: 'number' } } }, floor_price_30d_percentage_change: { type: 'object', description: 'NFT collection floor price 30 days percentage change', properties: { native_currency: { type: 'number' }, usd: { type: 'number' } } }, floor_price_60d_percentage_change: { type: 'object', description: 'NFT collection floor price 60 days percentage change', properties: { native_currency: { type: 'number' }, usd: { type: 'number' } } }, floor_price_7d_percentage_change: { type: 'object', description: 'NFT collection floor price 7 days percentage change', properties: { native_currency: { type: 'number' }, usd: { type: 'number' } } }, floor_price_in_usd_24h_percentage_change: { type: 'number', description: 'NFT collection floor price in usd 24 hours percentage change' }, image: { type: 'object', description: 'NFT collection image url', properties: { small: { type: 'string' }, small_2x: { type: 'string' } } }, links: { type: 'object', description: 'NFT collection links', properties: { discord: { type: 'string' }, homepage: { type: 'string' }, twitter: { type: 'string' } } }, market_cap: { type: 'object', description: 'NFT collection market cap', properties: { native_currency: { type: 'number' }, usd: { type: 'number' } } }, market_cap_24h_percentage_change: { type: 'object', description: 'NFT collection market cap 24 hours percentage change', properties: { native_currency: { type: 'number' }, usd: { type: 'number' } } }, market_cap_rank: { type: 'number', description: 'coin market cap rank' }, name: { type: 'string', description: 'NFT collection name' }, native_currency: { type: 'string', description: 'NFT collection native currency' }, native_currency_symbol: { type: 'string', description: 'NFT collection native currency symbol' }, number_of_unique_addresses: { type: 'number', description: 'number of unique address owning the NFTs' }, number_of_unique_addresses_24h_percentage_change: { type: 'number', description: 'number of unique address owning the NFTs 24 hours percentage change' }, one_day_average_sale_price: { type: 'number', description: 'NFT collection one day average sale price' }, one_day_average_sale_price_24h_percentage_change: { type: 'number', description: 'NFT collection one day average sale price 24 hours percentage change' }, one_day_sales: { type: 'number', description: 'NFT collection one day sales' }, one_day_sales_24h_percentage_change: { type: 'number', description: 'NFT collection one day sales 24 hours percentage change' }, symbol: { type: 'string', description: 'NFT collection symbol' }, total_supply: { type: 'number', description: 'NFT collection total supply' }, user_favorites_count: { type: 'number', description: 'NFT collection user favorites count' }, volume_24h: { type: 'object', description: 'NFT collection volume in 24 hours', properties: { native_currency: { type: 'number' }, usd: { type: 'number' } } }, volume_24h_percentage_change: { type: 'object', description: 'NFT collection volume in 24 hours percentage change', properties: { native_currency: { type: 'number' }, usd: { type: 'number' } } }, volume_in_usd_24h_percentage_change: { type: 'number', description: 'NFT collection volume in usd 24 hours percentage change' } } } } } ```
{
"type": "object",
"required": [
"id"
],
"properties": {
"id": {
"type": "string"
},
"jq_filter": {
"type": "string",
"title": "jq Filter",
"description": "A jq filter to apply to the response to include certain fields. Consult the output schema in the tool description to see the fields that are available.\n\nFor example: to include only the `name` field in every object of a results array, you can provide \".results[].name\".\n\nFor more information, see the [jq documentation](https://jqlang.org/manual/)."
}
}
}get_list_nfts
When using this tool, always use the `jq_filter` parameter to reduce the response size and improve performance. Only omit if you're sure you don't need the data. This endpoint allows you to **query all supported NFTs with ID, contract address, name, asset platform ID and symbol on CoinGecko** # Response Schema ```json { $ref: '#/$defs/nft_get_list_response', $defs: { nft_get_list_response: { type: 'object', properties: { id: { type: 'string', description: 'NFT collection ID' }, asset_platform_id: { type: 'string', description: 'NFT collection asset platform ID' }, contract_address: { type: 'string', description: 'NFT collection contract address' }, name: { type: 'string', description: 'NFT collection name' }, symbol: { type: 'string', description: 'NFT collection symbol' } } } } } ```
{
"type": "object",
"required": [],
"properties": {
"page": {
"type": "number",
"description": "page through results"
},
"order": {
"enum": [
"h24_volume_usd_asc",
"h24_volume_usd_desc",
"h24_volume_native_asc",
"h24_volume_native_desc",
"floor_price_native_asc",
"floor_price_native_desc",
"market_cap_native_asc",
"market_cap_native_desc",
"market_cap_usd_asc",
"market_cap_usd_desc"
],
"type": "string",
"description": "use this to sort the order of responses"
},
"per_page": {
"type": "number",
"description": "total results per page \n Valid values: 1...250"
},
"jq_filter": {
"type": "string",
"title": "jq Filter",
"description": "A jq filter to apply to the response to include certain fields. Consult the output schema in the tool description to see the fields that are available.\n\nFor example: to include only the `name` field in every object of a results array, you can provide \".results[].name\".\n\nFor more information, see the [jq documentation](https://jqlang.org/manual/)."
}
}
}get_markets_nfts
When using this tool, always use the `jq_filter` parameter to reduce the response size and improve performance. Only omit if you're sure you don't need the data. This endpoint allows you to **query all the supported NFT collections with floor price, market cap, volume and market related data on CoinGecko** # Response Schema ```json { $ref: '#/$defs/nft_get_markets_response', $defs: { nft_get_markets_response: { type: 'array', items: { type: 'object', properties: { id: { type: 'string', description: 'NFT collection ID' }, asset_platform_id: { type: 'string', description: 'NFT collection asset platform ID' }, contract_address: { type: 'string', description: 'NFT collection contract address' }, description: { type: 'string', description: 'NFT collection description' }, floor_price: { type: 'object', description: 'NFT collection floor price', properties: { native_currency: { type: 'number' }, usd: { type: 'number' } } }, floor_price_24h_percentage_change: { type: 'object', description: 'NFT collection floor price 24 hours percentage change', properties: { native_currency: { type: 'number' }, usd: { type: 'number' } } }, floor_price_in_usd_24h_percentage_change: { type: 'number', description: 'NFT collection floor price in usd 24 hours percentage change' }, image: { type: 'object', description: 'NFT collection image url', properties: { small: { type: 'string' }, small_2x: { type: 'string' } } }, market_cap: { type: 'object', description: 'NFT collection market cap', properties: { native_currency: { type: 'number' }, usd: { type: 'number' } } }, market_cap_24h_percentage_change: { type: 'object', description: 'NFT collection market cap 24 hours percentage change', properties: { native_currency: { type: 'number' }, usd: { type: 'number' } } }, market_cap_rank: { type: 'number', description: 'coin market cap rank' }, name: { type: 'string', description: 'NFT collection name' }, native_currency: { type: 'string', description: 'NFT collection native currency' }, native_currency_symbol: { type: 'string', description: 'NFT collection native currency symbol' }, number_of_unique_addresses: { type: 'number', description: 'number of unique address owning the NFTs' }, number_of_unique_addresses_24h_percentage_change: { type: 'number', description: 'number of unique address owning the NFTs 24 hours percentage change' }, one_day_average_sale_price: { type: 'number', description: 'NFT collection one day average sale price' }, one_day_average_sale_price_24h_percentage_change: { type: 'number', description: 'NFT collection one day average sale price 24 hours percentage change' }, one_day_sales: { type: 'number', description: 'NFT collection one day sales' }, one_day_sales_24h_percentage_change: { type: 'number', description: 'NFT collection one day sales 24 hours percentage change' }, symbol: { type: 'string', description: 'NFT collection symbol' }, total_supply: { type: 'number', description: 'NFT collection total supply' }, volume_24h: { type: 'object', description: 'NFT collection volume in 24 hours', properties: { native_currency: { type: 'number' }, usd: { type: 'number' } } }, volume_24h_percentage_change: { type: 'object', description: 'NFT collection volume in 24 hours percentage change', properties: { native_currency: { type: 'number' }, usd: { type: 'number' } } }, volume_in_usd_24h_percentage_change: { type: 'number', description: 'NFT collection volume in usd 24 hours percentage change' } } } } } } ```
{
"type": "object",
"required": [],
"properties": {
"page": {
"type": "number",
"description": "page through results \n Default: `1`"
},
"order": {
"enum": [
"h24_volume_native_asc",
"h24_volume_native_desc",
"h24_volume_usd_asc",
"h24_volume_usd_desc",
"market_cap_usd_asc",
"market_cap_usd_desc"
],
"type": "string",
"description": "sort results by field \n Default: `market_cap_usd_desc`"
},
"per_page": {
"type": "number",
"description": "total results per page \n Valid values: any integer between 1 and 250 \n Default: `100`"
},
"jq_filter": {
"type": "string",
"title": "jq Filter",
"description": "A jq filter to apply to the response to include certain fields. Consult the output schema in the tool description to see the fields that are available.\n\nFor example: to include only the `name` field in every object of a results array, you can provide \".results[].name\".\n\nFor more information, see the [jq documentation](https://jqlang.org/manual/)."
},
"asset_platform_id": {
"type": "string",
"description": "filter result by asset platform (blockchain network) \n *refers to [`/asset_platforms`](/reference/asset-platforms-list) filter=`nft`"
}
}
}get_nfts_market_chart
When using this tool, always use the `jq_filter` parameter to reduce the response size and improve performance. Only omit if you're sure you don't need the data. 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** # Response Schema ```json { $ref: '#/$defs/market_chart_get_response', $defs: { market_chart_get_response: { type: 'object', properties: { floor_price_native: { type: 'array', description: 'NFT collection floor price in native currency', items: { type: 'array', items: { type: 'number' } } }, floor_price_usd: { type: 'array', description: 'NFT collection floor price in usd', items: { type: 'array', items: { type: 'number' } } }, h24_volume_native: { type: 'array', description: 'NFT collection volume in 24 hours in native currency', items: { type: 'array', items: { type: 'number' } } }, h24_volume_usd: { type: 'array', description: 'NFT collection volume in 24 hours in usd', items: { type: 'array', items: { type: 'number' } } }, market_cap_native: { type: 'array', description: 'NFT collection market cap in native currency', items: { type: 'array', items: { type: 'number' } } }, market_cap_usd: { type: 'array', description: 'NFT collection market cap in usd', items: { type: 'array', items: { type: 'number' } } } } } } } ```
{
"type": "object",
"required": [
"id",
"days"
],
"properties": {
"id": {
"type": "string"
},
"days": {
"type": "string",
"description": "data up to number of days \n Valid values: any integer or max"
},
"jq_filter": {
"type": "string",
"title": "jq Filter",
"description": "A jq filter to apply to the response to include certain fields. Consult the output schema in the tool description to see the fields that are available.\n\nFor example: to include only the `name` field in every object of a results array, you can provide \".results[].name\".\n\nFor more information, see the [jq documentation](https://jqlang.org/manual/)."
}
}
}get_onchain_categories
When using this tool, always use the `jq_filter` parameter to reduce the response size and improve performance. Only omit if you're sure you don't need the data. This endpoint allows you to **query all the supported categories on GeckoTerminal** # Response Schema ```json { $ref: '#/$defs/category_get_response', $defs: { category_get_response: { type: 'object', properties: { data: { type: 'array', items: { type: 'object', properties: { id: { type: 'string' }, attributes: { type: 'object', properties: { description: { type: 'string' }, fdv_usd: { type: 'string' }, h24_tx_count: { type: 'integer' }, h24_volume_usd: { type: 'string' }, name: { type: 'string' }, reserve_in_usd: { type: 'string' }, volume_change_percentage: { type: 'object', properties: { h1: { type: 'string' }, h12: { type: 'string' }, h24: { type: 'string' }, h6: { type: 'string' } } } } }, type: { type: 'string' } } } } } } } } ```
{
"type": "object",
"required": [],
"properties": {
"page": {
"type": "integer",
"description": "page through results \n Default value: `1`"
},
"sort": {
"enum": [
"h1_volume_percentage_desc",
"h6_volume_percentage_desc",
"h12_volume_percentage_desc",
"h24_tx_count_desc",
"h24_volume_usd_desc",
"fdv_usd_desc",
"reserve_in_usd_desc"
],
"type": "string",
"description": "sort the categories by field \n Default value: `h6_volume_percentage_desc`"
},
"jq_filter": {
"type": "string",
"title": "jq Filter",
"description": "A jq filter to apply to the response to include certain fields. Consult the output schema in the tool description to see the fields that are available.\n\nFor example: to include only the `name` field in every object of a results array, you can provide \".results[].name\".\n\nFor more information, see the [jq documentation](https://jqlang.org/manual/)."
}
}
}get_pools_onchain_categories
When using this tool, always use the `jq_filter` parameter to reduce the response size and improve performance. Only omit if you're sure you don't need the data. This endpoint allows you to **query all the pools based on the provided category ID** # Response Schema ```json { $ref: '#/$defs/category_get_pools_response', $defs: { category_get_pools_response: { type: 'object', properties: { data: { type: 'array', items: { type: 'object', properties: { id: { type: 'string' }, attributes: { type: 'object', properties: { address: { type: 'string' }, base_token_price_native_currency: { type: 'string' }, base_token_price_quote_token: { type: 'string' }, base_token_price_usd: { type: 'string' }, fdv_usd: { type: 'string' }, h24_tx_count: { type: 'integer' }, h24_volume_usd: { type: 'string' }, market_cap_usd: { type: 'string' }, name: { type: 'string' }, pool_created_at: { type: 'string', format: 'date-time' }, price_change_percentage: { type: 'object', properties: { h1: { type: 'string' }, h24: { type: 'string' }, h6: { type: 'string' }, m15: { type: 'string' }, m30: { type: 'string' }, m5: { type: 'string' } } }, quote_token_price_base_token: { type: 'string' }, quote_token_price_native_currency: { type: 'string' }, quote_token_price_usd: { type: 'string' }, reserve_in_usd: { type: 'string' } } }, relationships: { type: 'object', properties: { base_token: { type: 'object', properties: { data: { type: 'object', properties: { id: { type: 'string' }, type: { type: 'string' } } } } }, dex: { type: 'object', properties: { data: { type: 'object', properties: { id: { type: 'string' }, type: { type: 'string' } } } } }, network: { type: 'object', properties: { data: { type: 'object', properties: { id: { type: 'string' }, type: { type: 'string' } } } } }, quote_token: { type: 'object', properties: { data: { type: 'object', properties: { id: { type: 'string' }, type: { type: 'string' } } } } } } }, type: { type: 'string' } } } }, included: { type: 'array', items: { type: 'object', properties: { id: { type: 'string' }, attributes: { type: 'object', properties: { address: { type: 'string' }, coingecko_coin_id: { type: 'string' }, decimals: { type: 'integer' }, image_url: { type: 'string' }, name: { type: 'string' }, symbol: { type: 'string' } } }, type: { type: 'string' } } } } } } } } ```
{
"type": "object",
"required": [
"category_id"
],
"properties": {
"page": {
"type": "integer",
"description": "page through results \n Default value: `1`"
},
"sort": {
"enum": [
"m5_trending",
"h1_trending",
"h6_trending",
"h24_trending",
"h24_tx_count_desc",
"h24_volume_usd_desc",
"pool_created_at_desc",
"h24_price_change_percentage_desc"
],
"type": "string",
"description": "sort the pools by field \n Default value: `pool_created_at_desc`"
},
"include": {
"type": "string",
"description": "attributes to include, comma-separated if more than one to include \n Available values: `base_token`, `quote_token`, `dex`, `network`. \n Example: `base_token` or `base_token,dex`"
},
"jq_filter": {
"type": "string",
"title": "jq Filter",
"description": "A jq filter to apply to the response to include certain fields. Consult the output schema in the tool description to see the fields that are available.\n\nFor example: to include only the `name` field in every object of a results array, you can provide \".results[].name\".\n\nFor more information, see the [jq documentation](https://jqlang.org/manual/)."
},
"category_id": {
"type": "string"
}
}
}get_onchain_networks
When using this tool, always use the `jq_filter` parameter to reduce the response size and improve performance. Only omit if you're sure you don't need the data. This endpoint allows you to **query all the supported networks on GeckoTerminal** # Response Schema ```json { $ref: '#/$defs/network_get_response', $defs: { network_get_response: { type: 'object', properties: { data: { type: 'array', items: { type: 'object', properties: { id: { type: 'string' }, attributes: { type: 'object', properties: { coingecko_asset_platform_id: { type: 'string' }, name: { type: 'string' } } }, type: { type: 'string' } } } } } } } } ```
{
"type": "object",
"required": [],
"properties": {
"page": {
"type": "integer",
"description": "page through results \n Default value: 1"
},
"jq_filter": {
"type": "string",
"title": "jq Filter",
"description": "A jq filter to apply to the response to include certain fields. Consult the output schema in the tool description to see the fields that are available.\n\nFor example: to include only the `name` field in every object of a results array, you can provide \".results[].name\".\n\nFor more information, see the [jq documentation](https://jqlang.org/manual/)."
}
}
}get_networks_onchain_new_pools
When using this tool, always use the `jq_filter` parameter to reduce the response size and improve performance. Only omit if you're sure you don't need the data. This endpoint allows you to **query all the latest pools across all networks on GeckoTerminal** # Response Schema ```json { $ref: '#/$defs/new_pool_get_response', $defs: { new_pool_get_response: { type: 'object', properties: { data: { type: 'array', items: { type: 'object', properties: { id: { type: 'string' }, attributes: { type: 'object', properties: { address: { type: 'string' }, base_token_price_native_currency: { type: 'string' }, base_token_price_quote_token: { type: 'string' }, base_token_price_usd: { type: 'string' }, community_sus_report: { type: 'number' }, fdv_usd: { type: 'string' }, market_cap_usd: { type: 'string' }, name: { type: 'string' }, pool_created_at: { type: 'string' }, price_change_percentage: { type: 'object', properties: { h1: { type: 'string' }, h24: { type: 'string' }, h6: { type: 'string' }, m15: { type: 'string' }, m30: { type: 'string' }, m5: { type: 'string' } } }, quote_token_price_base_token: { type: 'string' }, quote_token_price_native_currency: { type: 'string' }, quote_token_price_usd: { type: 'string' }, reserve_in_usd: { type: 'string' }, sentiment_vote_negative_percentage: { type: 'number' }, sentiment_vote_positive_percentage: { type: 'number' }, transactions: { type: 'object', properties: { h1: { type: 'object', properties: { buyers: { type: 'integer' }, buys: { type: 'integer' }, sellers: { type: 'integer' }, sells: { type: 'integer' } } }, h24: { type: 'object', properties: { buyers: { type: 'integer' }, buys: { type: 'integer' }, sellers: { type: 'integer' }, sells: { type: 'integer' } } }, m15: { type: 'object', properties: { buyers: { type: 'integer' }, buys: { type: 'integer' }, sellers: { type: 'integer' }, sells: { type: 'integer' } } }, m30: { type: 'object', properties: { buyers: { type: 'integer' }, buys: { type: 'integer' }, sellers: { type: 'integer' }, sells: { type: 'integer' } } }, m5: { type: 'object', properties: { buyers: { type: 'integer' }, buys: { type: 'integer' }, sellers: { type: 'integer' }, sells: { type: 'integer' } } } } }, volume_usd: { type: 'object', properties: { h1: { type: 'string' }, h24: { type: 'string' }, h6: { type: 'string' }, m15: { type: 'string' }, m30: { type: 'string' }, m5: { type: 'string' } } } } }, relationships: { type: 'object', properties: { base_token: { type: 'object', properties: { data: { type: 'object', properties: { id: { type: 'string' }, type: { type: 'string' } } } } }, dex: { type: 'object', properties: { data: { type: 'object', properties: { id: { type: 'string' }, type: { type: 'string' } } } } }, quote_token: { type: 'object', properties: { data: { type: 'object', properties: { id: { type: 'string' }, type: { type: 'string' } } } } } } }, type: { type: 'string' } } } }, included: { type: 'array', items: { type: 'object', properties: { id: { type: 'string' }, attributes: { type: 'object', properties: { address: { type: 'string' }, coingecko_coin_id: { type: 'string' }, decimals: { type: 'integer' }, image_url: { type: 'string' }, name: { type: 'string' }, symbol: { type: 'string' } } }, type: { type: 'string' } } } } } } } } ```
{
"type": "object",
"required": [],
"properties": {
"page": {
"type": "integer",
"description": "page through results \n Default value: 1"
},
"include": {
"type": "string",
"description": "attributes to include, comma-separated if more than one to include \n Available values: `base_token`, `quote_token`, `dex`, `network`"
},
"jq_filter": {
"type": "string",
"title": "jq Filter",
"description": "A jq filter to apply to the response to include certain fields. Consult the output schema in the tool description to see the fields that are available.\n\nFor example: to include only the `name` field in every object of a results array, you can provide \".results[].name\".\n\nFor more information, see the [jq documentation](https://jqlang.org/manual/)."
},
"include_gt_community_data": {
"type": "boolean",
"description": "include GeckoTerminal community data (Sentiment votes, Suspicious reports) \n Default value: false"
}
}
}get_network_networks_onchain_new_pools
This endpoint allows you to **query all the latest pools based on provided network**
{
"type": "object",
"required": [
"network"
],
"properties": {
"page": {
"type": "integer",
"description": "page through results \n Default value: 1"
},
"include": {
"type": "string",
"description": "attributes to include, comma-separated if more than one to include \n Available values: `base_token`, `quote_token`, `dex`"
},
"network": {
"type": "string"
},
"include_gt_community_data": {
"type": "boolean",
"description": "include GeckoTerminal community data (Sentiment votes, Suspicious reports) \n Default value: false"
}
}
}get_networks_onchain_dexes
When using this tool, always use the `jq_filter` parameter to reduce the response size and improve performance. Only omit if you're sure you don't need the data. This endpoint allows you to **query all the supported decentralized exchanges (DEXs) based on the provided network on GeckoTerminal** # Response Schema ```json { $ref: '#/$defs/dex_get_response', $defs: { dex_get_response: { type: 'object', properties: { data: { type: 'array', items: { type: 'object', properties: { id: { type: 'string' }, attributes: { type: 'object', properties: { name: { type: 'string' } } }, type: { type: 'string' } } } } } } } } ```
{
"type": "object",
"required": [
"network"
],
"properties": {
"page": {
"type": "integer",
"description": "page through results \n Default value: 1"
},
"network": {
"type": "string"
},
"jq_filter": {
"type": "string",
"title": "jq Filter",
"description": "A jq filter to apply to the response to include certain fields. Consult the output schema in the tool description to see the fields that are available.\n\nFor example: to include only the `name` field in every object of a results array, you can provide \".results[].name\".\n\nFor more information, see the [jq documentation](https://jqlang.org/manual/)."
}
}
}get_addresses_pools_networks_onchain_multi
This endpoint allows you to **query multiple pools based on the provided network and pool address**
{
"type": "object",
"required": [
"network",
"addresses"
],
"properties": {
"include": {
"type": "string",
"description": "attributes to include, comma-separated if more than one to include \n Available values: `base_token`, `quote_token`, `dex`"
},
"network": {
"type": "string"
},
"addresses": {
"type": "string"
},
"include_composition": {
"type": "boolean",
"description": "include pool composition, default: false"
},
"include_volume_breakdown": {
"type": "boolean",
"description": "include volume breakdown, default: false"
}
}
}get_pools_networks_onchain_info
When using this tool, always use the `jq_filter` parameter to reduce the response size and improve performance. Only omit if you're sure you don't need the data. 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** # Response Schema ```json { $ref: '#/$defs/info_get_response', $defs: { info_get_response: { type: 'object', properties: { data: { type: 'array', items: { type: 'object', properties: { data: { type: 'object', properties: { id: { type: 'string' }, attributes: { type: 'object', properties: { address: { type: 'string' }, categories: { type: 'array', items: { type: 'string' } }, coingecko_coin_id: { type: 'string' }, description: { type: 'string' }, discord_url: { type: 'string' }, farcaster_url: { type: 'string' }, freeze_authority: { type: 'string' }, gt_categories_id: { type: 'array', items: { type: 'string' } }, gt_score: { type: 'number' }, gt_score_details: { type: 'object', properties: { creation: { type: 'number' }, holders: { type: 'number' }, info: { type: 'number' }, pool: { type: 'number' }, transaction: { type: 'number' } } }, holders: { type: 'object', properties: { count: { type: 'integer' }, distribution_percentage: { type: 'object', properties: { '11_30': { type: 'number' }, '31_50': { type: 'number' }, rest: { type: 'number' }, top_10: { type: 'number' } } }, last_updated: { type: 'string' } } }, image: { type: 'object', properties: { large: { type: 'string' }, small: { type: 'string' }, thumb: { type: 'string' } } }, image_url: { type: 'string' }, is_honeypot: { anyOf: [ { type: 'boolean' }, { type: 'string' } ] }, mint_authority: { type: 'string' }, name: { type: 'string' }, symbol: { type: 'string' }, telegram_handle: { type: 'string' }, twitter_handle: { type: 'string' }, websites: { type: 'array', items: { type: 'string' } }, zora_url: { type: 'string' } } }, type: { type: 'string' } } } } } }, included: { type: 'array', items: { type: 'object', properties: { id: { type: 'string' }, attributes: { type: 'object', properties: { base_token_address: { type: 'string' }, community_sus_report: { type: 'number' }, quote_token_address: { type: 'string' }, sentiment_vote_negative_percentage: { type: 'number' }, sentiment_vote_positive_percentage: { type: 'number' } } }, type: { type: 'string' } } } } } } } } ```
{
"type": "object",
"required": [
"network",
"pool_address"
],
"properties": {
"include": {
"enum": [
"pool"
],
"type": "string",
"description": "attributes to include"
},
"network": {
"type": "string"
},
"jq_filter": {
"type": "string",
"title": "jq Filter",
"description": "A jq filter to apply to the response to include certain fields. Consult the output schema in the tool description to see the fields that are available.\n\nFor example: to include only the `name` field in every object of a results array, you can provide \".results[].name\".\n\nFor more information, see the [jq documentation](https://jqlang.org/manual/)."
},
"pool_address": {
"type": "string"
}
}
}get_timeframe_pools_networks_onchain_ohlcv
When using this tool, always use the `jq_filter` parameter to reduce the response size and improve performance. Only omit if you're sure you don't need the data. 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** # Response Schema ```json { $ref: '#/$defs/ohlcv_get_timeframe_response', $defs: { ohlcv_get_timeframe_response: { type: 'object', properties: { data: { type: 'object', properties: { id: { type: 'string' }, attributes: { type: 'object', properties: { ohlcv_list: { type: 'array', items: { type: 'array', items: { type: 'number' } } } } }, type: { type: 'string' } } }, meta: { type: 'object', properties: { base: { type: 'object', properties: { address: { type: 'string' }, coingecko_coin_id: { type: 'string' }, name: { type: 'string' }, symbol: { type: 'string' } } }, quote: { type: 'object', properties: { address: { type: 'string' }, coingecko_coin_id: { type: 'string' }, name: { type: 'string' }, symbol: { type: 'string' } } } } } } } } } ```
{
"type": "object",
"required": [
"network",
"pool_address",
"timeframe"
],
"properties": {
"limit": {
"type": "integer",
"description": "number of OHLCV results to return, maximum 1000 \n Default value: 100"
},
"token": {
"type": "string",
"description": "return OHLCV for token \n use this to invert the chart \n Available values: 'base', 'quote' or token address \n Default value: 'base'"
},
"network": {
"type": "string"
},
"currency": {
"enum": [
"usd",
"token"
],
"type": "string",
"description": "return OHLCV in USD or quote token \n Default value: usd"
},
"aggregate": {
"type": "string",
"description": "time period to aggregate each OHLCV \n Available values (day): `1` \n Available values (hour): `1` , `4` , `12` \n Available values (minute): `1` , `5` , `15` \n Available values (second): `1`, `15`, `30` \n Default value: 1"
},
"jq_filter": {
"type": "string",
"title": "jq Filter",
"description": "A jq filter to apply to the response to include certain fields. Consult the output schema in the tool description to see the fields that are available.\n\nFor example: to include only the `name` field in every object of a results array, you can provide \".results[].name\".\n\nFor more information, see the [jq documentation](https://jqlang.org/manual/)."
},
"timeframe": {
"enum": [
"day",
"hour",
"minute",
"second"
],
"type": "string"
},
"pool_address": {
"type": "string"
},
"before_timestamp": {
"type": "integer",
"description": "return OHLCV data before this timestamp (integer seconds since epoch)"
},
"include_empty_intervals": {
"type": "boolean",
"description": "include empty intervals with no trade data, default: false"
}
}
}get_pools_networks_onchain_trades
When using this tool, always use the `jq_filter` parameter to reduce the response size and improve performance. Only omit if you're sure you don't need the data. This endpoint allows you to **query the last 300 trades in the past 24 hours based on the provided pool address** # Response Schema ```json { $ref: '#/$defs/trade_get_response', $defs: { trade_get_response: { type: 'object', properties: { data: { type: 'array', items: { type: 'object', properties: { id: { type: 'string' }, attributes: { type: 'object', properties: { block_number: { type: 'integer' }, block_timestamp: { type: 'string' }, from_token_address: { type: 'string' }, from_token_amount: { type: 'string' }, kind: { type: 'string' }, price_from_in_currency_token: { type: 'string' }, price_from_in_usd: { type: 'string' }, price_to_in_currency_token: { type: 'string' }, price_to_in_usd: { type: 'string' }, to_token_address: { type: 'string' }, to_token_amount: { type: 'string' }, tx_from_address: { type: 'string' }, tx_hash: { type: 'string' }, volume_in_usd: { type: 'string' } } }, type: { type: 'string' } } } } } } } } ```
{
"type": "object",
"required": [
"network",
"pool_address"
],
"properties": {
"token": {
"type": "string",
"description": "return trades for token \n use this to invert the chart \n Available values: 'base', 'quote' or token address \n Default value: 'base'"
},
"network": {
"type": "string"
},
"jq_filter": {
"type": "string",
"title": "jq Filter",
"description": "A jq filter to apply to the response to include certain fields. Consult the output schema in the tool description to see the fields that are available.\n\nFor example: to include only the `name` field in every object of a results array, you can provide \".results[].name\".\n\nFor more information, see the [jq documentation](https://jqlang.org/manual/)."
},
"pool_address": {
"type": "string"
},
"trade_volume_in_usd_greater_than": {
"type": "number",
"description": "filter trades by trade volume in USD greater than this value \n Default value: 0"
}
}
}get_addresses_tokens_networks_onchain_multi
This endpoint allows you to **query multiple tokens data based on the provided token contract addresses on a network**
{
"type": "object",
"required": [
"network",
"addresses"
],
"properties": {
"include": {
"enum": [
"top_pools"
],
"type": "string",
"description": "attributes to include"
},
"network": {
"type": "string"
},
"addresses": {
"type": "string"
},
"include_composition": {
"type": "boolean",
"description": "include pool composition, default: false"
},
"include_inactive_source": {
"type": "boolean",
"description": "include tokens from inactive pools using the most recent swap, default: false"
}
}
}get_tokens_networks_onchain_info
When using this tool, always use the `jq_filter` parameter to reduce the response size and improve performance. Only omit if you're sure you don't need the data. 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** # Response Schema ```json { $ref: '#/$defs/info_get_response', $defs: { info_get_response: { type: 'object', properties: { data: { type: 'object', properties: { id: { type: 'string' }, attributes: { type: 'object', properties: { address: { type: 'string' }, categories: { type: 'array', items: { type: 'string' } }, coingecko_coin_id: { type: 'string' }, description: { type: 'string' }, discord_url: { type: 'string' }, farcaster_url: { type: 'string' }, freeze_authority: { type: 'string' }, gt_categories_id: { type: 'array', items: { type: 'string' } }, gt_score: { type: 'number' }, gt_score_details: { type: 'object', properties: { creation: { type: 'number' }, holders: { type: 'number' }, info: { type: 'number' }, pool: { type: 'number' }, transaction: { type: 'number' } } }, holders: { type: 'object', properties: { count: { type: 'integer' }, distribution_percentage: { type: 'object', properties: { '11_30': { type: 'number' }, '31_50': { type: 'number' }, rest: { type: 'number' }, top_10: { type: 'number' } } }, last_updated: { type: 'string' } } }, image: { type: 'object', properties: { large: { type: 'string' }, small: { type: 'string' }, thumb: { type: 'string' } } }, image_url: { type: 'string' }, is_honeypot: { anyOf: [ { type: 'boolean' }, { type: 'string' } ] }, mint_authority: { type: 'string' }, name: { type: 'string' }, symbol: { type: 'string' }, telegram_handle: { type: 'string' }, twitter_handle: { type: 'string' }, websites: { type: 'array', items: { type: 'string' } }, zora_url: { type: 'string' } } }, type: { type: 'string' } } } } } } } ```
{
"type": "object",
"required": [
"network",
"address"
],
"properties": {
"address": {
"type": "string"
},
"network": {
"type": "string"
},
"jq_filter": {
"type": "string",
"title": "jq Filter",
"description": "A jq filter to apply to the response to include certain fields. Consult the output schema in the tool description to see the fields that are available.\n\nFor example: to include only the `name` field in every object of a results array, you can provide \".results[].name\".\n\nFor more information, see the [jq documentation](https://jqlang.org/manual/)."
}
}
}get_tokens_networks_onchain_top_holders
When using this tool, always use the `jq_filter` parameter to reduce the response size and improve performance. Only omit if you're sure you don't need the data. This endpoint allows you to **query top token holders based on the provided token contract address on a network** # Response Schema ```json { $ref: '#/$defs/top_holder_get_response', $defs: { top_holder_get_response: { type: 'object', properties: { data: { type: 'object', properties: { id: { type: 'string' }, attributes: { type: 'object', properties: { holders: { type: 'array', items: { type: 'object', properties: { address: { type: 'string' }, amount: { type: 'string' }, label: { type: 'string' }, percentage: { type: 'string' }, rank: { type: 'number' }, value: { type: 'string' } } } }, last_updated_at: { type: 'string' } } }, type: { type: 'string' } } } } } } } ```
{
"type": "object",
"required": [
"network",
"address"
],
"properties": {
"address": {
"type": "string"
},
"holders": {
"type": "string",
"description": "number of top token holders to return, you may use any integer or `max` \n Default value: 10"
},
"network": {
"type": "string"
},
"jq_filter": {
"type": "string",
"title": "jq Filter",
"description": "A jq filter to apply to the response to include certain fields. Consult the output schema in the tool description to see the fields that are available.\n\nFor example: to include only the `name` field in every object of a results array, you can provide \".results[].name\".\n\nFor more information, see the [jq documentation](https://jqlang.org/manual/)."
}
}
}get_tokens_networks_onchain_holders_chart
When using this tool, always use the `jq_filter` parameter to reduce the response size and improve performance. Only omit if you're sure you don't need the data. This endpoint allows you to **get the historical token holders chart based on the provided token contract address on a network** # Response Schema ```json { $ref: '#/$defs/holders_chart_get_response', $defs: { holders_chart_get_response: { type: 'object', properties: { data: { type: 'object', properties: { id: { type: 'string' }, attributes: { type: 'object', properties: { token_holders_list: { type: 'array', items: { type: 'array', items: { type: 'string' } } } } }, type: { type: 'string' } } }, meta: { type: 'object', properties: { token: { type: 'object', properties: { address: { type: 'string' }, coingecko_coin_id: { type: 'string' }, name: { type: 'string' }, symbol: { type: 'string' } } } } } } } } } ```
{
"type": "object",
"required": [
"network",
"token_address"
],
"properties": {
"days": {
"enum": [
"7",
"30",
"max"
],
"type": "string",
"description": "number of days to return the historical token holders chart \n Default value: 7"
},
"network": {
"type": "string"
},
"jq_filter": {
"type": "string",
"title": "jq Filter",
"description": "A jq filter to apply to the response to include certain fields. Consult the output schema in the tool description to see the fields that are available.\n\nFor example: to include only the `name` field in every object of a results array, you can provide \".results[].name\".\n\nFor more information, see the [jq documentation](https://jqlang.org/manual/)."
},
"token_address": {
"type": "string"
}
}
}get_timeframe_tokens_networks_onchain_ohlcv
When using this tool, always use the `jq_filter` parameter to reduce the response size and improve performance. Only omit if you're sure you don't need the data. 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** # Response Schema ```json { $ref: '#/$defs/ohlcv_get_timeframe_response', $defs: { ohlcv_get_timeframe_response: { type: 'object', properties: { data: { type: 'object', properties: { id: { type: 'string' }, attributes: { type: 'object', properties: { ohlcv_list: { type: 'array', items: { type: 'array', items: { type: 'number' } } } } }, type: { type: 'string' } } }, meta: { type: 'object', properties: { base: { type: 'object', properties: { address: { type: 'string' }, coingecko_coin_id: { type: 'string' }, name: { type: 'string' }, symbol: { type: 'string' } } }, quote: { type: 'object', properties: { address: { type: 'string' }, coingecko_coin_id: { type: 'string' }, name: { type: 'string' }, symbol: { type: 'string' } } } } } } } } } ```
{
"type": "object",
"required": [
"network",
"token_address",
"timeframe"
],
"properties": {
"limit": {
"type": "integer",
"description": "number of OHLCV results to return, maximum 1000 \n Default value: 100"
},
"network": {
"type": "string"
},
"currency": {
"enum": [
"usd",
"token"
],
"type": "string",
"description": "return OHLCV in USD or quote token \n Default value: usd"
},
"aggregate": {
"type": "string",
"description": "time period to aggregate each OHLCV \n Available values (day): `1` \n Available values (hour): `1` , `4` , `12` \n Available values (minute): `1` , `5` , `15` \n Available values (second): `1`, `15`, `30` \n Default value: 1"
},
"jq_filter": {
"type": "string",
"title": "jq Filter",
"description": "A jq filter to apply to the response to include certain fields. Consult the output schema in the tool description to see the fields that are available.\n\nFor example: to include only the `name` field in every object of a results array, you can provide \".results[].name\".\n\nFor more information, see the [jq documentation](https://jqlang.org/manual/)."
},
"timeframe": {
"enum": [
"day",
"hour",
"minute",
"second"
],
"type": "string"
},
"token_address": {
"type": "string"
},
"before_timestamp": {
"type": "integer",
"description": "return OHLCV data before this timestamp (integer seconds since epoch)"
},
"include_empty_intervals": {
"type": "boolean",
"description": "include empty intervals with no trade data, default: false"
},
"include_inactive_source": {
"type": "boolean",
"description": "include token data from inactive pools using the most recent swap, default: false"
}
}
}get_tokens_networks_onchain_pools
This endpoint allows you to **query top pools based on the provided token contract address on a network**
{
"type": "object",
"required": [
"network",
"token_address"
],
"properties": {
"page": {
"type": "integer",
"description": "page through results \n Default value: 1"
},
"sort": {
"enum": [
"h24_volume_usd_liquidity_desc",
"h24_tx_count_desc",
"h24_volume_usd_desc"
],
"type": "string",
"description": "sort the pools by field \n Default value: h24_volume_usd_liquidity_desc"
},
"include": {
"type": "string",
"description": "attributes to include, comma-separated if more than one to include \n Available values: `base_token`, `quote_token`, `dex`"
},
"network": {
"type": "string"
},
"token_address": {
"type": "string"
},
"include_inactive_source": {
"type": "boolean",
"description": "include tokens from inactive pools using the most recent swap, default: false"
}
}
}get_tokens_networks_onchain_trades
When using this tool, always use the `jq_filter` parameter to reduce the response size and improve performance. Only omit if you're sure you don't need the data. 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** # Response Schema ```json { $ref: '#/$defs/trade_get_response', $defs: { trade_get_response: { type: 'object', properties: { data: { type: 'array', items: { type: 'object', properties: { id: { type: 'string' }, attributes: { type: 'object', properties: { block_number: { type: 'integer' }, block_timestamp: { type: 'string' }, from_token_address: { type: 'string' }, from_token_amount: { type: 'string' }, kind: { type: 'string' }, pool_address: { type: 'string' }, pool_dex: { type: 'string' }, price_from_in_currency_token: { type: 'string' }, price_from_in_usd: { type: 'string' }, price_to_in_currency_token: { type: 'string' }, price_to_in_usd: { type: 'string' }, to_token_address: { type: 'string' }, to_token_amount: { type: 'string' }, tx_from_address: { type: 'string' }, tx_hash: { type: 'string' }, volume_in_usd: { type: 'string' } } }, type: { type: 'string' } } } } } } } } ```
{
"type": "object",
"required": [
"network",
"token_address"
],
"properties": {
"network": {
"type": "string"
},
"jq_filter": {
"type": "string",
"title": "jq Filter",
"description": "A jq filter to apply to the response to include certain fields. Consult the output schema in the tool description to see the fields that are available.\n\nFor example: to include only the `name` field in every object of a results array, you can provide \".results[].name\".\n\nFor more information, see the [jq documentation](https://jqlang.org/manual/)."
},
"token_address": {
"type": "string"
},
"trade_volume_in_usd_greater_than": {
"type": "number",
"description": "filter trades by trade volume in USD greater than this value \n Default value: 0"
}
}
}get_tokens_networks_onchain_top_traders
When using this tool, always use the `jq_filter` parameter to reduce the response size and improve performance. Only omit if you're sure you don't need the data. This endpoint allows you to **query top token traders based on the provided token contract address on a network** # Response Schema ```json { $ref: '#/$defs/top_trader_get_response', $defs: { top_trader_get_response: { type: 'object', properties: { data: { type: 'object', properties: { id: { type: 'string' }, attributes: { type: 'object', properties: { traders: { type: 'array', items: { type: 'object', properties: { address: { type: 'string' }, average_buy_price_usd: { type: 'string' }, average_sell_price_usd: { type: 'string' }, explorer_url: { type: 'string' }, label: { type: 'string' }, name: { type: 'string' }, realized_pnl_usd: { type: 'string' }, token_balance: { type: 'string' }, total_buy_count: { type: 'integer' }, total_buy_token_amount: { type: 'string' }, total_buy_usd: { type: 'string' }, total_sell_count: { type: 'integer' }, total_sell_token_amount: { type: 'string' }, total_sell_usd: { type: 'string' }, type: { type: 'string' }, unrealized_pnl_usd: { type: 'string' } } } } } }, type: { type: 'string' } } } } } } } ```
{
"type": "object",
"required": [
"network_id",
"token_address"
],
"properties": {
"sort": {
"enum": [
"realized_pnl_usd_desc",
"unrealized_pnl_usd_desc",
"total_buy_usd_desc",
"total_sell_usd_desc"
],
"type": "string",
"description": "sort the traders by field \n Default value: realized_pnl_usd_desc"
},
"traders": {
"type": "string",
"description": "number of top token traders to return, you may use any integer or `max` \n Default value: 10"
},
"jq_filter": {
"type": "string",
"title": "jq Filter",
"description": "A jq filter to apply to the response to include certain fields. Consult the output schema in the tool description to see the fields that are available.\n\nFor example: to include only the `name` field in every object of a results array, you can provide \".results[].name\".\n\nFor more information, see the [jq documentation](https://jqlang.org/manual/)."
},
"network_id": {
"type": "string"
},
"token_address": {
"type": "string"
},
"include_address_label": {
"type": "boolean",
"description": "include address label data, default: false"
}
}
}get_pools_onchain_megafilter
This endpoint allows you to **query pools based on various filters across all networks on GeckoTerminal**
{
"type": "object",
"required": [],
"properties": {
"page": {
"type": "integer",
"description": "page through results \n Default value: 1"
},
"sort": {
"enum": [
"m5_trending",
"h1_trending",
"h6_trending",
"h24_trending",
"h24_tx_count_desc",
"h24_volume_usd_desc",
"m5_price_change_percentage_asc",
"h1_price_change_percentage_asc",
"h6_price_change_percentage_asc",
"h24_price_change_percentage_asc",
"m5_price_change_percentage_desc",
"h1_price_change_percentage_desc",
"h6_price_change_percentage_desc",
"h24_price_change_percentage_desc",
"fdv_usd_asc",
"fdv_usd_desc",
"reserve_in_usd_asc",
"reserve_in_usd_desc",
"pool_created_at_desc"
],
"type": "string",
"description": "sort the pools by field \n Default value: h6_trending"
},
"dexes": {
"type": "string",
"description": "filter pools by DEXes, comma-separated if more than one \n DEX ID refers to [/networks/{network}/dexes](/reference/dexes-list)"
},
"checks": {
"type": "string",
"description": "filter options for various checks, comma-separated if more than one \n Available values: `no_honeypot`, `good_gt_score`, `on_coingecko`, `has_social`"
},
"include": {
"type": "string",
"description": "attributes to include, comma-separated if more than one to include \n Available values: `base_token`, `quote_token`, `dex`, `network`"
},
"buys_max": {
"type": "integer",
"description": "maximum number of buy transactions"
},
"buys_min": {
"type": "integer",
"description": "minimum number of buy transactions"
},
"networks": {
"type": "string",
"description": "filter pools by networks, comma-separated if more than one \n Network ID refers to [/networks](/reference/networks-list)"
},
"sells_max": {
"type": "integer",
"description": "maximum number of sell transactions"
},
"sells_min": {
"type": "integer",
"description": "minimum number of sell transactions"
},
"fdv_usd_max": {
"type": "number",
"description": "maximum fully diluted value in USD"
},
"fdv_usd_min": {
"type": "number",
"description": "minimum fully diluted value in USD"
},
"tx_count_max": {
"type": "integer",
"description": "maximum transaction count"
},
"tx_count_min": {
"type": "integer",
"description": "minimum transaction count"
},
"buys_duration": {
"enum": [
"5m",
"1h",
"6h",
"24h"
],
"type": "string",
"description": "duration for buy transactions metric \n Default value: 24h"
},
"sells_duration": {
"enum": [
"5m",
"1h",
"6h",
"24h"
],
"type": "string",
"description": "duration for sell transactions metric \n Default value: 24h"
},
"tx_count_duration": {
"enum": [
"5m",
"1h",
"6h",
"24h"
],
"type": "string",
"description": "duration for transaction count metric \n Default value: 24h"
},
"h24_volume_usd_max": {
"type": "number",
"description": "maximum 24hr volume in USD"
},
"h24_volume_usd_min": {
"type": "number",
"description": "minimum 24hr volume in USD"
},
"reserve_in_usd_max": {
"type": "number",
"description": "maximum reserve in USD"
},
"reserve_in_usd_min": {
"type": "number",
"description": "minimum reserve in USD"
},
"pool_created_hour_max": {
"type": "number",
"description": "maximum pool age in hours"
},
"pool_created_hour_min": {
"type": "number",
"description": "minimum pool age in hours"
},
"buy_tax_percentage_max": {
"type": "number",
"description": "maximum buy tax percentage"
},
"buy_tax_percentage_min": {
"type": "number",
"description": "minimum buy tax percentage"
},
"sell_tax_percentage_max": {
"type": "number",
"description": "maximum sell tax percentage"
},
"sell_tax_percentage_min": {
"type": "number",
"description": "minimum sell tax percentage"
},
"include_unknown_honeypot_tokens": {
"type": "boolean",
"description": "when `checks` includes `no_honeypot`, set to **`true`** to also include 'unknown honeypot' tokens. Default value: `false`"
}
}
}get_pools_onchain_trending_search
When using this tool, always use the `jq_filter` parameter to reduce the response size and improve performance. Only omit if you're sure you don't need the data. This endpoint allows you to **query all the trending search pools across all networks on GeckoTerminal** # Response Schema ```json { $ref: '#/$defs/trending_search_get_response', $defs: { trending_search_get_response: { type: 'object', properties: { data: { type: 'array', items: { type: 'object', properties: { id: { type: 'string' }, attributes: { type: 'object', properties: { address: { type: 'string' }, fdv_usd: { type: 'string' }, market_cap_usd: { type: 'string' }, name: { type: 'string' }, pool_created_at: { type: 'string' }, reserve_in_usd: { type: 'string' }, trending_rank: { type: 'number' }, volume_usd: { type: 'object', properties: { h24: { type: 'string' } } } } }, relationships: { type: 'object', properties: { base_token: { type: 'object', properties: { data: { type: 'object', properties: { id: { type: 'string' }, type: { type: 'string' } } } } }, dex: { type: 'object', properties: { data: { type: 'object', properties: { id: { type: 'string' }, type: { type: 'string' } } } } }, network: { type: 'object', properties: { data: { type: 'object', properties: { id: { type: 'string' }, type: { type: 'string' } } } } }, quote_token: { type: 'object', properties: { data: { type: 'object', properties: { id: { type: 'string' }, type: { type: 'string' } } } } } } }, type: { type: 'string' } } } }, included: { type: 'array', items: { type: 'object', properties: { id: { type: 'string' }, attributes: { type: 'object', properties: { address: { type: 'string' }, coingecko_coin_id: { type: 'string' }, decimals: { type: 'integer' }, image_url: { type: 'string' }, name: { type: 'string' }, symbol: { type: 'string' } } }, type: { type: 'string' } } } } } } } } ```
{
"type": "object",
"required": [],
"properties": {
"pools": {
"type": "integer",
"description": "number of pools to return, maximum 10 \n Default value: 4"
},
"include": {
"type": "string",
"description": "attributes to include, comma-separated if more than one to include \n Available values: `base_token`, `quote_token`, `dex`, `network`"
},
"jq_filter": {
"type": "string",
"title": "jq Filter",
"description": "A jq filter to apply to the response to include certain fields. Consult the output schema in the tool description to see the fields that are available.\n\nFor example: to include only the `name` field in every object of a results array, you can provide \".results[].name\".\n\nFor more information, see the [jq documentation](https://jqlang.org/manual/)."
}
}
}get_search_onchain_pools
When using this tool, always use the `jq_filter` parameter to reduce the response size and improve performance. Only omit if you're sure you don't need the data. This endpoint allows you to **search for pools on a network** # Response Schema ```json { $ref: '#/$defs/pool_get_response', $defs: { pool_get_response: { type: 'object', properties: { data: { type: 'array', items: { type: 'object', properties: { id: { type: 'string' }, attributes: { type: 'object', properties: { address: { type: 'string' }, base_token_price_native_currency: { type: 'string' }, base_token_price_quote_token: { type: 'string' }, base_token_price_usd: { type: 'string' }, fdv_usd: { type: 'string' }, market_cap_usd: { type: 'string' }, name: { type: 'string' }, pool_created_at: { type: 'string' }, price_change_percentage: { type: 'object', properties: { h1: { type: 'string' }, h24: { type: 'string' }, h6: { type: 'string' }, m15: { type: 'string' }, m30: { type: 'string' }, m5: { type: 'string' } } }, quote_token_price_base_token: { type: 'string' }, quote_token_price_native_currency: { type: 'string' }, quote_token_price_usd: { type: 'string' }, reserve_in_usd: { type: 'string' }, transactions: { type: 'object', properties: { h1: { type: 'object', properties: { buyers: { type: 'integer' }, buys: { type: 'integer' }, sellers: { type: 'integer' }, sells: { type: 'integer' } } }, h24: { type: 'object', properties: { buyers: { type: 'integer' }, buys: { type: 'integer' }, sellers: { type: 'integer' }, sells: { type: 'integer' } } }, m15: { type: 'object', properties: { buyers: { type: 'integer' }, buys: { type: 'integer' }, sellers: { type: 'integer' }, sells: { type: 'integer' } } }, m30: { type: 'object', properties: { buyers: { type: 'integer' }, buys: { type: 'integer' }, sellers: { type: 'integer' }, sells: { type: 'integer' } } }, m5: { type: 'object', properties: { buyers: { type: 'integer' }, buys: { type: 'integer' }, sellers: { type: 'integer' }, sells: { type: 'integer' } } } } }, volume_usd: { type: 'object', properties: { h1: { type: 'string' }, h24: { type: 'string' }, h6: { type: 'string' }, m15: { type: 'string' }, m30: { type: 'string' }, m5: { type: 'string' } } } } }, relationships: { type: 'object', properties: { base_token: { type: 'object', properties: { data: { type: 'object', properties: { id: { type: 'string' }, type: { type: 'string' } } } } }, dex: { type: 'object', properties: { data: { type: 'object', properties: { id: { type: 'string' }, type: { type: 'string' } } } } }, quote_token: { type: 'object', properties: { data: { type: 'object', properties: { id: { type: 'string' }, type: { type: 'string' } } } } } } }, type: { type: 'string' } } } }, included: { type: 'array', items: { type: 'object', properties: { id: { type: 'string' }, attributes: { type: 'object', properties: { address: { type: 'string' }, coingecko_coin_id: { type: 'string' }, decimals: { type: 'integer' }, image_url: { type: 'string' }, name: { type: 'string' }, symbol: { type: 'string' } } }, type: { type: 'string' } } } } } } } } ```
{
"type": "object",
"required": [],
"properties": {
"page": {
"type": "integer",
"description": "page through results \n Default value: 1"
},
"query": {
"type": "string",
"description": "search query"
},
"include": {
"type": "string",
"description": "attributes to include, comma-separated if more than one to include \n Available values: `base_token`, `quote_token`, `dex`"
},
"network": {
"type": "string",
"description": "network ID \n *refers to [/networks](/reference/networks-list)"
},
"jq_filter": {
"type": "string",
"title": "jq Filter",
"description": "A jq filter to apply to the response to include certain fields. Consult the output schema in the tool description to see the fields that are available.\n\nFor example: to include only the `name` field in every object of a results array, you can provide \".results[].name\".\n\nFor more information, see the [jq documentation](https://jqlang.org/manual/)."
}
}
}get_addresses_networks_simple_onchain_token_price
When using this tool, always use the `jq_filter` parameter to reduce the response size and improve performance. Only omit if you're sure you don't need the data. This endpoint allows you to **get token price based on the provided token contract address on a network** # Response Schema ```json { $ref: '#/$defs/token_price_get_addresses_response', $defs: { token_price_get_addresses_response: { type: 'object', properties: { data: { type: 'object', properties: { id: { type: 'string' }, attributes: { type: 'object', properties: { h24_price_change_percentage: { type: 'object', additionalProperties: true }, h24_volume_usd: { type: 'object', additionalProperties: true }, last_trade_timestamp: { type: 'object', additionalProperties: true }, market_cap_usd: { type: 'object', additionalProperties: true }, token_prices: { type: 'object', additionalProperties: true }, total_reserve_in_usd: { type: 'object', additionalProperties: true } } }, type: { type: 'string' } } } } } } } ```
{
"type": "object",
"required": [
"network",
"addresses"
],
"properties": {
"network": {
"type": "string"
},
"addresses": {
"type": "string"
},
"jq_filter": {
"type": "string",
"title": "jq Filter",
"description": "A jq filter to apply to the response to include certain fields. Consult the output schema in the tool description to see the fields that are available.\n\nFor example: to include only the `name` field in every object of a results array, you can provide \".results[].name\".\n\nFor more information, see the [jq documentation](https://jqlang.org/manual/)."
},
"include_24hr_vol": {
"type": "boolean",
"description": "include 24hr volume, default: false"
},
"mcap_fdv_fallback": {
"type": "boolean",
"description": "return FDV if market cap is not available, default: false"
},
"include_market_cap": {
"type": "boolean",
"description": "include market capitalization, default: false"
},
"include_inactive_source": {
"type": "boolean",
"description": "include token price data from inactive pools using the most recent swap, default: false"
},
"include_24hr_price_change": {
"type": "boolean",
"description": "include 24hr price change, default: false"
},
"include_total_reserve_in_usd": {
"type": "boolean",
"description": "include total reserve in USD, default: false"
}
}
}get_holding_chart_public_treasury
When using this tool, always use the `jq_filter` parameter to reduce the response size and improve performance. Only omit if you're sure you don't need the data. This endpoint allows you to **query historical cryptocurrency holdings chart of public companies & governments** by Entity ID and Coin ID # Response Schema ```json { $ref: '#/$defs/public_treasury_get_holding_chart_response', $defs: { public_treasury_get_holding_chart_response: { type: 'object', properties: { holding_value_in_usd: { type: 'array', items: { type: 'array', items: { type: 'number' } } }, holdings: { type: 'array', items: { type: 'array', items: { type: 'number' } } } } } } } ```
{
"type": "object",
"required": [
"entity_id",
"coin_id",
"days"
],
"properties": {
"days": {
"type": "string",
"description": "data up to number of days ago \n Valid values: `7, 14, 30, 90, 180, 365, 730, max`"
},
"coin_id": {
"type": "string"
},
"entity_id": {
"type": "string"
},
"jq_filter": {
"type": "string",
"title": "jq Filter",
"description": "A jq filter to apply to the response to include certain fields. Consult the output schema in the tool description to see the fields that are available.\n\nFor example: to include only the `name` field in every object of a results array, you can provide \".results[].name\".\n\nFor more information, see the [jq documentation](https://jqlang.org/manual/)."
},
"include_empty_intervals": {
"type": "boolean",
"description": "include empty intervals with no transaction data, default: false"
}
}
}get_transaction_history_public_treasury
When using this tool, always use the `jq_filter` parameter to reduce the response size and improve performance. Only omit if you're sure you don't need the data. This endpoint allows you **query public companies & governments' cryptocurrency transaction history** by Entity ID # Response Schema ```json { $ref: '#/$defs/public_treasury_get_transaction_history_response', $defs: { public_treasury_get_transaction_history_response: { type: 'object', properties: { transactions: { type: 'array', items: { type: 'object', properties: { average_entry_value_usd: { type: 'number', description: 'average entry value in usd after the transaction' }, coin_id: { type: 'string', description: 'coin ID' }, date: { type: 'number', description: 'transaction date in UNIX timestamp' }, holding_balance: { type: 'number', description: 'total holding balance after the transaction' }, holding_net_change: { type: 'number', description: 'net change in holdings after the transaction' }, source_url: { type: 'string', description: 'source document URL' }, transaction_value_usd: { type: 'number', description: 'transaction value in usd' }, type: { type: 'string', description: 'transaction type: buy or sell', enum: [ 'buy', 'sell' ] } } } } } } } } ```
{
"type": "object",
"required": [
"entity_id"
],
"properties": {
"page": {
"type": "number",
"description": "page through results, default: `1`"
},
"order": {
"enum": [
"date_desc",
"date_asc",
"holding_net_change_desc",
"holding_net_change_asc",
"transaction_value_usd_desc",
"transaction_value_usd_asc",
"average_cost_desc",
"average_cost_asc"
],
"type": "string",
"description": "use this to sort the order of transactions, default: `date_desc`"
},
"coin_ids": {
"type": "string",
"description": "filter transactions by coin IDs, comma-separated if querying more than 1 coin \n *refers to [`/coins/list`](/reference/coins-list)."
},
"per_page": {
"type": "number",
"description": "total results per page, default: `100` \n Valid values: 1...250"
},
"entity_id": {
"type": "string"
},
"jq_filter": {
"type": "string",
"title": "jq Filter",
"description": "A jq filter to apply to the response to include certain fields. Consult the output schema in the tool description to see the fields that are available.\n\nFor example: to include only the `name` field in every object of a results array, you can provide \".results[].name\".\n\nFor more information, see the [jq documentation](https://jqlang.org/manual/)."
}
}
}get_search
When using this tool, always use the `jq_filter` parameter to reduce the response size and improve performance. Only omit if you're sure you don't need the data. This endpoint allows you to **search for coins, categories and markets listed on CoinGecko** # Response Schema ```json { $ref: '#/$defs/search_get_response', $defs: { search_get_response: { type: 'object', properties: { categories: { type: 'array', items: { type: 'object', properties: { id: { type: 'string', description: 'category ID' }, name: { type: 'string', description: 'category name' } } } }, coins: { type: 'array', items: { type: 'object', properties: { id: { type: 'string', description: 'coin ID' }, api_symbol: { type: 'string', description: 'coin api symbol' }, large: { type: 'string', description: 'coin large image url' }, market_cap_rank: { type: 'number', description: 'coin market cap rank' }, name: { type: 'string', description: 'coin name' }, symbol: { type: 'string', description: 'coin symbol' }, thumb: { type: 'string', description: 'coin thumb image url' } } } }, exchanges: { type: 'array', items: { type: 'object', properties: { id: { type: 'string', description: 'exchange ID' }, large: { type: 'string', description: 'exchange large image url' }, market_type: { type: 'string', description: 'exchange market type' }, name: { type: 'string', description: 'exchange name' }, thumb: { type: 'string', description: 'exchange thumb image url' } } } }, icos: { type: 'array', items: { type: 'string' } }, nfts: { type: 'array', items: { type: 'object', properties: { id: { type: 'string', description: 'NFT collection ID' }, name: { type: 'string', description: 'NFT name' }, symbol: { type: 'string', description: 'NFT collection symbol' }, thumb: { type: 'string', description: 'NFT collection thumb image url' } } } } } } } } ```
{
"type": "object",
"required": [
"query"
],
"properties": {
"query": {
"type": "string",
"description": "search query"
},
"jq_filter": {
"type": "string",
"title": "jq Filter",
"description": "A jq filter to apply to the response to include certain fields. Consult the output schema in the tool description to see the fields that are available.\n\nFor example: to include only the `name` field in every object of a results array, you can provide \".results[].name\".\n\nFor more information, see the [jq documentation](https://jqlang.org/manual/)."
}
}
}get_search_trending
When using this tool, always use the `jq_filter` parameter to reduce the response size and improve performance. Only omit if you're sure you don't need the data. This endpoint allows you **query trending search coins, NFTs and categories on CoinGecko in the last 24 hours** # Response Schema ```json { $ref: '#/$defs/trending_get_response', $defs: { trending_get_response: { type: 'object', properties: { categories: { type: 'array', items: { type: 'object', properties: { id: { type: 'number' }, coins_count: { type: 'number', description: 'category number of coins' }, data: { type: 'object', properties: { market_cap: { type: 'number', description: 'category market cap' }, market_cap_btc: { type: 'number', description: 'category market cap in btc' }, market_cap_change_percentage_24h: { type: 'object', description: 'category market cap change percentage in 24 hours', properties: { btc: { type: 'number' }, usd: { type: 'number' } } }, sparkline: { type: 'string', description: 'category sparkline image url' }, total_volume: { type: 'number', description: 'category total volume' }, total_volume_btc: { type: 'number', description: 'category total volume in btc' } } }, market_cap_1h_change: { type: 'number', description: 'category market cap 1 hour change' }, name: { type: 'string', description: 'category name' }, slug: { type: 'string', description: 'category web slug' } } } }, coins: { type: 'array', items: { type: 'object', properties: { id: { type: 'string', description: 'coin ID' }, coin_id: { type: 'number' }, data: { type: 'object', properties: { content: { type: 'string' }, market_cap: { type: 'string', description: 'coin market cap in usd' }, market_cap_btc: { type: 'string', description: 'coin market cap in btc' }, price: { type: 'number', description: 'coin price in usd' }, price_btc: { type: 'string', description: 'coin price in btc' }, price_change_percentage_24h: { type: 'object', description: 'coin price change percentage in 24 hours', properties: { btc: { type: 'number' }, usd: { type: 'number' } } }, sparkline: { type: 'string', description: 'coin sparkline image url' }, total_volume: { type: 'string', description: 'coin total volume in usd' }, total_volume_btc: { type: 'string', description: 'coin total volume in btc' } } }, large: { type: 'string', description: 'coin large image url' }, market_cap_rank: { type: 'number', description: 'coin market cap rank' }, name: { type: 'string', description: 'coin name' }, price_btc: { type: 'number', description: 'coin price in btc' }, score: { type: 'number', description: 'coin sequence in the list' }, slug: { type: 'string', description: 'coin web slug' }, small: { type: 'string', description: 'coin small image url' }, symbol: { type: 'string', description: 'coin symbol' }, thumb: { type: 'string', description: 'coin thumb image url' } } } }, nfts: { type: 'array', items: { type: 'object', properties: { id: { type: 'string', description: 'NFT collection ID' }, data: { type: 'object', properties: { content: { type: 'string' }, floor_price: { type: 'string', description: 'NFT collection floor price' }, floor_price_in_usd_24h_percentage_change: { type: 'string', description: 'NFT collection floor price in usd 24 hours percentage change' }, h24_average_sale_price: { type: 'string', description: 'NFT collection 24 hours average sale price' }, h24_volume: { type: 'string', description: 'NFT collection volume in 24 hours' }, sparkline: { type: 'string', description: 'NFT collection sparkline image url' } } }, floor_price_24h_percentage_change: { type: 'number', description: 'NFT collection floor price 24 hours percentage change' }, floor_price_in_native_currency: { type: 'number', description: 'NFT collection floor price in native currency' }, name: { type: 'string', description: 'NFT collection name' }, native_currency_symbol: { type: 'string', description: 'NFT collection native currency symbol' }, nft_contract_id: { type: 'number' }, symbol: { type: 'string', description: 'NFT collection symbol' }, thumb: { type: 'string', description: 'NFT collection thumb image url' } } } } } } } } ```
{
"type": "object",
"required": [],
"properties": {
"show_max": {
"type": "string",
"description": "show max number of results available for the given type \n Available values: `coins`, `nfts`, `categories` \n Example: `coins` or `coins,nfts,categories`"
},
"jq_filter": {
"type": "string",
"title": "jq Filter",
"description": "A jq filter to apply to the response to include certain fields. Consult the output schema in the tool description to see the fields that are available.\n\nFor example: to include only the `name` field in every object of a results array, you can provide \".results[].name\".\n\nFor more information, see the [jq documentation](https://jqlang.org/manual/)."
}
}
}get_simple_price
When using this tool, always use the `jq_filter` parameter to reduce the response size and improve performance. Only omit if you're sure you don't need the data. This endpoint allows you to **query the prices of one or more coins by using their unique Coin API IDs** # Response Schema ```json { $ref: '#/$defs/price_get_response', $defs: { price_get_response: { type: 'object', additionalProperties: true } } } ```
{
"type": "object",
"required": [
"vs_currencies"
],
"properties": {
"ids": {
"type": "string",
"description": "coins' IDs, comma-separated if querying more than 1 coin. \n *refers to [`/coins/list`](/reference/coins-list)."
},
"names": {
"type": "string",
"description": "coins' names, comma-separated if querying more than 1 coin."
},
"symbols": {
"type": "string",
"description": "coins' symbols, comma-separated if querying more than 1 coin."
},
"jq_filter": {
"type": "string",
"title": "jq Filter",
"description": "A jq filter to apply to the response to include certain fields. Consult the output schema in the tool description to see the fields that are available.\n\nFor example: to include only the `name` field in every object of a results array, you can provide \".results[].name\".\n\nFor more information, see the [jq documentation](https://jqlang.org/manual/)."
},
"precision": {
"enum": [
"full",
"0",
"1",
"2",
"3",
"4",
"5",
"6",
"7",
"8",
"9",
"10",
"11",
"12",
"13",
"14",
"15",
"16",
"17",
"18"
],
"type": "string",
"description": "decimal place for currency price value"
},
"vs_currencies": {
"type": "string",
"description": "target currency of coins, comma-separated if querying more than 1 currency. \n *refers to [`/simple/supported_vs_currencies`](/reference/simple-supported-currencies)."
},
"include_tokens": {
"enum": [
"top",
"all"
],
"type": "string",
"description": "for `symbols` lookups, specify `all` to include all matching tokens \n Default `top` returns top-ranked tokens (by market cap or volume)"
},
"include_24hr_vol": {
"type": "boolean",
"description": "include 24hr volume, default: false"
},
"include_market_cap": {
"type": "boolean",
"description": "include market capitalization, default: false"
},
"include_24hr_change": {
"type": "boolean",
"description": "include 24hr change percentage, default: false"
},
"include_last_updated_at": {
"type": "boolean",
"description": "include last updated price time in UNIX, default: false"
}
}
}get_simple_supported_vs_currencies
When using this tool, always use the `jq_filter` parameter to reduce the response size and improve performance. Only omit if you're sure you don't need the data. This endpoint allows you to **query all the supported currencies on CoinGecko** # Response Schema ```json { $ref: '#/$defs/supported_vs_currency_get_response', $defs: { supported_vs_currency_get_response: { type: 'array', items: { type: 'string' } } } } ```
{
"type": "object",
"required": [],
"properties": {
"jq_filter": {
"type": "string",
"title": "jq Filter",
"description": "A jq filter to apply to the response to include certain fields. Consult the output schema in the tool description to see the fields that are available.\n\nFor example: to include only the `name` field in every object of a results array, you can provide \".results[].name\".\n\nFor more information, see the [jq documentation](https://jqlang.org/manual/)."
}
}
}get_id_simple_token_price
When using this tool, always use the `jq_filter` parameter to reduce the response size and improve performance. Only omit if you're sure you don't need the data. This endpoint allows you to **query one or more token prices using their token contract addresses** # Response Schema ```json { $ref: '#/$defs/token_price_get_id_response', $defs: { token_price_get_id_response: { type: 'object', properties: { last_updated_at: { type: 'number', description: 'last updated timestamp' }, usd: { type: 'number', description: 'price in USD' }, usd_24h_change: { type: 'number', description: '24hr change in USD' }, usd_24h_vol: { type: 'number', description: '24hr volume in USD' }, usd_market_cap: { type: 'number', description: 'market cap in USD' } } } } } ```
{
"type": "object",
"required": [
"id",
"contract_addresses",
"vs_currencies"
],
"properties": {
"id": {
"type": "string"
},
"jq_filter": {
"type": "string",
"title": "jq Filter",
"description": "A jq filter to apply to the response to include certain fields. Consult the output schema in the tool description to see the fields that are available.\n\nFor example: to include only the `name` field in every object of a results array, you can provide \".results[].name\".\n\nFor more information, see the [jq documentation](https://jqlang.org/manual/)."
},
"precision": {
"enum": [
"full",
"0",
"1",
"2",
"3",
"4",
"5",
"6",
"7",
"8",
"9",
"10",
"11",
"12",
"13",
"14",
"15",
"16",
"17",
"18"
],
"type": "string",
"description": "decimal place for currency price value"
},
"vs_currencies": {
"type": "string",
"description": "target currency of coins, comma-separated if querying more than 1 currency. \n *refers to [`/simple/supported_vs_currencies`](/reference/simple-supported-currencies)."
},
"include_24hr_vol": {
"type": "boolean",
"description": "include 24hr volume, default: false"
},
"contract_addresses": {
"type": "string",
"description": "the contract addresses of tokens, comma-separated if querying more than 1 token's contract address"
},
"include_market_cap": {
"type": "boolean",
"description": "include market capitalization, default: false"
},
"include_24hr_change": {
"type": "boolean",
"description": "include 24hr change \n default: false"
},
"include_last_updated_at": {
"type": "boolean",
"description": "include last updated price time in UNIX , default: false"
}
}
}search_docs
Search for documentation for how to use the client to interact with the API.
{
"type": "object",
"required": [
"query",
"language"
],
"properties": {
"query": {
"type": "string",
"description": "The query to search for."
},
"detail": {
"enum": [
"default",
"verbose"
],
"type": "string",
"description": "The amount of detail to return."
},
"language": {
"enum": [
"http",
"python",
"go",
"typescript",
"javascript",
"terraform",
"ruby",
"java",
"kotlin"
],
"type": "string",
"description": "The language for the SDK to search for."
}
}
}No prompts published.
No resources published.