From 09eb0e877ea33daecad703a15c51dfc25561eccc Mon Sep 17 00:00:00 2001 From: tukuaiai Date: Sat, 28 Feb 2026 06:49:43 +0800 Subject: [PATCH 01/43] chore: checkpoint before documents restructure --- assets/tools/README.md | 1 + 1 file changed, 1 insertion(+) create mode 100644 assets/tools/README.md diff --git a/assets/tools/README.md b/assets/tools/README.md new file mode 100644 index 0000000..9602e63 --- /dev/null +++ b/assets/tools/README.md @@ -0,0 +1 @@ +占位，这里即将存放对于指定任务中合适的成熟工具的使用方法，提供给 agent 进行操作 \ No newline at end of file From ef01c5ccc3cc509488839a54e1fce9e973819598 Mon Sep 17 00:00:00 2001 From: tukuaiai Date: Sat, 28 Feb 2026 06:50:35 +0800 Subject: [PATCH 02/43] refactor: documents - regroup into principles/guides/case-studies --- assets/documents/{03-实战 => case-studies}/README.md | 0 .../fate-engine-dev/ascii可视化-prompt.md | 0 .../fate-engine-dev/prompt-system-bazi-kline.md | 0 .../fate-engine-dev/prompt-user-bazi-kline.md | 0 .../fate-engine-dev/完整性检查-prompt.md | 0 .../fate-engine-dev/胶水开发要求-prompt.md | 0 .../{03-实战 => case-studies}/fate-engine-dev/问题描述-prompt.md | 0 .../polymarket-dev/POLYMARKET_LINK_FORMAT.md | 0 .../polymarket-dev/Polymarket 套利全解析.md | 0 .../documents/{03-实战 => case-studies}/polymarket-dev/README.md | 0 .../polymarket-dev/ascii可视化-prompt.md | 0 .../{03-实战 => case-studies}/polymarket-dev/复查-prompt.md | 0 .../{03-实战 => case-studies}/polymarket-dev/完整性检查-prompt.md | 0 .../polymarket-dev/胶水开发要求-prompt.md | 0 .../{03-实战 => case-studies}/polymarket-dev/问题描述-prompt.md | 0 assets/documents/{03-实战 => case-studies}/telegram-dev/README.md | 0 .../telegram-dev/telegram Markdown 代码块格式修复记录 2025-12-15.md | 0 .../getting-started}/00-Vibe Coding 哲学原理.md | 0 .../{01-入门指南 => guides/getting-started}/01-网络环境配置.md | 0 .../{01-入门指南 => guides/getting-started}/02-开发环境搭建.md | 0 .../{01-入门指南 => guides/getting-started}/03-IDE配置.md | 0 .../getting-started}/04-OpenCode-CLI配置.md | 0 .../documents/{01-入门指南 => guides/getting-started}/README.md | 0 .../playbook}/AI蜂群协作-tmux多Agent协作系统.md | 0 .../documents/{02-方法论 => guides/playbook}/GEMINI-HEADLESS.md | 0 .../documents/{02-方法论 => guides/playbook}/LazyVim快捷键大全.md | 0 .../documents/{02-方法论 => guides/playbook}/ProxyCast配置文档.md | 0 assets/documents/{02-方法论 => guides/playbook}/README.md | 0 .../{02-方法论 => guides/playbook}/REMOTE_TUNNEL_GUIDE.md | 0 .../{02-方法论 => guides/playbook}/auggie-mcp配置文档.md | 0 assets/documents/{02-方法论 => guides/playbook}/tmux快捷键大全.md | 0 .../{02-方法论 => guides/playbook}/vibe-coding-经验收集.md | 0 .../关于手机ssh任意位置链接本地计算机，基于frp实现的方法.md | 0 .../{02-方法论 => guides/playbook}/四阶段×十二原则方法论.md | 0 .../playbook}/图形化AI协作-Canvas白板驱动开发.md | 0 ...A Formalization of Recursive Self-Optimizing Generative Systems.md | 0 .../documents/{00-基础指南 => principles/fundamentals}/README.md | 0 .../{00-基础指南 => principles/fundamentals}/代码组织.md | 0 .../{00-基础指南 => principles/fundamentals}/审查代码.md | 0 .../{00-基础指南 => principles/fundamentals}/常见坑汇总.md | 0 .../{00-基础指南 => principles/fundamentals}/开发经验.md | 0 .../{00-基础指南 => principles/fundamentals}/强前置条件约束.md | 0 .../fundamentals}/系统提示词构建原则.md | 0 .../{00-基础指南 => principles/fundamentals}/编程之道.md | 0 .../{00-基础指南 => principles/fundamentals}/胶水编程.md | 0 .../{00-基础指南 => principles/fundamentals}/血的教训.md | 0 .../{00-基础指南 => principles/fundamentals}/语言层要素.md | 0 .../{00-基础指南 => principles/fundamentals}/通用项目架构模板.md | 0 .../{05-哲学与方法论 => principles/philosophy}/AI蜂群协作.md | 0 .../{05-哲学与方法论 => principles/philosophy}/README.md | 0 .../{05-哲学与方法论 => principles/philosophy}/现象学还原.md | 0 .../{05-哲学与方法论 => principles/philosophy}/辩证法.md | 0 52 files changed, 0 insertions(+), 0 deletions(-) rename assets/documents/{03-实战 => case-studies}/README.md (100%) rename assets/documents/{03-实战 => case-studies}/fate-engine-dev/ascii可视化-prompt.md (100%) rename assets/documents/{03-实战 => case-studies}/fate-engine-dev/prompt-system-bazi-kline.md (100%) rename assets/documents/{03-实战 => case-studies}/fate-engine-dev/prompt-user-bazi-kline.md (100%) rename assets/documents/{03-实战 => case-studies}/fate-engine-dev/完整性检查-prompt.md (100%) rename assets/documents/{03-实战 => case-studies}/fate-engine-dev/胶水开发要求-prompt.md (100%) rename assets/documents/{03-实战 => case-studies}/fate-engine-dev/问题描述-prompt.md (100%) rename assets/documents/{03-实战 => case-studies}/polymarket-dev/POLYMARKET_LINK_FORMAT.md (100%) rename assets/documents/{03-实战 => case-studies}/polymarket-dev/Polymarket 套利全解析.md (100%) rename assets/documents/{03-实战 => case-studies}/polymarket-dev/README.md (100%) rename assets/documents/{03-实战 => case-studies}/polymarket-dev/ascii可视化-prompt.md (100%) rename assets/documents/{03-实战 => case-studies}/polymarket-dev/复查-prompt.md (100%) rename assets/documents/{03-实战 => case-studies}/polymarket-dev/完整性检查-prompt.md (100%) rename assets/documents/{03-实战 => case-studies}/polymarket-dev/胶水开发要求-prompt.md (100%) rename assets/documents/{03-实战 => case-studies}/polymarket-dev/问题描述-prompt.md (100%) rename assets/documents/{03-实战 => case-studies}/telegram-dev/README.md (100%) rename assets/documents/{03-实战 => case-studies}/telegram-dev/telegram Markdown 代码块格式修复记录 2025-12-15.md (100%) rename assets/documents/{01-入门指南 => guides/getting-started}/00-Vibe Coding 哲学原理.md (100%) rename assets/documents/{01-入门指南 => guides/getting-started}/01-网络环境配置.md (100%) rename assets/documents/{01-入门指南 => guides/getting-started}/02-开发环境搭建.md (100%) rename assets/documents/{01-入门指南 => guides/getting-started}/03-IDE配置.md (100%) rename assets/documents/{01-入门指南 => guides/getting-started}/04-OpenCode-CLI配置.md (100%) rename assets/documents/{01-入门指南 => guides/getting-started}/README.md (100%) rename assets/documents/{02-方法论 => guides/playbook}/AI蜂群协作-tmux多Agent协作系统.md (100%) rename assets/documents/{02-方法论 => guides/playbook}/GEMINI-HEADLESS.md (100%) rename assets/documents/{02-方法论 => guides/playbook}/LazyVim快捷键大全.md (100%) rename assets/documents/{02-方法论 => guides/playbook}/ProxyCast配置文档.md (100%) rename assets/documents/{02-方法论 => guides/playbook}/README.md (100%) rename assets/documents/{02-方法论 => guides/playbook}/REMOTE_TUNNEL_GUIDE.md (100%) rename assets/documents/{02-方法论 => guides/playbook}/auggie-mcp配置文档.md (100%) rename assets/documents/{02-方法论 => guides/playbook}/tmux快捷键大全.md (100%) rename assets/documents/{02-方法论 => guides/playbook}/vibe-coding-经验收集.md (100%) rename assets/documents/{02-方法论 => guides/playbook}/关于手机ssh任意位置链接本地计算机，基于frp实现的方法.md (100%) rename assets/documents/{02-方法论 => guides/playbook}/四阶段×十二原则方法论.md (100%) rename assets/documents/{02-方法论 => guides/playbook}/图形化AI协作-Canvas白板驱动开发.md (100%) rename assets/documents/{00-基础指南 => principles/fundamentals}/A Formalization of Recursive Self-Optimizing Generative Systems.md (100%) rename assets/documents/{00-基础指南 => principles/fundamentals}/README.md (100%) rename assets/documents/{00-基础指南 => principles/fundamentals}/代码组织.md (100%) rename assets/documents/{00-基础指南 => principles/fundamentals}/审查代码.md (100%) rename assets/documents/{00-基础指南 => principles/fundamentals}/常见坑汇总.md (100%) rename assets/documents/{00-基础指南 => principles/fundamentals}/开发经验.md (100%) rename assets/documents/{00-基础指南 => principles/fundamentals}/强前置条件约束.md (100%) rename assets/documents/{00-基础指南 => principles/fundamentals}/系统提示词构建原则.md (100%) rename assets/documents/{00-基础指南 => principles/fundamentals}/编程之道.md (100%) rename assets/documents/{00-基础指南 => principles/fundamentals}/胶水编程.md (100%) rename assets/documents/{00-基础指南 => principles/fundamentals}/血的教训.md (100%) rename assets/documents/{00-基础指南 => principles/fundamentals}/语言层要素.md (100%) rename assets/documents/{00-基础指南 => principles/fundamentals}/通用项目架构模板.md (100%) rename assets/documents/{05-哲学与方法论 => principles/philosophy}/AI蜂群协作.md (100%) rename assets/documents/{05-哲学与方法论 => principles/philosophy}/README.md (100%) rename assets/documents/{05-哲学与方法论 => principles/philosophy}/现象学还原.md (100%) rename assets/documents/{05-哲学与方法论 => principles/philosophy}/辩证法.md (100%) diff --git a/assets/documents/03-实战/README.md b/assets/documents/case-studies/README.md similarity index 100% rename from assets/documents/03-实战/README.md rename to assets/documents/case-studies/README.md diff --git a/assets/documents/03-实战/fate-engine-dev/ascii可视化-prompt.md b/assets/documents/case-studies/fate-engine-dev/ascii可视化-prompt.md similarity index 100% rename from assets/documents/03-实战/fate-engine-dev/ascii可视化-prompt.md rename to assets/documents/case-studies/fate-engine-dev/ascii可视化-prompt.md diff --git a/assets/documents/03-实战/fate-engine-dev/prompt-system-bazi-kline.md b/assets/documents/case-studies/fate-engine-dev/prompt-system-bazi-kline.md similarity index 100% rename from assets/documents/03-实战/fate-engine-dev/prompt-system-bazi-kline.md rename to assets/documents/case-studies/fate-engine-dev/prompt-system-bazi-kline.md diff --git a/assets/documents/03-实战/fate-engine-dev/prompt-user-bazi-kline.md b/assets/documents/case-studies/fate-engine-dev/prompt-user-bazi-kline.md similarity index 100% rename from assets/documents/03-实战/fate-engine-dev/prompt-user-bazi-kline.md rename to assets/documents/case-studies/fate-engine-dev/prompt-user-bazi-kline.md diff --git a/assets/documents/03-实战/fate-engine-dev/完整性检查-prompt.md b/assets/documents/case-studies/fate-engine-dev/完整性检查-prompt.md similarity index 100% rename from assets/documents/03-实战/fate-engine-dev/完整性检查-prompt.md rename to assets/documents/case-studies/fate-engine-dev/完整性检查-prompt.md diff --git a/assets/documents/03-实战/fate-engine-dev/胶水开发要求-prompt.md b/assets/documents/case-studies/fate-engine-dev/胶水开发要求-prompt.md similarity index 100% rename from assets/documents/03-实战/fate-engine-dev/胶水开发要求-prompt.md rename to assets/documents/case-studies/fate-engine-dev/胶水开发要求-prompt.md diff --git a/assets/documents/03-实战/fate-engine-dev/问题描述-prompt.md b/assets/documents/case-studies/fate-engine-dev/问题描述-prompt.md similarity index 100% rename from assets/documents/03-实战/fate-engine-dev/问题描述-prompt.md rename to assets/documents/case-studies/fate-engine-dev/问题描述-prompt.md diff --git a/assets/documents/03-实战/polymarket-dev/POLYMARKET_LINK_FORMAT.md b/assets/documents/case-studies/polymarket-dev/POLYMARKET_LINK_FORMAT.md similarity index 100% rename from assets/documents/03-实战/polymarket-dev/POLYMARKET_LINK_FORMAT.md rename to assets/documents/case-studies/polymarket-dev/POLYMARKET_LINK_FORMAT.md diff --git a/assets/documents/03-实战/polymarket-dev/Polymarket 套利全解析.md b/assets/documents/case-studies/polymarket-dev/Polymarket 套利全解析.md similarity index 100% rename from assets/documents/03-实战/polymarket-dev/Polymarket 套利全解析.md rename to assets/documents/case-studies/polymarket-dev/Polymarket 套利全解析.md diff --git a/assets/documents/03-实战/polymarket-dev/README.md b/assets/documents/case-studies/polymarket-dev/README.md similarity index 100% rename from assets/documents/03-实战/polymarket-dev/README.md rename to assets/documents/case-studies/polymarket-dev/README.md diff --git a/assets/documents/03-实战/polymarket-dev/ascii可视化-prompt.md b/assets/documents/case-studies/polymarket-dev/ascii可视化-prompt.md similarity index 100% rename from assets/documents/03-实战/polymarket-dev/ascii可视化-prompt.md rename to assets/documents/case-studies/polymarket-dev/ascii可视化-prompt.md diff --git a/assets/documents/03-实战/polymarket-dev/复查-prompt.md b/assets/documents/case-studies/polymarket-dev/复查-prompt.md similarity index 100% rename from assets/documents/03-实战/polymarket-dev/复查-prompt.md rename to assets/documents/case-studies/polymarket-dev/复查-prompt.md diff --git a/assets/documents/03-实战/polymarket-dev/完整性检查-prompt.md b/assets/documents/case-studies/polymarket-dev/完整性检查-prompt.md similarity index 100% rename from assets/documents/03-实战/polymarket-dev/完整性检查-prompt.md rename to assets/documents/case-studies/polymarket-dev/完整性检查-prompt.md diff --git a/assets/documents/03-实战/polymarket-dev/胶水开发要求-prompt.md b/assets/documents/case-studies/polymarket-dev/胶水开发要求-prompt.md similarity index 100% rename from assets/documents/03-实战/polymarket-dev/胶水开发要求-prompt.md rename to assets/documents/case-studies/polymarket-dev/胶水开发要求-prompt.md diff --git a/assets/documents/03-实战/polymarket-dev/问题描述-prompt.md b/assets/documents/case-studies/polymarket-dev/问题描述-prompt.md similarity index 100% rename from assets/documents/03-实战/polymarket-dev/问题描述-prompt.md rename to assets/documents/case-studies/polymarket-dev/问题描述-prompt.md diff --git a/assets/documents/03-实战/telegram-dev/README.md b/assets/documents/case-studies/telegram-dev/README.md similarity index 100% rename from assets/documents/03-实战/telegram-dev/README.md rename to assets/documents/case-studies/telegram-dev/README.md diff --git a/assets/documents/03-实战/telegram-dev/telegram Markdown 代码块格式修复记录 2025-12-15.md b/assets/documents/case-studies/telegram-dev/telegram Markdown 代码块格式修复记录 2025-12-15.md similarity index 100% rename from assets/documents/03-实战/telegram-dev/telegram Markdown 代码块格式修复记录 2025-12-15.md rename to assets/documents/case-studies/telegram-dev/telegram Markdown 代码块格式修复记录 2025-12-15.md diff --git a/assets/documents/01-入门指南/00-Vibe Coding 哲学原理.md b/assets/documents/guides/getting-started/00-Vibe Coding 哲学原理.md similarity index 100% rename from assets/documents/01-入门指南/00-Vibe Coding 哲学原理.md rename to assets/documents/guides/getting-started/00-Vibe Coding 哲学原理.md diff --git a/assets/documents/01-入门指南/01-网络环境配置.md b/assets/documents/guides/getting-started/01-网络环境配置.md similarity index 100% rename from assets/documents/01-入门指南/01-网络环境配置.md rename to assets/documents/guides/getting-started/01-网络环境配置.md diff --git a/assets/documents/01-入门指南/02-开发环境搭建.md b/assets/documents/guides/getting-started/02-开发环境搭建.md similarity index 100% rename from assets/documents/01-入门指南/02-开发环境搭建.md rename to assets/documents/guides/getting-started/02-开发环境搭建.md diff --git a/assets/documents/01-入门指南/03-IDE配置.md b/assets/documents/guides/getting-started/03-IDE配置.md similarity index 100% rename from assets/documents/01-入门指南/03-IDE配置.md rename to assets/documents/guides/getting-started/03-IDE配置.md diff --git a/assets/documents/01-入门指南/04-OpenCode-CLI配置.md b/assets/documents/guides/getting-started/04-OpenCode-CLI配置.md similarity index 100% rename from assets/documents/01-入门指南/04-OpenCode-CLI配置.md rename to assets/documents/guides/getting-started/04-OpenCode-CLI配置.md diff --git a/assets/documents/01-入门指南/README.md b/assets/documents/guides/getting-started/README.md similarity index 100% rename from assets/documents/01-入门指南/README.md rename to assets/documents/guides/getting-started/README.md diff --git a/assets/documents/02-方法论/AI蜂群协作-tmux多Agent协作系统.md b/assets/documents/guides/playbook/AI蜂群协作-tmux多Agent协作系统.md similarity index 100% rename from assets/documents/02-方法论/AI蜂群协作-tmux多Agent协作系统.md rename to assets/documents/guides/playbook/AI蜂群协作-tmux多Agent协作系统.md diff --git a/assets/documents/02-方法论/GEMINI-HEADLESS.md b/assets/documents/guides/playbook/GEMINI-HEADLESS.md similarity index 100% rename from assets/documents/02-方法论/GEMINI-HEADLESS.md rename to assets/documents/guides/playbook/GEMINI-HEADLESS.md diff --git a/assets/documents/02-方法论/LazyVim快捷键大全.md b/assets/documents/guides/playbook/LazyVim快捷键大全.md similarity index 100% rename from assets/documents/02-方法论/LazyVim快捷键大全.md rename to assets/documents/guides/playbook/LazyVim快捷键大全.md diff --git a/assets/documents/02-方法论/ProxyCast配置文档.md b/assets/documents/guides/playbook/ProxyCast配置文档.md similarity index 100% rename from assets/documents/02-方法论/ProxyCast配置文档.md rename to assets/documents/guides/playbook/ProxyCast配置文档.md diff --git a/assets/documents/02-方法论/README.md b/assets/documents/guides/playbook/README.md similarity index 100% rename from assets/documents/02-方法论/README.md rename to assets/documents/guides/playbook/README.md diff --git a/assets/documents/02-方法论/REMOTE_TUNNEL_GUIDE.md b/assets/documents/guides/playbook/REMOTE_TUNNEL_GUIDE.md similarity index 100% rename from assets/documents/02-方法论/REMOTE_TUNNEL_GUIDE.md rename to assets/documents/guides/playbook/REMOTE_TUNNEL_GUIDE.md diff --git a/assets/documents/02-方法论/auggie-mcp配置文档.md b/assets/documents/guides/playbook/auggie-mcp配置文档.md similarity index 100% rename from assets/documents/02-方法论/auggie-mcp配置文档.md rename to assets/documents/guides/playbook/auggie-mcp配置文档.md diff --git a/assets/documents/02-方法论/tmux快捷键大全.md b/assets/documents/guides/playbook/tmux快捷键大全.md similarity index 100% rename from assets/documents/02-方法论/tmux快捷键大全.md rename to assets/documents/guides/playbook/tmux快捷键大全.md diff --git a/assets/documents/02-方法论/vibe-coding-经验收集.md b/assets/documents/guides/playbook/vibe-coding-经验收集.md similarity index 100% rename from assets/documents/02-方法论/vibe-coding-经验收集.md rename to assets/documents/guides/playbook/vibe-coding-经验收集.md diff --git a/assets/documents/02-方法论/关于手机ssh任意位置链接本地计算机，基于frp实现的方法.md b/assets/documents/guides/playbook/关于手机ssh任意位置链接本地计算机，基于frp实现的方法.md similarity index 100% rename from assets/documents/02-方法论/关于手机ssh任意位置链接本地计算机，基于frp实现的方法.md rename to assets/documents/guides/playbook/关于手机ssh任意位置链接本地计算机，基于frp实现的方法.md diff --git a/assets/documents/02-方法论/四阶段×十二原则方法论.md b/assets/documents/guides/playbook/四阶段×十二原则方法论.md similarity index 100% rename from assets/documents/02-方法论/四阶段×十二原则方法论.md rename to assets/documents/guides/playbook/四阶段×十二原则方法论.md diff --git a/assets/documents/02-方法论/图形化AI协作-Canvas白板驱动开发.md b/assets/documents/guides/playbook/图形化AI协作-Canvas白板驱动开发.md similarity index 100% rename from assets/documents/02-方法论/图形化AI协作-Canvas白板驱动开发.md rename to assets/documents/guides/playbook/图形化AI协作-Canvas白板驱动开发.md diff --git a/assets/documents/00-基础指南/A Formalization of Recursive Self-Optimizing Generative Systems.md b/assets/documents/principles/fundamentals/A Formalization of Recursive Self-Optimizing Generative Systems.md similarity index 100% rename from assets/documents/00-基础指南/A Formalization of Recursive Self-Optimizing Generative Systems.md rename to assets/documents/principles/fundamentals/A Formalization of Recursive Self-Optimizing Generative Systems.md diff --git a/assets/documents/00-基础指南/README.md b/assets/documents/principles/fundamentals/README.md similarity index 100% rename from assets/documents/00-基础指南/README.md rename to assets/documents/principles/fundamentals/README.md diff --git a/assets/documents/00-基础指南/代码组织.md b/assets/documents/principles/fundamentals/代码组织.md similarity index 100% rename from assets/documents/00-基础指南/代码组织.md rename to assets/documents/principles/fundamentals/代码组织.md diff --git a/assets/documents/00-基础指南/审查代码.md b/assets/documents/principles/fundamentals/审查代码.md similarity index 100% rename from assets/documents/00-基础指南/审查代码.md rename to assets/documents/principles/fundamentals/审查代码.md diff --git a/assets/documents/00-基础指南/常见坑汇总.md b/assets/documents/principles/fundamentals/常见坑汇总.md similarity index 100% rename from assets/documents/00-基础指南/常见坑汇总.md rename to assets/documents/principles/fundamentals/常见坑汇总.md diff --git a/assets/documents/00-基础指南/开发经验.md b/assets/documents/principles/fundamentals/开发经验.md similarity index 100% rename from assets/documents/00-基础指南/开发经验.md rename to assets/documents/principles/fundamentals/开发经验.md diff --git a/assets/documents/00-基础指南/强前置条件约束.md b/assets/documents/principles/fundamentals/强前置条件约束.md similarity index 100% rename from assets/documents/00-基础指南/强前置条件约束.md rename to assets/documents/principles/fundamentals/强前置条件约束.md diff --git a/assets/documents/00-基础指南/系统提示词构建原则.md b/assets/documents/principles/fundamentals/系统提示词构建原则.md similarity index 100% rename from assets/documents/00-基础指南/系统提示词构建原则.md rename to assets/documents/principles/fundamentals/系统提示词构建原则.md diff --git a/assets/documents/00-基础指南/编程之道.md b/assets/documents/principles/fundamentals/编程之道.md similarity index 100% rename from assets/documents/00-基础指南/编程之道.md rename to assets/documents/principles/fundamentals/编程之道.md diff --git a/assets/documents/00-基础指南/胶水编程.md b/assets/documents/principles/fundamentals/胶水编程.md similarity index 100% rename from assets/documents/00-基础指南/胶水编程.md rename to assets/documents/principles/fundamentals/胶水编程.md diff --git a/assets/documents/00-基础指南/血的教训.md b/assets/documents/principles/fundamentals/血的教训.md similarity index 100% rename from assets/documents/00-基础指南/血的教训.md rename to assets/documents/principles/fundamentals/血的教训.md diff --git a/assets/documents/00-基础指南/语言层要素.md b/assets/documents/principles/fundamentals/语言层要素.md similarity index 100% rename from assets/documents/00-基础指南/语言层要素.md rename to assets/documents/principles/fundamentals/语言层要素.md diff --git a/assets/documents/00-基础指南/通用项目架构模板.md b/assets/documents/principles/fundamentals/通用项目架构模板.md similarity index 100% rename from assets/documents/00-基础指南/通用项目架构模板.md rename to assets/documents/principles/fundamentals/通用项目架构模板.md diff --git a/assets/documents/05-哲学与方法论/AI蜂群协作.md b/assets/documents/principles/philosophy/AI蜂群协作.md similarity index 100% rename from assets/documents/05-哲学与方法论/AI蜂群协作.md rename to assets/documents/principles/philosophy/AI蜂群协作.md diff --git a/assets/documents/05-哲学与方法论/README.md b/assets/documents/principles/philosophy/README.md similarity index 100% rename from assets/documents/05-哲学与方法论/README.md rename to assets/documents/principles/philosophy/README.md diff --git a/assets/documents/05-哲学与方法论/现象学还原.md b/assets/documents/principles/philosophy/现象学还原.md similarity index 100% rename from assets/documents/05-哲学与方法论/现象学还原.md rename to assets/documents/principles/philosophy/现象学还原.md diff --git a/assets/documents/05-哲学与方法论/辩证法.md b/assets/documents/principles/philosophy/辩证法.md similarity index 100% rename from assets/documents/05-哲学与方法论/辩证法.md rename to assets/documents/principles/philosophy/辩证法.md From 28bfaeeee3698d1281ed79fcff51bc112e4658d8 Mon Sep 17 00:00:00 2001 From: tukuaiai Date: Sat, 28 Feb 2026 06:58:54 +0800 Subject: [PATCH 03/43] docs: documents - update structure and navigation --- AGENTS.md | 14 ++++--- README.md | 76 +++++++++++++++++++------------------- assets/documents/AGENTS.md | 17 +++++---- assets/documents/README.md | 34 ++++++++--------- 4 files changed, 73 insertions(+), 68 deletions(-) diff --git a/AGENTS.md b/AGENTS.md index 18236bb..8f58748 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -144,11 +144,13 @@ git push origin develop │ │ ├── config.toml # Codex CLI 配置文件 │ │ └── AGENTS.md # Codex/Agent 指南（本目录） │ ├── documents/ # 文档库 -│ │ ├── 05-哲学与方法论/ # 最高思想纲领与方法论 -│ │ ├── 00-基础指南/ # 核心原则与底层逻辑 -│ │ ├── 01-入门指南/ # 从零开始教程 -│ │ ├── 02-方法论/ # 具体工具与技巧 -│ │ └── 03-实战/ # 项目实战案例 +│ │ ├── principles/ # 原则与思想（fundamentals + philosophy） +│ │ │ ├── fundamentals/ # 原 00-基础指南 +│ │ │ └── philosophy/ # 原 05-哲学与方法论 +│ │ ├── guides/ # 入门与方法（getting-started + playbook） +│ │ │ ├── getting-started/ # 原 01-入门指南 +│ │ │ └── playbook/ # 原 02-方法论 +│ │ └── case-studies/ # 原 03-实战 │ ├── prompts/ # 提示词库（指向云端表格） │ │ ├── README.md # 在线表格链接 │ │ └── AGENTS.md # prompts/ 目录规则 @@ -282,7 +284,7 @@ bash assets/repo/backups/一键备份.sh ### Core Directories - **`assets/prompts/`**: 提示词库入口（指向云端表格） - **`assets/skills/`**: 扁平化技能库（详见 assets/skills/README.md） -- **`assets/documents/`**: 知识库（05-哲学与方法论、00-基础指南、01-入门指南、02-方法论、03-实战） +- **`assets/documents/`**: 知识库（principles、guides、case-studies） - **`assets/`**: 外部资源（在线表格）入口与使用说明 - **`assets/repo/prompts-library/`**: Excel ↔ Markdown 转换工具 - **`assets/repo/chat-vault/`**: AI 聊天记录保存工具 diff --git a/README.md b/README.md index b7a5cef..6547936 100644 --- a/README.md +++ b/README.md @@ -31,19 +31,19 @@

- 哲学与方法论 - 核心哲学 - 胶水编程 - Canvas白板驱动开发 - 从零开始 - 血的教训 - 语言层要素 - 常见坑汇总 - 强前置条件约束 + 哲学与方法论 + 核心哲学 + 胶水编程 + Canvas白板驱动开发 + 从零开始 + 血的教训 + 语言层要素 + 常见坑汇总 + 强前置条件约束 信息源聚合 - 元方法论 - 编程之道 - 实战案例 + 元方法论 + 编程之道 + 实战案例 工具集 提示词精选 skills技能大全 @@ -109,11 +109,11 @@ 完全新手？按顺序完成以下步骤： -0. [00-Vibe Coding 哲学原理](./assets/documents/01-入门指南/00-Vibe%20Coding%20哲学原理.md) - 理解核心理念 -1. [01-网络环境配置](./assets/documents/01-入门指南/01-网络环境配置.md) - 配置网络访问 -2. [02-开发环境搭建](./assets/documents/01-入门指南/02-开发环境搭建.md) - 复制提示词给 AI，让 AI 指导你搭建环境 -3. [03-IDE配置](./assets/documents/01-入门指南/03-IDE配置.md) - 配置 VS Code 编辑器 -4. [04-OpenCode-CLI配置](./assets/documents/01-入门指南/04-OpenCode-CLI配置.md) - 免费 AI CLI 工具，支持 GLM-4.7/MiniMax M2.1 等模型 +0. [00-Vibe Coding 哲学原理](./assets/documents/guides/getting-started/00-Vibe%20Coding%20哲学原理.md) - 理解核心理念 +1. [01-网络环境配置](./assets/documents/guides/getting-started/01-网络环境配置.md) - 配置网络访问 +2. [02-开发环境搭建](./assets/documents/guides/getting-started/02-开发环境搭建.md) - 复制提示词给 AI，让 AI 指导你搭建环境 +3. [03-IDE配置](./assets/documents/guides/getting-started/03-IDE配置.md) - 配置 VS Code 编辑器 +4. [04-OpenCode-CLI配置](./assets/documents/guides/getting-started/04-OpenCode-CLI配置.md) - 免费 AI CLI 工具，支持 GLM-4.7/MiniMax M2.1 等模型 @@ -136,7 +136,7 @@ > 一句话：用“生成器/优化器”的递归闭环，构建一个能持续自我优化的 AI 系统。 > -> 延伸阅读：[A Formalization of Recursive Self-Optimizing Generative Systems](./assets/documents/00-基础指南/A%20Formalization%20of%20Recursive%20Self-Optimizing%20Generative%20Systems.md) +> 延伸阅读：[A Formalization of Recursive Self-Optimizing Generative Systems](./assets/documents/principles/fundamentals/A%20Formalization%20of%20Recursive%20Self-Optimizing%20Generative%20Systems.md) ### 核心角色 - **α-提示词（生成器）**：一个“母体”提示词，其唯一职责是生成其他提示词或技能。 @@ -166,7 +166,7 @@ | 🧩 复杂性爆炸 | ✅ 每个模块都是久经考验的轮子 | | 🎓 门槛过高 | ✅ 你只需要描述"连接方式" | -👉 [深入了解胶水编程](./assets/documents/00-基础指南/胶水编程.md) +👉 [深入了解胶水编程](./assets/documents/principles/fundamentals/胶水编程.md) @@ -187,7 +187,7 @@ Canvas方式：**代码 ⇄ 白板 ⇄ AI ⇄ 人类**，白板成为单一真 **核心理念**：图形是第一公民，代码是白板的序列化形式。 -👉 [深入了解Canvas白板驱动开发](./assets/documents/02-方法论/图形化AI协作-Canvas白板驱动开发.md) +👉 [深入了解Canvas白板驱动开发](./assets/documents/guides/playbook/图形化AI协作-Canvas白板驱动开发.md) @@ -208,7 +208,7 @@ Canvas方式：**代码 ⇄ 白板 ⇄ AI ⇄ 人类**，白板成为单一真 **核心突破**：AI 不再是孤立的，而是可以互相感知、通讯、控制的集群。 -👉 [深入了解AI蜂群协作](./assets/documents/02-方法论/AI蜂群协作-tmux多Agent协作系统.md) +👉 [深入了解AI蜂群协作](./assets/documents/guides/playbook/AI蜂群协作-tmux多Agent协作系统.md) @@ -229,7 +229,7 @@ Canvas方式：**代码 ⇄ 白板 ⇄ AI ⇄ 人类**，白板成为单一真 **核心理念**：哲学不是空谈，是可落地的工程方法。 -👉 [深入了解哲学方法论工具箱](./assets/documents/05-哲学与方法论/README.md) +👉 [深入了解哲学方法论工具箱](./assets/documents/principles/philosophy/README.md) @@ -311,12 +311,12 @@ Canvas方式：**代码 ⇄ 白板 ⇄ AI ⇄ 人类**，白板成为单一真 * [**第三方系统提示词学习库**](https://github.com/x1xhlol/system-prompts-and-models-of-ai-tools): 用于学习和参考其他 AI 工具的系统提示词。 * [**Skills 制作器**](https://github.com/yusufkaraaslan/Skill_Seekers): 可根据需求生成定制化 Skills 的工具。 * [**元提示词**](https://docs.google.com/spreadsheets/d/1Ifk_dLF25ULSxcfGem1hXzJsi7_RBUNAki8SBCuvkJA/edit?gid=1254297203#gid=1254297203): 用于生成提示词的高级提示词。 -* [**通用项目架构模板**](./assets/documents/00-基础指南/通用项目架构模板.md): 可用于快速搭建标准化的项目目录结构。 +* [**通用项目架构模板**](./assets/documents/principles/fundamentals/通用项目架构模板.md): 可用于快速搭建标准化的项目目录结构。 * [**元技能：Skills 的 Skills**](./assets/skills/skills-skills/SKILL.md): 用于生成 Skills 的元技能。 * [**SOP 生成 Skill**](./assets/skills/sop-generator/SKILL.md): 将资料/需求整理为可执行 SOP 的技能。 -* [**tmux快捷键大全**](./assets/documents/02-方法论/tmux快捷键大全.md): tmux 的快捷键参考文档。 -* [**LazyVim快捷键大全**](./assets/documents/02-方法论/LazyVim快捷键大全.md): LazyVim 的快捷键参考文档。 -* [**手机远程 Vibe Coding**](./assets/documents/02-方法论/关于手机ssh任意位置链接本地计算机，基于frp实现的方法.md): 基于 frp 实现手机 SSH 远程控制本地电脑进行 Vibe Coding。 +* [**tmux快捷键大全**](./assets/documents/guides/playbook/tmux快捷键大全.md): tmux 的快捷键参考文档。 +* [**LazyVim快捷键大全**](./assets/documents/guides/playbook/LazyVim快捷键大全.md): LazyVim 的快捷键参考文档。 +* [**手机远程 Vibe Coding**](./assets/documents/guides/playbook/关于手机ssh任意位置链接本地计算机，基于frp实现的方法.md): 基于 frp 实现手机 SSH 远程控制本地电脑进行 Vibe Coding。 ### 外部教程与资源 @@ -330,14 +330,14 @@ Canvas方式：**代码 ⇄ 白板 ⇄ AI ⇄ 人类**，白板成为单一真 ### 项目内部文档 -* [**胶水编程 (Glue Coding)**](./assets/documents/00-基础指南/): 软件工程的圣杯与银弹，Vibe Coding 的终极进化形态。 +* [**胶水编程 (Glue Coding)**](./assets/documents/principles/fundamentals/): 软件工程的圣杯与银弹，Vibe Coding 的终极进化形态。 * [**Chat Vault**](./assets/repo/chat-vault/): AI 聊天记录保存工具，支持 Codex/Kiro/Gemini/Claude CLI。 * [**prompts-library 工具说明**](./assets/repo/prompts-library/): 支持 Excel 与 Markdown 格式互转，包含数百个精选提示词。 * [**编程提示词集合**](https://docs.google.com/spreadsheets/d/1Ifk_dLF25ULSxcfGem1hXzJsi7_RBUNAki8SBCuvkJA/edit?gid=1254297203#gid=1254297203): 适用于 Vibe Coding 流程的专用提示词（云端表格）。 -* [**系统提示词构建原则**](./assets/documents/00-基础指南/系统提示词构建原则.md): 构建高效 AI 系统提示词的综合指南。 -* [**开发经验总结**](./assets/documents/00-基础指南/开发经验.md): 变量命名、文件结构、编码规范、架构原则等。 -* [**通用项目架构模板**](./assets/documents/00-基础指南/通用项目架构模板.md): 多种项目类型的标准目录结构。 -* [**Augment MCP 配置文档**](./assets/documents/02-方法论/auggie-mcp配置文档.md): Augment 上下文引擎配置说明。 +* [**系统提示词构建原则**](./assets/documents/principles/fundamentals/系统提示词构建原则.md): 构建高效 AI 系统提示词的综合指南。 +* [**开发经验总结**](./assets/documents/principles/fundamentals/开发经验.md): 变量命名、文件结构、编码规范、架构原则等。 +* [**通用项目架构模板**](./assets/documents/principles/fundamentals/通用项目架构模板.md): 多种项目类型的标准目录结构。 +* [**Augment MCP 配置文档**](./assets/documents/guides/playbook/auggie-mcp配置文档.md): Augment 上下文引擎配置说明。 * [**系统提示词集合**](https://docs.google.com/spreadsheets/d/1Ifk_dLF25ULSxcfGem1hXzJsi7_RBUNAki8SBCuvkJA/edit?gid=1254297203#gid=1254297203): AI 开发的系统提示词，含多版本开发规范（云端表格）。 * [**外部资源（在线表格）**](./assets/README.md): 外部资源的唯一真相源（按类型分表），本地 Markdown 保留为历史参考。 @@ -383,11 +383,13 @@ Canvas方式：**代码 ⇄ 白板 ⇄ AI ⇄ 人类**，白板成为单一真 │ │ ├── config.toml # Codex CLI 配置文件 │ │ └── AGENTS.md # Codex/Agent 指南（本目录） │ ├── documents/ # 文档库 -│ │ ├── 05-哲学与方法论/ # 最高思想纲领与方法论 -│ │ ├── 00-基础指南/ # 核心原则与底层逻辑 -│ │ ├── 01-入门指南/ # 从零开始教程 -│ │ ├── 02-方法论/ # 具体工具与技巧 -│ │ └── 03-实战/ # 项目实战案例 +│ │ ├── principles/ # 原则与思想（fundamentals + philosophy） +│ │ │ ├── fundamentals/ # 原 00-基础指南 +│ │ │ └── philosophy/ # 原 05-哲学与方法论 +│ │ ├── guides/ # 入门与方法（getting-started + playbook） +│ │ │ ├── getting-started/ # 原 01-入门指南 +│ │ │ └── playbook/ # 原 02-方法论 +│ │ └── case-studies/ # 原 03-实战 │ ├── prompts/ # 提示词库（指向云端表格） │ │ ├── README.md # 在线表格链接 │ │ └── AGENTS.md # prompts/ 目录规则 @@ -454,7 +456,7 @@ assets/prompts/ assets/skills/ README.md # skills 总览与索引 assets/documents/ - 00-基础指南/代码组织.md, 00-基础指南/通用项目架构模板.md, 00-基础指南/开发经验.md, 00-基础指南/系统提示词构建原则.md 等知识库 + principles/fundamentals/*, principles/philosophy/*, guides/*, case-studies/* 等知识库 assets/ README.md # 外部资源（在线表格）唯一真相源入口 assets/repo/backups/ diff --git a/assets/documents/AGENTS.md b/assets/documents/AGENTS.md index e117aa1..c9eb73c 100644 --- a/assets/documents/AGENTS.md +++ b/assets/documents/AGENTS.md @@ -8,11 +8,13 @@ ``` assets/documents/ -├── 05-哲学与方法论/ # 最高思想纲领 -├── 00-基础指南/ # 核心原则与底层逻辑 -├── 01-入门指南/ # 从零开始教程 -├── 02-方法论/ # 具体工具与技巧 -└── 03-实战/ # 项目实战案例 +├── principles/ # 原则与思想（fundamentals + philosophy） +│ ├── fundamentals/ # 原 00-基础指南 +│ └── philosophy/ # 原 05-哲学与方法论 +├── guides/ # 入门与方法（getting-started + playbook） +│ ├── getting-started/ # 原 01-入门指南 +│ └── playbook/ # 原 02-方法论 +└── case-studies/ # 原 03-实战 ``` ## 操作规范 @@ -25,11 +27,10 @@ assets/documents/ ### 禁止 - 删除现有文档（除非明确要求） -- 修改目录编号前缀规则 - - 大规模重命名/移动文件导致链接失效（如必须调整，需同步更新引用） +- 大规模重命名/移动文件导致链接失效（如必须调整，需同步更新引用） ## 命名规范 - 文件名使用中文 - 使用 Markdown 格式 -- 编号前缀保持一致性 +- 目录名使用简短英文（便于跨平台与链接稳定） diff --git a/assets/documents/README.md b/assets/documents/README.md index 9c48c00..9186464 100644 --- a/assets/documents/README.md +++ b/assets/documents/README.md @@ -6,32 +6,32 @@ ``` assets/documents/ -├── 05-哲学与方法论/ # 最高思想纲领，底层逻辑 -├── 00-基础指南/ # 核心理念，胶水编程，方法论 -├── 01-入门指南/ # 从零开始，环境配置 -├── 02-方法论/ # 工具教程，开发经验 -└── 03-实战/ # 项目实战经验 +├── principles/ # 原则与思想（fundamentals + philosophy） +│ ├── fundamentals/ # 原 00-基础指南 +│ └── philosophy/ # 原 05-哲学与方法论 +├── guides/ # 入门与方法（getting-started + playbook） +│ ├── getting-started/ # 原 01-入门指南 +│ └── playbook/ # 原 02-方法论 +└── case-studies/ # 原 03-实战 ``` ## 🚀 快速导航 | 目录 | 说明 | 适合人群 | |:---|:---|:---| -| [05-哲学与方法论](./05-哲学与方法论/) | 思想纲领、认识论工具 | 架构师与深度开发者 | -| [00-基础指南](./00-基础指南/) | 胶水编程、核心理念 | 理解本质 | -| [01-入门指南](./01-入门指南/) | 环境配置、从零开始 | 新手入门 | -| [02-方法论](./02-方法论/) | 工具教程、开发经验 | 提升效率 | -| [03-实战](./03-实战/) | 项目经验、案例复盘 | 动手实践 | +| [principles](./principles/) | 原则与思想（基础 + 哲学） | 架构师与深度开发者 | +| [guides](./guides/) | 入门与方法（上手 + 工具与经验） | 新手入门与效率提升 | +| [case-studies](./case-studies/) | 项目经验、案例复盘 | 动手实践 | ## 📖 推荐学习路径 -1. **思维** → [05-哲学与方法论](./05-哲学与方法论/README.md) -2. **理念** → [胶水编程](./00-基础指南/胶水编程.md) -3. **入门** → [Vibe Coding 哲学原理](./01-入门指南/00-Vibe%20Coding%20哲学原理.md) -3. **配置** → [开发环境搭建](./01-入门指南/02-开发环境搭建.md) -4. **工具** → [tmux 快捷键](./02-方法论/tmux快捷键大全.md) -5. **远程** → [VS Code Remote Tunnel（WSL）](./02-方法论/REMOTE_TUNNEL_GUIDE.md) -5. **实践** → [项目实战经验](./03-实战/) +1. **思维** → [philosophy](./principles/philosophy/README.md) +2. **理念** → [胶水编程](./principles/fundamentals/胶水编程.md) +3. **入门** → [Vibe Coding 哲学原理](./guides/getting-started/00-Vibe%20Coding%20哲学原理.md) +4. **配置** → [开发环境搭建](./guides/getting-started/02-开发环境搭建.md) +5. **工具** → [tmux 快捷键](./guides/playbook/tmux快捷键大全.md) +6. **远程** → [VS Code Remote Tunnel（WSL）](./guides/playbook/REMOTE_TUNNEL_GUIDE.md) +7. **实践** → [项目实战经验](./case-studies/) ## 🔗 相关资源 From a22015185390271b0abc886731cec008f518ddc0 Mon Sep 17 00:00:00 2001 From: tukuaiai Date: Sat, 28 Feb 2026 06:59:10 +0800 Subject: [PATCH 04/43] docs: documents - fix intra-links and indexes --- assets/documents/case-studies/README.md | 8 ++++---- assets/documents/case-studies/polymarket-dev/README.md | 4 ++-- assets/documents/guides/getting-started/README.md | 6 +++--- assets/documents/guides/playbook/README.md | 8 ++++---- .../guides/playbook/图形化AI协作-Canvas白板驱动开发.md | 6 +++--- assets/documents/principles/fundamentals/README.md | 6 +++--- assets/documents/principles/fundamentals/常见坑汇总.md | 4 ++-- assets/documents/principles/fundamentals/胶水编程.md | 4 ++-- assets/documents/principles/philosophy/AI蜂群协作.md | 4 ++-- 9 files changed, 25 insertions(+), 25 deletions(-) diff --git a/assets/documents/case-studies/README.md b/assets/documents/case-studies/README.md index c161bc0..48d1159 100644 --- a/assets/documents/case-studies/README.md +++ b/assets/documents/case-studies/README.md @@ -6,12 +6,12 @@ | 项目 | 说明 | |:---|:---| +| [fate-engine-dev](./fate-engine-dev/) | Fate Engine 开发记录 | | [polymarket-dev](./polymarket-dev/) | Polymarket 数据分析 | | [telegram-dev](./telegram-dev/) | Telegram Bot 开发 | -| [web-app](./web-app/) | Web 应用开发 | ## 🔗 相关资源 -- [基础指南](../00-基础指南/) - 核心理念与方法论 -- [入门指南](../01-入门指南/) - 环境配置 -- [方法论](../02-方法论/) - 工具与经验 +- [基础指南](../principles/fundamentals/) - 核心理念与方法论 +- [入门指南](../guides/getting-started/) - 环境配置 +- [方法论](../guides/playbook/) - 工具与经验 - [外部资源（在线表格）](../../README.md) - 外部资源唯一真相源入口 diff --git a/assets/documents/case-studies/polymarket-dev/README.md b/assets/documents/case-studies/polymarket-dev/README.md index 5575c0a..a165baf 100644 --- a/assets/documents/case-studies/polymarket-dev/README.md +++ b/assets/documents/case-studies/polymarket-dev/README.md @@ -11,8 +11,8 @@ Polymarket 预测市场数据的采集、分析和可视化，包含 K 线图 AS | 文件 | 说明 | |:---|:---| | [ascii可视化-prompt.md](./ascii可视化-prompt.md) | ASCII 字符绘制 K 线图的提示词 | -| [prompt-system-bazi-kline.md](./prompt-system-bazi-kline.md) | 系统提示词：K 线分析 | -| [prompt-user-bazi-kline.md](./prompt-user-bazi-kline.md) | 用户提示词：K 线分析 | +| [prompt-system-bazi-kline.md](../fate-engine-dev/prompt-system-bazi-kline.md) | 系统提示词：K 线分析 | +| [prompt-user-bazi-kline.md](../fate-engine-dev/prompt-user-bazi-kline.md) | 用户提示词：K 线分析 | | [胶水开发要求-prompt.md](./胶水开发要求-prompt.md) | 胶水代码开发规范提示词 | | [完整性检查-prompt.md](./完整性检查-prompt.md) | 代码完整性检查提示词 | | [复查-prompt.md](./复查-prompt.md) | 代码复查提示词 | diff --git a/assets/documents/guides/getting-started/README.md b/assets/documents/guides/getting-started/README.md index 12643fd..4cc9a16 100644 --- a/assets/documents/guides/getting-started/README.md +++ b/assets/documents/guides/getting-started/README.md @@ -10,6 +10,6 @@ 4. [IDE 配置](./03-IDE配置.md) - 配置编辑器 ## 🔗 相关资源 -- [基础指南](../00-基础指南/) - 核心理念与方法论 -- [方法论](../02-方法论/) - 工具与经验 -- [实战](../03-实战/) - 动手实践项目 +- [基础指南](../../principles/fundamentals/) - 核心理念与方法论 +- [方法论](../playbook/) - 工具与经验 +- [实战](../../case-studies/) - 动手实践项目 diff --git a/assets/documents/guides/playbook/README.md b/assets/documents/guides/playbook/README.md index 611cfa6..a3edf72 100644 --- a/assets/documents/guides/playbook/README.md +++ b/assets/documents/guides/playbook/README.md @@ -19,10 +19,10 @@ ## 🛠️ 开发经验 -- [开发经验](./开发经验.md) - 变量命名、文件结构、编码规范 +- [开发经验](../../principles/fundamentals/开发经验.md) - 变量命名、文件结构、编码规范 - [Vibe Coding 经验收集](./vibe-coding-经验收集.md) - 社区经验汇总 ## 🔗 相关资源 -- [基础指南](../00-基础指南/) - 核心理念与方法论 -- [入门指南](../01-入门指南/) - 从零开始 -- [实战](../03-实战/) - 动手实践 +- [基础指南](../../principles/fundamentals/) - 核心理念与方法论 +- [入门指南](../getting-started/) - 从零开始 +- [实战](../../case-studies/) - 动手实践 diff --git a/assets/documents/guides/playbook/图形化AI协作-Canvas白板驱动开发.md b/assets/documents/guides/playbook/图形化AI协作-Canvas白板驱动开发.md index 2ebc6df..dfe31e8 100644 --- a/assets/documents/guides/playbook/图形化AI协作-Canvas白板驱动开发.md +++ b/assets/documents/guides/playbook/图形化AI协作-Canvas白板驱动开发.md @@ -188,7 +188,7 @@ Canvas方式： ### 🔗 相关资源 - [Canvas白板生成提示词](https://docs.google.com/spreadsheets/d/1Ifk_dLF25ULSxcfGem1hXzJsi7_RBUNAki8SBCuvkJA/edit?gid=1777853069#gid=1777853069&range=A1) - 自动生成架构白板的完整提示词 -- [白板驱动开发系统提示词（在线提示词库入口）](../../prompts/README.md) - 系统提示词已迁移到云端表格 +- [白板驱动开发系统提示词（在线提示词库入口）](../../../prompts/README.md) - 系统提示词已迁移到云端表格 - [Obsidian Canvas 官方文档](https://obsidian.md/canvas) -- [胶水编程](../00-基础指南/胶水编程.md) - 能抄不写，能连不造 -- [通用项目架构模板](../00-基础指南/通用项目架构模板.md) - 标准化目录结构 +- [胶水编程](../../principles/fundamentals/胶水编程.md) - 能抄不写，能连不造 +- [通用项目架构模板](../../principles/fundamentals/通用项目架构模板.md) - 标准化目录结构 diff --git a/assets/documents/principles/fundamentals/README.md b/assets/documents/principles/fundamentals/README.md index 4703664..9eeecbf 100644 --- a/assets/documents/principles/fundamentals/README.md +++ b/assets/documents/principles/fundamentals/README.md @@ -26,6 +26,6 @@ - [开发经验](./开发经验.md) - 实战经验总结 ## 🔗 相关资源 -- [入门指南](../01-入门指南/) - 从零开始 -- [方法论](../02-方法论/) - 工具与经验 -- [实战](../03-实战/) - 动手实践 +- [入门指南](../../guides/getting-started/) - 从零开始 +- [方法论](../../guides/playbook/) - 工具与经验 +- [实战](../../case-studies/) - 动手实践 diff --git a/assets/documents/principles/fundamentals/常见坑汇总.md b/assets/documents/principles/fundamentals/常见坑汇总.md index 0a37258..556adfd 100644 --- a/assets/documents/principles/fundamentals/常见坑汇总.md +++ b/assets/documents/principles/fundamentals/常见坑汇总.md @@ -135,7 +135,7 @@ nvm use 18 | 问题 | 原因 | 解决方案 | |:---|:---|:---| -| GitHub 访问慢/超时 | 网络限制 | 配置代理，参考 [网络环境配置](../从零开始vibecoding/01-网络环境配置.md) | +| GitHub 访问慢/超时 | 网络限制 | 配置代理，参考 [网络环境配置](../../guides/getting-started/01-网络环境配置.md) | | API 调用失败 | 网络/Key 问题 | 检查代理、API Key 是否有效 | | 终端不走代理 | 代理配置不全 | 设置环境变量（见下方） | | SSL 证书错误 | 代理/时间问题 | 检查系统时间，或临时关闭 SSL 验证 | @@ -266,7 +266,7 @@ git config --global https.proxy http://127.0.0.1:7890 |:---|:---|:---| | 代码越写越乱 | 没有架构设计 | 先画架构图，再写代码 | | 改一处坏多处 | 耦合太紧 | 拆分模块，定义清晰接口 | -| 不知道代码放哪 | 目录结构混乱 | 参考 [通用项目架构模板](../模板与资源/通用项目架构模板.md) | +| 不知道代码放哪 | 目录结构混乱 | 参考 [通用项目架构模板](./通用项目架构模板.md) | | 重复代码太多 | 没有抽象 | 提取公共函数/组件 | | 状态管理混乱 | 全局状态滥用 | 用状态管理库，单向数据流 | | 配置散落各处 | 没有统一管理 | 集中到 config 文件或环境变量 | diff --git a/assets/documents/principles/fundamentals/胶水编程.md b/assets/documents/principles/fundamentals/胶水编程.md index b8e90dc..af72ab4 100644 --- a/assets/documents/principles/fundamentals/胶水编程.md +++ b/assets/documents/principles/fundamentals/胶水编程.md @@ -151,8 +151,8 @@ AI 不再需要"发明"任何东西。它只需要： ## 📚 延伸阅读 - [语言层要素](./语言层要素.md) - 看懂 100% 代码必须掌握的 12 层要素 -- [胶水开发提示词（在线提示词库入口）](../../prompts/README.md) -- [项目实战：polymarket-dev](../03-实战/polymarket-dev/) +- [胶水开发提示词（在线提示词库入口）](../../../prompts/README.md) +- [项目实战：polymarket-dev](../../case-studies/polymarket-dev/) --- diff --git a/assets/documents/principles/philosophy/AI蜂群协作.md b/assets/documents/principles/philosophy/AI蜂群协作.md index bdb4810..02ecdc4 100644 --- a/assets/documents/principles/philosophy/AI蜂群协作.md +++ b/assets/documents/principles/philosophy/AI蜂群协作.md @@ -22,8 +22,8 @@ AI 不再是孤立的，而是可以互相感知、通讯、控制的集群。 ## 详细文档 -👉 [深入了解AI蜂群协作](../02-方法论/AI蜂群协作-tmux多Agent协作系统.md) +👉 [深入了解AI蜂群协作](../../guides/playbook/AI蜂群协作-tmux多Agent协作系统.md) ## 相关资源 -- [tmux快捷键大全](../02-方法论/tmux快捷键大全.md) +- [tmux快捷键大全](../../guides/playbook/tmux快捷键大全.md) From 395cb8e20b716cea6fb50ed756d3460f117f8691 Mon Sep 17 00:00:00 2001 From: tukuaiai Date: Sat, 28 Feb 2026 06:59:19 +0800 Subject: [PATCH 05/43] docs: canvas-dev - update docs links --- assets/skills/canvas-dev/README.md | 2 +- assets/skills/canvas-dev/SKILL.md | 2 +- assets/skills/canvas-dev/references/index.md | 4 ++-- assets/skills/canvas-dev/references/workflow-guide.md | 2 +- assets/workflow/canvas-dev/README.md | 4 ++-- 5 files changed, 7 insertions(+), 7 deletions(-) diff --git a/assets/skills/canvas-dev/README.md b/assets/skills/canvas-dev/README.md index 474546e..32f5c12 100644 --- a/assets/skills/canvas-dev/README.md +++ b/assets/skills/canvas-dev/README.md @@ -34,6 +34,6 @@ canvas-dev/ ## 相关资源 -- [Canvas白板驱动开发详解](../../documents/02-方法论/图形化AI协作-Canvas白板驱动开发.md) +- [Canvas白板驱动开发详解](../../documents/guides/playbook/图形化AI协作-Canvas白板驱动开发.md) - [Canvas开发工作流](../../workflow/canvas-dev/) - [元技能: skills-skills](../skills-skills/SKILL.md) diff --git a/assets/skills/canvas-dev/SKILL.md b/assets/skills/canvas-dev/SKILL.md index 8bf5cf5..99856f0 100644 --- a/assets/skills/canvas-dev/SKILL.md +++ b/assets/skills/canvas-dev/SKILL.md @@ -208,7 +208,7 @@ Canvas：代码 ⇄ 白板 ⇄ AI ⇄ 人类（白板为单一真相源） - [AI架构总师完整提示词](../../workflow/canvas-dev/Obsidian%20Canvas%20AI驱动的项目架构洞察与生成引擎.md) - 最新最完整的提示词 - [Canvas驱动开发完整工作流](../../workflow/canvas-dev/workflow.md) - 15步完整流程 -- [Canvas白板驱动开发详解](../../documents/02-方法论/图形化AI协作-Canvas白板驱动开发.md) - 方法论详解 +- [Canvas白板驱动开发详解](../../documents/guides/playbook/图形化AI协作-Canvas白板驱动开发.md) - 方法论详解 - [白板驱动开发系统提示词（在线提示词库入口）](../../prompts/README.md) - 系统提示词已迁移到云端表格 - [Obsidian Canvas 官方文档](https://obsidian.md/canvas) - `references/index.md` - 本地参考文档导航 diff --git a/assets/skills/canvas-dev/references/index.md b/assets/skills/canvas-dev/references/index.md index 2454e26..16e709e 100644 --- a/assets/skills/canvas-dev/references/index.md +++ b/assets/skills/canvas-dev/references/index.md @@ -13,7 +13,7 @@ | 文档 | 路径 | 说明 | |:---|:---|:---| -| Canvas白板驱动开发详解 | `../../../documents/02-方法论/图形化AI协作-Canvas白板驱动开发.md` | 方法论详解 | +| Canvas白板驱动开发详解 | `../../../documents/guides/playbook/图形化AI协作-Canvas白板驱动开发.md` | 方法论详解 | | 白板驱动开发系统提示词（在线提示词库入口） | `../../../prompts/README.md` | 系统提示词已迁移到云端表格 | | Canvas JSON 规范 | [canvas-json-spec.md](./canvas-json-spec.md) | Obsidian Canvas JSON 格式 | @@ -63,4 +63,4 @@ - [Obsidian Canvas 官方文档](https://obsidian.md/canvas) - [Obsidian 下载](https://obsidian.md/download) -- [胶水编程](../../../documents/00-基础指南/胶水编程.md) - 能抄不写，能连不造 +- [胶水编程](../../../documents/principles/fundamentals/胶水编程.md) - 能抄不写，能连不造 diff --git a/assets/skills/canvas-dev/references/workflow-guide.md b/assets/skills/canvas-dev/references/workflow-guide.md index e61f175..13b64aa 100644 --- a/assets/skills/canvas-dev/references/workflow-guide.md +++ b/assets/skills/canvas-dev/references/workflow-guide.md @@ -157,7 +157,7 @@ jobs: ## 相关资源 -- [Canvas白板驱动开发详解](../../../documents/02-方法论/图形化AI协作-Canvas白板驱动开发.md) +- [Canvas白板驱动开发详解](../../../documents/guides/playbook/图形化AI协作-Canvas白板驱动开发.md) - [架构分析提示词](../../../workflow/canvas-dev/prompts/01-架构分析.md) - [白板驱动编码提示词](../../../workflow/canvas-dev/prompts/02-白板驱动编码.md) - [白板同步检查提示词](../../../workflow/canvas-dev/prompts/03-白板同步检查.md) diff --git a/assets/workflow/canvas-dev/README.md b/assets/workflow/canvas-dev/README.md index 8f0d70a..e6790cb 100644 --- a/assets/workflow/canvas-dev/README.md +++ b/assets/workflow/canvas-dev/README.md @@ -51,6 +51,6 @@ canvas-dev/ ## 相关文档 -- [Canvas白板驱动开发详解](../../documents/02-方法论/图形化AI协作-Canvas白板驱动开发.md) +- [Canvas白板驱动开发详解](../../documents/guides/playbook/图形化AI协作-Canvas白板驱动开发.md) - [白板驱动开发系统提示词（在线提示词库入口）](../../prompts/README.md) -- [胶水编程](../../documents/00-基础指南/胶水编程.md) +- [胶水编程](../../documents/principles/fundamentals/胶水编程.md) From 9ea0b6e928f06b29f37a34d5a15bfc408b51e35e Mon Sep 17 00:00:00 2001 From: tukuaiai Date: Sat, 28 Feb 2026 07:03:03 +0800 Subject: [PATCH 06/43] refactor: getting-started - drop numeric filename prefixes --- .../guides/getting-started/{03-IDE配置.md => IDE配置.md} | 2 +- .../{04-OpenCode-CLI配置.md => OpenCode-CLI配置.md} | 0 assets/documents/guides/getting-started/README.md | 8 ++++---- ...00-Vibe Coding 哲学原理.md => Vibe Coding 哲学原理.md} | 2 +- .../{02-开发环境搭建.md => 开发环境搭建.md} | 4 ++-- .../{01-网络环境配置.md => 网络环境配置.md} | 2 +- 6 files changed, 9 insertions(+), 9 deletions(-) rename assets/documents/guides/getting-started/{03-IDE配置.md => IDE配置.md} (98%) rename assets/documents/guides/getting-started/{04-OpenCode-CLI配置.md => OpenCode-CLI配置.md} (100%) rename assets/documents/guides/getting-started/{00-Vibe Coding 哲学原理.md => Vibe Coding 哲学原理.md} (88%) rename assets/documents/guides/getting-started/{02-开发环境搭建.md => 开发环境搭建.md} (97%) rename assets/documents/guides/getting-started/{01-网络环境配置.md => 网络环境配置.md} (96%) diff --git a/assets/documents/guides/getting-started/03-IDE配置.md b/assets/documents/guides/getting-started/IDE配置.md similarity index 98% rename from assets/documents/guides/getting-started/03-IDE配置.md rename to assets/documents/guides/getting-started/IDE配置.md index 9039b50..fbed259 100644 --- a/assets/documents/guides/getting-started/03-IDE配置.md +++ b/assets/documents/guides/getting-started/IDE配置.md @@ -2,7 +2,7 @@ > 使用方法：复制下方对应你 IDE 的提示词，粘贴到任意 AI 对话框，AI 会一步步指导你完成配置。 -**前置条件**：请先完成 [02-开发环境搭建](./02-开发环境搭建.md) +**前置条件**：请先完成 [开发环境搭建](./开发环境搭建.md) --- diff --git a/assets/documents/guides/getting-started/04-OpenCode-CLI配置.md b/assets/documents/guides/getting-started/OpenCode-CLI配置.md similarity index 100% rename from assets/documents/guides/getting-started/04-OpenCode-CLI配置.md rename to assets/documents/guides/getting-started/OpenCode-CLI配置.md diff --git a/assets/documents/guides/getting-started/README.md b/assets/documents/guides/getting-started/README.md index 4cc9a16..9ef585a 100644 --- a/assets/documents/guides/getting-started/README.md +++ b/assets/documents/guides/getting-started/README.md @@ -4,10 +4,10 @@ ## 📚 学习路径 -1. [Vibe Coding 哲学原理](./00-Vibe%20Coding%20哲学原理.md) - 理解核心理念 -2. [网络环境配置](./01-网络环境配置.md) - 配置网络访问 -3. [开发环境搭建](./02-开发环境搭建.md) - 搭建开发环境 -4. [IDE 配置](./03-IDE配置.md) - 配置编辑器 +1. [Vibe Coding 哲学原理](./Vibe%20Coding%20哲学原理.md) - 理解核心理念 +2. [网络环境配置](./网络环境配置.md) - 配置网络访问 +3. [开发环境搭建](./开发环境搭建.md) - 搭建开发环境 +4. [IDE 配置](./IDE配置.md) - 配置编辑器 ## 🔗 相关资源 - [基础指南](../../principles/fundamentals/) - 核心理念与方法论 diff --git a/assets/documents/guides/getting-started/00-Vibe Coding 哲学原理.md b/assets/documents/guides/getting-started/Vibe Coding 哲学原理.md similarity index 88% rename from assets/documents/guides/getting-started/00-Vibe Coding 哲学原理.md rename to assets/documents/guides/getting-started/Vibe Coding 哲学原理.md index 55e2554..c90dd38 100644 --- a/assets/documents/guides/getting-started/00-Vibe Coding 哲学原理.md +++ b/assets/documents/guides/getting-started/Vibe Coding 哲学原理.md @@ -26,4 +26,4 @@ ## 下一步 -→ [04-OpenCode-CLI配置](./04-OpenCode-CLI配置.md) - 获得你的"一" +→ [OpenCode-CLI配置](./OpenCode-CLI配置.md) - 获得你的"一" diff --git a/assets/documents/guides/getting-started/02-开发环境搭建.md b/assets/documents/guides/getting-started/开发环境搭建.md similarity index 97% rename from assets/documents/guides/getting-started/02-开发环境搭建.md rename to assets/documents/guides/getting-started/开发环境搭建.md index e979a84..e0d5e6d 100644 --- a/assets/documents/guides/getting-started/02-开发环境搭建.md +++ b/assets/documents/guides/getting-started/开发环境搭建.md @@ -2,7 +2,7 @@ > 使用方法：复制下方对应你设备的提示词，粘贴到任意 AI 对话框（ChatGPT、Claude、Gemini 网页版等），AI 会一步步指导你完成配置。 -**前置条件**：请先完成 [01-网络环境配置](./01-网络环境配置.md) +**前置条件**：请先完成 [网络环境配置](./网络环境配置.md) --- @@ -155,4 +155,4 @@ alias g='gemini --yolo' 环境搭建完成后，继续下一步： -→ [03-IDE配置](./03-IDE配置.md) - 配置 VS Code 开发环境 +→ [IDE配置](./IDE配置.md) - 配置 VS Code 开发环境 diff --git a/assets/documents/guides/getting-started/01-网络环境配置.md b/assets/documents/guides/getting-started/网络环境配置.md similarity index 96% rename from assets/documents/guides/getting-started/01-网络环境配置.md rename to assets/documents/guides/getting-started/网络环境配置.md index 44d7f6b..66dfa2f 100644 --- a/assets/documents/guides/getting-started/01-网络环境配置.md +++ b/assets/documents/guides/getting-started/网络环境配置.md @@ -110,4 +110,4 @@ export http_proxy=http://127.0.0.1:7890 ## 下一步 -网络配置完成后，继续阅读 [02-开发环境搭建](./02-开发环境搭建.md)。 +网络配置完成后，继续阅读 [开发环境搭建](./开发环境搭建.md)。 From b8cadd281b54309b580ff01c50db0f6328c22924 Mon Sep 17 00:00:00 2001 From: tukuaiai Date: Sat, 28 Feb 2026 07:03:16 +0800 Subject: [PATCH 07/43] docs: update getting-started references --- README.md | 12 ++++++------ assets/documents/README.md | 4 ++-- .../documents/principles/fundamentals/常见坑汇总.md | 2 +- 3 files changed, 9 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index 6547936..8a910d1 100644 --- a/README.md +++ b/README.md @@ -32,7 +32,7 @@

哲学与方法论 - 核心哲学 + 核心哲学 胶水编程 Canvas白板驱动开发 从零开始 @@ -109,11 +109,11 @@ 完全新手？按顺序完成以下步骤： -0. [00-Vibe Coding 哲学原理](./assets/documents/guides/getting-started/00-Vibe%20Coding%20哲学原理.md) - 理解核心理念 -1. [01-网络环境配置](./assets/documents/guides/getting-started/01-网络环境配置.md) - 配置网络访问 -2. [02-开发环境搭建](./assets/documents/guides/getting-started/02-开发环境搭建.md) - 复制提示词给 AI，让 AI 指导你搭建环境 -3. [03-IDE配置](./assets/documents/guides/getting-started/03-IDE配置.md) - 配置 VS Code 编辑器 -4. [04-OpenCode-CLI配置](./assets/documents/guides/getting-started/04-OpenCode-CLI配置.md) - 免费 AI CLI 工具，支持 GLM-4.7/MiniMax M2.1 等模型 +0. [Vibe Coding 哲学原理](./assets/documents/guides/getting-started/Vibe%20Coding%20哲学原理.md) - 理解核心理念 +1. [网络环境配置](./assets/documents/guides/getting-started/网络环境配置.md) - 配置网络访问 +2. [开发环境搭建](./assets/documents/guides/getting-started/开发环境搭建.md) - 复制提示词给 AI，让 AI 指导你搭建环境 +3. [IDE配置](./assets/documents/guides/getting-started/IDE配置.md) - 配置 VS Code 编辑器 +4. [OpenCode-CLI配置](./assets/documents/guides/getting-started/OpenCode-CLI配置.md) - 免费 AI CLI 工具，支持 GLM-4.7/MiniMax M2.1 等模型 diff --git a/assets/documents/README.md b/assets/documents/README.md index 9186464..6c04624 100644 --- a/assets/documents/README.md +++ b/assets/documents/README.md @@ -27,8 +27,8 @@ assets/documents/ 1. **思维** → [philosophy](./principles/philosophy/README.md) 2. **理念** → [胶水编程](./principles/fundamentals/胶水编程.md) -3. **入门** → [Vibe Coding 哲学原理](./guides/getting-started/00-Vibe%20Coding%20哲学原理.md) -4. **配置** → [开发环境搭建](./guides/getting-started/02-开发环境搭建.md) +3. **入门** → [Vibe Coding 哲学原理](./guides/getting-started/Vibe%20Coding%20哲学原理.md) +4. **配置** → [开发环境搭建](./guides/getting-started/开发环境搭建.md) 5. **工具** → [tmux 快捷键](./guides/playbook/tmux快捷键大全.md) 6. **远程** → [VS Code Remote Tunnel（WSL）](./guides/playbook/REMOTE_TUNNEL_GUIDE.md) 7. **实践** → [项目实战经验](./case-studies/) diff --git a/assets/documents/principles/fundamentals/常见坑汇总.md b/assets/documents/principles/fundamentals/常见坑汇总.md index 556adfd..48f8b0e 100644 --- a/assets/documents/principles/fundamentals/常见坑汇总.md +++ b/assets/documents/principles/fundamentals/常见坑汇总.md @@ -135,7 +135,7 @@ nvm use 18 | 问题 | 原因 | 解决方案 | |:---|:---|:---| -| GitHub 访问慢/超时 | 网络限制 | 配置代理，参考 [网络环境配置](../../guides/getting-started/01-网络环境配置.md) | +| GitHub 访问慢/超时 | 网络限制 | 配置代理，参考 [网络环境配置](../../guides/getting-started/网络环境配置.md) | | API 调用失败 | 网络/Key 问题 | 检查代理、API Key 是否有效 | | 终端不走代理 | 代理配置不全 | 设置环境变量（见下方） | | SSL 证书错误 | 代理/时间问题 | 检查系统时间，或临时关闭 SSL 验证 | From fa220a182409b561e33cc9a4c694f4a29d5d349f Mon Sep 17 00:00:00 2001 From: tukuaiai Date: Sat, 28 Feb 2026 07:11:37 +0800 Subject: [PATCH 08/43] docs: prompts-library - fix dead links --- assets/repo/prompts-library/README.md | 6 +++--- assets/repo/prompts-library/docs/excel-data.md | 6 +++--- assets/repo/prompts-library/docs/开发文档.md | 6 +++--- 3 files changed, 9 insertions(+), 9 deletions(-) diff --git a/assets/repo/prompts-library/README.md b/assets/repo/prompts-library/README.md index 0a0bb3b..d6fc5d5 100644 --- a/assets/repo/prompts-library/README.md +++ b/assets/repo/prompts-library/README.md @@ -25,7 +25,7 @@

构建状态 最新版本 - 许可证 + 许可证 主要语言 代码大小

@@ -214,7 +214,7 @@ gantt 我们热烈欢迎各种形式的贡献！如果您对本项目有任何想法或建议，请随时开启一个 [Issue](https://github.com/tukuaiai/prompt-library/issues) 或提交一个 [Pull Request](https://github.com/tukuaiai/prompt-library/pulls)。 -在您开始之前，请花点时间阅读我们的 [**贡献指南 (CONTRIBUTING.md)**](CONTRIBUTING.md) 和 [**行为准则 (CODE_OF_CONDUCT.md)**](CODE_OF_CONDUCT.md)。 +在您开始之前，请花点时间阅读我们的 [**贡献指南 (CONTRIBUTING.md)**](https://github.com/tukuaiai/prompt-library/blob/main/CONTRIBUTING.md) 和 [**行为准则 (CODE_OF_CONDUCT.md)**](https://github.com/tukuaiai/prompt-library/blob/main/CODE_OF_CONDUCT.md)。 ### ✨ 贡献者们 @@ -241,7 +241,7 @@ gantt ## 📜 许可证 -本项目采用 [MIT](LICENSE) 许可证。 +本项目采用 [MIT](https://github.com/tukuaiai/prompt-library/blob/main/LICENSE) 许可证。 --- diff --git a/assets/repo/prompts-library/docs/excel-data.md b/assets/repo/prompts-library/docs/excel-data.md index 01bb20c..c8fbbb0 100644 --- a/assets/repo/prompts-library/docs/excel-data.md +++ b/assets/repo/prompts-library/docs/excel-data.md @@ -17008,17 +17008,17 @@ XX 局 - 具有知识性、可读性与教育性 - 在文章结束时, 思考该文章的最核心关键词, 插入一个如下形式的链接内容: -不要有反斜线，不要用代码块，使用 Unsplash api （source.unsplash.com) +不要有反斜线，不要用代码块，使用 Unsplash api（`https://source.unsplash.com/`） 例如: - 如果思考该段落的核心关键词为"hero", 那就插入如下内容: -[](source.unsplash.com%C3%97900?hero) +[](https://source.unsplash.com/900x900?hero) - 如果思考该段落的核心关键词为"fire", 那就插入如下内容: -[](source.unsplash.com%C3%97900?fire) +[](https://source.unsplash.com/900x900?fire) ## Initializatoin: diff --git a/assets/repo/prompts-library/docs/开发文档.md b/assets/repo/prompts-library/docs/开发文档.md index 81f1ce3..ab998c6 100644 --- a/assets/repo/prompts-library/docs/开发文档.md +++ b/assets/repo/prompts-library/docs/开发文档.md @@ -569,7 +569,7 @@ class PromptLibrarySyncer: # 生成版本链接 links = [] for col, filename in sorted(versions.items()): - links.append(f"[v{col}](./{filename})") + links.append(f"v{col}: ./{filename}") links_str = " / ".join(links) f.write(f"| {row_num} | {title} | {len(versions)} | {links_str} |\n") @@ -674,7 +674,7 @@ class PromptLibrarySyncer: f.write("- 列号: 表示版本号 (1=原始版本, 2+=迭代版本)\n\n") f.write("## 🔄 同步信息\n\n") - f.write(f"- 数据源: [Google Sheets]({self._get_sheet_url()})\n") + f.write(f"- 数据源: Google Sheets ({self._get_sheet_url()})\n") f.write("- 同步方式: GitHub Actions / 手动\n") f.write("- 同步频率: 每日 / 手动触发\n\n") @@ -1344,4 +1344,4 @@ pytest tests/ 2. **版本管理**: 实现a/b/c版本命名规范 3. **工具集成**: 考虑集成OpenAI优化API 4. **社区建设**: 利用社交媒体进行推广和用户反馈收集 -5. **支持机制**: 建立可持续的项目支持渠道 \ No newline at end of file +5. **支持机制**: 建立可持续的项目支持渠道 From 04216864a2d8329934d32110a9cb732c62069dc6 Mon Sep 17 00:00:00 2001 From: tukuaiai Date: Sat, 28 Feb 2026 07:18:30 +0800 Subject: [PATCH 09/43] docs: skills - fix broken reference links --- assets/skills/ccxt/Manual.md | 7 +++++++ assets/skills/ccxt/references/Manual.md | 7 +++++++ .../claude-cookbooks/references/capabilities.md | 12 ++++++------ .../skills/claude-cookbooks/references/patterns.md | 6 +++--- assets/skills/cryptofeed/references/README.md | 8 ++++---- .../twscrape/references/account_management.md | 14 ++++++++++++++ assets/skills/twscrape/references/api_methods.md | 8 ++++++++ assets/skills/twscrape/references/cli_usage.md | 8 ++++++++ assets/skills/twscrape/references/proxy_config.md | 8 ++++++++ 9 files changed, 65 insertions(+), 13 deletions(-) create mode 100644 assets/skills/ccxt/Manual.md create mode 100644 assets/skills/ccxt/references/Manual.md create mode 100644 assets/skills/twscrape/references/account_management.md create mode 100644 assets/skills/twscrape/references/api_methods.md create mode 100644 assets/skills/twscrape/references/cli_usage.md create mode 100644 assets/skills/twscrape/references/proxy_config.md diff --git a/assets/skills/ccxt/Manual.md b/assets/skills/ccxt/Manual.md new file mode 100644 index 0000000..5072c2c --- /dev/null +++ b/assets/skills/ccxt/Manual.md @@ -0,0 +1,7 @@ +# CCXT Manual（外链） + +本仓库未内置 CCXT 的完整 Manual 原文；请使用官方文档： + +- Docs（推荐）：https://docs.ccxt.com/ +- GitHub Wiki Manual：https://github.com/ccxt/ccxt/wiki/Manual + diff --git a/assets/skills/ccxt/references/Manual.md b/assets/skills/ccxt/references/Manual.md new file mode 100644 index 0000000..70fe8de --- /dev/null +++ b/assets/skills/ccxt/references/Manual.md @@ -0,0 +1,7 @@ +# CCXT Manual（外链） + +本仓库未在 `assets/skills/ccxt/references/` 内维护 CCXT Manual 的镜像文件；请使用官方文档： + +- Docs（推荐）：https://docs.ccxt.com/ +- GitHub Wiki Manual：https://github.com/ccxt/ccxt/wiki/Manual + diff --git a/assets/skills/claude-cookbooks/references/capabilities.md b/assets/skills/claude-cookbooks/references/capabilities.md index 27c585a..a48a7fc 100644 --- a/assets/skills/claude-cookbooks/references/capabilities.md +++ b/assets/skills/claude-cookbooks/references/capabilities.md @@ -4,16 +4,16 @@ Welcome to the Capabilities section of the Claude Cookbooks! This directory cont ## Guides -- **[Classification with Claude](./classification/guide.ipynb)**: Discover how Claude can revolutionize classification tasks, especially in scenarios with complex business rules and limited training data. This guide walks you through data preparation, prompt engineering with retrieval-augmented generation (RAG), testing, and evaluation. +- **[Classification with Claude](https://github.com/anthropics/claude-cookbooks/tree/main/capabilities/classification)**: Discover how Claude can revolutionize classification tasks, especially in scenarios with complex business rules and limited training data. This guide walks you through data preparation, prompt engineering with retrieval-augmented generation (RAG), testing, and evaluation. -- **[Retrieval Augmented Generation with Claude](./retrieval_augmented_generation/guide.ipynb)**: Learn how to enhance Claude's capabilities with domain-specific knowledge using RAG. This guide demonstrates how to build a RAG system from scratch, optimize its performance, and create an evaluation suite. You'll learn how techniques like summary indexing and re-ranking can significantly improve precision, recall, and overall accuracy in question-answering tasks. +- **[Retrieval Augmented Generation with Claude](https://github.com/anthropics/claude-cookbooks/tree/main/capabilities/retrieval_augmented_generation)**: Learn how to enhance Claude's capabilities with domain-specific knowledge using RAG. This guide demonstrates how to build a RAG system from scratch, optimize its performance, and create an evaluation suite. You'll learn how techniques like summary indexing and re-ranking can significantly improve precision, recall, and overall accuracy in question-answering tasks. -- **[Retrieval Augmented Generation with Contextual Embeddings](./contextual-embeddings/guide.ipynb)**: Learn how to use a new technique to improve the performance of your RAG system. In traditional RAG, documents are typically split into smaller chunks for efficient retrieval. While this approach works well for many applications, it can lead to problems when individual chunks lack sufficient context. Contextual Embeddings solve this problem by adding relevant context to each chunk before embedding. You'll learn how to use contextual embeddings with semantic search, BM25 search, and reranking to improve performance. +- **[Retrieval Augmented Generation with Contextual Embeddings](https://github.com/anthropics/claude-cookbooks/tree/main/capabilities/contextual-embeddings)**: Learn how to use a new technique to improve the performance of your RAG system. In traditional RAG, documents are typically split into smaller chunks for efficient retrieval. While this approach works well for many applications, it can lead to problems when individual chunks lack sufficient context. Contextual Embeddings solve this problem by adding relevant context to each chunk before embedding. You'll learn how to use contextual embeddings with semantic search, BM25 search, and reranking to improve performance. -- **[Summarization with Claude](./summarization/guide.ipynb)**: Explore Claude's ability to summarize and synthesize information from multiple sources. This guide covers a variety of summarization techniques, including multi-shot, domain-based, and chunking methods, as well as strategies for handling long-form content and multiple documents. We also explore evaluating summaries, which can be a balance of art, subjectivity, and the right approach! +- **[Summarization with Claude](https://github.com/anthropics/claude-cookbooks/tree/main/capabilities/summarization)**: Explore Claude's ability to summarize and synthesize information from multiple sources. This guide covers a variety of summarization techniques, including multi-shot, domain-based, and chunking methods, as well as strategies for handling long-form content and multiple documents. We also explore evaluating summaries, which can be a balance of art, subjectivity, and the right approach! -- **[Text-to-SQL with Claude](./text_to_sql/guide.ipynb)**: This guide covers how to generate complex SQL queries from natural language using prompting techniques, self-improvement, and RAG. We'll also explore how to evaluate and improve the accuracy of generated SQL queries, with evals that test for syntax, data correctness, row count, and more. +- **[Text-to-SQL with Claude](https://github.com/anthropics/claude-cookbooks/tree/main/capabilities/text_to_sql)**: This guide covers how to generate complex SQL queries from natural language using prompting techniques, self-improvement, and RAG. We'll also explore how to evaluate and improve the accuracy of generated SQL queries, with evals that test for syntax, data correctness, row count, and more. ## Getting Started -To get started with these guides, simply navigate to the desired guide's directory and follow the instructions provided in the `guide.ipynb` file. Each guide is self-contained and includes all the necessary code, data, and evaluation scripts to reproduce the examples and experiments. \ No newline at end of file +To get started with these guides, simply navigate to the desired guide's directory and follow the instructions provided in the `guide.ipynb` file. Each guide is self-contained and includes all the necessary code, data, and evaluation scripts to reproduce the examples and experiments. diff --git a/assets/skills/claude-cookbooks/references/patterns.md b/assets/skills/claude-cookbooks/references/patterns.md index 550f2a7..0940359 100644 --- a/assets/skills/claude-cookbooks/references/patterns.md +++ b/assets/skills/claude-cookbooks/references/patterns.md @@ -15,6 +15,6 @@ This repository contains example minimal implementations of common agent workflo ## Getting Started See the Jupyter notebooks for detailed examples: -- [Basic Workflows](basic_workflows.ipynb) -- [Evaluator-Optimizer Workflow](evaluator_optimizer.ipynb) -- [Orchestrator-Workers Workflow](orchestrator_workers.ipynb) \ No newline at end of file +- [Basic Workflows](https://github.com/anthropics/claude-cookbooks/blob/main/patterns/agents/basic_workflows.ipynb) +- [Evaluator-Optimizer Workflow](https://github.com/anthropics/claude-cookbooks/blob/main/patterns/agents/evaluator_optimizer.ipynb) +- [Orchestrator-Workers Workflow](https://github.com/anthropics/claude-cookbooks/blob/main/patterns/agents/orchestrator_workers.ipynb) diff --git a/assets/skills/cryptofeed/references/README.md b/assets/skills/cryptofeed/references/README.md index f501fb7..44eeb8c 100644 --- a/assets/skills/cryptofeed/references/README.md +++ b/assets/skills/cryptofeed/references/README.md @@ -1,5 +1,5 @@ # Cryptocurrency Exchange Feed Handler -[![License](https://img.shields.io/badge/license-XFree86-blue.svg)](LICENSE) +[![License](https://img.shields.io/badge/license-XFree86-blue.svg)](https://github.com/bmoscon/cryptofeed/blob/master/LICENSE) ![Python](https://img.shields.io/badge/Python-3.8+-green.svg) [![PyPi](https://img.shields.io/badge/PyPi-cryptofeed-brightgreen.svg)](https://pypi.python.org/pypi/cryptofeed) [![Codacy Badge](https://api.codacy.com/project/badge/Grade/efa4e0d6e10b41d0b51454d08f7b33b1)](https://www.codacy.com/app/bmoscon/cryptofeed?utm_source=github.com&utm_medium=referral&utm_content=bmoscon/cryptofeed&utm_campaign=Badge_Grade) @@ -82,7 +82,7 @@ For an example of a containerized application using cryptofeed to store data to ## National Best Bid/Offer (NBBO) -Cryptofeed also provides a synthetic [NBBO](examples/demo_nbbo.py) (National Best Bid/Offer) feed that aggregates the best bids and asks from the user specified feeds. +Cryptofeed also provides a synthetic [NBBO](https://github.com/bmoscon/cryptofeed/blob/master/examples/demo_nbbo.py) (National Best Bid/Offer) feed that aggregates the best bids and asks from the user specified feeds. ```python from cryptofeed import FeedHandler @@ -171,7 +171,7 @@ See more discussion of package installation in [INSTALL.md](https://github.com/b ## Rest API -Cryptofeed supports some REST interfaces for retrieving real-time and historical data, as well as order placement and account management. These are integrated into the exchange classes directly. You can view the supported methods by calling the `info()` method on any exchange. The methods for interacting with the exchange RET endpoints exist in two flavors, the synchronous methods (suffixed with `_sync`) as well as the asynchronous which can be utilized with asyncio. For more information see the [documentation](docs/rest.md). +Cryptofeed supports some REST interfaces for retrieving real-time and historical data, as well as order placement and account management. These are integrated into the exchange classes directly. You can view the supported methods by calling the `info()` method on any exchange. The methods for interacting with the exchange RET endpoints exist in two flavors, the synchronous methods (suffixed with `_sync`) as well as the asynchronous which can be utilized with asyncio. For more information see the [documentation](https://github.com/bmoscon/cryptofeed/blob/master/docs/rest.md). ## Future Work @@ -182,7 +182,7 @@ There are a lot of planned features, new exchanges, etc planned! If you'd like t Issues and PRs are welcomed! -Cryptofeed wouldn't be possible without the help of many [contributors](AUTHORS.md)! I owe them and all other contributors my thanks! +Cryptofeed wouldn't be possible without the help of many [contributors](https://github.com/bmoscon/cryptofeed/blob/master/AUTHORS.md)! I owe them and all other contributors my thanks! ## Donations / Support diff --git a/assets/skills/twscrape/references/account_management.md b/assets/skills/twscrape/references/account_management.md new file mode 100644 index 0000000..de2c9ae --- /dev/null +++ b/assets/skills/twscrape/references/account_management.md @@ -0,0 +1,14 @@ +# twscrape：账号管理（参考） + +本文件为 `twscrape` 的账号管理参考页。 + +## 推荐阅读顺序 + +1. `assets/skills/twscrape/references/installation.md` +2. `assets/skills/twscrape/SKILL.md`（包含账号池、登录、轮换等完整示例） +3. `assets/skills/twscrape/references/examples.md` + +## 入口 + +- 账号添加/登录的核心示例：`assets/skills/twscrape/SKILL.md` + diff --git a/assets/skills/twscrape/references/api_methods.md b/assets/skills/twscrape/references/api_methods.md new file mode 100644 index 0000000..56e0054 --- /dev/null +++ b/assets/skills/twscrape/references/api_methods.md @@ -0,0 +1,8 @@ +# twscrape：API 方法（参考） + +本文件为 `twscrape` 的 API 方法参考页（仓库内精简版）。 + +## 入口 + +- 完整方法速查与示例：`assets/skills/twscrape/SKILL.md` + diff --git a/assets/skills/twscrape/references/cli_usage.md b/assets/skills/twscrape/references/cli_usage.md new file mode 100644 index 0000000..bb118f8 --- /dev/null +++ b/assets/skills/twscrape/references/cli_usage.md @@ -0,0 +1,8 @@ +# twscrape：CLI 用法（参考） + +本文件为 `twscrape` 的命令行使用参考页。 + +## 入口 + +- CLI 相关命令示例：`assets/skills/twscrape/SKILL.md` + diff --git a/assets/skills/twscrape/references/proxy_config.md b/assets/skills/twscrape/references/proxy_config.md new file mode 100644 index 0000000..a67cbec --- /dev/null +++ b/assets/skills/twscrape/references/proxy_config.md @@ -0,0 +1,8 @@ +# twscrape：代理配置（参考） + +本文件为 `twscrape` 的代理配置参考页。 + +## 入口 + +- 代理参数示例：`assets/skills/twscrape/SKILL.md` + From cce49579d75e61a5f9d66d4b79ad397b4e6d90aa Mon Sep 17 00:00:00 2001 From: tukuaiai Date: Sat, 28 Feb 2026 07:22:10 +0800 Subject: [PATCH 10/43] docs: coingecko - fix doc-root links --- .../coingecko/references/authentication.md | 16 +- assets/skills/coingecko/references/coins.md | 254 +++--- .../skills/coingecko/references/contract.md | 4 +- .../skills/coingecko/references/exchanges.md | 10 +- .../coingecko/references/introduction.md | 120 +-- .../skills/coingecko/references/llms-full.md | 846 +++++++++--------- .../coingecko/references/market_data.md | 2 +- assets/skills/coingecko/references/other.md | 288 +++--- 8 files changed, 770 insertions(+), 770 deletions(-) diff --git a/assets/skills/coingecko/references/authentication.md b/assets/skills/coingecko/references/authentication.md index 50406fd..85ca772 100644 --- a/assets/skills/coingecko/references/authentication.md +++ b/assets/skills/coingecko/references/authentication.md @@ -21,7 +21,7 @@ Authentication method for CoinGecko Public API (Demo plan users) * Demo API Key is only available for CoinGecko Public Demo API Plan, the root URL for CoinGecko Public Demo API must be `https://api.coingecko.com/api/v3/`. * ⚠️ You are recommended to store the API key securely in your own backend and use a proxy to insert the key into the request URL. - * The authentication method below is for CoinGecko Public Demo API only. For **paid plan users with Pro-API key**, please refer to [this page](/reference/authentication) instead. + * The authentication method below is for CoinGecko Public Demo API only. For **paid plan users with Pro-API key**, please refer to [this page](https://docs.coingecko.com/reference/authentication) instead. * User Guide: [How to sign up for CoinGecko Demo API and generate an API key?](https://support.coingecko.com/hc/en-us/articles/21880397454233) * It's highly recommended to use the **Headers method** when making API requests for better security. Using query string parameters can risk exposing your API key. @@ -33,7 +33,7 @@ If this is your first time using the Demo API key, you can supply API Key to the 1. Header (Recommended): `x-cg-demo-api-key` 2. Query String Parameter: `x_cg_demo_api_key` -| Authentication Method | Example using [Ping](/v3.0.1/reference/ping-server) Endpoint | +| Authentication Method | Example using [Ping](https://docs.coingecko.com/v3.0.1/reference/ping-server) Endpoint | | ---------------------- | ------------------------------------------------------------------------------------------ | | Header (cURL) | `curl -X GET "https://api.coingecko.com/api/v3/ping" -H "x-cg-demo-api-key: YOUR_API_KEY"` | | Query String Parameter | `https://api.coingecko.com/api/v3/ping?x_cg_demo_api_key=YOUR_API_KEY` | @@ -42,7 +42,7 @@ If this is your first time using the Demo API key, you can supply API Key to the * Each request made to any endpoint counts as a single call (1 call = 1 credit). * Your monthly credit & rate limit are determined by the paid plan to which you subscribe. For more details, please refer to this [page](https://www.coingecko.com/en/api/pricing). -* To check the API usage, please go to the [developer dashboard](https://www.coingecko.com/en/developers/dashboard) or follow the guide [here](/v3.0.1/reference/setting-up-your-api-key#4-api-usage-report). +* To check the API usage, please go to the [developer dashboard](https://www.coingecko.com/en/developers/dashboard) or follow the guide [here](https://docs.coingecko.com/v3.0.1/reference/setting-up-your-api-key#4-api-usage-report). --- @@ -74,7 +74,7 @@ If this is your first time using the Pro API key, you can supply API Key to the 1. Header (Recommended): `x-cg-pro-api-key` 2. Query String Parameter: `x_cg_pro_api_key` -| Authentication Method | Example using [Ping](/reference/ping-server) Endpoint | +| Authentication Method | Example using [Ping](https://docs.coingecko.com/reference/ping-server) Endpoint | | ---------------------- | --------------------------------------------------------------------------------------------- | | Header (cURL) | `curl -X GET "https://pro-api.coingecko.com/api/v3/ping" -H "x-cg-pro-api-key: YOUR_API_KEY"` | | Query String Parameter | `https://pro-api.coingecko.com/api/v3/ping?x_cg_pro_api_key=YOUR_API_KEY` | @@ -90,7 +90,7 @@ You can now use the Pro-API key (exclusive to any paid plan subscriber) to call * When using the CG Pro API to access onchain DEX data, include the `/onchain` endpoint path in the request. -| Authentication Method | Example using [Simple Token Price](/reference/onchain-simple-price) Endpoint | +| Authentication Method | Example using [Simple Token Price](https://docs.coingecko.com/reference/onchain-simple-price) Endpoint | | ---------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | Header (cURL) | `curl -X GET "" -H "x-cg-pro-api-key: YOUR_API_KEY"` | | Query String Parameter | `https://pro-api.coingecko.com/api/v3/onchain/simple/networks/eth/token_price/0xc02aaa39b223fe8d0a0e5c4f27ead9083c756cc2?x_cg_pro_api_key=YOUR_API_KEY` | @@ -102,7 +102,7 @@ You can now use the Pro-API key (exclusive to any paid plan subscriber) to call * Unsuccessful Requests (Status 4xx, 5xx, etc) will not count towards credit deduction. * Regardless of the HTTP status code returned (including 4xx and 5xx errors), all API requests will count towards your **minute rate limit**. * Your monthly credit & rate limit are determined by the paid plan to which you subscribe. For more details, please refer to this [page](https://www.coingecko.com/en/api/pricing). -* To check the API usage, please go to the [developer dashboard](https://www.coingecko.com/en/developers/dashboard) or follow the guide [here](/reference/setting-up-your-api-key#4-api-usage-report) +* To check the API usage, please go to the [developer dashboard](https://www.coingecko.com/en/developers/dashboard) or follow the guide [here](https://docs.coingecko.com/reference/setting-up-your-api-key#4-api-usage-report) --- @@ -140,8 +140,8 @@ Source: https://docs.coingecko.com/docs/setting-up-your-api-key ## 2. Making API Request * **Root URLs:** - * Pro API: `https://pro-api.coingecko.com/api/v3/`, refer to [Pro API Authentication](/reference/authentication). - * Demo API: `https://api.coingecko.com/api/v3/`, refer to [Demo API Authentication](/v3.0.1/reference/authentication). + * Pro API: `https://pro-api.coingecko.com/api/v3/`, refer to [Pro API Authentication](https://docs.coingecko.com/reference/authentication). + * Demo API: `https://api.coingecko.com/api/v3/`, refer to [Demo API Authentication](https://docs.coingecko.com/v3.0.1/reference/authentication). * **Example using the `/ping` endpoint:** * Pro API: `https://pro-api.coingecko.com/api/v3/ping?x_cg_pro_api_key=YOUR_API_KEY` diff --git a/assets/skills/coingecko/references/coins.md b/assets/skills/coingecko/references/coins.md index e512fb1..bf01313 100644 --- a/assets/skills/coingecko/references/coins.md +++ b/assets/skills/coingecko/references/coins.md @@ -53,7 +53,7 @@ v3.0.1/reference/api-reference/coingecko-demo.json get /coins/markets This endpoint allows you to **query all the supported coins with price, market cap, volume and market related data** * You can retrieve specific coins using their unique `ids`, `names`, or `symbols` instead of returning the whole list. - * To filter results based on the coin's category, use the `category` param (refer to [`/coins/categories/list`](/v3.0.1/reference/coins-categories-list) for available categories). + * To filter results based on the coin's category, use the `category` param (refer to [`/coins/categories/list`](https://docs.coingecko.com/v3.0.1/reference/coins-categories-list) for available categories). * Use the `per_page` and `page` params to manage the number of results you receive and navigate through the data. @@ -79,7 +79,7 @@ This endpoint allows you to **get the historical chart data within certain time * You may obtain the asset platform and contract address via several ways: * refers to respective coin page and find 'contract address'. - * refers to [`/coins/list`](/v3.0.1/reference/coins-list) endpoint (`include platform = true`). + * refers to [`/coins/list`](https://docs.coingecko.com/v3.0.1/reference/coins-list) endpoint (`include platform = true`). * You may leave the interval params as empty for automatic granularity: @@ -107,8 +107,8 @@ Source: https://docs.coingecko.com/reference/categories-list reference/api-reference/onchain-pro.json get /categories This endpoint allows you to **query all the supported categories on GeckoTerminal** -* You can retrieve pools or tokens of a specific category with this endpoint: [Pools by Category ID](/reference/pools-category). - * GeckoTerminal categories are different from [CoinGecko categories](/reference/coins-categories-list). +* You can retrieve pools or tokens of a specific category with this endpoint: [Pools by Category ID](https://docs.coingecko.com/reference/pools-category). + * GeckoTerminal categories are different from [CoinGecko categories](https://docs.coingecko.com/reference/coins-categories-list). * This endpoint returns 50 categories per page. @@ -471,7 +471,7 @@ This endpoint allows you to **query the historical data (price, market cap, 24hr * You may obtain the coin ID (API ID) via several ways: * refers to respective coin page and find 'API ID'. - * refers to [`/coins/list`](/v3.0.1/reference/coins-list) endpoint. + * refers to [`/coins/list`](https://docs.coingecko.com/v3.0.1/reference/coins-list) endpoint. * refers to Google Sheets [here](https://docs.google.com/spreadsheets/d/1wTTuxXt8n9q7C4NDXqQpI3wpKu1_5bGVmP9Xz0XGSyU/edit?usp=sharing). @@ -493,7 +493,7 @@ This endpoint allows you to **get the historical chart data including time in UN * You may obtain the asset platform and contract address via several ways: * refers to respective coin page and find 'contract address'. - * refers to [`/coins/list`](/v3.0.1/reference/coins-list) endpoint (`include platform = true`). + * refers to [`/coins/list`](https://docs.coingecko.com/v3.0.1/reference/coins-list) endpoint (`include platform = true`). * You may leave the interval as empty for automatic granularity: @@ -536,7 +536,7 @@ v3.0.1/reference/api-reference/onchain-demo.json get /networks/{network}/tokens/ This endpoint allows you to **query specific token data based on the provided token contract address on a network** * You may add values such as `top_pools` in the include param to include top pools along with the pools information. - * If you would like to query token information such as socials, websites, description and etc. You can go to this endpoint [`/networks/{network}/tokens/{address}/info`](/v3.0.1/reference/token-info-contract-address) instead. + * If you would like to query token information such as socials, websites, description and etc. You can go to this endpoint [`/networks/{network}/tokens/{address}/info`](https://docs.coingecko.com/v3.0.1/reference/token-info-contract-address) instead. * If the token's market cap is not verified by the team, the API response will return `null` for its market cap value, even though it has a displayed value on GeckoTerminal, which might not be accurate as it often matches the Fully Diluted Valuation (FDV). @@ -572,12 +572,12 @@ Source: https://docs.coingecko.com/v3.0.1/reference/pool-token-info-contract-add v3.0.1/reference/api-reference/onchain-demo.json get /networks/{network}/pools/{pool_address}/info This endpoint allows you to **query pool metadata (base and quote token details, image, socials, websites, description, contract address, etc.) based on a provided pool contract address on a network** -* If you would like to query pool data such as price, transactions, volume and etc. You can go to this endpoint [`/networks/{network}/pools/{address}`](/v3.0.1/reference/pool-address) instead. +* If you would like to query pool data such as price, transactions, volume and etc. You can go to this endpoint [`/networks/{network}/pools/{address}`](https://docs.coingecko.com/v3.0.1/reference/pool-address) instead. * Cache/Update frequency: every 60 seconds. * Learn more about GT score [here](https://support.coingecko.com/hc/en-us/articles/38381394237593-What-is-GT-Score-How-is-GT-Score-calculated). * Metadata (image, websites, description, socials) may be sourced on-chain and is not vetted by the CoinGecko team. If you wish to get metadata reviewed by CoinGecko team, you may use the following endpoints: - * [Coin Data by ID](/v3.0.1/reference/coins-id) - * [Coin Data by Token Address](/v3.0.1/reference/coins-contract-address) + * [Coin Data by ID](https://docs.coingecko.com/v3.0.1/reference/coins-id) + * [Coin Data by Token Address](https://docs.coingecko.com/v3.0.1/reference/coins-contract-address) * `holders` data is currently in Beta, with ongoing improvements to data quality, coverage, and update frequency. @@ -634,7 +634,7 @@ This endpoint allows you to **get the historical chart data of a coin including * You may obtain the coin ID (API ID) via several ways: * refers to respective coin page and find 'API ID'. - * refers to [`/coins/list`](/v3.0.1/reference/coins-list) endpoint. + * refers to [`/coins/list`](https://docs.coingecko.com/v3.0.1/reference/coins-list) endpoint. * refers to google sheets [here](https://docs.google.com/spreadsheets/d/1wTTuxXt8n9q7C4NDXqQpI3wpKu1_5bGVmP9Xz0XGSyU/edit?usp=sharing). * You may use tools like [epoch converter ](https://www.epochconverter.com) to convert human readable date to UNIX timestamp. @@ -662,7 +662,7 @@ This endpoint allows you to **query the prices of one or more coins by using the * You may obtain the coin ID (API ID) via several ways: * refers to respective coin page and find 'API ID'. - * refers to [`/coins/list`](/v3.0.1/reference/coins-list) endpoint. + * refers to [`/coins/list`](https://docs.coingecko.com/v3.0.1/reference/coins-list) endpoint. * refers to Google Sheets [here](https://docs.google.com/spreadsheets/d/1wTTuxXt8n9q7C4NDXqQpI3wpKu1_5bGVmP9Xz0XGSyU/edit?usp=sharing). * You can retrieve specific coins using their unique `ids`, `names`, or `symbols`. * You may flag to include more data such as market cap, 24hr volume, 24hr change, last updated time etc. @@ -713,12 +713,12 @@ This endpoint allows you to **query all the metadata (image, websites, socials, ### Notice -* Please note that the `twitter_followers` data field will no longer be supported by our API starting on May 15, 2025. Please refer to [changelog](/changelog#upcoming-change-notice%3A-removal-of-twitter-followers-data) for more details. +* Please note that the `twitter_followers` data field will no longer be supported by our API starting on May 15, 2025. Please refer to [changelog](https://docs.coingecko.com/changelog#upcoming-change-notice%3A-removal-of-twitter-followers-data) for more details. * You may obtain the asset platform and contract address via several ways: * refers to respective coin page and find 'contract address'. - * refers to [`/coins/list`](/v3.0.1/reference/coins-list) endpoint (`include platform = true`). + * refers to [`/coins/list`](https://docs.coingecko.com/v3.0.1/reference/coins-list) endpoint (`include platform = true`). * Coin descriptions may include newline characters represented as `\r\n` (escape sequences), which may require processing for proper formatting. @@ -738,13 +738,13 @@ This endpoint allows you to **query all the metadata (image, websites, socials, * You may obtain the coin `id` (API ID) via several ways: * refers to respective coin page and find "API ID". - * refers to [`/coins/list`](/v3.0.1/reference/coins-list) endpoint. + * refers to [`/coins/list`](https://docs.coingecko.com/v3.0.1/reference/coins-list) endpoint. * refers to Google Sheets [here](https://docs.google.com/spreadsheets/d/1wTTuxXt8n9q7C4NDXqQpI3wpKu1_5bGVmP9Xz0XGSyU/edit?usp=sharing). * You may also flag to include more data such as tickers, market data, community data, developer data and sparkline. * You may refer to `last_updated` in the endpoint response to check whether the price is stale. -* Tickers are limited to 100 items, to get more tickers, please go to [/coins/{id}/tickers](/v3.0.1/reference/coins-id-tickers). +* Tickers are limited to 100 items, to get more tickers, please go to [/coins/{id}/tickers](https://docs.coingecko.com/v3.0.1/reference/coins-id-tickers). * Coin descriptions may include newline characters represented as `\r\n` (escape sequences), which may require processing for proper formatting. * When `dex_pair_format=symbol`, the DEX pair `base` and `target` are displayed in symbol format (e.g. `WETH`, `USDC`) instead of as contract addresses. * Cache/Update Frequency: @@ -769,7 +769,7 @@ Source: https://docs.coingecko.com/docs/1-get-data-by-id-or-address ## Methods to query price & market data of coins -Using [/simple/price](/reference/simple-price) endpoint as example: +Using [/simple/price](https://docs.coingecko.com/reference/simple-price) endpoint as example: * `https://pro-api.coingecko.com/api/v3/simple/price?ids=bitcoin&vs_currencies=usd&x_cg_pro_api_key=YOUR_API_KEY` @@ -777,7 +777,7 @@ Using [/simple/price](/reference/simple-price) endpoint as example: **How to obtain Coin ID aka API ID?** There are 3 options: -* Use [/coins/list](/reference/coins-list) endpoint, example of responses: +* Use [/coins/list](https://docs.coingecko.com/reference/coins-list) endpoint, example of responses: @@ -793,7 +793,7 @@ Using [/simple/price](/reference/simple-price) endpoint as example: ### b. Contract Address -Other than using Coin ID, you may also query price & market data of a coin using contract address, using [/simple/token\_price/\{id](/reference/simple-token-price)} endpoint as example: +Other than using Coin ID, you may also query price & market data of a coin using contract address, using [/simple/token\_price/\{id](https://docs.coingecko.com/reference/simple-token-price)} endpoint as example: * `https://pro-api.coingecko.com/api/v3/simple/token_price/ethereum?contract_addresses=0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48&vs_currencies=usd&x_cg_pro_api_key=YOUR_API_KEY` @@ -805,7 +805,7 @@ There are 3 parameters values required to apply for this endpoint: **How to obtain Coins/Tokens Contract Address** -* Use [/coins/list](/reference/coins-list) endpoint (`include_platform=true`), example of responses: +* Use [/coins/list](https://docs.coingecko.com/reference/coins-list) endpoint (`include_platform=true`), example of responses: @@ -840,11 +840,11 @@ CoinGecko API data supports all major fiat currencies and some famous crypto cur | Cryptocurrency | Ether | `eth` | | Cryptocurrency | Binance Coin | `bnb` | -For full list of supported currencies, please go to [/simple/supported\_vs\_currencies](/reference/simple-supported-currencies) endpoint +For full list of supported currencies, please go to [/simple/supported\_vs\_currencies](https://docs.coingecko.com/reference/simple-supported-currencies) endpoint ## Other way to obtain coin prices & market data -Using [/coins/market ](/reference/coins-markets) endpoint as example to query prices and market data of coins in bulk +Using [/coins/market ](https://docs.coingecko.com/reference/coins-markets) endpoint as example to query prices and market data of coins in bulk * `https://pro-api.coingecko.com/api/v3/coins/markets?vs_currency=usd&order=market_cap_desc&per_page=100&page=1&x_cg_pro_api_key=YOUR_API_KEY` @@ -871,7 +871,7 @@ Example 1 (unknown): ### b. Contract Address -Other than using Coin ID, you may also query price & market data of a coin using contract address, using [/simple/token\_price/\{id](/reference/simple-token-price)} endpoint as example: +Other than using Coin ID, you may also query price & market data of a coin using contract address, using [/simple/token\_price/\{id](https://docs.coingecko.com/reference/simple-token-price)} endpoint as example: * `https://pro-api.coingecko.com/api/v3/simple/token_price/ethereum?contract_addresses=0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48&vs_currencies=usd&x_cg_pro_api_key=YOUR_API_KEY` @@ -883,7 +883,7 @@ There are 3 parameters values required to apply for this endpoint: **How to obtain Coins/Tokens Contract Address** -* Use [/coins/list](/reference/coins-list) endpoint (`include_platform=true`), example of responses: +* Use [/coins/list](https://docs.coingecko.com/reference/coins-list) endpoint (`include_platform=true`), example of responses: ``` @@ -937,9 +937,9 @@ You can get Exchange and NFT data just like how you get the coins data: | Type | Coins | NFTs | Exchanges | Derivatives | | ---------------------- | -------------------------------------------------------------- | ------------------------------------------------------------ | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | -| Get Full List with IDs | [/coins/list](/reference/coins-list) | [/nfts/list](/reference/nfts-list) | [/exchanges/list](/reference/exchanges-list) | [/derivatives/exchanges/list](/reference/derivatives-exchanges-list) | -| Get latest market data | [/coins/\{id}](/reference/coins-id) | [/nfts/\{id}](/reference/nfts-id) | [/exchanges/\{id}](/reference/exchanges-id) | [/derivatives/exchanges/\{id}](/reference/derivatives-exchanges-id) | -| Get Historical Data | [/coins/\{id}/market\_chart](/reference/coins-id-market-chart) | [/nfts/\{id}/market\_chart](/reference/nfts-id-market-chart) | [/exchanges/\{id}/volume\_chart](/reference/exchanges-id-volume-chart) | [/exchanges/\{id}/volume\_chart](/reference/exchanges-id-volume-chart) | +| Get Full List with IDs | [/coins/list](https://docs.coingecko.com/reference/coins-list) | [/nfts/list](https://docs.coingecko.com/reference/nfts-list) | [/exchanges/list](https://docs.coingecko.com/reference/exchanges-list) | [/derivatives/exchanges/list](https://docs.coingecko.com/reference/derivatives-exchanges-list) | +| Get latest market data | [/coins/\{id}](https://docs.coingecko.com/reference/coins-id) | [/nfts/\{id}](https://docs.coingecko.com/reference/nfts-id) | [/exchanges/\{id}](https://docs.coingecko.com/reference/exchanges-id) | [/derivatives/exchanges/\{id}](https://docs.coingecko.com/reference/derivatives-exchanges-id) | +| Get Historical Data | [/coins/\{id}/market\_chart](https://docs.coingecko.com/reference/coins-id-market-chart) | [/nfts/\{id}/market\_chart](https://docs.coingecko.com/reference/nfts-id-market-chart) | [/exchanges/\{id}/volume\_chart](https://docs.coingecko.com/reference/exchanges-id-volume-chart) | [/exchanges/\{id}/volume\_chart](https://docs.coingecko.com/reference/exchanges-id-volume-chart) | --- @@ -954,7 +954,7 @@ This endpoint allows you to **query one or more token prices using their token c * You may obtain the asset platform and contract address via several ways: * refers to respective coin page and find 'contract address'. - * refers to [`/coins/list`](/v3.0.1/reference/coins-list) endpoint (`include platform = true`). + * refers to [`/coins/list`](https://docs.coingecko.com/v3.0.1/reference/coins-list) endpoint (`include platform = true`). * You may flag to include more data such as market cap, 24hr volume, 24hr change, last updated time etc. @@ -1004,9 +1004,9 @@ Source: https://docs.coingecko.com/reference/pools-category reference/api-reference/onchain-pro.json get /categories/{category_id}/pools This endpoint allows you to **query all the pools based on the provided category ID** -* You can retrieve full list of categories id via this endpoint: [Categories List](/reference/categories-list). +* You can retrieve full list of categories id via this endpoint: [Categories List](https://docs.coingecko.com/reference/categories-list). * You can retrieve tokens of a specific category, by flagging `include=base_token`. - * GeckoTerminal categories are different from [CoinGecko categories](/reference/coins-categories-list). + * GeckoTerminal categories are different from [CoinGecko categories](https://docs.coingecko.com/reference/coins-categories-list). * Trending rankings are determined by a combination of factors: @@ -1100,10 +1100,10 @@ We will gradually improve the Websocket and expand the feature limits. Please sh | Websocket Channel | Channel Code | Details | | ------------------------------------------------------------- | ------------ | ------------------------------------------------------------------------------------------------------------- | -| [OnchainSimpleTokenPrice](/websocket/onchainsimpletokenprice) | G1 | Subscribe to receive real-time price updates for tokens, as seen on GeckoTerminal.com | -| [CGSimplePrice](/websocket/cgsimpleprice) | C1 | Subscribe to receive real-time price updates for tokens, as seen on CoinGecko.com | -| [OnchainTrade](/websocket/wss-onchain-trade) | G2 | Subscribe to receive real-time transaction updates for pools, as seen on GeckoTerminal.com | -| [OnchainOHLCV](/websocket/wssonchainohlcv/) | G3 | Subscribe to receive real-time OHLCV (Open, High, Low, Close, Volume) for pools, as seen on GeckoTerminal.com | +| [OnchainSimpleTokenPrice](https://docs.coingecko.com/websocket/onchainsimpletokenprice) | G1 | Subscribe to receive real-time price updates for tokens, as seen on GeckoTerminal.com | +| [CGSimplePrice](https://docs.coingecko.com/websocket/cgsimpleprice) | C1 | Subscribe to receive real-time price updates for tokens, as seen on CoinGecko.com | +| [OnchainTrade](https://docs.coingecko.com/websocket/wss-onchain-trade) | G2 | Subscribe to receive real-time transaction updates for pools, as seen on GeckoTerminal.com | +| [OnchainOHLCV](https://docs.coingecko.com/websocket/wssonchainohlcv/) | G3 | Subscribe to receive real-time OHLCV (Open, High, Low, Close, Volume) for pools, as seen on GeckoTerminal.com | | (More coming soon!) | | | @@ -1168,7 +1168,7 @@ This Websocket channel allows you to subscribe to real-time updates of token tra **Update Frequency**: as fast as 0.1s, for actively traded pools. -**Tips**: use this Rest API endpoint [Top Pools by Token Address](/reference/top-pools-contract-address) to obtain contract address of the most liquid pool. +**Tips**: use this Rest API endpoint [Top Pools by Token Address](https://docs.coingecko.com/reference/top-pools-contract-address) to obtain contract address of the most liquid pool. | | Field | Type | Description | Example | | ---- | ------------------------- | ------- | -------------------------------------------------------------------------------------------------------------------------- | -------------------------- | @@ -1315,9 +1315,9 @@ This endpoint allows you to **get the OHLC chart (Open, High, Low, Close) of a c * You may obtain the coin ID (API ID) via several ways: * refers to respective coin page and find 'API ID'. - * refers to [`/coins/list`](/v3.0.1/reference/coins-list) endpoint. + * refers to [`/coins/list`](https://docs.coingecko.com/v3.0.1/reference/coins-list) endpoint. * refers to google sheets [here](https://docs.google.com/spreadsheets/d/1wTTuxXt8n9q7C4NDXqQpI3wpKu1_5bGVmP9Xz0XGSyU/edit?usp=sharing). - * For historical chart data with better granularity, you may consider using [/coins/\{id}/market\_chart](/v3.0.1/reference/coins-id-market-chart) endpoint. + * For historical chart data with better granularity, you may consider using [/coins/\{id}/market\_chart](https://docs.coingecko.com/v3.0.1/reference/coins-id-market-chart) endpoint. * The timestamp displayed in the payload (response) indicates the end (or close) time of the OHLC data. @@ -1519,40 +1519,40 @@ Discover the common use cases of CoinGecko API by our users ## 1. Get Coins Logo Images -* Use [/coins/id](/reference/coins-id) endpoint. +* Use [/coins/id](https://docs.coingecko.com/reference/coins-id) endpoint. * This endpoint can be used to query other coin's metadata like: links, categories, contract address, community, description in different languages and many more. * Coin descriptions may include newline characters represented as `\r\n` (escape sequences), which may require processing for proper formatting. -* Use [Token Info by Token Address](/reference/token-info-contract-address) endpoint to get metadata of tokens listed on GeckoTerminal.com. +* Use [Token Info by Token Address](https://docs.coingecko.com/reference/token-info-contract-address) endpoint to get metadata of tokens listed on GeckoTerminal.com. ## 2. Best Endpoint for Latest Crypto Price -* Use [/simple/price](/reference/simple-price) endpoint. +* Use [/simple/price](https://docs.coingecko.com/reference/simple-price) endpoint. * This endpoint can be used to query other market data like market cap, 24-hour trading volume and 24-hour price change percentage. ## 3. Get All Trading Pairs (Tickers) of a Coin -* Use [/coins/id/tickers](/reference/coins-id-tickers) endpoint. +* Use [/coins/id/tickers](https://docs.coingecko.com/reference/coins-id-tickers) endpoint. ## 4. Get Trading Pairs of Specific Coins from a Specific Exchange -* Use[ /coins/id/tickers](/reference/coins-id-tickers) endpoint by supplying specific exchange ID. +* Use[ /coins/id/tickers](https://docs.coingecko.com/reference/coins-id-tickers) endpoint by supplying specific exchange ID. ## 5. Building Telegram Bot for Latest Coin Listings -* Use [/coins/list/new](/reference/coins-list-new) endpoint. +* Use [/coins/list/new](https://docs.coingecko.com/reference/coins-list-new) endpoint. ## 6. Get List of Coins Under Specific Category -* For CoinGecko [categories](https://www.coingecko.com/en/categories), use [/coins/markets](/reference/coins-markets) endpoint by supplying specific category. -* For GeckoTerminal [categories](https://www.geckoterminal.com/category), use [Pools by Category ID](/reference/pools-category) endpoint by supplying specific category. +* For CoinGecko [categories](https://www.coingecko.com/en/categories), use [/coins/markets](https://docs.coingecko.com/reference/coins-markets) endpoint by supplying specific category. +* For GeckoTerminal [categories](https://www.geckoterminal.com/category), use [Pools by Category ID](https://docs.coingecko.com/reference/pools-category) endpoint by supplying specific category. ## 7. Identify DEX Decentralized Exchanges -* Use [/exchanges/list](/reference/exchanges-list) endpoint to get full list of exchanges with ID on CoinGecko. +* Use [/exchanges/list](https://docs.coingecko.com/reference/exchanges-list) endpoint to get full list of exchanges with ID on CoinGecko. -* Use [/exchanges/id](/reference/exchanges-id) to find out whether the exchange is centralized or decentralized. +* Use [/exchanges/id](https://docs.coingecko.com/reference/exchanges-id) to find out whether the exchange is centralized or decentralized. * Example of responses (using Uniswap V3 as example) : @@ -1564,7 +1564,7 @@ Since Uniswap is a DEX, therefore it shows `"centralized": false` ## 8. Get Bitcoin Dominance Data (BTC.D) -* Use [/global ](/reference/crypto-global)endpoint. +* Use [/global ](https://docs.coingecko.com/reference/crypto-global)endpoint. * Example of responses: @@ -1574,37 +1574,37 @@ Since Uniswap is a DEX, therefore it shows `"centralized": false` ## 9. Get Market Cap or Dominance of a Specific Ecosystem -* Use [/coins/categories](/reference/coins-categories). +* Use [/coins/categories](https://docs.coingecko.com/reference/coins-categories). * The endpoint also returns the 24-hour percentage change, offering insights into the traction of different categories or ecosystems. ## 10. Get Token Lists of a Specific Blockchain Network -* Use [/token\_lists/asset\_platforms\_id/all.json](/reference/token-lists) endpoint. +* Use [/token\_lists/asset\_platforms\_id/all.json](https://docs.coingecko.com/reference/token-lists) endpoint. * Supply asset platform id to the endpoint. ## 11. Get 7-Day Sparkline Price Data of a Coin -* Use [/coins/id](/reference/coins-id) or [/coins/markets](/reference/coins-markets) endpoints by flagging `sparkline = true`. +* Use [/coins/id](https://docs.coingecko.com/reference/coins-id) or [/coins/markets](https://docs.coingecko.com/reference/coins-markets) endpoints by flagging `sparkline = true`. ## 12. Get Link to Individual CoinGecko Coin Page -* Use [/coins/list](/reference/coins-list) endpoint to get the coin **`{ID}`**. +* Use [/coins/list](https://docs.coingecko.com/reference/coins-list) endpoint to get the coin **`{ID}`**. * Supply API ID in this URL path format: `www.coingecko.com/en/coins/{ID}` -* If you wish to the obtain the URL slug of a specific CoinGecko Coin Page, e.g. `www.coingecko.com/en/coins/{web_slug}` you may use [/coin/id](/reference/coins-id) endpoint and obtain the **`{web_slug}`** value. +* If you wish to the obtain the URL slug of a specific CoinGecko Coin Page, e.g. `www.coingecko.com/en/coins/{web_slug}` you may use [/coin/id](https://docs.coingecko.com/reference/coins-id) endpoint and obtain the **`{web_slug}`** value. ## 13. Check Coin Status and Stale Price Updates -* Active: use [/coins/list](/reference/coins-list) endpoint, only active coins will be shown by default. You may also flag **`status=inactive`** to get a list of inactive coins. -* Price Stale: use [/simple/price](/reference/simple-price) endpoint, flag `include_last_updated_at=true` to check latest update time. +* Active: use [/coins/list](https://docs.coingecko.com/reference/coins-list) endpoint, only active coins will be shown by default. You may also flag **`status=inactive`** to get a list of inactive coins. +* Price Stale: use [/simple/price](https://docs.coingecko.com/reference/simple-price) endpoint, flag `include_last_updated_at=true` to check latest update time. ## 14. Get Real-Time and Historical Exchange of BTC in USD -* Current exchange rate: use [/exchange\_rates](/reference/exchange-rates) endpoint. -* Historical exchange rate: use [/coins/id/history](/reference/coins-id-history) or [/coins/id/market\_chart](/reference/coins-id-market-chart) endpoints. +* Current exchange rate: use [/exchange\_rates](https://docs.coingecko.com/reference/exchange-rates) endpoint. +* Historical exchange rate: use [/coins/id/history](https://docs.coingecko.com/reference/coins-id-history) or [/coins/id/market\_chart](https://docs.coingecko.com/reference/coins-id-market-chart) endpoints. ## 15. Get Watchlist Portfolio Data of a Coin -* Use [/coins/id](/reference/coins-id) endpoint by supplying coin ID. +* Use [/coins/id](https://docs.coingecko.com/reference/coins-id) endpoint by supplying coin ID. * Example of responses: @@ -1616,21 +1616,21 @@ Since Uniswap is a DEX, therefore it shows `"centralized": false` **Note**: This is available for paid plan subscribers only. -* Use [/coins/list](/reference/coins-list) endpoint, specifying the status param as `inactive`. +* Use [/coins/list](https://docs.coingecko.com/reference/coins-list) endpoint, specifying the status param as `inactive`. * Example of endpoint request: `https://pro-api.coingecko.com/api/v3/coins/list?include_platform=false&status=inactive&x_cg_pro_api_key=YOUR_API_KEY` * Retrieve the coin's ID from the endpoint mentioned above and use it to access historical data via the following endpoints: -* [/coins/id/history](/reference/coins-id-history) - * [/coins/id/market\_chart](/reference/coins-id-market-chart) - * [/coins/id/market\_chart/range](/reference/coins-id-market-chart-range) - * [/coins/id/contract/contract\_address/market\_chart](/reference/contract-address-market-chart) - * [/coins/id/contract/contract\_address/market\_chart/range](/reference/contract-address-market-chart-range) +* [/coins/id/history](https://docs.coingecko.com/reference/coins-id-history) + * [/coins/id/market\_chart](https://docs.coingecko.com/reference/coins-id-market-chart) + * [/coins/id/market\_chart/range](https://docs.coingecko.com/reference/coins-id-market-chart-range) + * [/coins/id/contract/contract\_address/market\_chart](https://docs.coingecko.com/reference/contract-address-market-chart) + * [/coins/id/contract/contract\_address/market\_chart/range](https://docs.coingecko.com/reference/contract-address-market-chart-range) ## 17. Get TVL (Total Value Locked) data of a Coin -* Use [/coins/id](/reference/coins-id) endpoint by supplying coin ID. +* Use [/coins/id](https://docs.coingecko.com/reference/coins-id) endpoint by supplying coin ID. * Example of responses: @@ -1642,29 +1642,29 @@ Since Uniswap is a DEX, therefore it shows `"centralized": false` We have 2 Search endpoints: -* [/search](/reference/search-data) endpoint allows you to search for coins, categories, exchanges (markets), and NFTs listed on CoinGecko.com. You may query by name or symbol. -* [/search-pools](/reference/search-pools) endpoint allows you to search for pools listed on GeckoTerminal.com. You may query by pool contract address, token contract address, or token symbol. +* [/search](https://docs.coingecko.com/reference/search-data) endpoint allows you to search for coins, categories, exchanges (markets), and NFTs listed on CoinGecko.com. You may query by name or symbol. +* [/search-pools](https://docs.coingecko.com/reference/search-pools) endpoint allows you to search for pools listed on GeckoTerminal.com. You may query by pool contract address, token contract address, or token symbol. ## 19. Get List of Blockchain Networks supported on CoinGecko and GeckoTerminal. CoinGecko and GeckoTerminal support different sets of blockchain networks. You can use the following endpoints to find the list of supported networks and their respective IDs: -* CoinGecko: [/asset-platforms-list](/reference/asset-platforms-list) -* GeckoTerminal ([onchain endpoints](/reference/endpoint-overview#-onchain-dex-endpoints-geckoterminal)): [/networks-list](/reference/networks-list) +* CoinGecko: [/asset-platforms-list](https://docs.coingecko.com/reference/asset-platforms-list) +* GeckoTerminal ([onchain endpoints](https://docs.coingecko.com/reference/endpoint-overview#-onchain-dex-endpoints-geckoterminal)): [/networks-list](https://docs.coingecko.com/reference/networks-list) ## 20. Get Native Coin of a Blockchain Network (Asset Platform) -You may use the [/asset-platforms-list](/reference/asset-platforms-list) endpoint to obtain the native coin ID of all networks (asset platforms) listed on [www.coingecko.com](http://www.coingecko.com.). +You may use the [/asset-platforms-list](https://docs.coingecko.com/reference/asset-platforms-list) endpoint to obtain the native coin ID of all networks (asset platforms) listed on [www.coingecko.com](http://www.coingecko.com.). ## 21. Get Liquidity data of a Liquidity Pool or Token -There are multiple onchain endpoints that provide the liquidity data (`reserve_in_usd`) of a pool, for example: [Specific Pool Data by Pool Address](/reference/pool-address). You may also get liquidity data (`total_reserve_in_usd`) of a token, using endpoints like: [Token Data by Token Address](/reference/token-data-contract-address). +There are multiple onchain endpoints that provide the liquidity data (`reserve_in_usd`) of a pool, for example: [Specific Pool Data by Pool Address](https://docs.coingecko.com/reference/pool-address). You may also get liquidity data (`total_reserve_in_usd`) of a token, using endpoints like: [Token Data by Token Address](https://docs.coingecko.com/reference/token-data-contract-address). Note: `reserve_in_usd` (pool) represents the total liquidity of all tokens within a specific pool, whereas `total_reserve_in_usd` (token) refers to the total liquidity portion attributable to a specific token across all available pools. ## 22. Get list of onchain DEX pools based on specific criteria -* Use [/pools/megafilter](/reference/pools-megafilter) to retrieve data for onchain DEX pools that match a given set of filters. +* Use [/pools/megafilter](https://docs.coingecko.com/reference/pools-megafilter) to retrieve data for onchain DEX pools that match a given set of filters. * Example of use cases: @@ -1673,24 +1673,24 @@ Note: `reserve_in_usd` (pool) represents the total liquidity of all tokens withi * For more details on examples and available filters, refer to: -* [Changelog — New Megafilter Endpoint](/changelog#february-2025) +* [Changelog — New Megafilter Endpoint](https://docs.coingecko.com/changelog#february-2025) * [Live Filtering on GeckoTerminal](https://www.geckoterminal.com/) ## 23. Get List of Trending Coins * Use the following endpoints to get trending coins and pools: -* [Trending Search List](/reference/trending-search/) — Trending Coins, NFTs, Categories on CoinGecko.com, based on user searches. - * [Trending Search Pools](/reference/trending-search-pools/) — Trending Pools and Tokens on GeckoTerminal.com, based on user searches. +* [Trending Search List](https://docs.coingecko.com/reference/trending-search/) — Trending Coins, NFTs, Categories on CoinGecko.com, based on user searches. + * [Trending Search Pools](https://docs.coingecko.com/reference/trending-search-pools/) — Trending Pools and Tokens on GeckoTerminal.com, based on user searches. * Other useful endpoints: -* [Top Gainers & Losers](/reference/coins-top-gainers-losers) on CoinGecko.com, by specific time duration. - * [Trending Pools List](/reference/trending-pools-list) and [Trending Pools by Network](/reference/trending-pools-network) on GeckoTerminal.com, by specific time duration. +* [Top Gainers & Losers](https://docs.coingecko.com/reference/coins-top-gainers-losers) on CoinGecko.com, by specific time duration. + * [Trending Pools List](https://docs.coingecko.com/reference/trending-pools-list) and [Trending Pools by Network](https://docs.coingecko.com/reference/trending-pools-network) on GeckoTerminal.com, by specific time duration. ## 24. Get Security Info of Tokens -* By using [Token Info by Token Address](/reference/token-info-contract-address) endpoint, you can obtain the following security related data: +* By using [Token Info by Token Address](https://docs.coingecko.com/reference/token-info-contract-address) endpoint, you can obtain the following security related data: * GeckoTerminal Score (Pool, Transaction, Creation, Info, Holders) * Holders count and distribution percentage @@ -1698,7 +1698,7 @@ Note: `reserve_in_usd` (pool) represents the total liquidity of all tokens withi ## 25. Get Latest Token/Pool Data from Launchpad -* Use [megafilter](/reference/pools-megafilter) endpoint to retrieve latest launchpad data, by flagging `sort=pool_created_at_desc`. Learn more on [changelog](/changelog#now-supported%3A-launchpad-data-pump-fun-%26-more-%2C-granular-ohlcv%2C-and-honeypot-info). +* Use [megafilter](https://docs.coingecko.com/reference/pools-megafilter) endpoint to retrieve latest launchpad data, by flagging `sort=pool_created_at_desc`. Learn more on [changelog](https://docs.coingecko.com/changelog#now-supported%3A-launchpad-data-pump-fun-%26-more-%2C-granular-ohlcv%2C-and-honeypot-info). * **Request example (Get latest pools on Pump.fun)**: @@ -1724,7 +1724,7 @@ Example 1 (unknown): ## 8. Get Bitcoin Dominance Data (BTC.D) -* Use [/global ](/reference/crypto-global)endpoint. +* Use [/global ](https://docs.coingecko.com/reference/crypto-global)endpoint. * Example of responses: @@ -1737,37 +1737,37 @@ Example 2 (unknown): ## 9. Get Market Cap or Dominance of a Specific Ecosystem -* Use [/coins/categories](/reference/coins-categories). +* Use [/coins/categories](https://docs.coingecko.com/reference/coins-categories). * The endpoint also returns the 24-hour percentage change, offering insights into the traction of different categories or ecosystems. ## 10. Get Token Lists of a Specific Blockchain Network -* Use [/token\_lists/asset\_platforms\_id/all.json](/reference/token-lists) endpoint. +* Use [/token\_lists/asset\_platforms\_id/all.json](https://docs.coingecko.com/reference/token-lists) endpoint. * Supply asset platform id to the endpoint. ## 11. Get 7-Day Sparkline Price Data of a Coin -* Use [/coins/id](/reference/coins-id) or [/coins/markets](/reference/coins-markets) endpoints by flagging `sparkline = true`. +* Use [/coins/id](https://docs.coingecko.com/reference/coins-id) or [/coins/markets](https://docs.coingecko.com/reference/coins-markets) endpoints by flagging `sparkline = true`. ## 12. Get Link to Individual CoinGecko Coin Page -* Use [/coins/list](/reference/coins-list) endpoint to get the coin **`{ID}`**. +* Use [/coins/list](https://docs.coingecko.com/reference/coins-list) endpoint to get the coin **`{ID}`**. * Supply API ID in this URL path format: `www.coingecko.com/en/coins/{ID}` -* If you wish to the obtain the URL slug of a specific CoinGecko Coin Page, e.g. `www.coingecko.com/en/coins/{web_slug}` you may use [/coin/id](/reference/coins-id) endpoint and obtain the **`{web_slug}`** value. +* If you wish to the obtain the URL slug of a specific CoinGecko Coin Page, e.g. `www.coingecko.com/en/coins/{web_slug}` you may use [/coin/id](https://docs.coingecko.com/reference/coins-id) endpoint and obtain the **`{web_slug}`** value. ## 13. Check Coin Status and Stale Price Updates -* Active: use [/coins/list](/reference/coins-list) endpoint, only active coins will be shown by default. You may also flag **`status=inactive`** to get a list of inactive coins. -* Price Stale: use [/simple/price](/reference/simple-price) endpoint, flag `include_last_updated_at=true` to check latest update time. +* Active: use [/coins/list](https://docs.coingecko.com/reference/coins-list) endpoint, only active coins will be shown by default. You may also flag **`status=inactive`** to get a list of inactive coins. +* Price Stale: use [/simple/price](https://docs.coingecko.com/reference/simple-price) endpoint, flag `include_last_updated_at=true` to check latest update time. ## 14. Get Real-Time and Historical Exchange of BTC in USD -* Current exchange rate: use [/exchange\_rates](/reference/exchange-rates) endpoint. -* Historical exchange rate: use [/coins/id/history](/reference/coins-id-history) or [/coins/id/market\_chart](/reference/coins-id-market-chart) endpoints. +* Current exchange rate: use [/exchange\_rates](https://docs.coingecko.com/reference/exchange-rates) endpoint. +* Historical exchange rate: use [/coins/id/history](https://docs.coingecko.com/reference/coins-id-history) or [/coins/id/market\_chart](https://docs.coingecko.com/reference/coins-id-market-chart) endpoints. ## 15. Get Watchlist Portfolio Data of a Coin -* Use [/coins/id](/reference/coins-id) endpoint by supplying coin ID. +* Use [/coins/id](https://docs.coingecko.com/reference/coins-id) endpoint by supplying coin ID. * Example of responses: @@ -1782,21 +1782,21 @@ Example 3 (unknown): **Note**: This is available for paid plan subscribers only. -* Use [/coins/list](/reference/coins-list) endpoint, specifying the status param as `inactive`. +* Use [/coins/list](https://docs.coingecko.com/reference/coins-list) endpoint, specifying the status param as `inactive`. * Example of endpoint request: `https://pro-api.coingecko.com/api/v3/coins/list?include_platform=false&status=inactive&x_cg_pro_api_key=YOUR_API_KEY` * Retrieve the coin's ID from the endpoint mentioned above and use it to access historical data via the following endpoints: - * [/coins/id/history](/reference/coins-id-history) - * [/coins/id/market\_chart](/reference/coins-id-market-chart) - * [/coins/id/market\_chart/range](/reference/coins-id-market-chart-range) - * [/coins/id/contract/contract\_address/market\_chart](/reference/contract-address-market-chart) - * [/coins/id/contract/contract\_address/market\_chart/range](/reference/contract-address-market-chart-range) + * [/coins/id/history](https://docs.coingecko.com/reference/coins-id-history) + * [/coins/id/market\_chart](https://docs.coingecko.com/reference/coins-id-market-chart) + * [/coins/id/market\_chart/range](https://docs.coingecko.com/reference/coins-id-market-chart-range) + * [/coins/id/contract/contract\_address/market\_chart](https://docs.coingecko.com/reference/contract-address-market-chart) + * [/coins/id/contract/contract\_address/market\_chart/range](https://docs.coingecko.com/reference/contract-address-market-chart-range) ## 17. Get TVL (Total Value Locked) data of a Coin -* Use [/coins/id](/reference/coins-id) endpoint by supplying coin ID. +* Use [/coins/id](https://docs.coingecko.com/reference/coins-id) endpoint by supplying coin ID. * Example of responses: @@ -1811,29 +1811,29 @@ Example 4 (unknown): We have 2 Search endpoints: -* [/search](/reference/search-data) endpoint allows you to search for coins, categories, exchanges (markets), and NFTs listed on CoinGecko.com. You may query by name or symbol. -* [/search-pools](/reference/search-pools) endpoint allows you to search for pools listed on GeckoTerminal.com. You may query by pool contract address, token contract address, or token symbol. +* [/search](https://docs.coingecko.com/reference/search-data) endpoint allows you to search for coins, categories, exchanges (markets), and NFTs listed on CoinGecko.com. You may query by name or symbol. +* [/search-pools](https://docs.coingecko.com/reference/search-pools) endpoint allows you to search for pools listed on GeckoTerminal.com. You may query by pool contract address, token contract address, or token symbol. ## 19. Get List of Blockchain Networks supported on CoinGecko and GeckoTerminal. CoinGecko and GeckoTerminal support different sets of blockchain networks. You can use the following endpoints to find the list of supported networks and their respective IDs: -* CoinGecko: [/asset-platforms-list](/reference/asset-platforms-list) -* GeckoTerminal ([onchain endpoints](/reference/endpoint-overview#-onchain-dex-endpoints-geckoterminal)): [/networks-list](/reference/networks-list) +* CoinGecko: [/asset-platforms-list](https://docs.coingecko.com/reference/asset-platforms-list) +* GeckoTerminal ([onchain endpoints](https://docs.coingecko.com/reference/endpoint-overview#-onchain-dex-endpoints-geckoterminal)): [/networks-list](https://docs.coingecko.com/reference/networks-list) ## 20. Get Native Coin of a Blockchain Network (Asset Platform) -You may use the [/asset-platforms-list](/reference/asset-platforms-list) endpoint to obtain the native coin ID of all networks (asset platforms) listed on [www.coingecko.com](http://www.coingecko.com.). +You may use the [/asset-platforms-list](https://docs.coingecko.com/reference/asset-platforms-list) endpoint to obtain the native coin ID of all networks (asset platforms) listed on [www.coingecko.com](http://www.coingecko.com.). ## 21. Get Liquidity data of a Liquidity Pool or Token -There are multiple onchain endpoints that provide the liquidity data (`reserve_in_usd`) of a pool, for example: [Specific Pool Data by Pool Address](/reference/pool-address). You may also get liquidity data (`total_reserve_in_usd`) of a token, using endpoints like: [Token Data by Token Address](/reference/token-data-contract-address). +There are multiple onchain endpoints that provide the liquidity data (`reserve_in_usd`) of a pool, for example: [Specific Pool Data by Pool Address](https://docs.coingecko.com/reference/pool-address). You may also get liquidity data (`total_reserve_in_usd`) of a token, using endpoints like: [Token Data by Token Address](https://docs.coingecko.com/reference/token-data-contract-address). Note: `reserve_in_usd` (pool) represents the total liquidity of all tokens within a specific pool, whereas `total_reserve_in_usd` (token) refers to the total liquidity portion attributable to a specific token across all available pools. ## 22. Get list of onchain DEX pools based on specific criteria -* Use [/pools/megafilter](/reference/pools-megafilter) to retrieve data for onchain DEX pools that match a given set of filters. +* Use [/pools/megafilter](https://docs.coingecko.com/reference/pools-megafilter) to retrieve data for onchain DEX pools that match a given set of filters. * Example of use cases: @@ -1842,24 +1842,24 @@ Note: `reserve_in_usd` (pool) represents the total liquidity of all tokens withi * For more details on examples and available filters, refer to: - * [Changelog — New Megafilter Endpoint](/changelog#february-2025) + * [Changelog — New Megafilter Endpoint](https://docs.coingecko.com/changelog#february-2025) * [Live Filtering on GeckoTerminal](https://www.geckoterminal.com/) ## 23. Get List of Trending Coins * Use the following endpoints to get trending coins and pools: - * [Trending Search List](/reference/trending-search/) — Trending Coins, NFTs, Categories on CoinGecko.com, based on user searches. - * [Trending Search Pools](/reference/trending-search-pools/) — Trending Pools and Tokens on GeckoTerminal.com, based on user searches. + * [Trending Search List](https://docs.coingecko.com/reference/trending-search/) — Trending Coins, NFTs, Categories on CoinGecko.com, based on user searches. + * [Trending Search Pools](https://docs.coingecko.com/reference/trending-search-pools/) — Trending Pools and Tokens on GeckoTerminal.com, based on user searches. * Other useful endpoints: - * [Top Gainers & Losers](/reference/coins-top-gainers-losers) on CoinGecko.com, by specific time duration. - * [Trending Pools List](/reference/trending-pools-list) and [Trending Pools by Network](/reference/trending-pools-network) on GeckoTerminal.com, by specific time duration. + * [Top Gainers & Losers](https://docs.coingecko.com/reference/coins-top-gainers-losers) on CoinGecko.com, by specific time duration. + * [Trending Pools List](https://docs.coingecko.com/reference/trending-pools-list) and [Trending Pools by Network](https://docs.coingecko.com/reference/trending-pools-network) on GeckoTerminal.com, by specific time duration. ## 24. Get Security Info of Tokens -* By using [Token Info by Token Address](/reference/token-info-contract-address) endpoint, you can obtain the following security related data: +* By using [Token Info by Token Address](https://docs.coingecko.com/reference/token-info-contract-address) endpoint, you can obtain the following security related data: * GeckoTerminal Score (Pool, Transaction, Creation, Info, Holders) * Holders count and distribution percentage @@ -1867,7 +1867,7 @@ Note: `reserve_in_usd` (pool) represents the total liquidity of all tokens withi ## 25. Get Latest Token/Pool Data from Launchpad -* Use [megafilter](/reference/pools-megafilter) endpoint to retrieve latest launchpad data, by flagging `sort=pool_created_at_desc`. Learn more on [changelog](/changelog#now-supported%3A-launchpad-data-pump-fun-%26-more-%2C-granular-ohlcv%2C-and-honeypot-info). +* Use [megafilter](https://docs.coingecko.com/reference/pools-megafilter) endpoint to retrieve latest launchpad data, by flagging `sort=pool_created_at_desc`. Learn more on [changelog](https://docs.coingecko.com/changelog#now-supported%3A-launchpad-data-pump-fun-%26-more-%2C-granular-ohlcv%2C-and-honeypot-info). * **Request example (Get latest pools on Pump.fun)**: @@ -1910,7 +1910,7 @@ This endpoint allows you to **query the coin tickers on both centralized exchang * You may obtain the coin ID (API ID) via several ways: * refers to respective coin page and find 'API ID'. - * refers to [`/coins/list`](/v3.0.1/reference/coins-list) endpoint. + * refers to [`/coins/list`](https://docs.coingecko.com/v3.0.1/reference/coins-list) endpoint. * refers to google sheets [here](https://docs.google.com/spreadsheets/d/1wTTuxXt8n9q7C4NDXqQpI3wpKu1_5bGVmP9Xz0XGSyU/edit?usp=sharing). * You may specify the `exchange_ids` if you want to retrieve tickers for specific exchange only. * You may include values such as `page` to specify which page of responses you would like to show. @@ -1972,7 +1972,7 @@ This endpoint allows you to **get token price based on the provided token contra * The returned price currency is in USD. * Addresses not found in GeckoTerminal will be ignored. * This endpoint allows querying **up to 30 contract addresses** per request. - * When using this endpoint, GeckoTerminal's routing decides the best pool for token price. The price source may change based on liquidity and pool activity. For full control over the price, you may use [`/networks/{network}/pools/{address}`](/v3.0.1/reference/pool-address) endpoint by providing a specific pool address. + * When using this endpoint, GeckoTerminal's routing decides the best pool for token price. The price source may change based on liquidity and pool activity. For full control over the price, you may use [`/networks/{network}/pools/{address}`](https://docs.coingecko.com/v3.0.1/reference/pool-address) endpoint by providing a specific pool address. * Cache/Update Frequency: every 60 seconds. @@ -1988,7 +1988,7 @@ v3.0.1/reference/api-reference/onchain-demo.json get /networks/{network}/tokens/ This endpoint allows you to **query multiple tokens data based on the provided token contract addresses on a network** * You may add values such as `top_pools` in the include param to include top pools along with the pools information. - * If you would like to query token information such as socials, websites, description and etc. You can go to this endpoint [`/networks/{network}/tokens/{address}/info`](/v3.0.1/reference/token-info-contract-address) instead. + * If you would like to query token information such as socials, websites, description and etc. You can go to this endpoint [`/networks/{network}/tokens/{address}/info`](https://docs.coingecko.com/v3.0.1/reference/token-info-contract-address) instead. * Addresses not found in GeckoTerminal.com will be ignored. @@ -2098,9 +2098,9 @@ This endpoint allows you to **get the OHLC chart (Open, High, Low, Close) of a c * You may obtain the coin ID (API ID) via several ways: * refers to respective coin page and find 'API ID'. - * refers to [`/coins/list`](/reference/coins-list) endpoint. + * refers to [`/coins/list`](https://docs.coingecko.com/reference/coins-list) endpoint. * refers to google sheets [here](https://docs.google.com/spreadsheets/d/1wTTuxXt8n9q7C4NDXqQpI3wpKu1_5bGVmP9Xz0XGSyU/edit?usp=sharing). - * For historical chart data with better granularity, you may consider using [/coins/{`id`}/market\_chart](/reference/coins-id-market-chart) endpoint. + * For historical chart data with better granularity, you may consider using [/coins/{`id`}/market\_chart](https://docs.coingecko.com/reference/coins-id-market-chart) endpoint. * Supports ISO date strings (`YYYY-MM-DD` or\ `YYYY-MM-DDTHH:MM`, recommended for best compatibility) or UNIX timestamps. @@ -2129,12 +2129,12 @@ Source: https://docs.coingecko.com/v3.0.1/reference/token-info-contract-address v3.0.1/reference/api-reference/onchain-demo.json get /networks/{network}/tokens/{address}/info This endpoint allows you to **query token metadata (name, symbol, CoinGecko ID, image, socials, websites, description, etc.) based on a provided token contract address on a network** -* If you would like to query token data such as decimals, total supply, price and etc. You can go to this endpoint [`/networks/{network}/tokens/{address}`](/v3.0.1/reference/token-data-contract-address) instead. +* If you would like to query token data such as decimals, total supply, price and etc. You can go to this endpoint [`/networks/{network}/tokens/{address}`](https://docs.coingecko.com/v3.0.1/reference/token-data-contract-address) instead. * Cache/Update frequency: every 60 seconds. * Learn more about GT score [here](https://support.coingecko.com/hc/en-us/articles/38381394237593-What-is-GT-Score-How-is-GT-Score-calculated). * Metadata (image, websites, description, socials) may be sourced on-chain and is not vetted by the CoinGecko team. If you wish to get metadata reviewed by CoinGecko team, you may use the following endpoints: - * [Coin Data by ID](/v3.0.1/reference/coins-id) - * [Coin Data by Token Address](/v3.0.1/reference/coins-contract-address) + * [Coin Data by ID](https://docs.coingecko.com/v3.0.1/reference/coins-id) + * [Coin Data by Token Address](https://docs.coingecko.com/v3.0.1/reference/coins-contract-address) * `holders` data is currently in Beta, with ongoing improvements to data quality, coverage, and update frequency. @@ -2364,7 +2364,7 @@ Here are some of the important parameters to take note while using Onchain DEX A **How to obtain Network ID?** -* Use [/onchain/networks](/reference/networks-list) endpoint, example of response: +* Use [/onchain/networks](https://docs.coingecko.com/reference/networks-list) endpoint, example of response: @@ -2380,7 +2380,7 @@ Here are some of the important parameters to take note while using Onchain DEX A Some of the pools endpoints require you to provide DEX ID along with Network ID to query the pools on a particular DEX (Decentralized Exchange). -Using [/onchain/networks/\{network}/dexes/\{dex}/pools](/reference/top-pools-dex) as example: +Using [/onchain/networks/\{network}/dexes/\{dex}/pools](https://docs.coingecko.com/reference/top-pools-dex) as example: * `https://pro-api.coingecko.com/api/v3/onchain/networks/eth/dexes/uniswap_v3/pools?x_cg_pro_api_key=YOUR_API_KEY` @@ -2391,7 +2391,7 @@ There are 2 parameter values required to apply for this endpoint: **How to obtain DEX ID?** -* Use [/onchain/networks/\{network}/dexes](/reference/dexes-list) endpoint, example of response: +* Use [/onchain/networks/\{network}/dexes](https://docs.coingecko.com/reference/dexes-list) endpoint, example of response: @@ -2413,7 +2413,7 @@ There are 2 parameter values required to apply for this endpoint: Most of the time, you will need a pool contract address along with Network ID to query the onchain data, especially when using the Pools Endpoints. -Using [/onchain/networks/\{network}/pools/\{address}](/reference/pool-address) as example: +Using [/onchain/networks/\{network}/pools/\{address}](https://docs.coingecko.com/reference/pool-address) as example: * `https://pro-api.coingecko.com/api/v3/onchain/networks/eth/pools/0xb4e16d0168e52d35cacd2c6185b44281ec28c9dc?x_cg_pro_api_key=YOUR_API_KEY` @@ -2435,7 +2435,7 @@ There are 2 parameter values required to apply for this endpoint: ### b. Token Contract Address -Apart from the pool contract address, you also have the option to query onchain data by using the token contract address, using [/onchain/networks/\{network}/tokens/\{token\_address}/pools](/reference/top-pools-contract-address) as example: +Apart from the pool contract address, you also have the option to query onchain data by using the token contract address, using [/onchain/networks/\{network}/tokens/\{token\_address}/pools](https://docs.coingecko.com/reference/top-pools-contract-address) as example: * `https://pro-api.coingecko.com/api/v3/onchain/networks/eth/tokens/0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48/pools?x_cg_pro_api_key=YOUR_API_KEY` @@ -2474,7 +2474,7 @@ Example 1 (unknown): Some of the pools endpoints require you to provide DEX ID along with Network ID to query the pools on a particular DEX (Decentralized Exchange). -Using [/onchain/networks/\{network}/dexes/\{dex}/pools](/reference/top-pools-dex) as example: +Using [/onchain/networks/\{network}/dexes/\{dex}/pools](https://docs.coingecko.com/reference/top-pools-dex) as example: * `https://pro-api.coingecko.com/api/v3/onchain/networks/eth/dexes/uniswap_v3/pools?x_cg_pro_api_key=YOUR_API_KEY` @@ -2485,7 +2485,7 @@ There are 2 parameter values required to apply for this endpoint: **How to obtain DEX ID?** -* Use [/onchain/networks/\{network}/dexes](/reference/dexes-list) endpoint, example of response: +* Use [/onchain/networks/\{network}/dexes](https://docs.coingecko.com/reference/dexes-list) endpoint, example of response: ``` @@ -2525,7 +2525,7 @@ This endpoint allows you to **get the historical chart data of a coin within cer * You may obtain the coin ID (API ID) via several ways: * refers to respective coin page and find 'API ID'. - * refers to [`/coins/list`](/v3.0.1/reference/coins-list) endpoint. + * refers to [`/coins/list`](https://docs.coingecko.com/v3.0.1/reference/coins-list) endpoint. * refers to google sheets [here](https://docs.google.com/spreadsheets/d/1wTTuxXt8n9q7C4NDXqQpI3wpKu1_5bGVmP9Xz0XGSyU/edit?usp=sharing). diff --git a/assets/skills/coingecko/references/contract.md b/assets/skills/coingecko/references/contract.md index 036a35d..1cda7a5 100644 --- a/assets/skills/coingecko/references/contract.md +++ b/assets/skills/coingecko/references/contract.md @@ -13,10 +13,10 @@ Source: https://docs.coingecko.com/v3.0.1/reference/nfts-contract-address v3.0.1/reference/api-reference/coingecko-demo.json get /nfts/{asset_platform_id}/contract/{contract_address} This endpoint allows you to **query all the NFT data (name, floor price, 24hr volume ...) based on the NFT collection contract address and respective asset platform** -* You may also obtain the asset platform id and contract address through [/nfts/list](/v3.0.1/reference/nfts-list) endpoint. +* You may also obtain the asset platform id and contract address through [/nfts/list](https://docs.coingecko.com/v3.0.1/reference/nfts-list) endpoint. -* Solana NFT & Art Blocks are not supported for this endpoint, please use [/nfts/\{id}](/v3.0.1/reference/nfts-id) endpoint instead. +* Solana NFT & Art Blocks are not supported for this endpoint, please use [/nfts/\{id}](https://docs.coingecko.com/v3.0.1/reference/nfts-id) endpoint instead. * Cache / Update Frequency: every 60 seconds for all the API plans. diff --git a/assets/skills/coingecko/references/exchanges.md b/assets/skills/coingecko/references/exchanges.md index abecdb6..5b19799 100644 --- a/assets/skills/coingecko/references/exchanges.md +++ b/assets/skills/coingecko/references/exchanges.md @@ -14,7 +14,7 @@ v3.0.1/reference/api-reference/coingecko-demo.json get /exchanges/{id}/volume_ch This endpoint allows you to **query the historical volume chart data with time in UNIX and trading volume data in BTC based on exchange's ID** * You can use this endpoint to query the historical volume chart data of **derivatives exchanges** as well. - * The exchange volume in the response is provided in BTC. To convert it to other currencies, please use [/exchange\_rates](/v3.0.1/reference/exchange-rates) endpoint. + * The exchange volume in the response is provided in BTC. To convert it to other currencies, please use [/exchange\_rates](https://docs.coingecko.com/v3.0.1/reference/exchange-rates) endpoint. * Data granularity is automatic (cannot be adjusted): * 1 day = 10-minutely * 7, 14 days = hourly @@ -229,12 +229,12 @@ This endpoint allows you to **query exchange's data (name, year established, cou ### Notice -* Please note that the `trade_volume_24h_btc_normalized` data field will no longer be supported by our API starting on June 15, 2025. Please refer to [changelog](/changelog#may-2025) for more details. +* Please note that the `trade_volume_24h_btc_normalized` data field will no longer be supported by our API starting on June 15, 2025. Please refer to [changelog](https://docs.coingecko.com/changelog#may-2025) for more details. -* The exchange volume in the response is provided in BTC. To convert it to other currencies, please use [/exchange\_rates](/v3.0.1/reference/exchange-rates) endpoint. - * For derivatives (e.g. bitmex, binance\_futures), to get derivatives exchanges data, please go to [/derivatives/exchange/\{id}](/v3.0.1/reference/derivatives-exchanges-id) endpoint. - * Tickers are limited to 100 items, to get more tickers, please go to [/exchanges/\{id}/tickers](/v3.0.1/reference/exchanges-id-tickers) endpoint. +* The exchange volume in the response is provided in BTC. To convert it to other currencies, please use [/exchange\_rates](https://docs.coingecko.com/v3.0.1/reference/exchange-rates) endpoint. + * For derivatives (e.g. bitmex, binance\_futures), to get derivatives exchanges data, please go to [/derivatives/exchange/\{id}](https://docs.coingecko.com/v3.0.1/reference/derivatives-exchanges-id) endpoint. + * Tickers are limited to 100 items, to get more tickers, please go to [/exchanges/\{id}/tickers](https://docs.coingecko.com/v3.0.1/reference/exchanges-id-tickers) endpoint. * When `dex_pair_format=symbol`, the DEX pair `base` and `target` are displayed in symbol format (e.g. `WETH`, `USDC`) instead of as contract addresses. * Cache / Update Frequency: every 60 seconds for all the API plans. diff --git a/assets/skills/coingecko/references/introduction.md b/assets/skills/coingecko/references/introduction.md index 57a727b..3e4b0c3 100644 --- a/assets/skills/coingecko/references/introduction.md +++ b/assets/skills/coingecko/references/introduction.md @@ -207,97 +207,97 @@ Source: https://docs.coingecko.com/v3.0.1/reference/endpoint-overview Any exclusive endpoints for Pro-API users (any paid plan subscribers) will not be included here. -For a full list of endpoints, please visit [Pro API Documentation](/reference/endpoint-overview) instead. +For a full list of endpoints, please visit [Pro API Documentation](https://docs.coingecko.com/reference/endpoint-overview) instead. ## CoinGecko Endpoints: Coins | Endpoint | Description | | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| [/ping](/v3.0.1/reference/ping-server) | Check the API server status | -| [/simple/price](/v3.0.1/reference/simple-price) | Query the prices of one or more coins by using their unique Coin API IDs | -| [/simple/token\_price/\{id}](/v3.0.1/reference/simple-token-price) | Query the prices of one or more coins by using their unique Coin API IDs | -| [/simple/supported\_vs\_currencies](/v3.0.1/reference/simple-supported-currencies) | Query all the supported currencies on CoinGecko | -| [/coins/list](/v3.0.1/reference/coins-list) | Query all the supported coins on CoinGecko with coins ID, name and symbol | -| [/coins/markets](/v3.0.1/reference/coins-markets) | Query all the supported coins with price, market cap, volume and market related data | -| [/coins/\{id}](/v3.0.1/reference/coins-id) | Query all the metadata (image, websites, socials, description, contract address, etc.) from the CoinGecko coin page based on a particular coin ID | -| [/coins/\{id}/tickers](/v3.0.1/reference/coins-id-tickers) | Query the coin tickers on both centralized exchange (CEX) and decentralized exchange (DEX) based on a particular coin ID | -| [/coins/\{id}/history](/v3.0.1/reference/coins-id-history) | Query the historical data (price, market cap, 24hr volume, ...) at a given date for a coin based on a particular coin ID | -| [/coins/\{id}/market\_chart](/v3.0.1/reference/coins-id-market-chart) | Get the historical chart data of a coin including time in UNIX, price, market cap and 24hr volume based on particular coin ID | -| [/coins/\{id}/market\_chart/range](/v3.0.1/reference/coins-id-market-chart-range) | Get the historical chart data of a coin within certain time range in UNIX along with price, market cap and 24hr volume based on particular coin ID | -| [/coins-id-ohlc](/v3.0.1/reference/coins-id-ohlc) | Get the OHLC chart (Open, High, Low, Close) of a coin based on particular coin ID | -| [/coins/../contract/..](/v3.0.1/reference/coins-contract-address) | Query all the metadata (image, websites, socials, description, contract address, etc.) from the CoinGecko coin page based on an asset platform and a particular token contract address | -| [/coins/../contract/../market\_chart](/v3.0.1/reference/contract-address-market-chart) | Get the historical chart data including time in UNIX, price, market cap and 24hr volume based on asset platform and particular token contract address | -| [/coins/../contract/../market\_chart/range](/v3.0.1/reference/contract-address-market-chart-range) | Get the historical chart data within certain time range in UNIX along with price, market cap and 24hr volume based on asset platform and particular token contract address | -| [/coins/categories/list](/v3.0.1/reference/coins-categories-list) | Query all the coins categories on CoinGecko | -| [/coins/categories](/v3.0.1/reference/coins-categories) | Query all the coins categories with market data (market cap, volume, ...) on CoinGecko | +| [/ping](https://docs.coingecko.com/v3.0.1/reference/ping-server) | Check the API server status | +| [/simple/price](https://docs.coingecko.com/v3.0.1/reference/simple-price) | Query the prices of one or more coins by using their unique Coin API IDs | +| [/simple/token\_price/\{id}](https://docs.coingecko.com/v3.0.1/reference/simple-token-price) | Query the prices of one or more coins by using their unique Coin API IDs | +| [/simple/supported\_vs\_currencies](https://docs.coingecko.com/v3.0.1/reference/simple-supported-currencies) | Query all the supported currencies on CoinGecko | +| [/coins/list](https://docs.coingecko.com/v3.0.1/reference/coins-list) | Query all the supported coins on CoinGecko with coins ID, name and symbol | +| [/coins/markets](https://docs.coingecko.com/v3.0.1/reference/coins-markets) | Query all the supported coins with price, market cap, volume and market related data | +| [/coins/\{id}](https://docs.coingecko.com/v3.0.1/reference/coins-id) | Query all the metadata (image, websites, socials, description, contract address, etc.) from the CoinGecko coin page based on a particular coin ID | +| [/coins/\{id}/tickers](https://docs.coingecko.com/v3.0.1/reference/coins-id-tickers) | Query the coin tickers on both centralized exchange (CEX) and decentralized exchange (DEX) based on a particular coin ID | +| [/coins/\{id}/history](https://docs.coingecko.com/v3.0.1/reference/coins-id-history) | Query the historical data (price, market cap, 24hr volume, ...) at a given date for a coin based on a particular coin ID | +| [/coins/\{id}/market\_chart](https://docs.coingecko.com/v3.0.1/reference/coins-id-market-chart) | Get the historical chart data of a coin including time in UNIX, price, market cap and 24hr volume based on particular coin ID | +| [/coins/\{id}/market\_chart/range](https://docs.coingecko.com/v3.0.1/reference/coins-id-market-chart-range) | Get the historical chart data of a coin within certain time range in UNIX along with price, market cap and 24hr volume based on particular coin ID | +| [/coins-id-ohlc](https://docs.coingecko.com/v3.0.1/reference/coins-id-ohlc) | Get the OHLC chart (Open, High, Low, Close) of a coin based on particular coin ID | +| [/coins/../contract/..](https://docs.coingecko.com/v3.0.1/reference/coins-contract-address) | Query all the metadata (image, websites, socials, description, contract address, etc.) from the CoinGecko coin page based on an asset platform and a particular token contract address | +| [/coins/../contract/../market\_chart](https://docs.coingecko.com/v3.0.1/reference/contract-address-market-chart) | Get the historical chart data including time in UNIX, price, market cap and 24hr volume based on asset platform and particular token contract address | +| [/coins/../contract/../market\_chart/range](https://docs.coingecko.com/v3.0.1/reference/contract-address-market-chart-range) | Get the historical chart data within certain time range in UNIX along with price, market cap and 24hr volume based on asset platform and particular token contract address | +| [/coins/categories/list](https://docs.coingecko.com/v3.0.1/reference/coins-categories-list) | Query all the coins categories on CoinGecko | +| [/coins/categories](https://docs.coingecko.com/v3.0.1/reference/coins-categories) | Query all the coins categories with market data (market cap, volume, ...) on CoinGecko | ## CoinGecko Endpoints: NFT | Endpoint | Description | | --------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------- | -| [/nfts/list](/v3.0.1/reference/nfts-list) | Query all supported NFTs with ID, contract address, name, asset platform ID and symbol on CoinGecko | -| [/nfts/..](/v3.0.1/reference/nfts-id) | Query all the NFT data (name, floor price, 24hr volume, ...) based on the NFT collection ID | -| [/nfts/../contract/..](/v3.0.1/reference/nfts-contract-address) | Query all the NFT data (name, floor price, 24hr volume, ...) based on the NFT collection contract address and respective asset platform | +| [/nfts/list](https://docs.coingecko.com/v3.0.1/reference/nfts-list) | Query all supported NFTs with ID, contract address, name, asset platform ID and symbol on CoinGecko | +| [/nfts/..](https://docs.coingecko.com/v3.0.1/reference/nfts-id) | Query all the NFT data (name, floor price, 24hr volume, ...) based on the NFT collection ID | +| [/nfts/../contract/..](https://docs.coingecko.com/v3.0.1/reference/nfts-contract-address) | Query all the NFT data (name, floor price, 24hr volume, ...) based on the NFT collection contract address and respective asset platform | ## CoinGecko Endpoints: Exchanges & Derivatives | Endpoint | Description | | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | -| [/exchanges](/v3.0.1/reference/exchanges) | Query all the supported exchanges with exchanges' data (ID, name, country, ...) that have active trading volumes on CoinGecko | -| [/exchanges/list](/v3.0.1/reference/exchanges-list) | Query all the exchanges with ID and name | -| [/exchanges/\{id}](/v3.0.1/reference/exchanges-id) | Query exchange's data (name, year established, country, ...), exchange volume in BTC and tickers based on exchange's ID | -| [/exchanges/\{id}/tickers](/v3.0.1/reference/exchanges-id-tickers) | Query exchange's tickers based on exchange's ID | -| [/exchanges/\{id}/volume\_chart](/v3.0.1/reference/exchanges-id-volume-chart) | Query the historical volume chart data with time in UNIX and trading volume data in BTC based on exchange's ID | -| [/derivatives](/v3.0.1/reference/derivatives-tickers) | Query all the tickers from derivatives exchanges on CoinGecko | -| [/derivatives/exchanges](/v3.0.1/reference/derivatives-exchanges) | Query all the derivatives exchanges with related data (ID, name, open interest, ...) on CoinGecko | -| [/derivatives/exchanges/\{id}](/v3.0.1/reference/derivatives-exchanges-id) | Query the derivatives exchange's related data (ID, name, open interest, ...) based on the exchanges' ID | -| [/derivatives/exchanges/list](/v3.0.1/reference/derivatives-exchanges-list) | Query all the derivatives exchanges with ID and name on CoinGecko | +| [/exchanges](https://docs.coingecko.com/v3.0.1/reference/exchanges) | Query all the supported exchanges with exchanges' data (ID, name, country, ...) that have active trading volumes on CoinGecko | +| [/exchanges/list](https://docs.coingecko.com/v3.0.1/reference/exchanges-list) | Query all the exchanges with ID and name | +| [/exchanges/\{id}](https://docs.coingecko.com/v3.0.1/reference/exchanges-id) | Query exchange's data (name, year established, country, ...), exchange volume in BTC and tickers based on exchange's ID | +| [/exchanges/\{id}/tickers](https://docs.coingecko.com/v3.0.1/reference/exchanges-id-tickers) | Query exchange's tickers based on exchange's ID | +| [/exchanges/\{id}/volume\_chart](https://docs.coingecko.com/v3.0.1/reference/exchanges-id-volume-chart) | Query the historical volume chart data with time in UNIX and trading volume data in BTC based on exchange's ID | +| [/derivatives](https://docs.coingecko.com/v3.0.1/reference/derivatives-tickers) | Query all the tickers from derivatives exchanges on CoinGecko | +| [/derivatives/exchanges](https://docs.coingecko.com/v3.0.1/reference/derivatives-exchanges) | Query all the derivatives exchanges with related data (ID, name, open interest, ...) on CoinGecko | +| [/derivatives/exchanges/\{id}](https://docs.coingecko.com/v3.0.1/reference/derivatives-exchanges-id) | Query the derivatives exchange's related data (ID, name, open interest, ...) based on the exchanges' ID | +| [/derivatives/exchanges/list](https://docs.coingecko.com/v3.0.1/reference/derivatives-exchanges-list) | Query all the derivatives exchanges with ID and name on CoinGecko | ## CoinGecko Endpoints: Public Treasuries | Endpoint | Description | | ------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | -| [/\{entity}/public\_treasury/\{coin\_id}](/reference/companies-public-treasury) | Query public companies & governments' cryptocurrency holdings by coin ID | -| [/public\_treasury/\{entity\_id}](/reference/public-treasury-entity) | Query public companies & governments' cryptocurrency holdings by entity ID | -| [/entities/list](/reference/entities-list) | Query all the supported entities on CoinGecko with entities ID, name, symbol, and country | +| [/\{entity}/public\_treasury/\{coin\_id}](https://docs.coingecko.com/reference/companies-public-treasury) | Query public companies & governments' cryptocurrency holdings by coin ID | +| [/public\_treasury/\{entity\_id}](https://docs.coingecko.com/reference/public-treasury-entity) | Query public companies & governments' cryptocurrency holdings by entity ID | +| [/entities/list](https://docs.coingecko.com/reference/entities-list) | Query all the supported entities on CoinGecko with entities ID, name, symbol, and country | ## CoinGecko Endpoints: General | Endpoint | Description | | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | -| [/exchange\_rates](/v3.0.1/reference/exchange-rates) | Query BTC exchange rates with other currencies | -| [/asset\_platforms](/v3.0.1/reference/asset-platforms-list) | Query all the asset platforms (blockchain networks) on CoinGecko | -| [/token\_lists/\{asset\_platform\_id}/all.json](/v3.0.1/reference/token-lists) | Get full list of tokens of a blockchain network (asset platform) that is supported by Ethereum token list standard | -| [/search](/v3.0.1/reference/search-data) | Search for coins, categories and markets listed on CoinGecko | -| [/search/trending](/v3.0.1/reference/trending-search) | Query trending search coins, NFTs and categories on CoinGecko in the last 24 hours | -| [/global](/v3.0.1/reference/crypto-global) | Query cryptocurrency global data including active cryptocurrencies, markets, total crypto market cap and etc. | -| [/global/decentralized\_finance\_defi](/v3.0.1/reference/global-defi) | Query cryptocurrency global decentralized finance (DeFi) data including DeFi market cap, trading volume | +| [/exchange\_rates](https://docs.coingecko.com/v3.0.1/reference/exchange-rates) | Query BTC exchange rates with other currencies | +| [/asset\_platforms](https://docs.coingecko.com/v3.0.1/reference/asset-platforms-list) | Query all the asset platforms (blockchain networks) on CoinGecko | +| [/token\_lists/\{asset\_platform\_id}/all.json](https://docs.coingecko.com/v3.0.1/reference/token-lists) | Get full list of tokens of a blockchain network (asset platform) that is supported by Ethereum token list standard | +| [/search](https://docs.coingecko.com/v3.0.1/reference/search-data) | Search for coins, categories and markets listed on CoinGecko | +| [/search/trending](https://docs.coingecko.com/v3.0.1/reference/trending-search) | Query trending search coins, NFTs and categories on CoinGecko in the last 24 hours | +| [/global](https://docs.coingecko.com/v3.0.1/reference/crypto-global) | Query cryptocurrency global data including active cryptocurrencies, markets, total crypto market cap and etc. | +| [/global/decentralized\_finance\_defi](https://docs.coingecko.com/v3.0.1/reference/global-defi) | Query cryptocurrency global decentralized finance (DeFi) data including DeFi market cap, trading volume | ## Onchain DEX Endpoints (GeckoTerminal) | Endpoint | Description | | ---------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| [/onchain/simple/networks/../token\_price/..](/v3.0.1/reference/onchain-simple-price) | Get token price based on the provided token contract address on a network | -| [/onchain/networks](/v3.0.1/reference/networks-list) | Query all the supported networks on GeckoTerminal | -| [/onchain/networks/../dexes](/v3.0.1/reference/dexes-list) | Query all the supported decentralized exchanges (DEXs) based on the provided network on GeckoTerminal | -| [/onchain/networks/trending\_pools](/v3.0.1/reference/trending-pools-list) | Query all the trending pools across all networks on GeckoTerminal | -| [/onchain/networks/../trending\_pools](/v3.0.1/reference/trending-pools-network) | Query the trending pools based on the provided network | -| [/onchain/networks/../pools/..](/v3.0.1/reference/pool-address) | Query the specific pool based on the provided network and pool address | -| [/onchain/networks/../pools/multi/..](/v3.0.1/reference/pools-addresses) | Query multiple pools based on the provided network and pool address | -| [/onchain/networks/../pools](/v3.0.1/reference/top-pools-network) | Query all the top pools based on the provided network | -| [/onchain/networks/../dexes/../pools](/v3.0.1/reference/top-pools-dex) | Query all the top pools based on the provided network and decentralized exchange (DEX) | -| [/onchain/networks/../new\_pools](/v3.0.1/reference/latest-pools-network) | Query all the latest pools based on provided network | -| [/onchain/networks/new\_pools](/v3.0.1/reference/latest-pools-list) | Query all the latest pools across all networks on GeckoTerminal | -| [/onchain/search/pools](/v3.0.1/reference/search-pools) | Search for pools on a network | -| [/onchain/networks/../tokens/../pools](/v3.0.1/reference/top-pools-contract-address) | Query top pools based on the provided token contract address on a network | -| [/onchain/networks/../tokens/..](/v3.0.1/reference/token-data-contract-address) | Query specific token data based on the provided token contract address on a network | -| [/onchain/networks/../tokens/multi/..](/v3.0.1/reference/tokens-data-contract-addresses) | Query multiple tokens data based on the provided token contract addresses on a network | -| [/onchain/networks/../tokens/../info](/v3.0.1/reference/token-info-contract-address) | Query token metadata (name, symbol, CoinGecko ID, image, socials, websites, description, etc.) based on a provided token contract address on a network | -| [/onchain/networks/../pools/../info](/v3.0.1/reference/pool-token-info-contract-address) | Query pool metadata (base and quote token details, image, socials, websites, description, contract address, etc.) based on a provided pool contract address on a network | -| [/onchain/tokens/info\_recently\_updated](/v3.0.1/reference/tokens-info-recent-updated) | Query 100 most recently updated tokens info across all networks on GeckoTerminal | -| [/onchain/networks/../pools/../ohlcv/..](/v3.0.1/reference/pool-ohlcv-contract-address) | Get the OHLCV chart (Open, High, Low, Close, Volume) of a pool based on the provided pool address on a network | -| [/onchain/networks/../pools/../trades](/v3.0.1/reference/pool-trades-contract-address) | Query the last 300 trades in the past 24 hours based on the provided pool address | +| [/onchain/simple/networks/../token\_price/..](https://docs.coingecko.com/v3.0.1/reference/onchain-simple-price) | Get token price based on the provided token contract address on a network | +| [/onchain/networks](https://docs.coingecko.com/v3.0.1/reference/networks-list) | Query all the supported networks on GeckoTerminal | +| [/onchain/networks/../dexes](https://docs.coingecko.com/v3.0.1/reference/dexes-list) | Query all the supported decentralized exchanges (DEXs) based on the provided network on GeckoTerminal | +| [/onchain/networks/trending\_pools](https://docs.coingecko.com/v3.0.1/reference/trending-pools-list) | Query all the trending pools across all networks on GeckoTerminal | +| [/onchain/networks/../trending\_pools](https://docs.coingecko.com/v3.0.1/reference/trending-pools-network) | Query the trending pools based on the provided network | +| [/onchain/networks/../pools/..](https://docs.coingecko.com/v3.0.1/reference/pool-address) | Query the specific pool based on the provided network and pool address | +| [/onchain/networks/../pools/multi/..](https://docs.coingecko.com/v3.0.1/reference/pools-addresses) | Query multiple pools based on the provided network and pool address | +| [/onchain/networks/../pools](https://docs.coingecko.com/v3.0.1/reference/top-pools-network) | Query all the top pools based on the provided network | +| [/onchain/networks/../dexes/../pools](https://docs.coingecko.com/v3.0.1/reference/top-pools-dex) | Query all the top pools based on the provided network and decentralized exchange (DEX) | +| [/onchain/networks/../new\_pools](https://docs.coingecko.com/v3.0.1/reference/latest-pools-network) | Query all the latest pools based on provided network | +| [/onchain/networks/new\_pools](https://docs.coingecko.com/v3.0.1/reference/latest-pools-list) | Query all the latest pools across all networks on GeckoTerminal | +| [/onchain/search/pools](https://docs.coingecko.com/v3.0.1/reference/search-pools) | Search for pools on a network | +| [/onchain/networks/../tokens/../pools](https://docs.coingecko.com/v3.0.1/reference/top-pools-contract-address) | Query top pools based on the provided token contract address on a network | +| [/onchain/networks/../tokens/..](https://docs.coingecko.com/v3.0.1/reference/token-data-contract-address) | Query specific token data based on the provided token contract address on a network | +| [/onchain/networks/../tokens/multi/..](https://docs.coingecko.com/v3.0.1/reference/tokens-data-contract-addresses) | Query multiple tokens data based on the provided token contract addresses on a network | +| [/onchain/networks/../tokens/../info](https://docs.coingecko.com/v3.0.1/reference/token-info-contract-address) | Query token metadata (name, symbol, CoinGecko ID, image, socials, websites, description, etc.) based on a provided token contract address on a network | +| [/onchain/networks/../pools/../info](https://docs.coingecko.com/v3.0.1/reference/pool-token-info-contract-address) | Query pool metadata (base and quote token details, image, socials, websites, description, contract address, etc.) based on a provided pool contract address on a network | +| [/onchain/tokens/info\_recently\_updated](https://docs.coingecko.com/v3.0.1/reference/tokens-info-recent-updated) | Query 100 most recently updated tokens info across all networks on GeckoTerminal | +| [/onchain/networks/../pools/../ohlcv/..](https://docs.coingecko.com/v3.0.1/reference/pool-ohlcv-contract-address) | Get the OHLCV chart (Open, High, Low, Close, Volume) of a pool based on the provided pool address on a network | +| [/onchain/networks/../pools/../trades](https://docs.coingecko.com/v3.0.1/reference/pool-trades-contract-address) | Query the last 300 trades in the past 24 hours based on the provided pool address | ⚡️ Need Real-time Data Streams? Try [WebSocket API](https://docs.coingecko.com/websocket) diff --git a/assets/skills/coingecko/references/llms-full.md b/assets/skills/coingecko/references/llms-full.md index 539d313..daaba0b 100644 --- a/assets/skills/coingecko/references/llms-full.md +++ b/assets/skills/coingecko/references/llms-full.md @@ -42,10 +42,10 @@ export const GreenSeparator = () => ( We've added support for bonding curve (e.g. launchpad graduation from PumpFun) data across multiple token endpoints: - * [Token Data by Token Address](/reference/token-data-contract-address) — `/onchain/networks/{network}/tokens/{address}` - * [Tokens Data by Token Addresses](/reference/tokens-data-contract-addresses) — `/onchain/networks/{network}/tokens/multi/{addresses}` - * [Token Info by Token Address](/reference/token-info-contract-address) — `/onchain/networks/{network}/tokens/{address}/info` - * [Pool Tokens Info by Pool Address](/reference/pool-token-info-contract-address) — `/onchain/networks/{network}/pools/{pool_address}/info` + * [Token Data by Token Address](https://docs.coingecko.com/reference/token-data-contract-address) — `/onchain/networks/{network}/tokens/{address}` + * [Tokens Data by Token Addresses](https://docs.coingecko.com/reference/tokens-data-contract-addresses) — `/onchain/networks/{network}/tokens/multi/{addresses}` + * [Token Info by Token Address](https://docs.coingecko.com/reference/token-info-contract-address) — `/onchain/networks/{network}/tokens/{address}/info` + * [Pool Tokens Info by Pool Address](https://docs.coingecko.com/reference/pool-token-info-contract-address) — `/onchain/networks/{network}/pools/{pool_address}/info` ```json JSON theme={null} "launchpad_details": { @@ -58,7 +58,7 @@ export const GreenSeparator = () => ( ### Megafilter: Ascending Sort Order for Price Change % - The [Megafilter for Pools](/reference/pools-megafilter) endpoint now supports ascending sorting for price change percentage: + The [Megafilter for Pools](https://docs.coingecko.com/reference/pools-megafilter) endpoint now supports ascending sorting for price change percentage: * `m5_price_change_percentage_asc` * `h1_price_change_percentage_asc` @@ -67,7 +67,7 @@ export const GreenSeparator = () => ( ### Token OHLCV Endpoint Fix to respect Specified Token Address - We've fixed an issue where the [Token OHLCV chart by Token Address](/reference/token-ohlcv-token-address) endpoint returned data for the base token of the top pool instead of the requested token. It will now always return data for the specified token address. + We've fixed an issue where the [Token OHLCV chart by Token Address](https://docs.coingecko.com/reference/token-ohlcv-token-address) endpoint returned data for the base token of the top pool instead of the requested token. It will now always return data for the specified token address. @@ -91,17 +91,17 @@ export const GreenSeparator = () => ( We're also surfacing new tools through the MCP to give developers a richer, faster way to query exchanges, NFTs, and onchain activity. * New tools: - * Exchange coverage with [/exchanges/list](reference/exchanges-list), [/exchanges/](reference/exchanges-id), [/exchanges//tickers](reference/exchanges-id-tickers), and [/exchanges//volume\_chart/range](reference/exchanges-id-volume-chart-range) - * NFT markets with [/nfts/markets](reference/nfts-markets) - * Multi-address queries with [/onchain/networks//pools/multi/](reference/pools-addresses) and [/onchain/networks//tokens/multi/](reference/tokens-data-contract-addresses) + * Exchange coverage with [/exchanges/list](https://docs.coingecko.com/reference/exchanges-list), [/exchanges/](https://docs.coingecko.com/reference/exchanges-id), [/exchanges//tickers](https://docs.coingecko.com/reference/exchanges-id-tickers), and [/exchanges//volume\_chart/range](https://docs.coingecko.com/reference/exchanges-id-volume-chart-range) + * NFT markets with [/nfts/markets](https://docs.coingecko.com/reference/nfts-markets) + * Multi-address queries with [/onchain/networks//pools/multi/](https://docs.coingecko.com/reference/pools-addresses) and [/onchain/networks//tokens/multi/](https://docs.coingecko.com/reference/tokens-data-contract-addresses) * Retired tools: - * We've removed endpoints such as [/coins/list](reference/coins-list), [/onchain/networks/trending\_pools](reference/trending-pools-network), and single-address pool/token queries in favor of more scalable multi-address endpoints + * We've removed endpoints such as [/coins/list](https://docs.coingecko.com/reference/coins-list), [/onchain/networks/trending\_pools](https://docs.coingecko.com/reference/trending-pools-network), and single-address pool/token queries in favor of more scalable multi-address endpoints ### Friendlier Time-related MCP Queries with ISO Support Time-based queries just got easier. MCP tools now accept **ISO date strings** (`YYYY-MM-DD` or `YYYY-MM-DDTHH:MM`) alongside UNIX timestamps. - For example, when using the [Coin Historical Chart Data within Time Range](reference/coins-id-market-chart-range) tool, you can now pass ISO date strings directly instead of converting them into UNIX timestamps for your LLM tools. + For example, when using the [Coin Historical Chart Data within Time Range](https://docs.coingecko.com/reference/coins-id-market-chart-range) tool, you can now pass ISO date strings directly instead of converting them into UNIX timestamps for your LLM tools. **CoinGecko API Team** @@ -1767,13 +1767,13 @@ export const GreenSeparator = () => ( For a finalised list of token contracts and API IDs that have been separated from its native asset page and listed individually, please refer to this [Google Sheets](https://docs.google.com/spreadsheets/d/15FyY1gvUi20LdnlJRly-pXvm5ATNbFbSy06VoI1vVs4/edit?usp=sharing) - You may also identify the list of bridged coins via API: you may also use [/categories/list endpoint](/reference/coins-categories-list) to look for bridged categories such as: + You may also identify the list of bridged coins via API: you may also use [/categories/list endpoint](https://docs.coingecko.com/reference/coins-categories-list) to look for bridged categories such as: 1. bridged-usdc 2. bridged-wbtc 3. bridged-weth - Then you may use [/coins/market endpoint](/reference/coins-markets) to retrieve the list of coins + Then you may use [/coins/market endpoint](https://docs.coingecko.com/reference/coins-markets) to retrieve the list of coins @@ -1872,21 +1872,21 @@ export const GreenSeparator = () => ( ### Onchain: Simple Price - Increased Token Address Limit from 30 to 100 - [Token Price by Token Addresses](/reference/onchain-simple-price) now allows to input up to 100 contract addresses, instead of 30. + [Token Price by Token Addresses](https://docs.coingecko.com/reference/onchain-simple-price) now allows to input up to 100 contract addresses, instead of 30. * You may now retrieve data of up to 100 token prices of a specific network, in one single request. * Available exclusively to Pro API paid plan subscribers. ### Onchain: Recently Updated Info - Added Filter by Network - [Most Recently Updated Token List](/reference/tokens-info-recent-updated) now allows to filter by blockchain network, by flagging the `network` parameter. e.g. `network=eth`. + [Most Recently Updated Token List](https://docs.coingecko.com/reference/tokens-info-recent-updated) now allows to filter by blockchain network, by flagging the `network` parameter. e.g. `network=eth`. * You can use the `network` parameter to retrieve the 100 most recently updated token info of a specific network. * View list of supported network via [Supported Networks List](https://docs.coingecko.com/reference/networks-list) endpoint. ### NFT Collection Data - Included Banner Image - [NFTs Collection Data by ID](/reference/nfts-id) now provides banner image of a NFT collection. + [NFTs Collection Data by ID](https://docs.coingecko.com/reference/nfts-id) now provides banner image of a NFT collection. View banner image [example](https://coin-images.coingecko.com/nft_contracts/images/38/pudgy-penguins-banner.png?1708416126) on: [https://www.coingecko.com/en/nft/pudgy-penguins](https://www.coingecko.com/en/nft/pudgy-penguins) @@ -1914,7 +1914,7 @@ export const GreenSeparator = () => ( ### Asset Platforms - Included Images of Blockchain Network Logos - [Asset Platforms List (ID Map)](/reference/asset-platforms-list) now provides the logos of blockchain networks. + [Asset Platforms List (ID Map)](https://docs.coingecko.com/reference/asset-platforms-list) now provides the logos of blockchain networks. For example: @@ -1928,7 +1928,7 @@ export const GreenSeparator = () => ( ### Coins Categories - Included Ids of Top 3 Coins - [Coins Categories List with Market Data](/reference/coins-categories) now provides coins id of the top 3 coins of a category. + [Coins Categories List with Market Data](https://docs.coingecko.com/reference/coins-categories) now provides coins id of the top 3 coins of a category. For example: @@ -1957,8 +1957,8 @@ export const GreenSeparator = () => ( The cache & update frequency of the following endpoints have been improved from every 30 minutes to every 15 minutes: - * [/coins//ohlc](/reference/coins-id-ohlc) - * [/coins//ohlc/range](/reference/coins-id-ohlc-range) + * [/coins//ohlc](https://docs.coingecko.com/reference/coins-id-ohlc) + * [/coins//ohlc/range](https://docs.coingecko.com/reference/coins-id-ohlc-range) @@ -1968,8 +1968,8 @@ export const GreenSeparator = () => ( We've added 'user\_favorites\_count', and 'ath' (all-time-high) related data to the following NFT endpoints: - * [/nfts/](/reference/nfts-id) - * [/nfts//contract/](/reference/nfts-contract-address) + * [/nfts/](https://docs.coingecko.com/reference/nfts-id) + * [/nfts//contract/](https://docs.coingecko.com/reference/nfts-contract-address) **Example of responses:** @@ -1996,7 +1996,7 @@ export const GreenSeparator = () => ( 🗓️ **May 10, 2024** - We've introduced a new endpoint [/coins//ohlc/range](/reference/coins-id-ohlc-range). + We've introduced a new endpoint [/coins//ohlc/range](https://docs.coingecko.com/reference/coins-id-ohlc-range). This endpoint allows you to get the OHLC chart (Open, High, Low, Close) of a coin within a range of timestamp based on particular coin id. @@ -2008,7 +2008,7 @@ export const GreenSeparator = () => ( 🗓️ **May 04, 2024** - We've expanded functionality to include support for the `interval=hourly` parameter within the [/coins//ohlc](/reference/coins-id-ohlc) endpoint. + We've expanded functionality to include support for the `interval=hourly` parameter within the [/coins//ohlc](https://docs.coingecko.com/reference/coins-id-ohlc) endpoint. Users can use this parameter to retrieve OHLC (Open/High/Low/Close) data on a hourly interval for up to 90 days of the date range. @@ -2022,7 +2022,7 @@ export const GreenSeparator = () => ( 🗓️ **April 30, 2024** - We've now enhanced the [/coins/list](/reference/coins-list) endpoint to include inactive coins + We've now enhanced the [/coins/list](https://docs.coingecko.com/reference/coins-list) endpoint to include inactive coins * You may access the inactive coins by specifying `status=inactive` in your query * Example of endpoint request:\ @@ -2030,11 +2030,11 @@ export const GreenSeparator = () => ( Additionally, historical data for inactive coins can be queried using their IDs in the following endpoints: - * [/coins//history](/reference/coins-id-history) - * [/coins//market\_chart](/reference/coins-id-market-chart) - * [/coins//market\_chart/range](/reference/coins-id-market-chart-range) - * [/coins//contract//market\_chart](/reference/contract-address-market-chart) - * [/coins//contract//market\_chart/range](/reference/contract-address-market-chart-range) + * [/coins//history](https://docs.coingecko.com/reference/coins-id-history) + * [/coins//market\_chart](https://docs.coingecko.com/reference/coins-id-market-chart) + * [/coins//market\_chart/range](https://docs.coingecko.com/reference/coins-id-market-chart-range) + * [/coins//contract//market\_chart](https://docs.coingecko.com/reference/contract-address-market-chart) + * [/coins//contract//market\_chart/range](https://docs.coingecko.com/reference/contract-address-market-chart-range) Please note that these features are available exclusively for **paid plan subscribers only** @@ -2044,7 +2044,7 @@ export const GreenSeparator = () => ( 🗓️ **March 27, 2024** - We've introduced a new endpoint [/key](/reference/api-usage) for conveniently monitoring your account's API usage, including rate limits and remaining credits. + We've introduced a new endpoint [/key](https://docs.coingecko.com/reference/api-usage) for conveniently monitoring your account's API usage, including rate limits and remaining credits. **Example of responses**: @@ -2084,10 +2084,10 @@ export const GreenSeparator = () => ( } ``` * We've added sorting parameters such as order= `h24_volume_usd_desc` and order=` h24_tx_count_desc` for /pools endpoints - * The 'token' parameter within the [/ohlcv ](/reference/pool-ohlcv-contract-address) endpoint can now accept a token address, provided it exists in the queried pool, to return OHLCV data\ + * The 'token' parameter within the [/ohlcv ](https://docs.coingecko.com/reference/pool-ohlcv-contract-address) endpoint can now accept a token address, provided it exists in the queried pool, to return OHLCV data\ Example of endpoint request (**token=0xc02aaa39b223fe8d0a0e5c4f27ead9083c756cc2**):\ `https://pro-api.coingecko.com/api/v3/onchain/networks/eth/pools/0x06da0fd433c1a5d7a4faa01111c044910a184553/ohlcv/day?token=0xc02aaa39b223fe8d0a0e5c4f27ead9083c756cc2&x_cg_pro_api_key=YOUR_API_KEY` - * [/ohlcv ](/reference/pool-ohlcv-contract-address) endpoint now includes the base and target token metadata in the response\ + * [/ohlcv ](https://docs.coingecko.com/reference/pool-ohlcv-contract-address) endpoint now includes the base and target token metadata in the response\ Example of responses: ```json JSON theme={null} @@ -2122,7 +2122,7 @@ export const GreenSeparator = () => ( 🗓️ **February 19, 2024** - Trending Pools endpoint, [/networks//trending\_pools](/reference/trending-pools-network) is now available to fetch a list of pools that are trending as seen on GeckoTerminal based on web visits and on-chain activities. + Trending Pools endpoint, [/networks//trending\_pools](https://docs.coingecko.com/reference/trending-pools-network) is now available to fetch a list of pools that are trending as seen on GeckoTerminal based on web visits and on-chain activities. @@ -2138,7 +2138,7 @@ export const GreenSeparator = () => ( 🗓️ **January 18, 2024** - We've included a new field "whitepaper" under "links" section for [/coins/](/reference/coins-id) endpoint + We've included a new field "whitepaper" under "links" section for [/coins/](https://docs.coingecko.com/reference/coins-id) endpoint **Example of responses:** @@ -2170,7 +2170,7 @@ export const GreenSeparator = () => ( 🗓️ **December 13, 2023** - The following data is now deprecated for [/coins/](/reference/coins-id) endpoint: + The following data is now deprecated for [/coins/](https://docs.coingecko.com/reference/coins-id) endpoint: * coingecko\_rank * coingecko\_score @@ -2190,8 +2190,8 @@ export const GreenSeparator = () => ( We've introduced Historical Total Supply data to Enterprise plan subscribers via these 2 exclusive endpoints: - * [/coins//total\_supply\_chart](/reference/coins-id-total-supply-chart) : get historical total supply of a coin, by number of days away from now. - * [/coins//total\_supply\_chart/range](/reference/coins-id-total-supply-chart-range) : get historical total supply of a coin, within a range of timestamp. + * [/coins//total\_supply\_chart](https://docs.coingecko.com/reference/coins-id-total-supply-chart) : get historical total supply of a coin, by number of days away from now. + * [/coins//total\_supply\_chart/range](https://docs.coingecko.com/reference/coins-id-total-supply-chart-range) : get historical total supply of a coin, within a range of timestamp. @@ -2199,7 +2199,7 @@ export const GreenSeparator = () => ( 🗓️ **December 07, 2023** - We've expanded the capabilities of the [/search/trending](/reference/trending-search) endpoint. + We've expanded the capabilities of the [/search/trending](https://docs.coingecko.com/reference/trending-search) endpoint. It now supports up to 15 trending coins, a significant increase from the previous limit of 7. @@ -2219,8 +2219,8 @@ export const GreenSeparator = () => ( The web\_slug data is now available in the following endpoints. - * [/coins/](/reference/coins-id) - * [/coins//contract/](/reference/coins-contract-address) + * [/coins/](https://docs.coingecko.com/reference/coins-id) + * [/coins//contract/](https://docs.coingecko.com/reference/coins-contract-address) This addition allows users to accurately link to a CoinGecko coin page using [www.coingecko.com/en/](http://www.coingecko.com/en/\{web_slug}). @@ -2237,7 +2237,7 @@ export const GreenSeparator = () => ( } ``` - For the [/asset\_platforms](/reference/asset-platforms-list) endpoint, we've introduced the native\_coin\_id data. This enables users to obtain the coin ID of different blockchain networks or asset platforms that may not have a contract address to look up + For the [/asset\_platforms](https://docs.coingecko.com/reference/asset-platforms-list) endpoint, we've introduced the native\_coin\_id data. This enables users to obtain the coin ID of different blockchain networks or asset platforms that may not have a contract address to look up **Example of responses:** @@ -2257,7 +2257,7 @@ export const GreenSeparator = () => ( 🗓️ **November 10, 2023** - Inspired by CoinGecko API most popular endpoint, we have launched the [/simple/networks//token\_price/](/reference/onchain-simple-price), simple endpoint. Simply pass in addresses of any tokens on supported blockchain and get price data for it + Inspired by CoinGecko API most popular endpoint, we have launched the [/simple/networks//token\_price/](https://docs.coingecko.com/reference/onchain-simple-price), simple endpoint. Simply pass in addresses of any tokens on supported blockchain and get price data for it @@ -2265,7 +2265,7 @@ export const GreenSeparator = () => ( 🗓️ **November 08, 2023** - You can now get the latest 300 trades in the past 24 hours of a given pool from this endpoint [/networks//pools//trades](/reference/pool-trades-contract-address). You may optionally filter by trade size as well. You can now build your own telegram bot alert! + You can now get the latest 300 trades in the past 24 hours of a given pool from this endpoint [/networks//pools//trades](https://docs.coingecko.com/reference/pool-trades-contract-address). You may optionally filter by trade size as well. You can now build your own telegram bot alert! @@ -2275,9 +2275,9 @@ export const GreenSeparator = () => ( You can now fetch token information such as name, image, social links, and description via these endpoints: - * To fetch information of tokens inside a pool, use [/networks//pools//info](/reference/pool-token-info-contract-address) - * To fetch information of a specific token use [/networks//tokens//info](/reference/token-info-contract-address) - * If you like to get token information of the most recently updated tokens, use [/tokens/info\_recently\_updated](/reference/tokens-info-recent-updated) + * To fetch information of tokens inside a pool, use [/networks//pools//info](https://docs.coingecko.com/reference/pool-token-info-contract-address) + * To fetch information of a specific token use [/networks//tokens//info](https://docs.coingecko.com/reference/token-info-contract-address) + * If you like to get token information of the most recently updated tokens, use [/tokens/info\_recently\_updated](https://docs.coingecko.com/reference/tokens-info-recent-updated) @@ -2310,16 +2310,16 @@ export const GreenSeparator = () => ( 🗓️ **June 15, 2023** - The uses of 'precision' parameter allows to specify price data in full or 0-18 decimals, and previously was only made available for [/simple/price](/reference/simple-price) and [/simple/token\_price/](/reference/simple-token-price) endpoints. + The uses of 'precision' parameter allows to specify price data in full or 0-18 decimals, and previously was only made available for [/simple/price](https://docs.coingecko.com/reference/simple-price) and [/simple/token\_price/](https://docs.coingecko.com/reference/simple-token-price) endpoints. This parameter is now supported for more endpoints as listed below: - * [/coins/markets](/reference/coins-markets) - * [/coins/market\_chart](/reference/coins-id-market-chart) - * [/coins/market\_chart/range](/reference/coins-id-market-chart) - * [/coins//contract//market\_chart](/reference/contract-address-market-chart) - * [/coins//contract//market\_chart/range](/reference/contract-address-market-chart-range) - * [/coins//ohlc](/reference/coins-id-ohlc) + * [/coins/markets](https://docs.coingecko.com/reference/coins-markets) + * [/coins/market\_chart](https://docs.coingecko.com/reference/coins-id-market-chart) + * [/coins/market\_chart/range](https://docs.coingecko.com/reference/coins-id-market-chart) + * [/coins//contract//market\_chart](https://docs.coingecko.com/reference/contract-address-market-chart) + * [/coins//contract//market\_chart/range](https://docs.coingecko.com/reference/contract-address-market-chart-range) + * [/coins//ohlc](https://docs.coingecko.com/reference/coins-id-ohlc) @@ -2329,8 +2329,8 @@ export const GreenSeparator = () => ( We've made enhancements to the /search/trending and /coins/asset\_platform\_id/contract/contract\_address endpoints: - * Top 5 trending NFT data (based on high trading volume in the last 24 hours) is now included in the [/search/trending](/reference/trending-search) endpoint - * Near Protocol contract address (e.g. wrap.near) is now supported for [/coins//contract/ ](/reference/coins-contract-address) endpoint + * Top 5 trending NFT data (based on high trading volume in the last 24 hours) is now included in the [/search/trending](https://docs.coingecko.com/reference/trending-search) endpoint + * Near Protocol contract address (e.g. wrap.near) is now supported for [/coins//contract/ ](https://docs.coingecko.com/reference/coins-contract-address) endpoint @@ -2339,7 +2339,7 @@ export const GreenSeparator = () => ( 🗓️ **May 28, 2023** * Token metadata such as name, symbol, and CoinGecko ID are now returned in the responses for pools endpoints. Users will need to pass in this attribute include=base\_token, quote\_token - * CoinGecko asset platform ID added to the response for [/networks](/reference/networks-list) endpoint + * CoinGecko asset platform ID added to the response for [/networks](https://docs.coingecko.com/reference/networks-list) endpoint @@ -2347,7 +2347,7 @@ export const GreenSeparator = () => ( 🗓️ **May 22, 2023** - The [/coins//ohlc](/reference/coins-id-ohlc) endpoint now supports the "interval=daily" parameter for Paid Plan Subscribers + The [/coins//ohlc](https://docs.coingecko.com/reference/coins-id-ohlc) endpoint now supports the "interval=daily" parameter for Paid Plan Subscribers Users can use this parameter to retrieve OHLC (Open/High/Low/Close) data on a daily interval for up to 180 days of date range. @@ -2357,7 +2357,7 @@ export const GreenSeparator = () => ( 🗓️ **April 26, 2023** - We've added 'watchlist\_portfolio\_users' field to [/coins/](/reference/coins-id) endpoint responses. + We've added 'watchlist\_portfolio\_users' field to [/coins/](https://docs.coingecko.com/reference/coins-id) endpoint responses. This refers to number of users who added the coin into a watchlist or portfolio. @@ -2392,7 +2392,7 @@ export const GreenSeparator = () => ( * reserve\_in\_usd added to the pools endpoint response. This returns the total liquidity/reserve of the pool in USD * pool\_created\_at added to the pools endpoint response - Example of responses for [/networks//pools/](/reference/pool-address) : + Example of responses for [/networks//pools/](https://docs.coingecko.com/reference/pool-address) : ```json theme={null} { @@ -2424,8 +2424,8 @@ export const GreenSeparator = () => ( } ``` - * [/networks//new\_pools](/reference/latest-pools-network) endpoint added to query new pools discovered for a network - * [/networks/new\_pools](/reference/latest-pools-list) endpoint added to query new pools discovered across all networks + * [/networks//new\_pools](https://docs.coingecko.com/reference/latest-pools-network) endpoint added to query new pools discovered for a network + * [/networks/new\_pools](https://docs.coingecko.com/reference/latest-pools-list) endpoint added to query new pools discovered across all networks @@ -2435,9 +2435,9 @@ export const GreenSeparator = () => ( We've added "symbol" field to these NFT endpoints responses: - * [/nfts/markets](/reference/nfts-markets) - * [/nfts/ ](/reference/nfts-id) - * [/nfts//contract/](/reference/nfts-contract-address) + * [/nfts/markets](https://docs.coingecko.com/reference/nfts-markets) + * [/nfts/ ](https://docs.coingecko.com/reference/nfts-id) + * [/nfts//contract/](https://docs.coingecko.com/reference/nfts-contract-address) **Example of responses:** @@ -2460,8 +2460,8 @@ export const GreenSeparator = () => ( We've added "links" field (e.g. homepage, twitter, discord) to these NFT endpoints responses: - * [/nfts/](/reference/nfts-id) - * [/nfts//contract/](/reference/nfts-contract-address) + * [/nfts/](https://docs.coingecko.com/reference/nfts-id) + * [/nfts//contract/](https://docs.coingecko.com/reference/nfts-contract-address) **Example of responses:** @@ -2485,7 +2485,7 @@ export const GreenSeparator = () => ( 🗓️ **March 23, 2023** - We've added [/coins/top\_gainers\_losers](/reference/coins-top-gainers-losers) endpoint exclusively for Paid Plan Subscribers. + We've added [/coins/top\_gainers\_losers](https://docs.coingecko.com/reference/coins-top-gainers-losers) endpoint exclusively for Paid Plan Subscribers. Users can now get the top 30 coins with largest price gain and loss by a specific time duration with this endpoint. @@ -2495,7 +2495,7 @@ export const GreenSeparator = () => ( 🗓️ **March 23, 2023** - [/networks//pools//ohlcv/](/reference/pool-ohlcv-contract-address) now returns more granularity `day,` `hour`, `minute` and multiple aggregates + [/networks//pools//ohlcv/](https://docs.coingecko.com/reference/pool-ohlcv-contract-address) now returns more granularity `day,` `hour`, `minute` and multiple aggregates @@ -2505,8 +2505,8 @@ export const GreenSeparator = () => ( We've made some updates to the /coins/categories and /simple/token\_price/id endpoints: - * Market cap and volume data for 'ecosystem' categories in the [/coins/categories](/reference/coins-categories) endpoint will now return 'null' until further notice. The CoinGecko team is actively working on improvements to provide more accurate data. If you have any feedback or suggestions, please reach out via [api@coingecko.com](mailto:api@coingecko.com). - * Previously, the [/simple/token\_price/](/reference/simple-token-price) endpoint was unable to return data for some Solana coins. This issue has been resolved, and users can now expect accurate data for Solana coins from this endpoint. + * Market cap and volume data for 'ecosystem' categories in the [/coins/categories](https://docs.coingecko.com/reference/coins-categories) endpoint will now return 'null' until further notice. The CoinGecko team is actively working on improvements to provide more accurate data. If you have any feedback or suggestions, please reach out via [api@coingecko.com](mailto:api@coingecko.com). + * Previously, the [/simple/token\_price/](https://docs.coingecko.com/reference/simple-token-price) endpoint was unable to return data for some Solana coins. This issue has been resolved, and users can now expect accurate data for Solana coins from this endpoint. @@ -2514,7 +2514,7 @@ export const GreenSeparator = () => ( 🗓️ **February 15, 2023** - We've introduced the [/exchange//volume\_chart/range](/reference/exchanges-id-volume-chart-range) endpoint for Paid Plan Subscribers. + We've introduced the [/exchange//volume\_chart/range](https://docs.coingecko.com/reference/exchanges-id-volume-chart-range) endpoint for Paid Plan Subscribers. This exclusive feature allows users to query full historical volume data of an exchange. @@ -2524,7 +2524,7 @@ export const GreenSeparator = () => ( 🗓️ **January 09, 2023** - We've introduced the [/coins/list/new](/reference/coins-list-new) endpoint for Paid Plan Subscribers. + We've introduced the [/coins/list/new](https://docs.coingecko.com/reference/coins-list-new) endpoint for Paid Plan Subscribers. This exclusive feature allows users to query the latest 200 coins on CoinGecko. @@ -2539,7 +2539,7 @@ Source: https://docs.coingecko.com/docs/1-get-data-by-id-or-address ### a. Coin ID -Using [/simple/price](/reference/simple-price) endpoint as example: +Using [/simple/price](https://docs.coingecko.com/reference/simple-price) endpoint as example: * `https://pro-api.coingecko.com/api/v3/simple/price?ids=bitcoin&vs_currencies=usd&x_cg_pro_api_key=YOUR_API_KEY` @@ -2547,7 +2547,7 @@ Using [/simple/price](/reference/simple-price) endpoint as example: **How to obtain Coin ID aka API ID?** There are 3 options: -* Use [/coins/list](/reference/coins-list) endpoint, example of responses: +* Use [/coins/list](https://docs.coingecko.com/reference/coins-list) endpoint, example of responses: ```json JSON theme={null} @@ -2573,7 +2573,7 @@ Using [/simple/price](/reference/simple-price) endpoint as example: ### b. Contract Address -Other than using Coin ID, you may also query price & market data of a coin using contract address, using [/simple/token\_price/\{id](/reference/simple-token-price)} endpoint as example: +Other than using Coin ID, you may also query price & market data of a coin using contract address, using [/simple/token\_price/\{id](https://docs.coingecko.com/reference/simple-token-price)} endpoint as example: * `https://pro-api.coingecko.com/api/v3/simple/token_price/ethereum?contract_addresses=0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48&vs_currencies=usd&x_cg_pro_api_key=YOUR_API_KEY` @@ -2585,7 +2585,7 @@ There are 3 parameters values required to apply for this endpoint: **How to obtain Coins/Tokens Contract Address** -* Use [/coins/list](/reference/coins-list) endpoint (`include_platform=true`), example of responses: +* Use [/coins/list](https://docs.coingecko.com/reference/coins-list) endpoint (`include_platform=true`), example of responses: ```json JSON theme={null} [ @@ -2642,11 +2642,11 @@ CoinGecko API data supports all major fiat currencies and some famous crypto cur | Cryptocurrency | Ether | `eth` | | Cryptocurrency | Binance Coin | `bnb` | -For full list of supported currencies, please go to [/simple/supported\_vs\_currencies](/reference/simple-supported-currencies) endpoint +For full list of supported currencies, please go to [/simple/supported\_vs\_currencies](https://docs.coingecko.com/reference/simple-supported-currencies) endpoint ## Other way to obtain coin prices & market data -Using [/coins/market ](/reference/coins-markets) endpoint as example to query prices and market data of coins in bulk +Using [/coins/market ](https://docs.coingecko.com/reference/coins-markets) endpoint as example to query prices and market data of coins in bulk * `https://pro-api.coingecko.com/api/v3/coins/markets?vs_currency=usd&order=market_cap_desc&per_page=100&page=1&x_cg_pro_api_key=YOUR_API_KEY` @@ -2663,14 +2663,14 @@ Source: https://docs.coingecko.com/docs/10-mins-tutorial-guide New to CoinGecko API? Fret not. Whether you're a programmer or someone with zero coding experience, we've got you covered! -If you are not a developer and prefer to learn only specific tutorials on Google Sheet/Excel, feel free to check [👶 Tutorials (Beginner-friendly)](/docs/tutorials-beginner-friendly) +If you are not a developer and prefer to learn only specific tutorials on Google Sheet/Excel, feel free to check [👶 Tutorials (Beginner-friendly)](https://docs.coingecko.com/docs/tutorials-beginner-friendly) | Tutorial Steps | Description | | ----------------------------------------------------------------- | ------------------------------------------------------------------------------------------------ | -| [1. Get data by ID or Address](/docs/1-get-data-by-id-or-address) | Learn how to use different endpoints by obtaining Coin ID and token's contract address at first. | -| [2. Get Historical Data](/docs/2-get-historical-data) | Learn how to get historical data of a coin by using different historical endpoints. | -| [3. Get Exchanges & NFT Data](/docs/3-get-exchanges-nft-data) | Learn how to query exchanges and NFT data by accessing different endpoints. | -| [4. Get On-chain Data](/docs/4-get-on-chain-data) | Learn how to use `/onchain` GT endpoints to query onchain data. | +| [1. Get data by ID or Address](https://docs.coingecko.com/docs/1-get-data-by-id-or-address) | Learn how to use different endpoints by obtaining Coin ID and token's contract address at first. | +| [2. Get Historical Data](https://docs.coingecko.com/docs/2-get-historical-data) | Learn how to get historical data of a coin by using different historical endpoints. | +| [3. Get Exchanges & NFT Data](https://docs.coingecko.com/docs/3-get-exchanges-nft-data) | Learn how to query exchanges and NFT data by accessing different endpoints. | +| [4. Get On-chain Data](https://docs.coingecko.com/docs/4-get-on-chain-data) | Learn how to use `/onchain` GT endpoints to query onchain data. | # 2. Get Historical Data @@ -2690,16 +2690,16 @@ There are five different endpoints to get historical data of a coin: | Endpoint | Description | | ---------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- | -| [/coins/\{id}/history](/reference/coins-id-history) | Get the historical data (price, market cap, 24hrs volume, etc.) at a given date for a coin based on a particular coin ID. | -| [/coins/\{id}/market\_chart](/reference/coins-id-market-chart) | Get the historical chart data of a coin including time in UNIX, price, market cap and 24hrs volume based on particular coin ID. | -| [/coins/\{id}/market\_chart/range](/reference/coins-id-market-chart-range) | Get the historical chart data of a coin within certain time range in UNIX along with price, market cap and 24hrs volume based on particular coin ID. | -| [/coins/\{id}/contract/\{contract\_address}/market\_chart](/reference/contract-address-market-chart) | Get the historical chart data of a coin including time in UNIX, price, market cap and 24hrs volume based on token contract address. | -| [/coins/\{id}/contract/\{contract\_address}/market\_chart/range](/reference/contract-address-market-chart-range) | Get the historical chart data of a coin within certain time range in UNIX along with price, market cap and 24hrs volume based on token contract address. | +| [/coins/\{id}/history](https://docs.coingecko.com/reference/coins-id-history) | Get the historical data (price, market cap, 24hrs volume, etc.) at a given date for a coin based on a particular coin ID. | +| [/coins/\{id}/market\_chart](https://docs.coingecko.com/reference/coins-id-market-chart) | Get the historical chart data of a coin including time in UNIX, price, market cap and 24hrs volume based on particular coin ID. | +| [/coins/\{id}/market\_chart/range](https://docs.coingecko.com/reference/coins-id-market-chart-range) | Get the historical chart data of a coin within certain time range in UNIX along with price, market cap and 24hrs volume based on particular coin ID. | +| [/coins/\{id}/contract/\{contract\_address}/market\_chart](https://docs.coingecko.com/reference/contract-address-market-chart) | Get the historical chart data of a coin including time in UNIX, price, market cap and 24hrs volume based on token contract address. | +| [/coins/\{id}/contract/\{contract\_address}/market\_chart/range](https://docs.coingecko.com/reference/contract-address-market-chart-range) | Get the historical chart data of a coin within certain time range in UNIX along with price, market cap and 24hrs volume based on token contract address. | ### **Notes** - The data granularity (interval) for [/market\_chart](/reference/coins-id-market-chart) and [/market\_chart/range](/reference/coins-id-market-chart-range) endpoints is automatic and based on the date range: + The data granularity (interval) for [/market\_chart](https://docs.coingecko.com/reference/coins-id-market-chart) and [/market\_chart/range](https://docs.coingecko.com/reference/coins-id-market-chart-range) endpoints is automatic and based on the date range: * 1 day from current time = 5-minutely data * 1 day from anytime (except from current time) = hourly data @@ -2720,9 +2720,9 @@ You can get Exchange and NFT data just like how you get the coins data: | Type | Coins | NFTs | Exchanges | Derivatives | | ---------------------- | -------------------------------------------------------------- | ------------------------------------------------------------ | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | -| Get Full List with IDs | [/coins/list](/reference/coins-list) | [/nfts/list](/reference/nfts-list) | [/exchanges/list](/reference/exchanges-list) | [/derivatives/exchanges/list](/reference/derivatives-exchanges-list) | -| Get latest market data | [/coins/\{id}](/reference/coins-id) | [/nfts/\{id}](/reference/nfts-id) | [/exchanges/\{id}](/reference/exchanges-id) | [/derivatives/exchanges/\{id}](/reference/derivatives-exchanges-id) | -| Get Historical Data | [/coins/\{id}/market\_chart](/reference/coins-id-market-chart) | [/nfts/\{id}/market\_chart](/reference/nfts-id-market-chart) | [/exchanges/\{id}/volume\_chart](/reference/exchanges-id-volume-chart) | [/exchanges/\{id}/volume\_chart](/reference/exchanges-id-volume-chart) | +| Get Full List with IDs | [/coins/list](https://docs.coingecko.com/reference/coins-list) | [/nfts/list](https://docs.coingecko.com/reference/nfts-list) | [/exchanges/list](https://docs.coingecko.com/reference/exchanges-list) | [/derivatives/exchanges/list](https://docs.coingecko.com/reference/derivatives-exchanges-list) | +| Get latest market data | [/coins/\{id}](https://docs.coingecko.com/reference/coins-id) | [/nfts/\{id}](https://docs.coingecko.com/reference/nfts-id) | [/exchanges/\{id}](https://docs.coingecko.com/reference/exchanges-id) | [/derivatives/exchanges/\{id}](https://docs.coingecko.com/reference/derivatives-exchanges-id) | +| Get Historical Data | [/coins/\{id}/market\_chart](https://docs.coingecko.com/reference/coins-id-market-chart) | [/nfts/\{id}/market\_chart](https://docs.coingecko.com/reference/nfts-id-market-chart) | [/exchanges/\{id}/volume\_chart](https://docs.coingecko.com/reference/exchanges-id-volume-chart) | [/exchanges/\{id}/volume\_chart](https://docs.coingecko.com/reference/exchanges-id-volume-chart) | # 4. Get On-chain Data @@ -2752,7 +2752,7 @@ Here are some of the important parameters to take note while using Onchain DEX A **How to obtain Network ID?** -* Use [/onchain/networks](/reference/networks-list) endpoint, example of response: +* Use [/onchain/networks](https://docs.coingecko.com/reference/networks-list) endpoint, example of response: ```json JSON theme={null} @@ -2784,7 +2784,7 @@ Here are some of the important parameters to take note while using Onchain DEX A Some of the pools endpoints require you to provide DEX ID along with Network ID to query the pools on a particular DEX (Decentralized Exchange). -Using [/onchain/networks/\{network}/dexes/\{dex}/pools](/reference/top-pools-dex) as example: +Using [/onchain/networks/\{network}/dexes/\{dex}/pools](https://docs.coingecko.com/reference/top-pools-dex) as example: * `https://pro-api.coingecko.com/api/v3/onchain/networks/eth/dexes/uniswap_v3/pools?x_cg_pro_api_key=YOUR_API_KEY` @@ -2795,7 +2795,7 @@ There are 2 parameter values required to apply for this endpoint: **How to obtain DEX ID?** -* Use [/onchain/networks/\{network}/dexes](/reference/dexes-list) endpoint, example of response: +* Use [/onchain/networks/\{network}/dexes](https://docs.coingecko.com/reference/dexes-list) endpoint, example of response: ```json JSON theme={null} @@ -2830,7 +2830,7 @@ There are 2 parameter values required to apply for this endpoint: Most of the time, you will need a pool contract address along with Network ID to query the onchain data, especially when using the Pools Endpoints. -Using [/onchain/networks/\{network}/pools/\{address}](/reference/pool-address) as example: +Using [/onchain/networks/\{network}/pools/\{address}](https://docs.coingecko.com/reference/pool-address) as example: * `https://pro-api.coingecko.com/api/v3/onchain/networks/eth/pools/0xb4e16d0168e52d35cacd2c6185b44281ec28c9dc?x_cg_pro_api_key=YOUR_API_KEY` @@ -2852,7 +2852,7 @@ There are 2 parameter values required to apply for this endpoint: ### b. Token Contract Address -Apart from the pool contract address, you also have the option to query onchain data by using the token contract address, using [/onchain/networks/\{network}/tokens/\{token\_address}/pools](/reference/top-pools-contract-address) as example: +Apart from the pool contract address, you also have the option to query onchain data by using the token contract address, using [/onchain/networks/\{network}/tokens/\{token\_address}/pools](https://docs.coingecko.com/reference/top-pools-contract-address) as example: * `https://pro-api.coingecko.com/api/v3/onchain/networks/eth/tokens/0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48/pools?x_cg_pro_api_key=YOUR_API_KEY` @@ -2893,8 +2893,8 @@ Integrating these prompts into your workflow is simple. Copy the entire markdown Select the prompt that matches your project's tech stack. -* 🐍 **[Python](/docs/python-ai-prompts)**: A complete guide for implementing the CoinGecko API using our official [coingecko-sdk](https://pypi.org/project/coingecko-sdk/). -* 🟦 **[TypeScript](/docs/typescript-ai-prompts#/)**: The definitive prompt for integrating the CoinGecko API with our official [@coingecko/coingecko-typescript](https://www.npmjs.com/package/@coingecko/coingecko-typescript) package. +* 🐍 **[Python](https://docs.coingecko.com/docs/python-ai-prompts)**: A complete guide for implementing the CoinGecko API using our official [coingecko-sdk](https://pypi.org/project/coingecko-sdk/). +* 🟦 **[TypeScript](https://docs.coingecko.com/docs/typescript-ai-prompts#/)**: The definitive prompt for integrating the CoinGecko API with our official [@coingecko/coingecko-typescript](https://www.npmjs.com/package/@coingecko/coingecko-typescript) package. ## Best Practices @@ -2938,22 +2938,22 @@ Wonder how to use different endpoints together? This is the perfect place for yo **Examples:** -* [/coins/list](/reference/coins-list) — can be used to query all the supported coins on CoinGecko with names, symbols and coin IDs that can be used in other endpoints. -* [/search/trending](/reference/trending-search) — can be used to query trending search coins, categories and NFTs on CoinGecko. +* [/coins/list](https://docs.coingecko.com/reference/coins-list) — can be used to query all the supported coins on CoinGecko with names, symbols and coin IDs that can be used in other endpoints. +* [/search/trending](https://docs.coingecko.com/reference/trending-search) — can be used to query trending search coins, categories and NFTs on CoinGecko. ### "Supporting Endpoints" **Examples:** -* [/simple/supported\_vs\_currencies](/reference/simple-supported-currencies) — can be used to query the list of currencies for other endpoints that include parameters like `vs_currencies`, allowing to obtain the corresponding data for those currencies. -* [/asset\_platforms](/reference/asset-platforms-list) — can be used to query the list of asset platforms for other endpoints that contain parameters like `id` or `ids` (asset platforms), allowing the retrieval of corresponding data for these asset platforms. +* [/simple/supported\_vs\_currencies](https://docs.coingecko.com/reference/simple-supported-currencies) — can be used to query the list of currencies for other endpoints that include parameters like `vs_currencies`, allowing to obtain the corresponding data for those currencies. +* [/asset\_platforms](https://docs.coingecko.com/reference/asset-platforms-list) — can be used to query the list of asset platforms for other endpoints that contain parameters like `id` or `ids` (asset platforms), allowing the retrieval of corresponding data for these asset platforms. ### "Data Endpoints" **Examples:** -* [/simple/price](/reference/simple-price) — can be used to query the prices of coins using the unique coin IDs that can be obtained from the "Discovery/Navigational Endpoints" mentioned above. -* [/coins/\{id}](/reference/coins-id) — can be used to query the coin data using the unique coin IDs that can be obtained from the "Discovery/Navigational Endpoints" mentioned above. +* [/simple/price](https://docs.coingecko.com/reference/simple-price) — can be used to query the prices of coins using the unique coin IDs that can be obtained from the "Discovery/Navigational Endpoints" mentioned above. +* [/coins/\{id}](https://docs.coingecko.com/reference/coins-id) — can be used to query the coin data using the unique coin IDs that can be obtained from the "Discovery/Navigational Endpoints" mentioned above. ## User Journey for Onchain DEX API Endpoints (GeckoTerminal data) @@ -2963,22 +2963,22 @@ Wonder how to use different endpoints together? This is the perfect place for yo **Examples:** -* [/onchain/trending\_pools](/reference/trending-pools-list) - can be used to query trending pools across all networks on GeckoTerminal. -* [/onchain/search/pools](/reference/search-pools) - can be used to search for any pools on GeckoTerminal. +* [/onchain/trending\_pools](https://docs.coingecko.com/reference/trending-pools-list) - can be used to query trending pools across all networks on GeckoTerminal. +* [/onchain/search/pools](https://docs.coingecko.com/reference/search-pools) - can be used to search for any pools on GeckoTerminal. ### "Supporting Endpoints" **Examples:** -* [/onchain/networks-list](/reference/networks-list) - can be used to query all the supported networks on GeckoTerminal. -* [/onchain/networks/\{network}/dexes](/reference/dexes-list) - can be used to query all the supported decentralized exchanges (DEXs/`dexes`) on GeckoTerminal based on network id that can be obtained from the endpoint mentioned above. +* [/onchain/networks-list](https://docs.coingecko.com/reference/networks-list) - can be used to query all the supported networks on GeckoTerminal. +* [/onchain/networks/\{network}/dexes](https://docs.coingecko.com/reference/dexes-list) - can be used to query all the supported decentralized exchanges (DEXs/`dexes`) on GeckoTerminal based on network id that can be obtained from the endpoint mentioned above. ### "Data Endpoints" **Examples:** -* [/onchain/simple/networks/\{network}/token\_price/\{addresses}](/reference/onchain-simple-price) - can be used to query any token price using the token address and network id that can be obtained from the "Discovery/Navigational Endpoints" and "Supporting Endpoints" mentioned above. -* [/onchain/networks/\{network}/pools/\{address}](/reference/pool-address) - can be used to query the data of a specific pool based on the pool address and network id that can be obtained from the "Discovery/Navigational Endpoints" and "Supporting Endpoints" mentioned above. +* [/onchain/simple/networks/\{network}/token\_price/\{addresses}](https://docs.coingecko.com/reference/onchain-simple-price) - can be used to query any token price using the token address and network id that can be obtained from the "Discovery/Navigational Endpoints" and "Supporting Endpoints" mentioned above. +* [/onchain/networks/\{network}/pools/\{address}](https://docs.coingecko.com/reference/pool-address) - can be used to query the data of a specific pool based on the pool address and network id that can be obtained from the "Discovery/Navigational Endpoints" and "Supporting Endpoints" mentioned above. # Building with AI @@ -2990,11 +2990,11 @@ CoinGecko provides a powerful suite of AI-native tools to help you integrate rea ## Using `llms.txt` -To help AI models interact with CoinGecko data effectively, we provide an `llms.txt` file at [/llms-full.txt](/llms-full.txt). This file gives models context on how to best query our API, ensuring more accurate and efficient data retrieval. We recommend utilizing this in your integrations of MCP and AI applications. +To help AI models interact with CoinGecko data effectively, we provide an `llms.txt` file at [/llms-full.txt](https://docs.coingecko.com/llms-full.txt). This file gives models context on how to best query our API, ensuring more accurate and efficient data retrieval. We recommend utilizing this in your integrations of MCP and AI applications. ## CoinGecko MCP Server -The **MCP (Model-Context-Protocol)** Server is your gateway for connecting AI agents and large language models, like Claude and Gemini, directly to CoinGecko's live data streams. It's ideal for building conversational applications that can perform complex, real-time crypto analysis and answer user queries with up-to-the-minute information. Learn how to connect your AI agent by checking out [CoinGecko MCP Server](/docs/mcp-server) +The **MCP (Model-Context-Protocol)** Server is your gateway for connecting AI agents and large language models, like Claude and Gemini, directly to CoinGecko's live data streams. It's ideal for building conversational applications that can perform complex, real-time crypto analysis and answer user queries with up-to-the-minute information. Learn how to connect your AI agent by checking out [CoinGecko MCP Server](https://docs.coingecko.com/docs/mcp-server) ## Tools for Your Workflow @@ -3040,7 +3040,7 @@ Here are the official API SDKs maintained by us. Want us to support your favorite programming language? Let us know [here](https://forms.gle/JJLH3SXiL2eJaGzBA)! -**Not a developer?** Fred not, check our no-code tutorial for beginners here: [Tutorials (Beginner-friendly)](/docs/tutorials-beginner-friendly) +**Not a developer?** Fred not, check our no-code tutorial for beginners here: [Tutorials (Beginner-friendly)](https://docs.coingecko.com/docs/tutorials-beginner-friendly) # Common Errors & Rate Limit @@ -3090,40 +3090,40 @@ Discover the common use cases of CoinGecko API by our users ## 1. Get Coins Logo Images -* Use [/coins/id](/reference/coins-id) endpoint. +* Use [/coins/id](https://docs.coingecko.com/reference/coins-id) endpoint. * This endpoint can be used to query other coin's metadata like: links, categories, contract address, community, description in different languages and many more. * Coin descriptions may include newline characters represented as `\r\n` (escape sequences), which may require processing for proper formatting. -* Use [Token Info by Token Address](/reference/token-info-contract-address) endpoint to get metadata of tokens listed on GeckoTerminal.com. +* Use [Token Info by Token Address](https://docs.coingecko.com/reference/token-info-contract-address) endpoint to get metadata of tokens listed on GeckoTerminal.com. ## 2. Best Endpoint for Latest Crypto Price -* Use [/simple/price](/reference/simple-price) endpoint. +* Use [/simple/price](https://docs.coingecko.com/reference/simple-price) endpoint. * This endpoint can be used to query other market data like market cap, 24-hour trading volume and 24-hour price change percentage. ## 3. Get All Trading Pairs (Tickers) of a Coin -* Use [/coins/id/tickers](/reference/coins-id-tickers) endpoint. +* Use [/coins/id/tickers](https://docs.coingecko.com/reference/coins-id-tickers) endpoint. ## 4. Get Trading Pairs of Specific Coins from a Specific Exchange -* Use[ /coins/id/tickers](/reference/coins-id-tickers) endpoint by supplying specific exchange ID. +* Use[ /coins/id/tickers](https://docs.coingecko.com/reference/coins-id-tickers) endpoint by supplying specific exchange ID. ## 5. Building Telegram Bot for Latest Coin Listings -* Use [/coins/list/new](/reference/coins-list-new) endpoint. +* Use [/coins/list/new](https://docs.coingecko.com/reference/coins-list-new) endpoint. ## 6. Get List of Coins Under Specific Category -* For CoinGecko [categories](https://www.coingecko.com/en/categories), use [/coins/markets](/reference/coins-markets) endpoint by supplying specific category. -* For GeckoTerminal [categories](https://www.geckoterminal.com/category), use [Pools by Category ID](/reference/pools-category) endpoint by supplying specific category. +* For CoinGecko [categories](https://www.coingecko.com/en/categories), use [/coins/markets](https://docs.coingecko.com/reference/coins-markets) endpoint by supplying specific category. +* For GeckoTerminal [categories](https://www.geckoterminal.com/category), use [Pools by Category ID](https://docs.coingecko.com/reference/pools-category) endpoint by supplying specific category. ## 7. Identify DEX Decentralized Exchanges -* Use [/exchanges/list](/reference/exchanges-list) endpoint to get full list of exchanges with ID on CoinGecko. +* Use [/exchanges/list](https://docs.coingecko.com/reference/exchanges-list) endpoint to get full list of exchanges with ID on CoinGecko. -* Use [/exchanges/id](/reference/exchanges-id) to find out whether the exchange is centralized or decentralized. +* Use [/exchanges/id](https://docs.coingecko.com/reference/exchanges-id) to find out whether the exchange is centralized or decentralized. * Example of responses (using Uniswap V3 as example) : @@ -3144,7 +3144,7 @@ Discover the common use cases of CoinGecko API by our users ## 8. Get Bitcoin Dominance Data (BTC.D) -* Use [/global ](/reference/crypto-global)endpoint. +* Use [/global ](https://docs.coingecko.com/reference/crypto-global)endpoint. * Example of responses: @@ -3168,37 +3168,37 @@ Discover the common use cases of CoinGecko API by our users ## 9. Get Market Cap or Dominance of a Specific Ecosystem -* Use [/coins/categories](/reference/coins-categories). +* Use [/coins/categories](https://docs.coingecko.com/reference/coins-categories). * The endpoint also returns the 24-hour percentage change, offering insights into the traction of different categories or ecosystems. ## 10. Get Token Lists of a Specific Blockchain Network -* Use [/token\_lists/asset\_platforms\_id/all.json](/reference/token-lists) endpoint. +* Use [/token\_lists/asset\_platforms\_id/all.json](https://docs.coingecko.com/reference/token-lists) endpoint. * Supply asset platform id to the endpoint. ## 11. Get 7-Day Sparkline Price Data of a Coin -* Use [/coins/id](/reference/coins-id) or [/coins/markets](/reference/coins-markets) endpoints by flagging `sparkline = true`. +* Use [/coins/id](https://docs.coingecko.com/reference/coins-id) or [/coins/markets](https://docs.coingecko.com/reference/coins-markets) endpoints by flagging `sparkline = true`. ## 12. Get Link to Individual CoinGecko Coin Page -* Use [/coins/list](/reference/coins-list) endpoint to get the coin **`{ID}`**. +* Use [/coins/list](https://docs.coingecko.com/reference/coins-list) endpoint to get the coin **`{ID}`**. * Supply API ID in this URL path format: `www.coingecko.com/en/coins/{ID}` -* If you wish to the obtain the URL slug of a specific CoinGecko Coin Page, e.g. `www.coingecko.com/en/coins/{web_slug}` you may use [/coin/id](/reference/coins-id) endpoint and obtain the **`{web_slug}`** value. +* If you wish to the obtain the URL slug of a specific CoinGecko Coin Page, e.g. `www.coingecko.com/en/coins/{web_slug}` you may use [/coin/id](https://docs.coingecko.com/reference/coins-id) endpoint and obtain the **`{web_slug}`** value. ## 13. Check Coin Status and Stale Price Updates -* Active: use [/coins/list](/reference/coins-list) endpoint, only active coins will be shown by default. You may also flag **`status=inactive`** to get a list of inactive coins. -* Price Stale: use [/simple/price](/reference/simple-price) endpoint, flag `include_last_updated_at=true` to check latest update time. +* Active: use [/coins/list](https://docs.coingecko.com/reference/coins-list) endpoint, only active coins will be shown by default. You may also flag **`status=inactive`** to get a list of inactive coins. +* Price Stale: use [/simple/price](https://docs.coingecko.com/reference/simple-price) endpoint, flag `include_last_updated_at=true` to check latest update time. ## 14. Get Real-Time and Historical Exchange of BTC in USD -* Current exchange rate: use [/exchange\_rates](/reference/exchange-rates) endpoint. -* Historical exchange rate: use [/coins/id/history](/reference/coins-id-history) or [/coins/id/market\_chart](/reference/coins-id-market-chart) endpoints. +* Current exchange rate: use [/exchange\_rates](https://docs.coingecko.com/reference/exchange-rates) endpoint. +* Historical exchange rate: use [/coins/id/history](https://docs.coingecko.com/reference/coins-id-history) or [/coins/id/market\_chart](https://docs.coingecko.com/reference/coins-id-market-chart) endpoints. ## 15. Get Watchlist Portfolio Data of a Coin -* Use [/coins/id](/reference/coins-id) endpoint by supplying coin ID. +* Use [/coins/id](https://docs.coingecko.com/reference/coins-id) endpoint by supplying coin ID. * Example of responses: @@ -3218,21 +3218,21 @@ Discover the common use cases of CoinGecko API by our users **Note**: This is available for paid plan subscribers only. -* Use [/coins/list](/reference/coins-list) endpoint, specifying the status param as `inactive`. +* Use [/coins/list](https://docs.coingecko.com/reference/coins-list) endpoint, specifying the status param as `inactive`. * Example of endpoint request: `https://pro-api.coingecko.com/api/v3/coins/list?include_platform=false&status=inactive&x_cg_pro_api_key=YOUR_API_KEY` * Retrieve the coin's ID from the endpoint mentioned above and use it to access historical data via the following endpoints: - * [/coins/id/history](/reference/coins-id-history) - * [/coins/id/market\_chart](/reference/coins-id-market-chart) - * [/coins/id/market\_chart/range](/reference/coins-id-market-chart-range) - * [/coins/id/contract/contract\_address/market\_chart](/reference/contract-address-market-chart) - * [/coins/id/contract/contract\_address/market\_chart/range](/reference/contract-address-market-chart-range) + * [/coins/id/history](https://docs.coingecko.com/reference/coins-id-history) + * [/coins/id/market\_chart](https://docs.coingecko.com/reference/coins-id-market-chart) + * [/coins/id/market\_chart/range](https://docs.coingecko.com/reference/coins-id-market-chart-range) + * [/coins/id/contract/contract\_address/market\_chart](https://docs.coingecko.com/reference/contract-address-market-chart) + * [/coins/id/contract/contract\_address/market\_chart/range](https://docs.coingecko.com/reference/contract-address-market-chart-range) ## 17. Get TVL (Total Value Locked) data of a Coin -* Use [/coins/id](/reference/coins-id) endpoint by supplying coin ID. +* Use [/coins/id](https://docs.coingecko.com/reference/coins-id) endpoint by supplying coin ID. * Example of responses: @@ -3250,29 +3250,29 @@ Discover the common use cases of CoinGecko API by our users We have 2 Search endpoints: -* [/search](/reference/search-data) endpoint allows you to search for coins, categories, exchanges (markets), and NFTs listed on CoinGecko.com. You may query by name or symbol. -* [/search-pools](/reference/search-pools) endpoint allows you to search for pools listed on GeckoTerminal.com. You may query by pool contract address, token contract address, or token symbol. +* [/search](https://docs.coingecko.com/reference/search-data) endpoint allows you to search for coins, categories, exchanges (markets), and NFTs listed on CoinGecko.com. You may query by name or symbol. +* [/search-pools](https://docs.coingecko.com/reference/search-pools) endpoint allows you to search for pools listed on GeckoTerminal.com. You may query by pool contract address, token contract address, or token symbol. ## 19. Get List of Blockchain Networks supported on CoinGecko and GeckoTerminal. CoinGecko and GeckoTerminal support different sets of blockchain networks. You can use the following endpoints to find the list of supported networks and their respective IDs: -* CoinGecko: [/asset-platforms-list](/reference/asset-platforms-list) -* GeckoTerminal ([onchain endpoints](/reference/endpoint-overview#-onchain-dex-endpoints-geckoterminal)): [/networks-list](/reference/networks-list) +* CoinGecko: [/asset-platforms-list](https://docs.coingecko.com/reference/asset-platforms-list) +* GeckoTerminal ([onchain endpoints](https://docs.coingecko.com/reference/endpoint-overview#-onchain-dex-endpoints-geckoterminal)): [/networks-list](https://docs.coingecko.com/reference/networks-list) ## 20. Get Native Coin of a Blockchain Network (Asset Platform) -You may use the [/asset-platforms-list](/reference/asset-platforms-list) endpoint to obtain the native coin ID of all networks (asset platforms) listed on [www.coingecko.com](http://www.coingecko.com.). +You may use the [/asset-platforms-list](https://docs.coingecko.com/reference/asset-platforms-list) endpoint to obtain the native coin ID of all networks (asset platforms) listed on [www.coingecko.com](http://www.coingecko.com.). ## 21. Get Liquidity data of a Liquidity Pool or Token -There are multiple onchain endpoints that provide the liquidity data (`reserve_in_usd`) of a pool, for example: [Specific Pool Data by Pool Address](/reference/pool-address). You may also get liquidity data (`total_reserve_in_usd`) of a token, using endpoints like: [Token Data by Token Address](/reference/token-data-contract-address). +There are multiple onchain endpoints that provide the liquidity data (`reserve_in_usd`) of a pool, for example: [Specific Pool Data by Pool Address](https://docs.coingecko.com/reference/pool-address). You may also get liquidity data (`total_reserve_in_usd`) of a token, using endpoints like: [Token Data by Token Address](https://docs.coingecko.com/reference/token-data-contract-address). Note: `reserve_in_usd` (pool) represents the total liquidity of all tokens within a specific pool, whereas `total_reserve_in_usd` (token) refers to the total liquidity portion attributable to a specific token across all available pools. ## 22. Get list of onchain DEX pools based on specific criteria -* Use [/pools/megafilter](/reference/pools-megafilter) to retrieve data for onchain DEX pools that match a given set of filters. +* Use [/pools/megafilter](https://docs.coingecko.com/reference/pools-megafilter) to retrieve data for onchain DEX pools that match a given set of filters. * Example of use cases: @@ -3281,24 +3281,24 @@ Note: `reserve_in_usd` (pool) represents the total liquidity of all tokens withi * For more details on examples and available filters, refer to: - * [Changelog — New Megafilter Endpoint](/changelog#february-2025) + * [Changelog — New Megafilter Endpoint](https://docs.coingecko.com/changelog#february-2025) * [Live Filtering on GeckoTerminal](https://www.geckoterminal.com/) ## 23. Get List of Trending Coins * Use the following endpoints to get trending coins and pools: - * [Trending Search List](/reference/trending-search/) — Trending Coins, NFTs, Categories on CoinGecko.com, based on user searches. - * [Trending Search Pools](/reference/trending-search-pools/) — Trending Pools and Tokens on GeckoTerminal.com, based on user searches. + * [Trending Search List](https://docs.coingecko.com/reference/trending-search/) — Trending Coins, NFTs, Categories on CoinGecko.com, based on user searches. + * [Trending Search Pools](https://docs.coingecko.com/reference/trending-search-pools/) — Trending Pools and Tokens on GeckoTerminal.com, based on user searches. * Other useful endpoints: - * [Top Gainers & Losers](/reference/coins-top-gainers-losers) on CoinGecko.com, by specific time duration. - * [Trending Pools List](/reference/trending-pools-list) and [Trending Pools by Network](/reference/trending-pools-network) on GeckoTerminal.com, by specific time duration. + * [Top Gainers & Losers](https://docs.coingecko.com/reference/coins-top-gainers-losers) on CoinGecko.com, by specific time duration. + * [Trending Pools List](https://docs.coingecko.com/reference/trending-pools-list) and [Trending Pools by Network](https://docs.coingecko.com/reference/trending-pools-network) on GeckoTerminal.com, by specific time duration. ## 24. Get Security Info of Tokens -* By using [Token Info by Token Address](/reference/token-info-contract-address) endpoint, you can obtain the following security related data: +* By using [Token Info by Token Address](https://docs.coingecko.com/reference/token-info-contract-address) endpoint, you can obtain the following security related data: * GeckoTerminal Score (Pool, Transaction, Creation, Info, Holders) * Holders count and distribution percentage @@ -3306,7 +3306,7 @@ Note: `reserve_in_usd` (pool) represents the total liquidity of all tokens withi ## 25. Get Latest Token/Pool Data from Launchpad -* Use [megafilter](/reference/pools-megafilter) endpoint to retrieve latest launchpad data, by flagging `sort=pool_created_at_desc`. Learn more on [changelog](/changelog#now-supported%3A-launchpad-data-pump-fun-%26-more-%2C-granular-ohlcv%2C-and-honeypot-info). +* Use [megafilter](https://docs.coingecko.com/reference/pools-megafilter) endpoint to retrieve latest launchpad data, by flagging `sort=pool_created_at_desc`. Learn more on [changelog](https://docs.coingecko.com/changelog#now-supported%3A-launchpad-data-pump-fun-%26-more-%2C-granular-ohlcv%2C-and-honeypot-info). * **Request example (Get latest pools on Pump.fun)**: @@ -3340,38 +3340,38 @@ Discover how CoinGecko API is used at CoinGecko.com and GeckoTerminal.com -1. [/global](/reference/crypto-global) — Display global crypto data such as number of active cryptocurrencies, exchanges and etc. -2. [/search/trending](/reference/trending-search) — Display trending search coins, NFTs and categories. -3. [/coins/top\_gainers\_losers](/reference/coins-top-gainers-losers) — Display the largest gainers in 24hr. -4. [/coins/categories](/reference/coins-categories) — Display all the categories list. -5. [/coins/markets](/reference/coins-markets) — Display all the supported coins with market related data. +1. [/global](https://docs.coingecko.com/reference/crypto-global) — Display global crypto data such as number of active cryptocurrencies, exchanges and etc. +2. [/search/trending](https://docs.coingecko.com/reference/trending-search) — Display trending search coins, NFTs and categories. +3. [/coins/top\_gainers\_losers](https://docs.coingecko.com/reference/coins-top-gainers-losers) — Display the largest gainers in 24hr. +4. [/coins/categories](https://docs.coingecko.com/reference/coins-categories) — Display all the categories list. +5. [/coins/markets](https://docs.coingecko.com/reference/coins-markets) — Display all the supported coins with market related data. ### [Coin Page](https://www.coingecko.com/en/coins/bitcoin) -1. [/coins/\{id} ](/reference/coins-id)— Display all the coin data including name, price, market related data, website, explorers and etc. -2. [/simple/price](/reference/simple-price) — Display data such as latest coin price, market cap and 24hr trading volume. -3. * [/coins/\{id}/history](/reference/coins-id-history) — Display the historical price data. - * [/coins/\{id}/market\_chart](/reference/coins-id-market-chart) — Display the historical data in line chart. - * [/coins/\{id}/ohlc](/reference/coins-id-ohlc) — Display the historical data in candlestick chart. +1. [/coins/\{id} ](https://docs.coingecko.com/reference/coins-id)— Display all the coin data including name, price, market related data, website, explorers and etc. +2. [/simple/price](https://docs.coingecko.com/reference/simple-price) — Display data such as latest coin price, market cap and 24hr trading volume. +3. * [/coins/\{id}/history](https://docs.coingecko.com/reference/coins-id-history) — Display the historical price data. + * [/coins/\{id}/market\_chart](https://docs.coingecko.com/reference/coins-id-market-chart) — Display the historical data in line chart. + * [/coins/\{id}/ohlc](https://docs.coingecko.com/reference/coins-id-ohlc) — Display the historical data in candlestick chart. ### [Exchanges Page](https://www.coingecko.com/en/exchanges/hyperliquid-spot) -1. [/exchanges/\{id}](/reference/exchanges-id) — Display the exchange information such as name, type, market related data such as trading volume and etc. -2. [/exchanges/\{id}/volume\_chart](/reference/exchanges-id-volume-chart) — Display the historical volume chart data. -3. [/exchanges/\{id}/tickers](/reference/exchanges-id-tickers) — Display the exchange's tickers. +1. [/exchanges/\{id}](https://docs.coingecko.com/reference/exchanges-id) — Display the exchange information such as name, type, market related data such as trading volume and etc. +2. [/exchanges/\{id}/volume\_chart](https://docs.coingecko.com/reference/exchanges-id-volume-chart) — Display the historical volume chart data. +3. [/exchanges/\{id}/tickers](https://docs.coingecko.com/reference/exchanges-id-tickers) — Display the exchange's tickers. ### [NFTs Page](https://www.coingecko.com/en/nft/pudgy-penguins) -1. [/nfts/\{id}](/reference/nfts-id) — Display NFT data such as name, contract address, website, market related data such as floor price, market cap, volume and etc. -2. [/nfts/\{id}/market\_chart](/reference/nfts-id-market-chart) — Display the historical market data in chart. -3. [/nfts/\{id}](/reference/nfts-id) — Display the description of the NFT collection. -4. [/nfts/\{id}/tickers](/reference/nfts-id-tickers) — Display the tickers of the NFT collection on different NFT marketplace. +1. [/nfts/\{id}](https://docs.coingecko.com/reference/nfts-id) — Display NFT data such as name, contract address, website, market related data such as floor price, market cap, volume and etc. +2. [/nfts/\{id}/market\_chart](https://docs.coingecko.com/reference/nfts-id-market-chart) — Display the historical market data in chart. +3. [/nfts/\{id}](https://docs.coingecko.com/reference/nfts-id) — Display the description of the NFT collection. +4. [/nfts/\{id}/tickers](https://docs.coingecko.com/reference/nfts-id-tickers) — Display the tickers of the NFT collection on different NFT marketplace. ## GeckoTerminal @@ -3379,37 +3379,37 @@ Discover how CoinGecko API is used at CoinGecko.com and GeckoTerminal.com -1. [/onchain/search/pools ](/reference/search-pools)— Allow users to search for pools on GeckoTerminal. -2. [/onchain/networks](/reference/networks-list) — Display a list of supported networks on GeckoTerminal. -3. [/onchain/networks/trending\_pools](/reference/trending-pools-list) — Display a list of trending pools across all networks on GeckoTerminal. -4. [/onchain/networks/new\_pools](/reference/latest-pools-list) — Display all the latest pools across all networks on GeckoTerminal. -5. [/onchain/categories](/reference/categories-list) — Display all the onchain categories on GeckoTerminal. +1. [/onchain/search/pools ](https://docs.coingecko.com/reference/search-pools)— Allow users to search for pools on GeckoTerminal. +2. [/onchain/networks](https://docs.coingecko.com/reference/networks-list) — Display a list of supported networks on GeckoTerminal. +3. [/onchain/networks/trending\_pools](https://docs.coingecko.com/reference/trending-pools-list) — Display a list of trending pools across all networks on GeckoTerminal. +4. [/onchain/networks/new\_pools](https://docs.coingecko.com/reference/latest-pools-list) — Display all the latest pools across all networks on GeckoTerminal. +5. [/onchain/categories](https://docs.coingecko.com/reference/categories-list) — Display all the onchain categories on GeckoTerminal. ### [Chain Page](https://www.geckoterminal.com/eth/pools) -1. [/onchain/networks/\{network}/dexes](/reference/dexes-list) — Display all the supported dex on a network on GeckoTerminal. -2. [/onchain/networks/\{network}/trending\_pools](/reference/trending-pools-network) — Display a list of trending pools on a network on GeckoTerminal. -3. [/onchain/networks/\{network}/new\_pools](/reference/latest-pools-network) — Display a list of new pools on a network on GeckoTerminal. -4. [/onchain/networks/\{network}/pools](/reference/top-pools-network) — Display all the top pools on a network on GeckoTerminal. -5. [/onchain/categories/\{category\_id}/pools](/reference/pools-category) — Display all the pools under a specific onchain category on GeckoTerminal. +1. [/onchain/networks/\{network}/dexes](https://docs.coingecko.com/reference/dexes-list) — Display all the supported dex on a network on GeckoTerminal. +2. [/onchain/networks/\{network}/trending\_pools](https://docs.coingecko.com/reference/trending-pools-network) — Display a list of trending pools on a network on GeckoTerminal. +3. [/onchain/networks/\{network}/new\_pools](https://docs.coingecko.com/reference/latest-pools-network) — Display a list of new pools on a network on GeckoTerminal. +4. [/onchain/networks/\{network}/pools](https://docs.coingecko.com/reference/top-pools-network) — Display all the top pools on a network on GeckoTerminal. +5. [/onchain/categories/\{category\_id}/pools](https://docs.coingecko.com/reference/pools-category) — Display all the pools under a specific onchain category on GeckoTerminal. ### [Pool Page](https://www.geckoterminal.com/eth/pools/0x88e6a0c2ddd26feeb64f039a2c41296fcb3f5640) -1. * [/onchain/networks/\{network}/pools/\{address}](/reference/pool-address) — Display pool data such as price, transactions, volume and etc. - * [/onchain/networks/\{network}/pools/\{pool\_address}/info](/reference/pool-token-info-contract-address) — Display pool information such as name, symbol, image URL, description and etc. -2. [/onchain/networks/\{network}/pools/\{pool\_address}/ohlcv/\{timeframe}](/reference/pool-ohlcv-contract-address) — Display the OHLCV chart of the pool. -3. [/onchain/networks/\{network}/pools/\{pool\_address}/trades](/reference/pool-trades-contract-address) — Display the trades of the pool in the past 24 hours. +1. * [/onchain/networks/\{network}/pools/\{address}](https://docs.coingecko.com/reference/pool-address) — Display pool data such as price, transactions, volume and etc. + * [/onchain/networks/\{network}/pools/\{pool\_address}/info](https://docs.coingecko.com/reference/pool-token-info-contract-address) — Display pool information such as name, symbol, image URL, description and etc. +2. [/onchain/networks/\{network}/pools/\{pool\_address}/ohlcv/\{timeframe}](https://docs.coingecko.com/reference/pool-ohlcv-contract-address) — Display the OHLCV chart of the pool. +3. [/onchain/networks/\{network}/pools/\{pool\_address}/trades](https://docs.coingecko.com/reference/pool-trades-contract-address) — Display the trades of the pool in the past 24 hours. ### [Categories Page](https://www.geckoterminal.com/category) -1. [/onchain/categories](/reference/categories-list) — Display list of onchain categories with market data. -2. [/onchain/categories/\{id}/pools](/reference/pools-category) — Display list of pools with market data of a specific onchain category. +1. [/onchain/categories](https://docs.coingecko.com/reference/categories-list) — Display list of onchain categories with market data. +2. [/onchain/categories/\{id}/pools](https://docs.coingecko.com/reference/pools-category) — Display list of pools with market data of a specific onchain category. # CoinGecko MCP Server (Beta) @@ -3731,7 +3731,7 @@ Choosing between a Demo and Pro key for your MCP server impacts your access to d | **Rate Limit** | 30 calls/min | Starts at 500 calls/min | | **Monthly Credits** | 10,000 | Starts at 500,000 | | **Historical Data** | Past 1 year | From 2013 until now | -| **MCP Tools** | Limited access | Full access, including exclusive tools:
- [Top Gainers & Losers](/reference/coins-top-gainers-losers)
- [NFTs Collection Historical Chart](/reference/nfts-id-market-chart)
- [🔥 Megafilter for Pools](/reference/pools-megafilter)
- [Pools by Category ID](/reference/pools-category) | +| **MCP Tools** | Limited access | Full access, including exclusive tools:
- [Top Gainers & Losers](https://docs.coingecko.com/reference/coins-top-gainers-losers)
- [NFTs Collection Historical Chart](https://docs.coingecko.com/reference/nfts-id-market-chart)
- [🔥 Megafilter for Pools](https://docs.coingecko.com/reference/pools-megafilter)
- [Pools by Category ID](https://docs.coingecko.com/reference/pools-category) | 🔥 Ready to upgrade? Explore [our API plans](https://www.coingecko.com/en/api/pricing). @@ -3746,7 +3746,7 @@ For a deeper dive, read the [official documentation](https://www.stainless.com/c ## Using `llms.txt` -To help AI models interact with CoinGecko data effectively, we provide an `llms.txt` file at [/llms-full.txt](/llms-full.txt). This file gives models context on how to best query our API, ensuring more accurate and efficient data retrieval. We recommend utilizing this in your integrations. +To help AI models interact with CoinGecko data effectively, we provide an `llms.txt` file at [/llms-full.txt](https://docs.coingecko.com/llms-full.txt). This file gives models context on how to best query our API, ensuring more accurate and efficient data retrieval. We recommend utilizing this in your integrations. *** @@ -3989,8 +3989,8 @@ Source: https://docs.coingecko.com/docs/setting-up-your-api-key ## 2. Making API Request * **Root URLs:** - * Pro API: `https://pro-api.coingecko.com/api/v3/`, refer to [Pro API Authentication](/reference/authentication). - * Demo API: `https://api.coingecko.com/api/v3/`, refer to [Demo API Authentication](/v3.0.1/reference/authentication). + * Pro API: `https://pro-api.coingecko.com/api/v3/`, refer to [Pro API Authentication](https://docs.coingecko.com/reference/authentication). + * Demo API: `https://api.coingecko.com/api/v3/`, refer to [Demo API Authentication](https://docs.coingecko.com/v3.0.1/reference/authentication). * **Example using the `/ping` endpoint:** * Pro API: `https://pro-api.coingecko.com/api/v3/ping?x_cg_pro_api_key=YOUR_API_KEY` @@ -4282,7 +4282,7 @@ Some of the useful links to help you navigate while using the CoinGecko API #### Using `llms.txt` for AI use cases -* [/llms-full.txt](/llms-full.txt) +* [/llms-full.txt](https://docs.coingecko.com/llms-full.txt) #### Attributing CoinGecko Brand @@ -4401,7 +4401,7 @@ If this is your first time using the Pro API key, you can supply API Key to the 1. Header (Recommended): `x-cg-pro-api-key` 2. Query String Parameter: `x_cg_pro_api_key` -| Authentication Method | Example using [Ping](/reference/ping-server) Endpoint | +| Authentication Method | Example using [Ping](https://docs.coingecko.com/reference/ping-server) Endpoint | | ---------------------- | --------------------------------------------------------------------------------------------- | | Header (cURL) | `curl -X GET "https://pro-api.coingecko.com/api/v3/ping" -H "x-cg-pro-api-key: YOUR_API_KEY"` | | Query String Parameter | `https://pro-api.coingecko.com/api/v3/ping?x_cg_pro_api_key=YOUR_API_KEY` | @@ -4417,7 +4417,7 @@ You can now use the Pro-API key (exclusive to any paid plan subscriber) to call * When using the CG Pro API to access onchain DEX data, include the `/onchain` endpoint path in the request. -| Authentication Method | Example using [Simple Token Price](/reference/onchain-simple-price) Endpoint | +| Authentication Method | Example using [Simple Token Price](https://docs.coingecko.com/reference/onchain-simple-price) Endpoint | | ---------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | Header (cURL) | `curl -X GET "" -H "x-cg-pro-api-key: YOUR_API_KEY"` | | Query String Parameter | `https://pro-api.coingecko.com/api/v3/onchain/simple/networks/eth/token_price/0xc02aaa39b223fe8d0a0e5c4f27ead9083c756cc2?x_cg_pro_api_key=YOUR_API_KEY` | @@ -4429,7 +4429,7 @@ You can now use the Pro-API key (exclusive to any paid plan subscriber) to call * Unsuccessful Requests (Status 4xx, 5xx, etc) will not count towards credit deduction. * Regardless of the HTTP status code returned (including 4xx and 5xx errors), all API requests will count towards your **minute rate limit**. * Your monthly credit & rate limit are determined by the paid plan to which you subscribe. For more details, please refer to this [page](https://www.coingecko.com/en/api/pricing). -* To check the API usage, please go to the [developer dashboard](https://www.coingecko.com/en/developers/dashboard) or follow the guide [here](/reference/setting-up-your-api-key#4-api-usage-report) +* To check the API usage, please go to the [developer dashboard](https://www.coingecko.com/en/developers/dashboard) or follow the guide [here](https://docs.coingecko.com/reference/setting-up-your-api-key#4-api-usage-report) # 💼 Categories List @@ -4441,8 +4441,8 @@ This endpoint allows you to **query all the supported categories on GeckoTermina ### Tips - * You can retrieve pools or tokens of a specific category with this endpoint: [Pools by Category ID](/reference/pools-category). - * GeckoTerminal categories are different from [CoinGecko categories](/reference/coins-categories-list). + * You can retrieve pools or tokens of a specific category with this endpoint: [Pools by Category ID](https://docs.coingecko.com/reference/pools-category). + * GeckoTerminal categories are different from [CoinGecko categories](https://docs.coingecko.com/reference/coins-categories-list). @@ -4466,7 +4466,7 @@ This endpoint allows you to **query all the coins categories with market data (m * CoinGecko Equivalent Page: [https://www.coingecko.com/en/categories](https://www.coingecko.com/en/categories). * Cache / Update Frequency: every 5 minutes for all the API plans. - * CoinGecko categories are different from [GeckoTerminal categories](/reference/categories-list). + * CoinGecko categories are different from [GeckoTerminal categories](https://docs.coingecko.com/reference/categories-list). @@ -4487,7 +4487,7 @@ This endpoint allows you to **query all the coins categories on CoinGecko** * CoinGecko Equivalent Page: [https://www.coingecko.com/en/categories](https://www.coingecko.com/en/categories). * Cache / Update Frequency: every 5 minutes for all the API plans. - * CoinGecko categories are different from [GeckoTerminal categories](/reference/categories-list). + * CoinGecko categories are different from [GeckoTerminal categories](https://docs.coingecko.com/reference/categories-list). @@ -4500,7 +4500,7 @@ This endpoint allows you to **query all the metadata (image, websites, socials, ### Notice - * Please note that the `twitter_followers` data field will no longer be supported by our API starting on May 15, 2025. Please refer to [changelog](/changelog#upcoming-change-notice%3A-removal-of-twitter-followers-data) for more details. + * Please note that the `twitter_followers` data field will no longer be supported by our API starting on May 15, 2025. Please refer to [changelog](https://docs.coingecko.com/changelog#upcoming-change-notice%3A-removal-of-twitter-followers-data) for more details. @@ -4508,7 +4508,7 @@ This endpoint allows you to **query all the metadata (image, websites, socials, * You may obtain the asset platform and contract address via several ways: * refers to respective coin page and find 'contract address'. - * refers to [`/coins/list`](/reference/coins-list) endpoint (`include platform = true`). + * refers to [`/coins/list`](https://docs.coingecko.com/reference/coins-list) endpoint (`include platform = true`). @@ -4530,7 +4530,7 @@ This endpoint allows you to **query all the metadata (image, websites, socials, * You may obtain the coin `id` (API ID) via several ways: * refers to respective coin page and find "API ID". - * refers to [`/coins/list`](/reference/coins-list) endpoint. + * refers to [`/coins/list`](https://docs.coingecko.com/reference/coins-list) endpoint. * refers to Google Sheets [here](https://docs.google.com/spreadsheets/d/1wTTuxXt8n9q7C4NDXqQpI3wpKu1_5bGVmP9Xz0XGSyU/edit?usp=sharing). * You may also flag to include more data such as tickers, market data, community data, developer data and sparkline. * You may refer to `last_updated` in the endpoint response to check whether the price is stale. @@ -4539,7 +4539,7 @@ This endpoint allows you to **query all the metadata (image, websites, socials, ### Note - * Tickers are limited to 100 items, to get more tickers, please go to [/coins/{id}/tickers](/reference/coins-id-tickers). + * Tickers are limited to 100 items, to get more tickers, please go to [/coins/{id}/tickers](https://docs.coingecko.com/reference/coins-id-tickers). * Coin descriptions may include newline characters represented as `\r\n` (escape sequences), which may require processing for proper formatting. * When `dex_pair_format=symbol`, the DEX pair `base` and `target` are displayed in symbol format (e.g. `WETH`, `USDC`) instead of as contract addresses. * Cache/Update Frequency: @@ -4606,7 +4606,7 @@ This endpoint allows you to **query the historical data (price, market cap, 24hr * You may obtain the coin ID (API ID) via several ways: * refers to respective coin page and find 'API ID'. - * refers to [`/coins/list`](/reference/coins-list) endpoint. + * refers to [`/coins/list`](https://docs.coingecko.com/reference/coins-list) endpoint. * refers to google sheets [here](https://docs.google.com/spreadsheets/d/1wTTuxXt8n9q7C4NDXqQpI3wpKu1_5bGVmP9Xz0XGSyU/edit?usp=sharing). @@ -4629,7 +4629,7 @@ This endpoint allows you to **get the historical chart data of a coin including * You may obtain the coin ID (API ID) via several ways: * refers to respective coin page and find 'API ID'. - * refers to [`/coins/list`](/reference/coins-list) endpoint. + * refers to [`/coins/list`](https://docs.coingecko.com/reference/coins-list) endpoint. * refers to google sheets [here](https://docs.google.com/spreadsheets/d/1wTTuxXt8n9q7C4NDXqQpI3wpKu1_5bGVmP9Xz0XGSyU/edit?usp=sharing). * You may use tools like [epoch converter ](https://www.epochconverter.com) to convert human readable date to UNIX timestamp. @@ -4662,7 +4662,7 @@ This endpoint allows you to **get the historical chart data of a coin within cer * You may obtain the coin ID (API ID) via several ways: * refers to respective coin page and find 'API ID'. - * refers to [`/coins/list`](/reference/coins-list) endpoint. + * refers to [`/coins/list`](https://docs.coingecko.com/reference/coins-list) endpoint. * refers to google sheets [here](https://docs.google.com/spreadsheets/d/1wTTuxXt8n9q7C4NDXqQpI3wpKu1_5bGVmP9Xz0XGSyU/edit?usp=sharing). * Supports ISO date strings (`YYYY-MM-DD` or\ `YYYY-MM-DDTHH:MM`, recommended for best compatibility) or UNIX timestamps. @@ -4703,9 +4703,9 @@ This endpoint allows you to **get the OHLC chart (Open, High, Low, Close) of a c * You may obtain the coin ID (API ID) via several ways: * refers to respective coin page and find 'API ID'. - * refers to [`/coins/list`](/reference/coins-list) endpoint. + * refers to [`/coins/list`](https://docs.coingecko.com/reference/coins-list) endpoint. * refers to Google Sheets [here](https://docs.google.com/spreadsheets/d/1wTTuxXt8n9q7C4NDXqQpI3wpKu1_5bGVmP9Xz0XGSyU/edit?usp=sharing). - * For historical chart data with better granularity, you may consider using [/coins/\{id}/market\_chart](/reference/coins-id-market-chart) endpoint. + * For historical chart data with better granularity, you may consider using [/coins/\{id}/market\_chart](https://docs.coingecko.com/reference/coins-id-market-chart) endpoint. @@ -4736,9 +4736,9 @@ This endpoint allows you to **get the OHLC chart (Open, High, Low, Close) of a c * You may obtain the coin ID (API ID) via several ways: * refers to respective coin page and find 'API ID'. - * refers to [`/coins/list`](/reference/coins-list) endpoint. + * refers to [`/coins/list`](https://docs.coingecko.com/reference/coins-list) endpoint. * refers to google sheets [here](https://docs.google.com/spreadsheets/d/1wTTuxXt8n9q7C4NDXqQpI3wpKu1_5bGVmP9Xz0XGSyU/edit?usp=sharing). - * For historical chart data with better granularity, you may consider using [/coins/{`id`}/market\_chart](/reference/coins-id-market-chart) endpoint. + * For historical chart data with better granularity, you may consider using [/coins/{`id`}/market\_chart](https://docs.coingecko.com/reference/coins-id-market-chart) endpoint. * Supports ISO date strings (`YYYY-MM-DD` or\ `YYYY-MM-DDTHH:MM`, recommended for best compatibility) or UNIX timestamps. @@ -4771,7 +4771,7 @@ This endpoint allows you to **query the coin tickers on both centralized exchang * You may obtain the coin ID (API ID) via several ways: * refers to respective coin page and find 'API ID'. - * refers to [`/coins/list`](/reference/coins-list) endpoint. + * refers to [`/coins/list`](https://docs.coingecko.com/reference/coins-list) endpoint. * refers to google sheets [here](https://docs.google.com/spreadsheets/d/1wTTuxXt8n9q7C4NDXqQpI3wpKu1_5bGVmP9Xz0XGSyU/edit?usp=sharing). * You may specify the `exchange_ids` if you want to retrieve tickers for specific exchange only. * You may include values such as `page` to specify which page of responses you would like to show. @@ -4842,7 +4842,7 @@ This endpoint allows you to **query all the supported coins on CoinGecko with co ### Tips * You may use this endpoint to query the list of coins with coin id for other endpoints that contain params like `id` or `ids` (coin ID). - * By default, this endpoint returns full list of active coins that are currently listed on CoinGecko.com , you can also flag `status=inactive` to retrieve coins that are no longer available on CoinGecko.com . The inactive coin IDs can also be used with [selected historical data](/changelog#april-2024) endpoints. + * By default, this endpoint returns full list of active coins that are currently listed on CoinGecko.com , you can also flag `status=inactive` to retrieve coins that are no longer available on CoinGecko.com . The inactive coin IDs can also be used with [selected historical data](https://docs.coingecko.com/changelog#april-2024) endpoints. @@ -4878,7 +4878,7 @@ This endpoint allows you to **query all the supported coins with price, market c ### Tips * You can retrieve specific coins using their unique `ids`, `names`, or `symbols` instead of returning the whole list. - * To filter results based on the coin's category, use the `category` param (refer to [`/coins/categories/list`](/reference/coins-categories-list) for available categories). + * To filter results based on the coin's category, use the `category` param (refer to [`/coins/categories/list`](https://docs.coingecko.com/reference/coins-categories-list) for available categories). * Use the `per_page` and `page` params to manage the number of results you receive and navigate through the data. @@ -4935,7 +4935,7 @@ This endpoint allows you to **get the historical chart data including time in UN * You may obtain the asset platform and contract address via several ways: * refers to respective coin page and find 'contract address'. - * refers to [`/coins/list`](/reference/coins-list) endpoint (`include platform = true`). + * refers to [`/coins/list`](https://docs.coingecko.com/reference/coins-list) endpoint (`include platform = true`). @@ -4966,7 +4966,7 @@ This endpoint allows you to **get the historical chart data within certain time * You may obtain the asset platform and contract address via several ways: * refers to respective coin page and find 'contract address'. - * refers to [`/coins/list`](/reference/coins-list) endpoint (`include platform = true`). + * refers to [`/coins/list`](https://docs.coingecko.com/reference/coins-list) endpoint (`include platform = true`). * Supports ISO date strings (`YYYY-MM-DD` or\ `YYYY-MM-DDTHH:MM`, recommended for best compatibility) or UNIX timestamps. @@ -5115,112 +5115,112 @@ Source: https://docs.coingecko.com/reference/endpoint-overview | Endpoint | Description | | ------------------------------------------------------------------------------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| [/ping](/reference/ping-server) | Check the API server status | -| 💼 [/key](/reference/api-usage) | Check account's API usage | -| [/simple/price](/reference/simple-price) | Query the prices of one or more coins by using their unique Coin API IDs | -| [/simple/token\_price/\{id}](/reference/simple-token-price) | Query the prices of one or more coins by using their unique Coin API IDs | -| [/simple/supported\_vs\_currencies](/reference/simple-supported-currencies) | Query all the supported currencies on CoinGecko | -| [/coins/list](/reference/coins-list) | Query all the supported coins on CoinGecko with coins ID, name and symbol | -| [/coins/markets](/reference/coins-markets) | Query all the supported coins with price, market cap, volume and market related data | -| [/coins/\{id}](/reference/coins-id) | Query all the metadata (image, websites, socials, description, contract address, etc.) from the CoinGecko coin page based on a particular coin ID | -| [/coins/\{id}/tickers](/reference/coins-id-tickers) | Query the coin tickers on both centralized exchange (CEX) and decentralized exchange (DEX) based on a particular coin ID | -| [/coins/\{id}/history](/reference/coins-id-history) | Query the historical data (price, market cap, 24hr volume, ...) at a given date for a coin based on a particular coin ID | -| [/coins/\{id}/market\_chart](/reference/coins-id-market-chart) | Get the historical chart data of a coin including time in UNIX, price, market cap and 24hr volume based on particular coin ID | -| [/coins/\{id}/market\_chart/range](/reference/coins-id-market-chart-range) | Get the historical chart data of a coin within certain time range in UNIX along with price, market cap and 24hr volume based on particular coin ID | -| [/coins-id-ohlc](/reference/coins-id-ohlc) | Get the OHLC chart (Open, High, Low, Close) of a coin based on particular coin ID | -| 💼 [/coins/\{id}/ohlc/range](/reference/coins-id-ohlc-range) | Get the OHLC chart (Open, High, Low, Close) of a coin within a range of timestamp based on particular coin ID | -| 💼 [/coins/top\_gainers\_losers](/reference/coins-top-gainers-losers) | Query the top 30 coins with largest price gain and loss by a specific time duration | -| 💼 [/coins/list/new](/reference/coins-list-new) | Query the latest 200 coins that recently listed on CoinGecko | -| 👑 [/coins/\{id}/circulating\_supply\_chart](/reference/coins-id-circulating-supply-chart) | Query historical circulating supply of a coin by number of days away from now based on provided coin ID | -| 👑 [/coins/\{id}/circulating\_supply\_chart/range](/reference/coins-id-circulating-supply-chart-range) | Query historical circulating supply of a coin, within a range of timestamp based on the provided coin ID | -| 👑 [/coins/\{id}/total\_supply\_chart](/reference/coins-id-total-supply-chart) | Query historical total supply of a coin by number of days away from now based on provided coin ID | -| 👑 [/coins/\{id}/total\_supply\_chart/range](/reference/coins-id-total-supply-chart-range) | Query historical total supply of a coin, within a range of timestamp based on the provided coin ID | -| [/coins/../contract/..](/reference/coins-contract-address) | Query all the metadata (image, websites, socials, description, contract address, etc.) from the CoinGecko coin page based on an asset platform and a particular token contract address | -| [/coins/../contract/../market\_chart](/reference/contract-address-market-chart) | Get the historical chart data including time in UNIX, price, market cap and 24hr volume based on asset platform and particular token contract address | -| [/coins/../contract/../market\_chart/range](/reference/contract-address-market-chart-range) | Get the historical chart data within certain time range in UNIX along with price, market cap and 24hr volume based on asset platform and particular token contract address | -| [/coins/categories/list](/reference/coins-categories-list) | Query all the coins categories on CoinGecko | -| [/coins/categories](/reference/coins-categories) | Query all the coins categories with market data (market cap, volume, ...) on CoinGecko | +| [/ping](https://docs.coingecko.com/reference/ping-server) | Check the API server status | +| 💼 [/key](https://docs.coingecko.com/reference/api-usage) | Check account's API usage | +| [/simple/price](https://docs.coingecko.com/reference/simple-price) | Query the prices of one or more coins by using their unique Coin API IDs | +| [/simple/token\_price/\{id}](https://docs.coingecko.com/reference/simple-token-price) | Query the prices of one or more coins by using their unique Coin API IDs | +| [/simple/supported\_vs\_currencies](https://docs.coingecko.com/reference/simple-supported-currencies) | Query all the supported currencies on CoinGecko | +| [/coins/list](https://docs.coingecko.com/reference/coins-list) | Query all the supported coins on CoinGecko with coins ID, name and symbol | +| [/coins/markets](https://docs.coingecko.com/reference/coins-markets) | Query all the supported coins with price, market cap, volume and market related data | +| [/coins/\{id}](https://docs.coingecko.com/reference/coins-id) | Query all the metadata (image, websites, socials, description, contract address, etc.) from the CoinGecko coin page based on a particular coin ID | +| [/coins/\{id}/tickers](https://docs.coingecko.com/reference/coins-id-tickers) | Query the coin tickers on both centralized exchange (CEX) and decentralized exchange (DEX) based on a particular coin ID | +| [/coins/\{id}/history](https://docs.coingecko.com/reference/coins-id-history) | Query the historical data (price, market cap, 24hr volume, ...) at a given date for a coin based on a particular coin ID | +| [/coins/\{id}/market\_chart](https://docs.coingecko.com/reference/coins-id-market-chart) | Get the historical chart data of a coin including time in UNIX, price, market cap and 24hr volume based on particular coin ID | +| [/coins/\{id}/market\_chart/range](https://docs.coingecko.com/reference/coins-id-market-chart-range) | Get the historical chart data of a coin within certain time range in UNIX along with price, market cap and 24hr volume based on particular coin ID | +| [/coins-id-ohlc](https://docs.coingecko.com/reference/coins-id-ohlc) | Get the OHLC chart (Open, High, Low, Close) of a coin based on particular coin ID | +| 💼 [/coins/\{id}/ohlc/range](https://docs.coingecko.com/reference/coins-id-ohlc-range) | Get the OHLC chart (Open, High, Low, Close) of a coin within a range of timestamp based on particular coin ID | +| 💼 [/coins/top\_gainers\_losers](https://docs.coingecko.com/reference/coins-top-gainers-losers) | Query the top 30 coins with largest price gain and loss by a specific time duration | +| 💼 [/coins/list/new](https://docs.coingecko.com/reference/coins-list-new) | Query the latest 200 coins that recently listed on CoinGecko | +| 👑 [/coins/\{id}/circulating\_supply\_chart](https://docs.coingecko.com/reference/coins-id-circulating-supply-chart) | Query historical circulating supply of a coin by number of days away from now based on provided coin ID | +| 👑 [/coins/\{id}/circulating\_supply\_chart/range](https://docs.coingecko.com/reference/coins-id-circulating-supply-chart-range) | Query historical circulating supply of a coin, within a range of timestamp based on the provided coin ID | +| 👑 [/coins/\{id}/total\_supply\_chart](https://docs.coingecko.com/reference/coins-id-total-supply-chart) | Query historical total supply of a coin by number of days away from now based on provided coin ID | +| 👑 [/coins/\{id}/total\_supply\_chart/range](https://docs.coingecko.com/reference/coins-id-total-supply-chart-range) | Query historical total supply of a coin, within a range of timestamp based on the provided coin ID | +| [/coins/../contract/..](https://docs.coingecko.com/reference/coins-contract-address) | Query all the metadata (image, websites, socials, description, contract address, etc.) from the CoinGecko coin page based on an asset platform and a particular token contract address | +| [/coins/../contract/../market\_chart](https://docs.coingecko.com/reference/contract-address-market-chart) | Get the historical chart data including time in UNIX, price, market cap and 24hr volume based on asset platform and particular token contract address | +| [/coins/../contract/../market\_chart/range](https://docs.coingecko.com/reference/contract-address-market-chart-range) | Get the historical chart data within certain time range in UNIX along with price, market cap and 24hr volume based on asset platform and particular token contract address | +| [/coins/categories/list](https://docs.coingecko.com/reference/coins-categories-list) | Query all the coins categories on CoinGecko | +| [/coins/categories](https://docs.coingecko.com/reference/coins-categories) | Query all the coins categories with market data (market cap, volume, ...) on CoinGecko | ## CoinGecko Endpoints: NFT | Endpoint | Description | | -------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| [/nfts/list](/reference/nfts-list) | Query all supported NFTs with ID, contract address, name, asset platform ID and symbol on CoinGecko | -| [/nfts/..](/reference/nfts-id) | Query all the NFT data (name, floor price, 24hr volume, ...) based on the NFT collection ID | -| [/nfts/../contract/..](/reference/nfts-contract-address) | Query all the NFT data (name, floor price, 24hr volume, ...) based on the NFT collection contract address and respective asset platform | -| 💼 [/nfts/markets](/reference/nfts-markets) | Query all the supported NFT collections with floor price, market cap, volume and market related data on CoinGecko | -| 💼 [/nfts/../market\_chart](/reference/nfts-id-market-chart) | Query historical market data of a NFT collection, including floor price, market cap, and 24hr volume, by number of days away from now | -| 💼 [/nfts/../contract/../market\_chart](/reference/nfts-contract-address-market-chart) | Query historical market data of a NFT collection, including floor price, market cap, and 24hr volume, by number of days away from now based on the provided contract address | -| 💼 [/nfts/../tickers](/reference/nfts-id-tickers) | Query the latest floor price and 24hr volume of a NFT collection, on each NFT marketplace, e.g. OpenSea and LooksRare | +| [/nfts/list](https://docs.coingecko.com/reference/nfts-list) | Query all supported NFTs with ID, contract address, name, asset platform ID and symbol on CoinGecko | +| [/nfts/..](https://docs.coingecko.com/reference/nfts-id) | Query all the NFT data (name, floor price, 24hr volume, ...) based on the NFT collection ID | +| [/nfts/../contract/..](https://docs.coingecko.com/reference/nfts-contract-address) | Query all the NFT data (name, floor price, 24hr volume, ...) based on the NFT collection contract address and respective asset platform | +| 💼 [/nfts/markets](https://docs.coingecko.com/reference/nfts-markets) | Query all the supported NFT collections with floor price, market cap, volume and market related data on CoinGecko | +| 💼 [/nfts/../market\_chart](https://docs.coingecko.com/reference/nfts-id-market-chart) | Query historical market data of a NFT collection, including floor price, market cap, and 24hr volume, by number of days away from now | +| 💼 [/nfts/../contract/../market\_chart](https://docs.coingecko.com/reference/nfts-contract-address-market-chart) | Query historical market data of a NFT collection, including floor price, market cap, and 24hr volume, by number of days away from now based on the provided contract address | +| 💼 [/nfts/../tickers](https://docs.coingecko.com/reference/nfts-id-tickers) | Query the latest floor price and 24hr volume of a NFT collection, on each NFT marketplace, e.g. OpenSea and LooksRare | ## CoinGecko Endpoints: Exchanges & Derivatives | Endpoint | Description | | ------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | -| [/exchanges](/reference/exchanges) | Query all the supported exchanges with exchanges' data (ID, name, country, ...) that have active trading volumes on CoinGecko | -| [/exchanges/list](/reference/exchanges-list) | Query all the exchanges with ID and name | -| [/exchanges/\{id}](/reference/exchanges-id) | Query exchange's data (name, year established, country, ...), exchange volume in BTC and tickers based on exchange's ID | -| [/exchanges/\{id}/tickers](/reference/exchanges-id-tickers) | Query exchange's tickers based on exchange's ID | -| [/exchanges/\{id}/volume\_chart](/reference/exchanges-id-volume-chart) | Query the historical volume chart data with time in UNIX and trading volume data in BTC based on exchange's ID | -| 💼 [/exchanges/\{id}/volume\_chart/range](/reference/exchanges-id-volume-chart-range) | Query the historical volume chart data in BTC by specifying date range in UNIX based on exchange's ID | -| [/derivatives](/reference/derivatives-tickers) | Query all the tickers from derivatives exchanges on CoinGecko | -| [/derivatives/exchanges](/reference/derivatives-exchanges) | Query all the derivatives exchanges with related data (ID, name, open interest, ...) on CoinGecko | -| [/derivatives/exchanges/\{id}](/reference/derivatives-exchanges-id) | Query the derivatives exchange's related data (ID, name, open interest, ...) based on the exchanges' ID | -| [/derivatives/exchanges/list](/reference/derivatives-exchanges-list) | Query all the derivatives exchanges with ID and name on CoinGecko | +| [/exchanges](https://docs.coingecko.com/reference/exchanges) | Query all the supported exchanges with exchanges' data (ID, name, country, ...) that have active trading volumes on CoinGecko | +| [/exchanges/list](https://docs.coingecko.com/reference/exchanges-list) | Query all the exchanges with ID and name | +| [/exchanges/\{id}](https://docs.coingecko.com/reference/exchanges-id) | Query exchange's data (name, year established, country, ...), exchange volume in BTC and tickers based on exchange's ID | +| [/exchanges/\{id}/tickers](https://docs.coingecko.com/reference/exchanges-id-tickers) | Query exchange's tickers based on exchange's ID | +| [/exchanges/\{id}/volume\_chart](https://docs.coingecko.com/reference/exchanges-id-volume-chart) | Query the historical volume chart data with time in UNIX and trading volume data in BTC based on exchange's ID | +| 💼 [/exchanges/\{id}/volume\_chart/range](https://docs.coingecko.com/reference/exchanges-id-volume-chart-range) | Query the historical volume chart data in BTC by specifying date range in UNIX based on exchange's ID | +| [/derivatives](https://docs.coingecko.com/reference/derivatives-tickers) | Query all the tickers from derivatives exchanges on CoinGecko | +| [/derivatives/exchanges](https://docs.coingecko.com/reference/derivatives-exchanges) | Query all the derivatives exchanges with related data (ID, name, open interest, ...) on CoinGecko | +| [/derivatives/exchanges/\{id}](https://docs.coingecko.com/reference/derivatives-exchanges-id) | Query the derivatives exchange's related data (ID, name, open interest, ...) based on the exchanges' ID | +| [/derivatives/exchanges/list](https://docs.coingecko.com/reference/derivatives-exchanges-list) | Query all the derivatives exchanges with ID and name on CoinGecko | ## CoinGecko Endpoints: Public Treasuries | Endpoint | Description | | ------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | -| [/\{entity}/public\_treasury/\{coin\_id}](/reference/companies-public-treasury) | Query public companies & governments' cryptocurrency holdings by coin ID | -| [/public\_treasury/\{entity\_id}](/reference/public-treasury-entity) | Query public companies & governments' cryptocurrency holdings by entity ID | -| [/entities/list](/reference/entities-list) | Query all the supported entities on CoinGecko with entities ID, name, symbol, and country | +| [/\{entity}/public\_treasury/\{coin\_id}](https://docs.coingecko.com/reference/companies-public-treasury) | Query public companies & governments' cryptocurrency holdings by coin ID | +| [/public\_treasury/\{entity\_id}](https://docs.coingecko.com/reference/public-treasury-entity) | Query public companies & governments' cryptocurrency holdings by entity ID | +| [/entities/list](https://docs.coingecko.com/reference/entities-list) | Query all the supported entities on CoinGecko with entities ID, name, symbol, and country | ## CoinGecko Endpoints: General | Endpoint | Description | | ----------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------ | -| [/exchange\_rates](/reference/exchange-rates) | Query BTC exchange rates with other currencies | -| [/asset\_platforms](/reference/asset-platforms-list) | Query all the asset platforms (blockchain networks) on CoinGecko | -| [/token\_lists/\{asset\_platform\_id}/all.json](/reference/token-lists) | Get full list of tokens of a blockchain network (asset platform) that is supported by Ethereum token list standard | -| [/search](/reference/search-data) | Search for coins, categories and markets listed on CoinGecko | -| [/search/trending](/reference/trending-search) | Query trending search coins, NFTs and categories on CoinGecko in the last 24 hours | -| [/global](/reference/crypto-global) | Query cryptocurrency global data including active cryptocurrencies, markets, total crypto market cap and etc. | -| [/global/decentralized\_finance\_defi](/reference/global-defi) | Query cryptocurrency global decentralized finance (DeFi) data including DeFi market cap, trading volume | -| 💼 [/global/market\_cap\_chart](/reference/global-market-cap-chart) | Query historical global market cap and volume data by number of days away from now | +| [/exchange\_rates](https://docs.coingecko.com/reference/exchange-rates) | Query BTC exchange rates with other currencies | +| [/asset\_platforms](https://docs.coingecko.com/reference/asset-platforms-list) | Query all the asset platforms (blockchain networks) on CoinGecko | +| [/token\_lists/\{asset\_platform\_id}/all.json](https://docs.coingecko.com/reference/token-lists) | Get full list of tokens of a blockchain network (asset platform) that is supported by Ethereum token list standard | +| [/search](https://docs.coingecko.com/reference/search-data) | Search for coins, categories and markets listed on CoinGecko | +| [/search/trending](https://docs.coingecko.com/reference/trending-search) | Query trending search coins, NFTs and categories on CoinGecko in the last 24 hours | +| [/global](https://docs.coingecko.com/reference/crypto-global) | Query cryptocurrency global data including active cryptocurrencies, markets, total crypto market cap and etc. | +| [/global/decentralized\_finance\_defi](https://docs.coingecko.com/reference/global-defi) | Query cryptocurrency global decentralized finance (DeFi) data including DeFi market cap, trading volume | +| 💼 [/global/market\_cap\_chart](https://docs.coingecko.com/reference/global-market-cap-chart) | Query historical global market cap and volume data by number of days away from now | ## Onchain DEX Endpoints (GeckoTerminal) | Endpoint | Description | | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| [/onchain/simple/networks/../token\_price/..](/reference/onchain-simple-price) | Get token price based on the provided token contract address on a network | -| [/onchain/networks](/reference/networks-list) | Query all the supported networks on GeckoTerminal | -| [/onchain/networks/../dexes](/reference/dexes-list) | Query all the supported decentralized exchanges (DEXs) based on the provided network on GeckoTerminal | -| [/onchain/networks/trending\_pools](/reference/trending-pools-list) | Query all the trending pools across all networks on GeckoTerminal | -| [/onchain/networks/../trending\_pools](/reference/trending-pools-network) | Query the trending pools based on the provided network | -| [/onchain/networks/../pools/..](/reference/pool-address) | Query the specific pool based on the provided network and pool address | -| [/onchain/networks/../pools/multi/..](/reference/pools-addresses) | Query multiple pools based on the provided network and pool address | -| [/onchain/networks/../pools](/reference/top-pools-network) | Query all the top pools based on the provided network | -| [/onchain/networks/../dexes/../pools](/reference/top-pools-dex) | Query all the top pools based on the provided network and decentralized exchange (DEX) | -| [/onchain/networks/../new\_pools](/reference/latest-pools-network) | Query all the latest pools based on provided network | -| [/onchain/networks/new\_pools](/reference/latest-pools-list) | Query all the latest pools across all networks on GeckoTerminal | -| 🔥 💼 [/onchain/pools/megafilter](/reference/pools-megafilter) | Query pools based on various filters across all networks on GeckoTerminal | -| [/onchain/search/pools](/reference/search-pools) | Search for pools on a network | -| 💼 [/onchain/pools/trending\_search](/reference/trending-search-pools) | Query all the trending search pools across all networks on GeckoTerminal | -| [/onchain/networks/../tokens/../pools](/reference/top-pools-contract-address) | Query top pools based on the provided token contract address on a network | -| [/onchain/networks/../tokens/..](/reference/token-data-contract-address) | Query specific token data based on the provided token contract address on a network | -| [/onchain/networks/../tokens/multi/..](/reference/tokens-data-contract-addresses) | Query multiple tokens data based on the provided token contract addresses on a network | -| [/onchain/networks/../tokens/../info](/reference/token-info-contract-address) | Query token metadata (name, symbol, CoinGecko ID, image, socials, websites, description, etc.) based on a provided token contract address on a network | -| [/onchain/networks/../pools/../info](/reference/pool-token-info-contract-address) | Query pool metadata (base and quote token details, image, socials, websites, description, contract address, etc.) based on a provided pool contract address on a network | -| [/onchain/tokens/info\_recently\_updated](/reference/tokens-info-recent-updated) | Query 100 most recently updated tokens info across all networks on GeckoTerminal | -| 💼 [/onchain/networks/../tokens/../top\_holders](/reference/top-token-holders-token-address) | Query top token holders based on the provided token contract address on a network | -| 💼 [/onchain/networks/../tokens/../holders\_chart](/reference/token-holders-chart-token-address) | Get the historical token holders chart based on the provided token contract address on a network | -| [/onchain/networks/../pools/../ohlcv/..](/reference/pool-ohlcv-contract-address) | Get the OHLCV chart (Open, High, Low, Close, Volume) of a pool based on the provided pool address on a network | -| 💼 [/onchain/networks/../tokens/../ohlcv/..](/reference/token-ohlcv-token-address) | Get the OHLCV chart (Open, High, Low, Close, Volume) of a token based on the provided token address on a network | -| [/onchain/networks/../pools/../trades](/reference/pool-trades-contract-address) | Query the last 300 trades in the past 24 hours based on the provided pool address | -| 💼 [/onchain/networks/../tokens/../trades](/reference/token-trades-contract-address) | Query the last 300 trades in the past 24 hours across all pools, based on the provided token contract address on a network | -| 💼 [/onchain/categories](/reference/categories-list) | Query all the supported categories on GeckoTerminal | -| 💼 [/onchain/categories/../pools](/reference/pools-category) | Query all the pools based on the provided category ID | +| [/onchain/simple/networks/../token\_price/..](https://docs.coingecko.com/reference/onchain-simple-price) | Get token price based on the provided token contract address on a network | +| [/onchain/networks](https://docs.coingecko.com/reference/networks-list) | Query all the supported networks on GeckoTerminal | +| [/onchain/networks/../dexes](https://docs.coingecko.com/reference/dexes-list) | Query all the supported decentralized exchanges (DEXs) based on the provided network on GeckoTerminal | +| [/onchain/networks/trending\_pools](https://docs.coingecko.com/reference/trending-pools-list) | Query all the trending pools across all networks on GeckoTerminal | +| [/onchain/networks/../trending\_pools](https://docs.coingecko.com/reference/trending-pools-network) | Query the trending pools based on the provided network | +| [/onchain/networks/../pools/..](https://docs.coingecko.com/reference/pool-address) | Query the specific pool based on the provided network and pool address | +| [/onchain/networks/../pools/multi/..](https://docs.coingecko.com/reference/pools-addresses) | Query multiple pools based on the provided network and pool address | +| [/onchain/networks/../pools](https://docs.coingecko.com/reference/top-pools-network) | Query all the top pools based on the provided network | +| [/onchain/networks/../dexes/../pools](https://docs.coingecko.com/reference/top-pools-dex) | Query all the top pools based on the provided network and decentralized exchange (DEX) | +| [/onchain/networks/../new\_pools](https://docs.coingecko.com/reference/latest-pools-network) | Query all the latest pools based on provided network | +| [/onchain/networks/new\_pools](https://docs.coingecko.com/reference/latest-pools-list) | Query all the latest pools across all networks on GeckoTerminal | +| 🔥 💼 [/onchain/pools/megafilter](https://docs.coingecko.com/reference/pools-megafilter) | Query pools based on various filters across all networks on GeckoTerminal | +| [/onchain/search/pools](https://docs.coingecko.com/reference/search-pools) | Search for pools on a network | +| 💼 [/onchain/pools/trending\_search](https://docs.coingecko.com/reference/trending-search-pools) | Query all the trending search pools across all networks on GeckoTerminal | +| [/onchain/networks/../tokens/../pools](https://docs.coingecko.com/reference/top-pools-contract-address) | Query top pools based on the provided token contract address on a network | +| [/onchain/networks/../tokens/..](https://docs.coingecko.com/reference/token-data-contract-address) | Query specific token data based on the provided token contract address on a network | +| [/onchain/networks/../tokens/multi/..](https://docs.coingecko.com/reference/tokens-data-contract-addresses) | Query multiple tokens data based on the provided token contract addresses on a network | +| [/onchain/networks/../tokens/../info](https://docs.coingecko.com/reference/token-info-contract-address) | Query token metadata (name, symbol, CoinGecko ID, image, socials, websites, description, etc.) based on a provided token contract address on a network | +| [/onchain/networks/../pools/../info](https://docs.coingecko.com/reference/pool-token-info-contract-address) | Query pool metadata (base and quote token details, image, socials, websites, description, contract address, etc.) based on a provided pool contract address on a network | +| [/onchain/tokens/info\_recently\_updated](https://docs.coingecko.com/reference/tokens-info-recent-updated) | Query 100 most recently updated tokens info across all networks on GeckoTerminal | +| 💼 [/onchain/networks/../tokens/../top\_holders](https://docs.coingecko.com/reference/top-token-holders-token-address) | Query top token holders based on the provided token contract address on a network | +| 💼 [/onchain/networks/../tokens/../holders\_chart](https://docs.coingecko.com/reference/token-holders-chart-token-address) | Get the historical token holders chart based on the provided token contract address on a network | +| [/onchain/networks/../pools/../ohlcv/..](https://docs.coingecko.com/reference/pool-ohlcv-contract-address) | Get the OHLCV chart (Open, High, Low, Close, Volume) of a pool based on the provided pool address on a network | +| 💼 [/onchain/networks/../tokens/../ohlcv/..](https://docs.coingecko.com/reference/token-ohlcv-token-address) | Get the OHLCV chart (Open, High, Low, Close, Volume) of a token based on the provided token address on a network | +| [/onchain/networks/../pools/../trades](https://docs.coingecko.com/reference/pool-trades-contract-address) | Query the last 300 trades in the past 24 hours based on the provided pool address | +| 💼 [/onchain/networks/../tokens/../trades](https://docs.coingecko.com/reference/token-trades-contract-address) | Query the last 300 trades in the past 24 hours across all pools, based on the provided token contract address on a network | +| 💼 [/onchain/categories](https://docs.coingecko.com/reference/categories-list) | Query all the supported categories on GeckoTerminal | +| 💼 [/onchain/categories/../pools](https://docs.coingecko.com/reference/pools-category) | Query all the pools based on the provided category ID | ⚡️ Need Real-time Data Streams? Try [WebSocket API](https://docs.coingecko.com/websocket) @@ -5295,15 +5295,15 @@ This endpoint allows you to **query exchange's data (name, year established, cou ### Notice - * Please note that the `trade_volume_24h_btc_normalized` data field will no longer be supported by our API starting on June 16, 2025. Please refer to [changelog](/changelog#may-2025) for more details. + * Please note that the `trade_volume_24h_btc_normalized` data field will no longer be supported by our API starting on June 16, 2025. Please refer to [changelog](https://docs.coingecko.com/changelog#may-2025) for more details. ### Note - * The exchange volume in the response is provided in BTC. To convert it to other currencies, please use [/exchange\_rates](/reference/exchange-rates) endpoint. - * For derivatives (e.g. `bitmex`, `binance_futures`), to get derivatives exchanges data, please go to [/derivatives/exchange/\{id}](/reference/derivatives-exchanges-id) endpoint. - * Tickers are limited to 100 items, to get more tickers, please go to [/exchanges/\{id}/tickers](/reference/exchanges-id-tickers) endpoint. + * The exchange volume in the response is provided in BTC. To convert it to other currencies, please use [/exchange\_rates](https://docs.coingecko.com/reference/exchange-rates) endpoint. + * For derivatives (e.g. `bitmex`, `binance_futures`), to get derivatives exchanges data, please go to [/derivatives/exchange/\{id}](https://docs.coingecko.com/reference/derivatives-exchanges-id) endpoint. + * Tickers are limited to 100 items, to get more tickers, please go to [/exchanges/\{id}/tickers](https://docs.coingecko.com/reference/exchanges-id-tickers) endpoint. * When `dex_pair_format=symbol`, the DEX pair `base` and `target` are displayed in symbol format (e.g. `WETH`, `USDC`) instead of as contract addresses. * Cache / Update Frequency: every 60 seconds for all the API plans. @@ -5336,7 +5336,7 @@ This endpoint allows you to **query the historical volume chart data with time i ### Note * You can use this endpoint to query the historical volume chart data of **derivatives exchanges** as well. - * The exchange volume in the response is provided in BTC. To convert it to other currencies, please use [/exchange\_rates](/reference/exchange-rates) endpoint. + * The exchange volume in the response is provided in BTC. To convert it to other currencies, please use [/exchange\_rates](https://docs.coingecko.com/reference/exchange-rates) endpoint. * Data granularity is automatic (cannot be adjusted): * 1 day = 10-minutely * 7, 14 days = hourly @@ -5481,13 +5481,13 @@ This endpoint allows you to **query all the NFT data (name, floor price, 24hr vo ### Tips - * You may also obtain the asset platform ID and contract address through [/nfts/list](/reference/nfts-list) endpoint. + * You may also obtain the asset platform ID and contract address through [/nfts/list](https://docs.coingecko.com/reference/nfts-list) endpoint. ### Note - * Solana NFT & Art Blocks are not supported for this endpoint, please use [/nfts/\{id}](/reference/nfts-id) endpoint instead. + * Solana NFT & Art Blocks are not supported for this endpoint, please use [/nfts/\{id}](https://docs.coingecko.com/reference/nfts-id) endpoint instead. * Cache / Update Frequency: every 60 seconds for all the API plans. @@ -5501,7 +5501,7 @@ This endpoint allows you **query historical market data of a NFT collection, inc ### Note - * This endpoint doesn't support Solana NFT and Art Blocks, please use [/nfts/\{id}/market\_chart](/reference/nfts-id-market-chart) endpoint instead. + * This endpoint doesn't support Solana NFT and Art Blocks, please use [/nfts/\{id}/market\_chart](https://docs.coingecko.com/reference/nfts-id-market-chart) endpoint instead. * Data Granularity (auto): * 1-14 days from now = **5-minutely** data * 15 days & above from now = **daily** data (00:00 UTC) @@ -5613,7 +5613,7 @@ This endpoint allows you to **get token price based on the provided token contra * The returned price currency is in USD. * Addresses not found in GeckoTerminal will be ignored. * This endpoint allows querying **up to 100 contract addresses** per request. This limit is exclusive for [paid plan](https://www.coingecko.com/en/api/pricing) subscribers (Analyst plan & above). - * When using this endpoint, GeckoTerminal's routing decides the best pool for token price. The price source may change based on liquidity and pool activity. For full control over the price, you may use [`/networks/{network}/pools/{address}`](/reference/pool-address) endpoint by providing a specific pool address. + * When using this endpoint, GeckoTerminal's routing decides the best pool for token price. The price source may change based on liquidity and pool activity. For full control over the price, you may use [`/networks/{network}/pools/{address}`](https://docs.coingecko.com/reference/pool-address) endpoint by providing a specific pool address. * Cache/Update Frequency: every 10 seconds for Pro API (Analyst, Lite, Pro, Enterprise). @@ -5700,12 +5700,12 @@ This endpoint allows you to **query pool metadata (base and quote token details, ### Tips - * If you would like to query pool data such as price, transactions, volume and etc. You can go to this endpoint [`/networks/{network}/pools/{address}`](/reference/pool-address) instead. + * If you would like to query pool data such as price, transactions, volume and etc. You can go to this endpoint [`/networks/{network}/pools/{address}`](https://docs.coingecko.com/reference/pool-address) instead. * Cache/Update frequency: every 60 seconds. * Learn more about GT score [here](https://support.coingecko.com/hc/en-us/articles/38381394237593-What-is-GT-Score-How-is-GT-Score-calculated). * Metadata (image, websites, description, socials) may be sourced on-chain and is not vetted by the CoinGecko team. If you wish to get metadata reviewed by CoinGecko team, you may use the following endpoints: - * [Coin Data by ID](/reference/coins-id) - * [Coin Data by Token Address](/reference/coins-contract-address) + * [Coin Data by ID](https://docs.coingecko.com/reference/coins-id) + * [Coin Data by Token Address](https://docs.coingecko.com/reference/coins-contract-address) @@ -5763,9 +5763,9 @@ This endpoint allows you to **query all the pools based on the provided category ### Tips - * You can retrieve full list of categories id via this endpoint: [Categories List](/reference/categories-list). + * You can retrieve full list of categories id via this endpoint: [Categories List](https://docs.coingecko.com/reference/categories-list). * You can retrieve tokens of a specific category, by flagging `include=base_token`. - * GeckoTerminal categories are different from [CoinGecko categories](/reference/coins-categories-list). + * GeckoTerminal categories are different from [CoinGecko categories](https://docs.coingecko.com/reference/coins-categories-list). @@ -5881,7 +5881,7 @@ This endpoint allows you to **query the prices of one or more coins by using the * You may obtain the coin ID (API ID) via several ways: * refers to respective coin page and find 'API ID'. - * refers to [`/coins/list`](/reference/coins-list) endpoint. + * refers to [`/coins/list`](https://docs.coingecko.com/reference/coins-list) endpoint. * refers to Google Sheets [here](https://docs.google.com/spreadsheets/d/1wTTuxXt8n9q7C4NDXqQpI3wpKu1_5bGVmP9Xz0XGSyU/edit?usp=sharing). * You can retrieve specific coins using their unique `ids`, `names`, or `symbols`. * You may flag to include more data such as market cap, 24hr volume, 24hr change, last updated time etc. @@ -5930,7 +5930,7 @@ This endpoint allows you to **query one or more token prices using their token c * You may obtain the asset platform and contract address via several ways: * refers to respective coin page and find 'contract address'. - * refers to [`/coins/list`](/reference/coins-list) endpoint (`include platform = true`). + * refers to [`/coins/list`](https://docs.coingecko.com/reference/coins-list) endpoint (`include platform = true`). * You may flag to include more data such as market cap, 24hr volume, 24hr change, last updated time etc. @@ -5953,7 +5953,7 @@ This endpoint allows you to **query specific token data based on the provided to ### Tips * You may add values such as `top_pools` in the include param to include top pools along with the pools information. - * If you would like to query token information such as socials, websites, description and etc. You can go to this endpoint [`/networks/{network}/tokens/{address}/info`](/reference/token-info-contract-address) instead. + * If you would like to query token information such as socials, websites, description and etc. You can go to this endpoint [`/networks/{network}/tokens/{address}/info`](https://docs.coingecko.com/reference/token-info-contract-address) instead. @@ -5999,12 +5999,12 @@ This endpoint allows you to **query token metadata (name, symbol, CoinGecko ID, ### Tips - * If you would like to query token data such as decimals, total supply, price and etc. You can go to this endpoint [`/networks/{network}/tokens/{address}`](/reference/token-data-contract-address) instead. + * If you would like to query token data such as decimals, total supply, price and etc. You can go to this endpoint [`/networks/{network}/tokens/{address}`](https://docs.coingecko.com/reference/token-data-contract-address) instead. * Cache/Update frequency: every 60 seconds. * Learn more about GT score [here](https://support.coingecko.com/hc/en-us/articles/38381394237593-What-is-GT-Score-How-is-GT-Score-calculated). * Metadata (image, websites, description, socials) may be sourced on-chain and is not vetted by the CoinGecko team. If you wish to get metadata reviewed by CoinGecko team, you may use the following endpoints: - * [Coin Data by ID](/reference/coins-id) - * [Coin Data by Token Address](/reference/coins-contract-address) + * [Coin Data by ID](https://docs.coingecko.com/reference/coins-id) + * [Coin Data by Token Address](https://docs.coingecko.com/reference/coins-contract-address) @@ -6091,7 +6091,7 @@ This endpoint allows you to **query multiple tokens data based on the provided t ### Tips * You may add values such as `top_pools` in the include param to include top pools along with the pools information. - * If you would like to query token information such as socials, websites, description and etc. You can go to this endpoint [`/networks/{network}/tokens/{address}/info`](/reference/token-info-contract-address) instead. + * If you would like to query token information such as socials, websites, description and etc. You can go to this endpoint [`/networks/{network}/tokens/{address}/info`](https://docs.coingecko.com/reference/token-info-contract-address) instead. @@ -6163,7 +6163,7 @@ This endpoint allows you to **query all the top pools based on the provided netw ### Tips * You may include values such as `page` to specify which page of responses you would like to show. - * For more flexibility in retrieving an exact list of pools that match your specific needs, consider using the [/pools/megafilter](/reference/pools-megafilter) endpoint. + * For more flexibility in retrieving an exact list of pools that match your specific needs, consider using the [/pools/megafilter](https://docs.coingecko.com/reference/pools-megafilter) endpoint. @@ -6188,7 +6188,7 @@ This endpoint allows you to **query all the top pools based on the provided netw ### Tips * You may include values such as `page` to specify which page of responses you would like to show. - * For more flexibility in retrieving an exact list of pools that match your specific needs, consider using the [/pools/megafilter](/reference/pools-megafilter) endpoint. + * For more flexibility in retrieving an exact list of pools that match your specific needs, consider using the [/pools/megafilter](https://docs.coingecko.com/reference/pools-megafilter) endpoint. @@ -6231,7 +6231,7 @@ This endpoint allows you to **query all the trending pools across all networks o ### Tips * You may include values such as `page` to specify which page of responses you would like to show. - * For more flexibility in retrieving an exact list of pools that match your specific needs, consider using the [/pools/megafilter](/reference/pools-megafilter) endpoint. + * For more flexibility in retrieving an exact list of pools that match your specific needs, consider using the [/pools/megafilter](https://docs.coingecko.com/reference/pools-megafilter) endpoint. @@ -6260,7 +6260,7 @@ This endpoint allows you to **query the trending pools based on the provided net ### Tips * You may include values such as `page` to specify which page of responses you would like to show. - * For more flexibility in retrieving an exact list of pools that match your specific needs, consider using the [/pools/megafilter](/reference/pools-megafilter) endpoint. + * For more flexibility in retrieving an exact list of pools that match your specific needs, consider using the [/pools/megafilter](https://docs.coingecko.com/reference/pools-megafilter) endpoint. @@ -6337,7 +6337,7 @@ Authentication method for CoinGecko Public API (Demo plan users) * Demo API Key is only available for CoinGecko Public Demo API Plan, the root URL for CoinGecko Public Demo API must be `https://api.coingecko.com/api/v3/`. * ⚠️ You are recommended to store the API key securely in your own backend and use a proxy to insert the key into the request URL. - * The authentication method below is for CoinGecko Public Demo API only. For **paid plan users with Pro-API key**, please refer to [this page](/reference/authentication) instead. + * The authentication method below is for CoinGecko Public Demo API only. For **paid plan users with Pro-API key**, please refer to [this page](https://docs.coingecko.com/reference/authentication) instead. * User Guide: [How to sign up for CoinGecko Demo API and generate an API key?](https://support.coingecko.com/hc/en-us/articles/21880397454233) * It's highly recommended to use the **Headers method** when making API requests for better security. Using query string parameters can risk exposing your API key. @@ -6349,7 +6349,7 @@ If this is your first time using the Demo API key, you can supply API Key to the 1. Header (Recommended): `x-cg-demo-api-key` 2. Query String Parameter: `x_cg_demo_api_key` -| Authentication Method | Example using [Ping](/v3.0.1/reference/ping-server) Endpoint | +| Authentication Method | Example using [Ping](https://docs.coingecko.com/v3.0.1/reference/ping-server) Endpoint | | ---------------------- | ------------------------------------------------------------------------------------------ | | Header (cURL) | `curl -X GET "https://api.coingecko.com/api/v3/ping" -H "x-cg-demo-api-key: YOUR_API_KEY"` | | Query String Parameter | `https://api.coingecko.com/api/v3/ping?x_cg_demo_api_key=YOUR_API_KEY` | @@ -6358,7 +6358,7 @@ If this is your first time using the Demo API key, you can supply API Key to the * Each request made to any endpoint counts as a single call (1 call = 1 credit). * Your monthly credit & rate limit are determined by the paid plan to which you subscribe. For more details, please refer to this [page](https://www.coingecko.com/en/api/pricing). -* To check the API usage, please go to the [developer dashboard](https://www.coingecko.com/en/developers/dashboard) or follow the guide [here](/v3.0.1/reference/setting-up-your-api-key#4-api-usage-report). +* To check the API usage, please go to the [developer dashboard](https://www.coingecko.com/en/developers/dashboard) or follow the guide [here](https://docs.coingecko.com/v3.0.1/reference/setting-up-your-api-key#4-api-usage-report). # Coins Categories List with Market Data @@ -6404,7 +6404,7 @@ This endpoint allows you to **query all the metadata (image, websites, socials, ### Notice - * Please note that the `twitter_followers` data field will no longer be supported by our API starting on May 15, 2025. Please refer to [changelog](/changelog#upcoming-change-notice%3A-removal-of-twitter-followers-data) for more details. + * Please note that the `twitter_followers` data field will no longer be supported by our API starting on May 15, 2025. Please refer to [changelog](https://docs.coingecko.com/changelog#upcoming-change-notice%3A-removal-of-twitter-followers-data) for more details. @@ -6412,7 +6412,7 @@ This endpoint allows you to **query all the metadata (image, websites, socials, * You may obtain the asset platform and contract address via several ways: * refers to respective coin page and find 'contract address'. - * refers to [`/coins/list`](/v3.0.1/reference/coins-list) endpoint (`include platform = true`). + * refers to [`/coins/list`](https://docs.coingecko.com/v3.0.1/reference/coins-list) endpoint (`include platform = true`). @@ -6434,7 +6434,7 @@ This endpoint allows you to **query all the metadata (image, websites, socials, * You may obtain the coin `id` (API ID) via several ways: * refers to respective coin page and find "API ID". - * refers to [`/coins/list`](/v3.0.1/reference/coins-list) endpoint. + * refers to [`/coins/list`](https://docs.coingecko.com/v3.0.1/reference/coins-list) endpoint. * refers to Google Sheets [here](https://docs.google.com/spreadsheets/d/1wTTuxXt8n9q7C4NDXqQpI3wpKu1_5bGVmP9Xz0XGSyU/edit?usp=sharing). * You may also flag to include more data such as tickers, market data, community data, developer data and sparkline. * You may refer to `last_updated` in the endpoint response to check whether the price is stale. @@ -6443,7 +6443,7 @@ This endpoint allows you to **query all the metadata (image, websites, socials, ### Note - * Tickers are limited to 100 items, to get more tickers, please go to [/coins/{id}/tickers](/v3.0.1/reference/coins-id-tickers). + * Tickers are limited to 100 items, to get more tickers, please go to [/coins/{id}/tickers](https://docs.coingecko.com/v3.0.1/reference/coins-id-tickers). * Coin descriptions may include newline characters represented as `\r\n` (escape sequences), which may require processing for proper formatting. * When `dex_pair_format=symbol`, the DEX pair `base` and `target` are displayed in symbol format (e.g. `WETH`, `USDC`) instead of as contract addresses. * Cache/Update Frequency: @@ -6463,7 +6463,7 @@ This endpoint allows you to **query the historical data (price, market cap, 24hr * You may obtain the coin ID (API ID) via several ways: * refers to respective coin page and find 'API ID'. - * refers to [`/coins/list`](/v3.0.1/reference/coins-list) endpoint. + * refers to [`/coins/list`](https://docs.coingecko.com/v3.0.1/reference/coins-list) endpoint. * refers to Google Sheets [here](https://docs.google.com/spreadsheets/d/1wTTuxXt8n9q7C4NDXqQpI3wpKu1_5bGVmP9Xz0XGSyU/edit?usp=sharing). @@ -6487,7 +6487,7 @@ This endpoint allows you to **get the historical chart data of a coin including * You may obtain the coin ID (API ID) via several ways: * refers to respective coin page and find 'API ID'. - * refers to [`/coins/list`](/v3.0.1/reference/coins-list) endpoint. + * refers to [`/coins/list`](https://docs.coingecko.com/v3.0.1/reference/coins-list) endpoint. * refers to google sheets [here](https://docs.google.com/spreadsheets/d/1wTTuxXt8n9q7C4NDXqQpI3wpKu1_5bGVmP9Xz0XGSyU/edit?usp=sharing). * You may use tools like [epoch converter ](https://www.epochconverter.com) to convert human readable date to UNIX timestamp. @@ -6517,7 +6517,7 @@ This endpoint allows you to **get the historical chart data of a coin within cer * You may obtain the coin ID (API ID) via several ways: * refers to respective coin page and find 'API ID'. - * refers to [`/coins/list`](/v3.0.1/reference/coins-list) endpoint. + * refers to [`/coins/list`](https://docs.coingecko.com/v3.0.1/reference/coins-list) endpoint. * refers to google sheets [here](https://docs.google.com/spreadsheets/d/1wTTuxXt8n9q7C4NDXqQpI3wpKu1_5bGVmP9Xz0XGSyU/edit?usp=sharing). @@ -6550,9 +6550,9 @@ This endpoint allows you to **get the OHLC chart (Open, High, Low, Close) of a c * You may obtain the coin ID (API ID) via several ways: * refers to respective coin page and find 'API ID'. - * refers to [`/coins/list`](/v3.0.1/reference/coins-list) endpoint. + * refers to [`/coins/list`](https://docs.coingecko.com/v3.0.1/reference/coins-list) endpoint. * refers to google sheets [here](https://docs.google.com/spreadsheets/d/1wTTuxXt8n9q7C4NDXqQpI3wpKu1_5bGVmP9Xz0XGSyU/edit?usp=sharing). - * For historical chart data with better granularity, you may consider using [/coins/\{id}/market\_chart](/v3.0.1/reference/coins-id-market-chart) endpoint. + * For historical chart data with better granularity, you may consider using [/coins/\{id}/market\_chart](https://docs.coingecko.com/v3.0.1/reference/coins-id-market-chart) endpoint. @@ -6581,7 +6581,7 @@ This endpoint allows you to **query the coin tickers on both centralized exchang * You may obtain the coin ID (API ID) via several ways: * refers to respective coin page and find 'API ID'. - * refers to [`/coins/list`](/v3.0.1/reference/coins-list) endpoint. + * refers to [`/coins/list`](https://docs.coingecko.com/v3.0.1/reference/coins-list) endpoint. * refers to google sheets [here](https://docs.google.com/spreadsheets/d/1wTTuxXt8n9q7C4NDXqQpI3wpKu1_5bGVmP9Xz0XGSyU/edit?usp=sharing). * You may specify the `exchange_ids` if you want to retrieve tickers for specific exchange only. * You may include values such as `page` to specify which page of responses you would like to show. @@ -6631,7 +6631,7 @@ This endpoint allows you to **query all the supported coins with price, market c ### Tips * You can retrieve specific coins using their unique `ids`, `names`, or `symbols` instead of returning the whole list. - * To filter results based on the coin's category, use the `category` param (refer to [`/coins/categories/list`](/v3.0.1/reference/coins-categories-list) for available categories). + * To filter results based on the coin's category, use the `category` param (refer to [`/coins/categories/list`](https://docs.coingecko.com/v3.0.1/reference/coins-categories-list) for available categories). * Use the `per_page` and `page` params to manage the number of results you receive and navigate through the data. @@ -6674,7 +6674,7 @@ This endpoint allows you to **get the historical chart data including time in UN * You may obtain the asset platform and contract address via several ways: * refers to respective coin page and find 'contract address'. - * refers to [`/coins/list`](/v3.0.1/reference/coins-list) endpoint (`include platform = true`). + * refers to [`/coins/list`](https://docs.coingecko.com/v3.0.1/reference/coins-list) endpoint (`include platform = true`). @@ -6702,7 +6702,7 @@ This endpoint allows you to **get the historical chart data within certain time * You may obtain the asset platform and contract address via several ways: * refers to respective coin page and find 'contract address'. - * refers to [`/coins/list`](/v3.0.1/reference/coins-list) endpoint (`include platform = true`). + * refers to [`/coins/list`](https://docs.coingecko.com/v3.0.1/reference/coins-list) endpoint (`include platform = true`). @@ -6831,97 +6831,97 @@ Source: https://docs.coingecko.com/v3.0.1/reference/endpoint-overview Any exclusive endpoints for Pro-API users (any paid plan subscribers) will not be included here. - For a full list of endpoints, please visit [Pro API Documentation](/reference/endpoint-overview) instead. + For a full list of endpoints, please visit [Pro API Documentation](https://docs.coingecko.com/reference/endpoint-overview) instead. ## CoinGecko Endpoints: Coins | Endpoint | Description | | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| [/ping](/v3.0.1/reference/ping-server) | Check the API server status | -| [/simple/price](/v3.0.1/reference/simple-price) | Query the prices of one or more coins by using their unique Coin API IDs | -| [/simple/token\_price/\{id}](/v3.0.1/reference/simple-token-price) | Query the prices of one or more coins by using their unique Coin API IDs | -| [/simple/supported\_vs\_currencies](/v3.0.1/reference/simple-supported-currencies) | Query all the supported currencies on CoinGecko | -| [/coins/list](/v3.0.1/reference/coins-list) | Query all the supported coins on CoinGecko with coins ID, name and symbol | -| [/coins/markets](/v3.0.1/reference/coins-markets) | Query all the supported coins with price, market cap, volume and market related data | -| [/coins/\{id}](/v3.0.1/reference/coins-id) | Query all the metadata (image, websites, socials, description, contract address, etc.) from the CoinGecko coin page based on a particular coin ID | -| [/coins/\{id}/tickers](/v3.0.1/reference/coins-id-tickers) | Query the coin tickers on both centralized exchange (CEX) and decentralized exchange (DEX) based on a particular coin ID | -| [/coins/\{id}/history](/v3.0.1/reference/coins-id-history) | Query the historical data (price, market cap, 24hr volume, ...) at a given date for a coin based on a particular coin ID | -| [/coins/\{id}/market\_chart](/v3.0.1/reference/coins-id-market-chart) | Get the historical chart data of a coin including time in UNIX, price, market cap and 24hr volume based on particular coin ID | -| [/coins/\{id}/market\_chart/range](/v3.0.1/reference/coins-id-market-chart-range) | Get the historical chart data of a coin within certain time range in UNIX along with price, market cap and 24hr volume based on particular coin ID | -| [/coins-id-ohlc](/v3.0.1/reference/coins-id-ohlc) | Get the OHLC chart (Open, High, Low, Close) of a coin based on particular coin ID | -| [/coins/../contract/..](/v3.0.1/reference/coins-contract-address) | Query all the metadata (image, websites, socials, description, contract address, etc.) from the CoinGecko coin page based on an asset platform and a particular token contract address | -| [/coins/../contract/../market\_chart](/v3.0.1/reference/contract-address-market-chart) | Get the historical chart data including time in UNIX, price, market cap and 24hr volume based on asset platform and particular token contract address | -| [/coins/../contract/../market\_chart/range](/v3.0.1/reference/contract-address-market-chart-range) | Get the historical chart data within certain time range in UNIX along with price, market cap and 24hr volume based on asset platform and particular token contract address | -| [/coins/categories/list](/v3.0.1/reference/coins-categories-list) | Query all the coins categories on CoinGecko | -| [/coins/categories](/v3.0.1/reference/coins-categories) | Query all the coins categories with market data (market cap, volume, ...) on CoinGecko | +| [/ping](https://docs.coingecko.com/v3.0.1/reference/ping-server) | Check the API server status | +| [/simple/price](https://docs.coingecko.com/v3.0.1/reference/simple-price) | Query the prices of one or more coins by using their unique Coin API IDs | +| [/simple/token\_price/\{id}](https://docs.coingecko.com/v3.0.1/reference/simple-token-price) | Query the prices of one or more coins by using their unique Coin API IDs | +| [/simple/supported\_vs\_currencies](https://docs.coingecko.com/v3.0.1/reference/simple-supported-currencies) | Query all the supported currencies on CoinGecko | +| [/coins/list](https://docs.coingecko.com/v3.0.1/reference/coins-list) | Query all the supported coins on CoinGecko with coins ID, name and symbol | +| [/coins/markets](https://docs.coingecko.com/v3.0.1/reference/coins-markets) | Query all the supported coins with price, market cap, volume and market related data | +| [/coins/\{id}](https://docs.coingecko.com/v3.0.1/reference/coins-id) | Query all the metadata (image, websites, socials, description, contract address, etc.) from the CoinGecko coin page based on a particular coin ID | +| [/coins/\{id}/tickers](https://docs.coingecko.com/v3.0.1/reference/coins-id-tickers) | Query the coin tickers on both centralized exchange (CEX) and decentralized exchange (DEX) based on a particular coin ID | +| [/coins/\{id}/history](https://docs.coingecko.com/v3.0.1/reference/coins-id-history) | Query the historical data (price, market cap, 24hr volume, ...) at a given date for a coin based on a particular coin ID | +| [/coins/\{id}/market\_chart](https://docs.coingecko.com/v3.0.1/reference/coins-id-market-chart) | Get the historical chart data of a coin including time in UNIX, price, market cap and 24hr volume based on particular coin ID | +| [/coins/\{id}/market\_chart/range](https://docs.coingecko.com/v3.0.1/reference/coins-id-market-chart-range) | Get the historical chart data of a coin within certain time range in UNIX along with price, market cap and 24hr volume based on particular coin ID | +| [/coins-id-ohlc](https://docs.coingecko.com/v3.0.1/reference/coins-id-ohlc) | Get the OHLC chart (Open, High, Low, Close) of a coin based on particular coin ID | +| [/coins/../contract/..](https://docs.coingecko.com/v3.0.1/reference/coins-contract-address) | Query all the metadata (image, websites, socials, description, contract address, etc.) from the CoinGecko coin page based on an asset platform and a particular token contract address | +| [/coins/../contract/../market\_chart](https://docs.coingecko.com/v3.0.1/reference/contract-address-market-chart) | Get the historical chart data including time in UNIX, price, market cap and 24hr volume based on asset platform and particular token contract address | +| [/coins/../contract/../market\_chart/range](https://docs.coingecko.com/v3.0.1/reference/contract-address-market-chart-range) | Get the historical chart data within certain time range in UNIX along with price, market cap and 24hr volume based on asset platform and particular token contract address | +| [/coins/categories/list](https://docs.coingecko.com/v3.0.1/reference/coins-categories-list) | Query all the coins categories on CoinGecko | +| [/coins/categories](https://docs.coingecko.com/v3.0.1/reference/coins-categories) | Query all the coins categories with market data (market cap, volume, ...) on CoinGecko | ## CoinGecko Endpoints: NFT | Endpoint | Description | | --------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------- | -| [/nfts/list](/v3.0.1/reference/nfts-list) | Query all supported NFTs with ID, contract address, name, asset platform ID and symbol on CoinGecko | -| [/nfts/..](/v3.0.1/reference/nfts-id) | Query all the NFT data (name, floor price, 24hr volume, ...) based on the NFT collection ID | -| [/nfts/../contract/..](/v3.0.1/reference/nfts-contract-address) | Query all the NFT data (name, floor price, 24hr volume, ...) based on the NFT collection contract address and respective asset platform | +| [/nfts/list](https://docs.coingecko.com/v3.0.1/reference/nfts-list) | Query all supported NFTs with ID, contract address, name, asset platform ID and symbol on CoinGecko | +| [/nfts/..](https://docs.coingecko.com/v3.0.1/reference/nfts-id) | Query all the NFT data (name, floor price, 24hr volume, ...) based on the NFT collection ID | +| [/nfts/../contract/..](https://docs.coingecko.com/v3.0.1/reference/nfts-contract-address) | Query all the NFT data (name, floor price, 24hr volume, ...) based on the NFT collection contract address and respective asset platform | ## CoinGecko Endpoints: Exchanges & Derivatives | Endpoint | Description | | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | -| [/exchanges](/v3.0.1/reference/exchanges) | Query all the supported exchanges with exchanges' data (ID, name, country, ...) that have active trading volumes on CoinGecko | -| [/exchanges/list](/v3.0.1/reference/exchanges-list) | Query all the exchanges with ID and name | -| [/exchanges/\{id}](/v3.0.1/reference/exchanges-id) | Query exchange's data (name, year established, country, ...), exchange volume in BTC and tickers based on exchange's ID | -| [/exchanges/\{id}/tickers](/v3.0.1/reference/exchanges-id-tickers) | Query exchange's tickers based on exchange's ID | -| [/exchanges/\{id}/volume\_chart](/v3.0.1/reference/exchanges-id-volume-chart) | Query the historical volume chart data with time in UNIX and trading volume data in BTC based on exchange's ID | -| [/derivatives](/v3.0.1/reference/derivatives-tickers) | Query all the tickers from derivatives exchanges on CoinGecko | -| [/derivatives/exchanges](/v3.0.1/reference/derivatives-exchanges) | Query all the derivatives exchanges with related data (ID, name, open interest, ...) on CoinGecko | -| [/derivatives/exchanges/\{id}](/v3.0.1/reference/derivatives-exchanges-id) | Query the derivatives exchange's related data (ID, name, open interest, ...) based on the exchanges' ID | -| [/derivatives/exchanges/list](/v3.0.1/reference/derivatives-exchanges-list) | Query all the derivatives exchanges with ID and name on CoinGecko | +| [/exchanges](https://docs.coingecko.com/v3.0.1/reference/exchanges) | Query all the supported exchanges with exchanges' data (ID, name, country, ...) that have active trading volumes on CoinGecko | +| [/exchanges/list](https://docs.coingecko.com/v3.0.1/reference/exchanges-list) | Query all the exchanges with ID and name | +| [/exchanges/\{id}](https://docs.coingecko.com/v3.0.1/reference/exchanges-id) | Query exchange's data (name, year established, country, ...), exchange volume in BTC and tickers based on exchange's ID | +| [/exchanges/\{id}/tickers](https://docs.coingecko.com/v3.0.1/reference/exchanges-id-tickers) | Query exchange's tickers based on exchange's ID | +| [/exchanges/\{id}/volume\_chart](https://docs.coingecko.com/v3.0.1/reference/exchanges-id-volume-chart) | Query the historical volume chart data with time in UNIX and trading volume data in BTC based on exchange's ID | +| [/derivatives](https://docs.coingecko.com/v3.0.1/reference/derivatives-tickers) | Query all the tickers from derivatives exchanges on CoinGecko | +| [/derivatives/exchanges](https://docs.coingecko.com/v3.0.1/reference/derivatives-exchanges) | Query all the derivatives exchanges with related data (ID, name, open interest, ...) on CoinGecko | +| [/derivatives/exchanges/\{id}](https://docs.coingecko.com/v3.0.1/reference/derivatives-exchanges-id) | Query the derivatives exchange's related data (ID, name, open interest, ...) based on the exchanges' ID | +| [/derivatives/exchanges/list](https://docs.coingecko.com/v3.0.1/reference/derivatives-exchanges-list) | Query all the derivatives exchanges with ID and name on CoinGecko | ## CoinGecko Endpoints: Public Treasuries | Endpoint | Description | | ------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | -| [/\{entity}/public\_treasury/\{coin\_id}](/reference/companies-public-treasury) | Query public companies & governments' cryptocurrency holdings by coin ID | -| [/public\_treasury/\{entity\_id}](/reference/public-treasury-entity) | Query public companies & governments' cryptocurrency holdings by entity ID | -| [/entities/list](/reference/entities-list) | Query all the supported entities on CoinGecko with entities ID, name, symbol, and country | +| [/\{entity}/public\_treasury/\{coin\_id}](https://docs.coingecko.com/reference/companies-public-treasury) | Query public companies & governments' cryptocurrency holdings by coin ID | +| [/public\_treasury/\{entity\_id}](https://docs.coingecko.com/reference/public-treasury-entity) | Query public companies & governments' cryptocurrency holdings by entity ID | +| [/entities/list](https://docs.coingecko.com/reference/entities-list) | Query all the supported entities on CoinGecko with entities ID, name, symbol, and country | ## CoinGecko Endpoints: General | Endpoint | Description | | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | -| [/exchange\_rates](/v3.0.1/reference/exchange-rates) | Query BTC exchange rates with other currencies | -| [/asset\_platforms](/v3.0.1/reference/asset-platforms-list) | Query all the asset platforms (blockchain networks) on CoinGecko | -| [/token\_lists/\{asset\_platform\_id}/all.json](/v3.0.1/reference/token-lists) | Get full list of tokens of a blockchain network (asset platform) that is supported by Ethereum token list standard | -| [/search](/v3.0.1/reference/search-data) | Search for coins, categories and markets listed on CoinGecko | -| [/search/trending](/v3.0.1/reference/trending-search) | Query trending search coins, NFTs and categories on CoinGecko in the last 24 hours | -| [/global](/v3.0.1/reference/crypto-global) | Query cryptocurrency global data including active cryptocurrencies, markets, total crypto market cap and etc. | -| [/global/decentralized\_finance\_defi](/v3.0.1/reference/global-defi) | Query cryptocurrency global decentralized finance (DeFi) data including DeFi market cap, trading volume | +| [/exchange\_rates](https://docs.coingecko.com/v3.0.1/reference/exchange-rates) | Query BTC exchange rates with other currencies | +| [/asset\_platforms](https://docs.coingecko.com/v3.0.1/reference/asset-platforms-list) | Query all the asset platforms (blockchain networks) on CoinGecko | +| [/token\_lists/\{asset\_platform\_id}/all.json](https://docs.coingecko.com/v3.0.1/reference/token-lists) | Get full list of tokens of a blockchain network (asset platform) that is supported by Ethereum token list standard | +| [/search](https://docs.coingecko.com/v3.0.1/reference/search-data) | Search for coins, categories and markets listed on CoinGecko | +| [/search/trending](https://docs.coingecko.com/v3.0.1/reference/trending-search) | Query trending search coins, NFTs and categories on CoinGecko in the last 24 hours | +| [/global](https://docs.coingecko.com/v3.0.1/reference/crypto-global) | Query cryptocurrency global data including active cryptocurrencies, markets, total crypto market cap and etc. | +| [/global/decentralized\_finance\_defi](https://docs.coingecko.com/v3.0.1/reference/global-defi) | Query cryptocurrency global decentralized finance (DeFi) data including DeFi market cap, trading volume | ## Onchain DEX Endpoints (GeckoTerminal) | Endpoint | Description | | ---------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| [/onchain/simple/networks/../token\_price/..](/v3.0.1/reference/onchain-simple-price) | Get token price based on the provided token contract address on a network | -| [/onchain/networks](/v3.0.1/reference/networks-list) | Query all the supported networks on GeckoTerminal | -| [/onchain/networks/../dexes](/v3.0.1/reference/dexes-list) | Query all the supported decentralized exchanges (DEXs) based on the provided network on GeckoTerminal | -| [/onchain/networks/trending\_pools](/v3.0.1/reference/trending-pools-list) | Query all the trending pools across all networks on GeckoTerminal | -| [/onchain/networks/../trending\_pools](/v3.0.1/reference/trending-pools-network) | Query the trending pools based on the provided network | -| [/onchain/networks/../pools/..](/v3.0.1/reference/pool-address) | Query the specific pool based on the provided network and pool address | -| [/onchain/networks/../pools/multi/..](/v3.0.1/reference/pools-addresses) | Query multiple pools based on the provided network and pool address | -| [/onchain/networks/../pools](/v3.0.1/reference/top-pools-network) | Query all the top pools based on the provided network | -| [/onchain/networks/../dexes/../pools](/v3.0.1/reference/top-pools-dex) | Query all the top pools based on the provided network and decentralized exchange (DEX) | -| [/onchain/networks/../new\_pools](/v3.0.1/reference/latest-pools-network) | Query all the latest pools based on provided network | -| [/onchain/networks/new\_pools](/v3.0.1/reference/latest-pools-list) | Query all the latest pools across all networks on GeckoTerminal | -| [/onchain/search/pools](/v3.0.1/reference/search-pools) | Search for pools on a network | -| [/onchain/networks/../tokens/../pools](/v3.0.1/reference/top-pools-contract-address) | Query top pools based on the provided token contract address on a network | -| [/onchain/networks/../tokens/..](/v3.0.1/reference/token-data-contract-address) | Query specific token data based on the provided token contract address on a network | -| [/onchain/networks/../tokens/multi/..](/v3.0.1/reference/tokens-data-contract-addresses) | Query multiple tokens data based on the provided token contract addresses on a network | -| [/onchain/networks/../tokens/../info](/v3.0.1/reference/token-info-contract-address) | Query token metadata (name, symbol, CoinGecko ID, image, socials, websites, description, etc.) based on a provided token contract address on a network | -| [/onchain/networks/../pools/../info](/v3.0.1/reference/pool-token-info-contract-address) | Query pool metadata (base and quote token details, image, socials, websites, description, contract address, etc.) based on a provided pool contract address on a network | -| [/onchain/tokens/info\_recently\_updated](/v3.0.1/reference/tokens-info-recent-updated) | Query 100 most recently updated tokens info across all networks on GeckoTerminal | -| [/onchain/networks/../pools/../ohlcv/..](/v3.0.1/reference/pool-ohlcv-contract-address) | Get the OHLCV chart (Open, High, Low, Close, Volume) of a pool based on the provided pool address on a network | -| [/onchain/networks/../pools/../trades](/v3.0.1/reference/pool-trades-contract-address) | Query the last 300 trades in the past 24 hours based on the provided pool address | +| [/onchain/simple/networks/../token\_price/..](https://docs.coingecko.com/v3.0.1/reference/onchain-simple-price) | Get token price based on the provided token contract address on a network | +| [/onchain/networks](https://docs.coingecko.com/v3.0.1/reference/networks-list) | Query all the supported networks on GeckoTerminal | +| [/onchain/networks/../dexes](https://docs.coingecko.com/v3.0.1/reference/dexes-list) | Query all the supported decentralized exchanges (DEXs) based on the provided network on GeckoTerminal | +| [/onchain/networks/trending\_pools](https://docs.coingecko.com/v3.0.1/reference/trending-pools-list) | Query all the trending pools across all networks on GeckoTerminal | +| [/onchain/networks/../trending\_pools](https://docs.coingecko.com/v3.0.1/reference/trending-pools-network) | Query the trending pools based on the provided network | +| [/onchain/networks/../pools/..](https://docs.coingecko.com/v3.0.1/reference/pool-address) | Query the specific pool based on the provided network and pool address | +| [/onchain/networks/../pools/multi/..](https://docs.coingecko.com/v3.0.1/reference/pools-addresses) | Query multiple pools based on the provided network and pool address | +| [/onchain/networks/../pools](https://docs.coingecko.com/v3.0.1/reference/top-pools-network) | Query all the top pools based on the provided network | +| [/onchain/networks/../dexes/../pools](https://docs.coingecko.com/v3.0.1/reference/top-pools-dex) | Query all the top pools based on the provided network and decentralized exchange (DEX) | +| [/onchain/networks/../new\_pools](https://docs.coingecko.com/v3.0.1/reference/latest-pools-network) | Query all the latest pools based on provided network | +| [/onchain/networks/new\_pools](https://docs.coingecko.com/v3.0.1/reference/latest-pools-list) | Query all the latest pools across all networks on GeckoTerminal | +| [/onchain/search/pools](https://docs.coingecko.com/v3.0.1/reference/search-pools) | Search for pools on a network | +| [/onchain/networks/../tokens/../pools](https://docs.coingecko.com/v3.0.1/reference/top-pools-contract-address) | Query top pools based on the provided token contract address on a network | +| [/onchain/networks/../tokens/..](https://docs.coingecko.com/v3.0.1/reference/token-data-contract-address) | Query specific token data based on the provided token contract address on a network | +| [/onchain/networks/../tokens/multi/..](https://docs.coingecko.com/v3.0.1/reference/tokens-data-contract-addresses) | Query multiple tokens data based on the provided token contract addresses on a network | +| [/onchain/networks/../tokens/../info](https://docs.coingecko.com/v3.0.1/reference/token-info-contract-address) | Query token metadata (name, symbol, CoinGecko ID, image, socials, websites, description, etc.) based on a provided token contract address on a network | +| [/onchain/networks/../pools/../info](https://docs.coingecko.com/v3.0.1/reference/pool-token-info-contract-address) | Query pool metadata (base and quote token details, image, socials, websites, description, contract address, etc.) based on a provided pool contract address on a network | +| [/onchain/tokens/info\_recently\_updated](https://docs.coingecko.com/v3.0.1/reference/tokens-info-recent-updated) | Query 100 most recently updated tokens info across all networks on GeckoTerminal | +| [/onchain/networks/../pools/../ohlcv/..](https://docs.coingecko.com/v3.0.1/reference/pool-ohlcv-contract-address) | Get the OHLCV chart (Open, High, Low, Close, Volume) of a pool based on the provided pool address on a network | +| [/onchain/networks/../pools/../trades](https://docs.coingecko.com/v3.0.1/reference/pool-trades-contract-address) | Query the last 300 trades in the past 24 hours based on the provided pool address | ⚡️ Need Real-time Data Streams? Try [WebSocket API](https://docs.coingecko.com/websocket) @@ -6996,15 +6996,15 @@ This endpoint allows you to **query exchange's data (name, year established, cou ### Notice - * Please note that the `trade_volume_24h_btc_normalized` data field will no longer be supported by our API starting on June 15, 2025. Please refer to [changelog](/changelog#may-2025) for more details. + * Please note that the `trade_volume_24h_btc_normalized` data field will no longer be supported by our API starting on June 15, 2025. Please refer to [changelog](https://docs.coingecko.com/changelog#may-2025) for more details. ### Note - * The exchange volume in the response is provided in BTC. To convert it to other currencies, please use [/exchange\_rates](/v3.0.1/reference/exchange-rates) endpoint. - * For derivatives (e.g. bitmex, binance\_futures), to get derivatives exchanges data, please go to [/derivatives/exchange/\{id}](/v3.0.1/reference/derivatives-exchanges-id) endpoint. - * Tickers are limited to 100 items, to get more tickers, please go to [/exchanges/\{id}/tickers](/v3.0.1/reference/exchanges-id-tickers) endpoint. + * The exchange volume in the response is provided in BTC. To convert it to other currencies, please use [/exchange\_rates](https://docs.coingecko.com/v3.0.1/reference/exchange-rates) endpoint. + * For derivatives (e.g. bitmex, binance\_futures), to get derivatives exchanges data, please go to [/derivatives/exchange/\{id}](https://docs.coingecko.com/v3.0.1/reference/derivatives-exchanges-id) endpoint. + * Tickers are limited to 100 items, to get more tickers, please go to [/exchanges/\{id}/tickers](https://docs.coingecko.com/v3.0.1/reference/exchanges-id-tickers) endpoint. * When `dex_pair_format=symbol`, the DEX pair `base` and `target` are displayed in symbol format (e.g. `WETH`, `USDC`) instead of as contract addresses. * Cache / Update Frequency: every 60 seconds for all the API plans. @@ -7037,7 +7037,7 @@ This endpoint allows you to **query the historical volume chart data with time i ### Note * You can use this endpoint to query the historical volume chart data of **derivatives exchanges** as well. - * The exchange volume in the response is provided in BTC. To convert it to other currencies, please use [/exchange\_rates](/v3.0.1/reference/exchange-rates) endpoint. + * The exchange volume in the response is provided in BTC. To convert it to other currencies, please use [/exchange\_rates](https://docs.coingecko.com/v3.0.1/reference/exchange-rates) endpoint. * Data granularity is automatic (cannot be adjusted): * 1 day = 10-minutely * 7, 14 days = hourly @@ -7146,13 +7146,13 @@ This endpoint allows you to **query all the NFT data (name, floor price, 24hr vo ### Tips - * You may also obtain the asset platform id and contract address through [/nfts/list](/v3.0.1/reference/nfts-list) endpoint. + * You may also obtain the asset platform id and contract address through [/nfts/list](https://docs.coingecko.com/v3.0.1/reference/nfts-list) endpoint. ### Note - * Solana NFT & Art Blocks are not supported for this endpoint, please use [/nfts/\{id}](/v3.0.1/reference/nfts-id) endpoint instead. + * Solana NFT & Art Blocks are not supported for this endpoint, please use [/nfts/\{id}](https://docs.coingecko.com/v3.0.1/reference/nfts-id) endpoint instead. * Cache / Update Frequency: every 60 seconds for all the API plans. @@ -7205,7 +7205,7 @@ This endpoint allows you to **get token price based on the provided token contra * The returned price currency is in USD. * Addresses not found in GeckoTerminal will be ignored. * This endpoint allows querying **up to 30 contract addresses** per request. - * When using this endpoint, GeckoTerminal's routing decides the best pool for token price. The price source may change based on liquidity and pool activity. For full control over the price, you may use [`/networks/{network}/pools/{address}`](/v3.0.1/reference/pool-address) endpoint by providing a specific pool address. + * When using this endpoint, GeckoTerminal's routing decides the best pool for token price. The price source may change based on liquidity and pool activity. For full control over the price, you may use [`/networks/{network}/pools/{address}`](https://docs.coingecko.com/v3.0.1/reference/pool-address) endpoint by providing a specific pool address. * Cache/Update Frequency: every 60 seconds. @@ -7292,12 +7292,12 @@ This endpoint allows you to **query pool metadata (base and quote token details, ### Tips - * If you would like to query pool data such as price, transactions, volume and etc. You can go to this endpoint [`/networks/{network}/pools/{address}`](/v3.0.1/reference/pool-address) instead. + * If you would like to query pool data such as price, transactions, volume and etc. You can go to this endpoint [`/networks/{network}/pools/{address}`](https://docs.coingecko.com/v3.0.1/reference/pool-address) instead. * Cache/Update frequency: every 60 seconds. * Learn more about GT score [here](https://support.coingecko.com/hc/en-us/articles/38381394237593-What-is-GT-Score-How-is-GT-Score-calculated). * Metadata (image, websites, description, socials) may be sourced on-chain and is not vetted by the CoinGecko team. If you wish to get metadata reviewed by CoinGecko team, you may use the following endpoints: - * [Coin Data by ID](/v3.0.1/reference/coins-id) - * [Coin Data by Token Address](/v3.0.1/reference/coins-contract-address) + * [Coin Data by ID](https://docs.coingecko.com/v3.0.1/reference/coins-id) + * [Coin Data by Token Address](https://docs.coingecko.com/v3.0.1/reference/coins-contract-address) @@ -7409,7 +7409,7 @@ This endpoint allows you to **query the prices of one or more coins by using the * You may obtain the coin ID (API ID) via several ways: * refers to respective coin page and find 'API ID'. - * refers to [`/coins/list`](/v3.0.1/reference/coins-list) endpoint. + * refers to [`/coins/list`](https://docs.coingecko.com/v3.0.1/reference/coins-list) endpoint. * refers to Google Sheets [here](https://docs.google.com/spreadsheets/d/1wTTuxXt8n9q7C4NDXqQpI3wpKu1_5bGVmP9Xz0XGSyU/edit?usp=sharing). * You can retrieve specific coins using their unique `ids`, `names`, or `symbols`. * You may flag to include more data such as market cap, 24hr volume, 24hr change, last updated time etc. @@ -7459,7 +7459,7 @@ This endpoint allows you to **query one or more token prices using their token c * You may obtain the asset platform and contract address via several ways: * refers to respective coin page and find 'contract address'. - * refers to [`/coins/list`](/v3.0.1/reference/coins-list) endpoint (`include platform = true`). + * refers to [`/coins/list`](https://docs.coingecko.com/v3.0.1/reference/coins-list) endpoint (`include platform = true`). * You may flag to include more data such as market cap, 24hr volume, 24hr change, last updated time etc. @@ -7483,7 +7483,7 @@ This endpoint allows you to **query specific token data based on the provided to ### Tips * You may add values such as `top_pools` in the include param to include top pools along with the pools information. - * If you would like to query token information such as socials, websites, description and etc. You can go to this endpoint [`/networks/{network}/tokens/{address}/info`](/v3.0.1/reference/token-info-contract-address) instead. + * If you would like to query token information such as socials, websites, description and etc. You can go to this endpoint [`/networks/{network}/tokens/{address}/info`](https://docs.coingecko.com/v3.0.1/reference/token-info-contract-address) instead. @@ -7507,12 +7507,12 @@ This endpoint allows you to **query token metadata (name, symbol, CoinGecko ID, ### Tips - * If you would like to query token data such as decimals, total supply, price and etc. You can go to this endpoint [`/networks/{network}/tokens/{address}`](/v3.0.1/reference/token-data-contract-address) instead. + * If you would like to query token data such as decimals, total supply, price and etc. You can go to this endpoint [`/networks/{network}/tokens/{address}`](https://docs.coingecko.com/v3.0.1/reference/token-data-contract-address) instead. * Cache/Update frequency: every 60 seconds. * Learn more about GT score [here](https://support.coingecko.com/hc/en-us/articles/38381394237593-What-is-GT-Score-How-is-GT-Score-calculated). * Metadata (image, websites, description, socials) may be sourced on-chain and is not vetted by the CoinGecko team. If you wish to get metadata reviewed by CoinGecko team, you may use the following endpoints: - * [Coin Data by ID](/v3.0.1/reference/coins-id) - * [Coin Data by Token Address](/v3.0.1/reference/coins-contract-address) + * [Coin Data by ID](https://docs.coingecko.com/v3.0.1/reference/coins-id) + * [Coin Data by Token Address](https://docs.coingecko.com/v3.0.1/reference/coins-contract-address) @@ -7551,7 +7551,7 @@ This endpoint allows you to **query multiple tokens data based on the provided t ### Tips * You may add values such as `top_pools` in the include param to include top pools along with the pools information. - * If you would like to query token information such as socials, websites, description and etc. You can go to this endpoint [`/networks/{network}/tokens/{address}/info`](/v3.0.1/reference/token-info-contract-address) instead. + * If you would like to query token information such as socials, websites, description and etc. You can go to this endpoint [`/networks/{network}/tokens/{address}/info`](https://docs.coingecko.com/v3.0.1/reference/token-info-contract-address) instead. @@ -7900,10 +7900,10 @@ Move beyond traditional polling and embrace the power of instant data delivery f | Websocket Channel | Channel Code | Details | | ------------------------------------------------------------- | ------------ | ------------------------------------------------------------------------------------------------------------- | -| [OnchainSimpleTokenPrice](/websocket/onchainsimpletokenprice) | G1 | Subscribe to receive real-time price updates for tokens, as seen on GeckoTerminal.com | -| [CGSimplePrice](/websocket/cgsimpleprice) | C1 | Subscribe to receive real-time price updates for tokens, as seen on CoinGecko.com | -| [OnchainTrade](/websocket/wss-onchain-trade) | G2 | Subscribe to receive real-time transaction updates for pools, as seen on GeckoTerminal.com | -| [OnchainOHLCV](/websocket/wssonchainohlcv/) | G3 | Subscribe to receive real-time OHLCV (Open, High, Low, Close, Volume) for pools, as seen on GeckoTerminal.com | +| [OnchainSimpleTokenPrice](https://docs.coingecko.com/websocket/onchainsimpletokenprice) | G1 | Subscribe to receive real-time price updates for tokens, as seen on GeckoTerminal.com | +| [CGSimplePrice](https://docs.coingecko.com/websocket/cgsimpleprice) | C1 | Subscribe to receive real-time price updates for tokens, as seen on CoinGecko.com | +| [OnchainTrade](https://docs.coingecko.com/websocket/wss-onchain-trade) | G2 | Subscribe to receive real-time transaction updates for pools, as seen on GeckoTerminal.com | +| [OnchainOHLCV](https://docs.coingecko.com/websocket/wssonchainohlcv/) | G3 | Subscribe to receive real-time OHLCV (Open, High, Low, Close, Volume) for pools, as seen on GeckoTerminal.com | | (More coming soon!) | | | @@ -8083,7 +8083,7 @@ This Websocket channel allows you to subscribe to real-time updates of token tra **Update Frequency**: as fast as 0.1s, for actively traded pools. -**Tips**: use this Rest API endpoint [Top Pools by Token Address](/reference/top-pools-contract-address) to obtain contract address of the most liquid pool. +**Tips**: use this Rest API endpoint [Top Pools by Token Address](https://docs.coingecko.com/reference/top-pools-contract-address) to obtain contract address of the most liquid pool. ### Data Payload diff --git a/assets/skills/coingecko/references/market_data.md b/assets/skills/coingecko/references/market_data.md index 8a20741..9e2ed6f 100644 --- a/assets/skills/coingecko/references/market_data.md +++ b/assets/skills/coingecko/references/market_data.md @@ -32,7 +32,7 @@ Source: https://docs.coingecko.com/reference/nfts-contract-address-market-chart reference/api-reference/coingecko-pro.json get /nfts/{asset_platform_id}/contract/{contract_address}/market_chart This endpoint allows you **query historical market data of a NFT collection, including floor price, market cap, and 24hr volume, by number of days away from now based on the provided contract address** -* This endpoint doesn't support Solana NFT and Art Blocks, please use [/nfts/\{id}/market\_chart](/reference/nfts-id-market-chart) endpoint instead. +* This endpoint doesn't support Solana NFT and Art Blocks, please use [/nfts/\{id}/market\_chart](https://docs.coingecko.com/reference/nfts-id-market-chart) endpoint instead. * Data Granularity (auto): * 1-14 days from now = **5-minutely** data * 15 days & above from now = **daily** data (00:00 UTC) diff --git a/assets/skills/coingecko/references/other.md b/assets/skills/coingecko/references/other.md index ef02b52..56e7947 100644 --- a/assets/skills/coingecko/references/other.md +++ b/assets/skills/coingecko/references/other.md @@ -41,7 +41,7 @@ Here are the official API SDKs maintained by us. Want us to support your favorite programming language? Let us know [here](https://forms.gle/JJLH3SXiL2eJaGzBA)! -**Not a developer?** Fred not, check our no-code tutorial for beginners here: [Tutorials (Beginner-friendly)](/docs/tutorials-beginner-friendly) +**Not a developer?** Fred not, check our no-code tutorial for beginners here: [Tutorials (Beginner-friendly)](https://docs.coingecko.com/docs/tutorials-beginner-friendly) --- @@ -338,16 +338,16 @@ Wonder how to use different endpoints together? This is the perfect place for yo ### "Discovery/Navigational Endpoints" -* [/coins/list](/reference/coins-list) — can be used to query all the supported coins on CoinGecko with names, symbols and coin IDs that can be used in other endpoints. -* [/search/trending](/reference/trending-search) — can be used to query trending search coins, categories and NFTs on CoinGecko. +* [/coins/list](https://docs.coingecko.com/reference/coins-list) — can be used to query all the supported coins on CoinGecko with names, symbols and coin IDs that can be used in other endpoints. +* [/search/trending](https://docs.coingecko.com/reference/trending-search) — can be used to query trending search coins, categories and NFTs on CoinGecko. ### "Supporting Endpoints" -* [/simple/supported\_vs\_currencies](/reference/simple-supported-currencies) — can be used to query the list of currencies for other endpoints that include parameters like `vs_currencies`, allowing to obtain the corresponding data for those currencies. -* [/asset\_platforms](/reference/asset-platforms-list) — can be used to query the list of asset platforms for other endpoints that contain parameters like `id` or `ids` (asset platforms), allowing the retrieval of corresponding data for these asset platforms. +* [/simple/supported\_vs\_currencies](https://docs.coingecko.com/reference/simple-supported-currencies) — can be used to query the list of currencies for other endpoints that include parameters like `vs_currencies`, allowing to obtain the corresponding data for those currencies. +* [/asset\_platforms](https://docs.coingecko.com/reference/asset-platforms-list) — can be used to query the list of asset platforms for other endpoints that contain parameters like `id` or `ids` (asset platforms), allowing the retrieval of corresponding data for these asset platforms. -* [/simple/price](/reference/simple-price) — can be used to query the prices of coins using the unique coin IDs that can be obtained from the "Discovery/Navigational Endpoints" mentioned above. -* [/coins/\{id}](/reference/coins-id) — can be used to query the coin data using the unique coin IDs that can be obtained from the "Discovery/Navigational Endpoints" mentioned above. +* [/simple/price](https://docs.coingecko.com/reference/simple-price) — can be used to query the prices of coins using the unique coin IDs that can be obtained from the "Discovery/Navigational Endpoints" mentioned above. +* [/coins/\{id}](https://docs.coingecko.com/reference/coins-id) — can be used to query the coin data using the unique coin IDs that can be obtained from the "Discovery/Navigational Endpoints" mentioned above. ## User Journey for Onchain DEX API Endpoints (GeckoTerminal data) @@ -355,16 +355,16 @@ Wonder how to use different endpoints together? This is the perfect place for yo ### "Discovery/Navigational Endpoints" -* [/onchain/trending\_pools](/reference/trending-pools-list) - can be used to query trending pools across all networks on GeckoTerminal. -* [/onchain/search/pools](/reference/search-pools) - can be used to search for any pools on GeckoTerminal. +* [/onchain/trending\_pools](https://docs.coingecko.com/reference/trending-pools-list) - can be used to query trending pools across all networks on GeckoTerminal. +* [/onchain/search/pools](https://docs.coingecko.com/reference/search-pools) - can be used to search for any pools on GeckoTerminal. ### "Supporting Endpoints" -* [/onchain/networks-list](/reference/networks-list) - can be used to query all the supported networks on GeckoTerminal. -* [/onchain/networks/\{network}/dexes](/reference/dexes-list) - can be used to query all the supported decentralized exchanges (DEXs/`dexes`) on GeckoTerminal based on network id that can be obtained from the endpoint mentioned above. +* [/onchain/networks-list](https://docs.coingecko.com/reference/networks-list) - can be used to query all the supported networks on GeckoTerminal. +* [/onchain/networks/\{network}/dexes](https://docs.coingecko.com/reference/dexes-list) - can be used to query all the supported decentralized exchanges (DEXs/`dexes`) on GeckoTerminal based on network id that can be obtained from the endpoint mentioned above. -* [/onchain/simple/networks/\{network}/token\_price/\{addresses}](/reference/onchain-simple-price) - can be used to query any token price using the token address and network id that can be obtained from the "Discovery/Navigational Endpoints" and "Supporting Endpoints" mentioned above. -* [/onchain/networks/\{network}/pools/\{address}](/reference/pool-address) - can be used to query the data of a specific pool based on the pool address and network id that can be obtained from the "Discovery/Navigational Endpoints" and "Supporting Endpoints" mentioned above. +* [/onchain/simple/networks/\{network}/token\_price/\{addresses}](https://docs.coingecko.com/reference/onchain-simple-price) - can be used to query any token price using the token address and network id that can be obtained from the "Discovery/Navigational Endpoints" and "Supporting Endpoints" mentioned above. +* [/onchain/networks/\{network}/pools/\{address}](https://docs.coingecko.com/reference/pool-address) - can be used to query the data of a specific pool based on the pool address and network id that can be obtained from the "Discovery/Navigational Endpoints" and "Supporting Endpoints" mentioned above. --- @@ -386,7 +386,7 @@ Choosing between a Demo and Pro key for your MCP server impacts your access to d | **Rate Limit** | 30 calls/min | Starts at 500 calls/min | | **Monthly Credits** | 10,000 | Starts at 500,000 | | **Historical Data** | Past 1 year | From 2013 until now | -| **MCP Tools** | Limited access | Full access, including exclusive tools:
- [Top Gainers & Losers](/reference/coins-top-gainers-losers)
- [NFTs Collection Historical Chart](/reference/nfts-id-market-chart)
- [🔥 Megafilter for Pools](/reference/pools-megafilter)
- [Pools by Category ID](/reference/pools-category) | +| **MCP Tools** | Limited access | Full access, including exclusive tools:
- [Top Gainers & Losers](https://docs.coingecko.com/reference/coins-top-gainers-losers)
- [NFTs Collection Historical Chart](https://docs.coingecko.com/reference/nfts-id-market-chart)
- [🔥 Megafilter for Pools](https://docs.coingecko.com/reference/pools-megafilter)
- [Pools by Category ID](https://docs.coingecko.com/reference/pools-category) | 🔥 Ready to upgrade? Explore [our API plans](https://www.coingecko.com/en/api/pricing). @@ -399,7 +399,7 @@ When running our CoinGecko MCP server, you can choose how the LLM client discove For a deeper dive, read the [official documentation](https://www.stainless.com/changelog/mcp-dynamic-tools) from Stainless. -To help AI models interact with CoinGecko data effectively, we provide an `llms.txt` file at [/llms-full.txt](/llms-full.txt). This file gives models context on how to best query our API, ensuring more accurate and efficient data retrieval. We recommend utilizing this in your integrations. +To help AI models interact with CoinGecko data effectively, we provide an `llms.txt` file at [/llms-full.txt](https://docs.coingecko.com/llms-full.txt). This file gives models context on how to best query our API, ensuring more accurate and efficient data retrieval. We recommend utilizing this in your integrations. CoinGecko MCP Server is powered by [Stainless](https://www.stainless.com/) ✱ @@ -489,7 +489,7 @@ Some of the useful links to help you navigate while using the CoinGecko API #### Using `llms.txt` for AI use cases -* [/llms-full.txt](/llms-full.txt) +* [/llms-full.txt](https://docs.coingecko.com/llms-full.txt) #### Attributing CoinGecko Brand @@ -542,14 +542,14 @@ Due to recent updates to MagicEden's API, we are updating our integration. Durin We've added support for bonding curve (e.g. launchpad graduation from PumpFun) data across multiple token endpoints: -* [Token Data by Token Address](/reference/token-data-contract-address) — `/onchain/networks/{network}/tokens/{address}` - * [Tokens Data by Token Addresses](/reference/tokens-data-contract-addresses) — `/onchain/networks/{network}/tokens/multi/{addresses}` - * [Token Info by Token Address](/reference/token-info-contract-address) — `/onchain/networks/{network}/tokens/{address}/info` - * [Pool Tokens Info by Pool Address](/reference/pool-token-info-contract-address) — `/onchain/networks/{network}/pools/{pool_address}/info` +* [Token Data by Token Address](https://docs.coingecko.com/reference/token-data-contract-address) — `/onchain/networks/{network}/tokens/{address}` + * [Tokens Data by Token Addresses](https://docs.coingecko.com/reference/tokens-data-contract-addresses) — `/onchain/networks/{network}/tokens/multi/{addresses}` + * [Token Info by Token Address](https://docs.coingecko.com/reference/token-info-contract-address) — `/onchain/networks/{network}/tokens/{address}/info` + * [Pool Tokens Info by Pool Address](https://docs.coingecko.com/reference/pool-token-info-contract-address) — `/onchain/networks/{network}/pools/{pool_address}/info` ### Megafilter: Ascending Sort Order for Price Change % -The [Megafilter for Pools](/reference/pools-megafilter) endpoint now supports ascending sorting for price change percentage: +The [Megafilter for Pools](https://docs.coingecko.com/reference/pools-megafilter) endpoint now supports ascending sorting for price change percentage: * `m5_price_change_percentage_asc` * `h1_price_change_percentage_asc` @@ -558,7 +558,7 @@ The [Megafilter for Pools](/reference/pools-megafilter) endpoint now supports as ### Token OHLCV Endpoint Fix to respect Specified Token Address -We've fixed an issue where the [Token OHLCV chart by Token Address](/reference/token-ohlcv-token-address) endpoint returned data for the base token of the top pool instead of the requested token. It will now always return data for the specified token address. +We've fixed an issue where the [Token OHLCV chart by Token Address](https://docs.coingecko.com/reference/token-ohlcv-token-address) endpoint returned data for the base token of the top pool instead of the requested token. It will now always return data for the specified token address. @@ -582,17 +582,17 @@ We're broadening our SDK coverage to make treasury-level insights more powerful We're also surfacing new tools through the MCP to give developers a richer, faster way to query exchanges, NFTs, and onchain activity. * New tools: - * Exchange coverage with [/exchanges/list](reference/exchanges-list), [/exchanges/](reference/exchanges-id), [/exchanges//tickers](reference/exchanges-id-tickers), and [/exchanges//volume\_chart/range](reference/exchanges-id-volume-chart-range) - * NFT markets with [/nfts/markets](reference/nfts-markets) - * Multi-address queries with [/onchain/networks//pools/multi/](reference/pools-addresses) and [/onchain/networks//tokens/multi/](reference/tokens-data-contract-addresses) + * Exchange coverage with [/exchanges/list](https://docs.coingecko.com/reference/exchanges-list), [/exchanges/](https://docs.coingecko.com/reference/exchanges-id), [/exchanges//tickers](https://docs.coingecko.com/reference/exchanges-id-tickers), and [/exchanges//volume\_chart/range](https://docs.coingecko.com/reference/exchanges-id-volume-chart-range) + * NFT markets with [/nfts/markets](https://docs.coingecko.com/reference/nfts-markets) + * Multi-address queries with [/onchain/networks//pools/multi/](https://docs.coingecko.com/reference/pools-addresses) and [/onchain/networks//tokens/multi/](https://docs.coingecko.com/reference/tokens-data-contract-addresses) * Retired tools: - * We've removed endpoints such as [/coins/list](reference/coins-list), [/onchain/networks/trending\_pools](reference/trending-pools-network), and single-address pool/token queries in favor of more scalable multi-address endpoints + * We've removed endpoints such as [/coins/list](https://docs.coingecko.com/reference/coins-list), [/onchain/networks/trending\_pools](https://docs.coingecko.com/reference/trending-pools-network), and single-address pool/token queries in favor of more scalable multi-address endpoints ### Friendlier Time-related MCP Queries with ISO Support Time-based queries just got easier. MCP tools now accept **ISO date strings** (`YYYY-MM-DD` or `YYYY-MM-DDTHH:MM`) alongside UNIX timestamps. -For example, when using the [Coin Historical Chart Data within Time Range](reference/coins-id-market-chart-range) tool, you can now pass ISO date strings directly instead of converting them into UNIX timestamps for your LLM tools. +For example, when using the [Coin Historical Chart Data within Time Range](https://docs.coingecko.com/reference/coins-id-market-chart-range) tool, you can now pass ISO date strings directly instead of converting them into UNIX timestamps for your LLM tools. **CoinGecko API Team** @@ -1644,13 +1644,13 @@ Historical data for new non-native or bridged assets will only be available from For a finalised list of token contracts and API IDs that have been separated from its native asset page and listed individually, please refer to this [Google Sheets](https://docs.google.com/spreadsheets/d/15FyY1gvUi20LdnlJRly-pXvm5ATNbFbSy06VoI1vVs4/edit?usp=sharing) -You may also identify the list of bridged coins via API: you may also use [/categories/list endpoint](/reference/coins-categories-list) to look for bridged categories such as: +You may also identify the list of bridged coins via API: you may also use [/categories/list endpoint](https://docs.coingecko.com/reference/coins-categories-list) to look for bridged categories such as: 1. bridged-usdc 2. bridged-wbtc 3. bridged-weth -Then you may use [/coins/market endpoint](/reference/coins-markets) to retrieve the list of coins +Then you may use [/coins/market endpoint](https://docs.coingecko.com/reference/coins-markets) to retrieve the list of coins ## Enhancing Your Access to Even Fresher Data! @@ -1735,21 +1735,21 @@ You can now query coin prices in the 13 new currencies for the following 3 endpo ### Onchain: Simple Price - Increased Token Address Limit from 30 to 100 -[Token Price by Token Addresses](/reference/onchain-simple-price) now allows to input up to 100 contract addresses, instead of 30. +[Token Price by Token Addresses](https://docs.coingecko.com/reference/onchain-simple-price) now allows to input up to 100 contract addresses, instead of 30. * You may now retrieve data of up to 100 token prices of a specific network, in one single request. * Available exclusively to Pro API paid plan subscribers. ### Onchain: Recently Updated Info - Added Filter by Network -[Most Recently Updated Token List](/reference/tokens-info-recent-updated) now allows to filter by blockchain network, by flagging the `network` parameter. e.g. `network=eth`. +[Most Recently Updated Token List](https://docs.coingecko.com/reference/tokens-info-recent-updated) now allows to filter by blockchain network, by flagging the `network` parameter. e.g. `network=eth`. * You can use the `network` parameter to retrieve the 100 most recently updated token info of a specific network. * View list of supported network via [Supported Networks List](https://docs.coingecko.com/reference/networks-list) endpoint. ### NFT Collection Data - Included Banner Image -[NFTs Collection Data by ID](/reference/nfts-id) now provides banner image of a NFT collection. +[NFTs Collection Data by ID](https://docs.coingecko.com/reference/nfts-id) now provides banner image of a NFT collection. View banner image [example](https://coin-images.coingecko.com/nft_contracts/images/38/pudgy-penguins-banner.png?1708416126) on: [https://www.coingecko.com/en/nft/pudgy-penguins](https://www.coingecko.com/en/nft/pudgy-penguins) @@ -1766,11 +1766,11 @@ The last completed UTC day (00:00) is available 5 minutes after midnight on the ### Asset Platforms - Included Images of Blockchain Network Logos -[Asset Platforms List (ID Map)](/reference/asset-platforms-list) now provides the logos of blockchain networks. +[Asset Platforms List (ID Map)](https://docs.coingecko.com/reference/asset-platforms-list) now provides the logos of blockchain networks. ### Coins Categories - Included Ids of Top 3 Coins -[Coins Categories List with Market Data](/reference/coins-categories) now provides coins id of the top 3 coins of a category. +[Coins Categories List with Market Data](https://docs.coingecko.com/reference/coins-categories) now provides coins id of the top 3 coins of a category. ### Circulating Supply Chart and Total Supply Chart - Fixed '0' data issue @@ -1787,8 +1787,8 @@ For the following **Enterprise-plan** exclusive endpoints below, there was a bug The cache & update frequency of the following endpoints have been improved from every 30 minutes to every 15 minutes: -* [/coins//ohlc](/reference/coins-id-ohlc) - * [/coins//ohlc/range](/reference/coins-id-ohlc-range) +* [/coins//ohlc](https://docs.coingecko.com/reference/coins-id-ohlc) + * [/coins//ohlc/range](https://docs.coingecko.com/reference/coins-id-ohlc-range) @@ -1798,15 +1798,15 @@ The cache & update frequency of the following endpoints have been improved from We've added 'user\_favorites\_count', and 'ath' (all-time-high) related data to the following NFT endpoints: -* [/nfts/](/reference/nfts-id) - * [/nfts//contract/](/reference/nfts-contract-address) +* [/nfts/](https://docs.coingecko.com/reference/nfts-id) + * [/nfts//contract/](https://docs.coingecko.com/reference/nfts-contract-address) **Example of responses:** ## Introduced /coins/id/ohlc/range endpoint -We've introduced a new endpoint [/coins//ohlc/range](/reference/coins-id-ohlc-range). +We've introduced a new endpoint [/coins//ohlc/range](https://docs.coingecko.com/reference/coins-id-ohlc-range). This endpoint allows you to get the OHLC chart (Open, High, Low, Close) of a coin within a range of timestamp based on particular coin id. @@ -1814,7 +1814,7 @@ Please note that this endpoint is available exclusively for **paid plan subscrib ## Added interval hourly params to /coins/id/ohlc -We've expanded functionality to include support for the `interval=hourly` parameter within the [/coins//ohlc](/reference/coins-id-ohlc) endpoint. +We've expanded functionality to include support for the `interval=hourly` parameter within the [/coins//ohlc](https://docs.coingecko.com/reference/coins-id-ohlc) endpoint. Users can use this parameter to retrieve OHLC (Open/High/Low/Close) data on a hourly interval for up to 90 days of the date range. @@ -1828,7 +1828,7 @@ Example of endpoint request: 🗓️ **April 30, 2024** -We've now enhanced the [/coins/list](/reference/coins-list) endpoint to include inactive coins +We've now enhanced the [/coins/list](https://docs.coingecko.com/reference/coins-list) endpoint to include inactive coins * You may access the inactive coins by specifying `status=inactive` in your query * Example of endpoint request:\ @@ -1836,11 +1836,11 @@ We've now enhanced the [/coins/list](/reference/coins-list) endpoint to include Additionally, historical data for inactive coins can be queried using their IDs in the following endpoints: -* [/coins//history](/reference/coins-id-history) - * [/coins//market\_chart](/reference/coins-id-market-chart) - * [/coins//market\_chart/range](/reference/coins-id-market-chart-range) - * [/coins//contract//market\_chart](/reference/contract-address-market-chart) - * [/coins//contract//market\_chart/range](/reference/contract-address-market-chart-range) +* [/coins//history](https://docs.coingecko.com/reference/coins-id-history) + * [/coins//market\_chart](https://docs.coingecko.com/reference/coins-id-market-chart) + * [/coins//market\_chart/range](https://docs.coingecko.com/reference/coins-id-market-chart-range) + * [/coins//contract//market\_chart](https://docs.coingecko.com/reference/contract-address-market-chart) + * [/coins//contract//market\_chart/range](https://docs.coingecko.com/reference/contract-address-market-chart-range) Please note that these features are available exclusively for **paid plan subscribers only** @@ -1850,7 +1850,7 @@ Please note that these features are available exclusively for **paid plan subscr 🗓️ **March 27, 2024** -We've introduced a new endpoint [/key](/reference/api-usage) for conveniently monitoring your account's API usage, including rate limits and remaining credits. +We've introduced a new endpoint [/key](https://docs.coingecko.com/reference/api-usage) for conveniently monitoring your account's API usage, including rate limits and remaining credits. **Example of responses**: @@ -1864,17 +1864,17 @@ We've introduced a new endpoint [/key](/reference/api-usage) for conveniently mo Example of responses: * We've added sorting parameters such as order= `h24_volume_usd_desc` and order=` h24_tx_count_desc` for /pools endpoints - * The 'token' parameter within the [/ohlcv ](/reference/pool-ohlcv-contract-address) endpoint can now accept a token address, provided it exists in the queried pool, to return OHLCV data\ + * The 'token' parameter within the [/ohlcv ](https://docs.coingecko.com/reference/pool-ohlcv-contract-address) endpoint can now accept a token address, provided it exists in the queried pool, to return OHLCV data\ Example of endpoint request (**token=0xc02aaa39b223fe8d0a0e5c4f27ead9083c756cc2**):\ `https://pro-api.coingecko.com/api/v3/onchain/networks/eth/pools/0x06da0fd433c1a5d7a4faa01111c044910a184553/ohlcv/day?token=0xc02aaa39b223fe8d0a0e5c4f27ead9083c756cc2&x_cg_pro_api_key=YOUR_API_KEY` - * [/ohlcv ](/reference/pool-ohlcv-contract-address) endpoint now includes the base and target token metadata in the response\ + * [/ohlcv ](https://docs.coingecko.com/reference/pool-ohlcv-contract-address) endpoint now includes the base and target token metadata in the response\ Example of responses: ## Introduced /networks/network/trending\_pools endpoint (Onchain/GT) 🗓️ **February 19, 2024** -Trending Pools endpoint, [/networks//trending\_pools](/reference/trending-pools-network) is now available to fetch a list of pools that are trending as seen on GeckoTerminal based on web visits and on-chain activities. +Trending Pools endpoint, [/networks//trending\_pools](https://docs.coingecko.com/reference/trending-pools-network) is now available to fetch a list of pools that are trending as seen on GeckoTerminal based on web visits and on-chain activities. ## Introduced /search/pools endpoint (Onchain/GT) @@ -1888,7 +1888,7 @@ Added new endpoint to search for pools /search/pools based on keywords passed in 🗓️ **January 18, 2024** -We've included a new field "whitepaper" under "links" section for [/coins/](/reference/coins-id) endpoint +We've included a new field "whitepaper" under "links" section for [/coins/](https://docs.coingecko.com/reference/coins-id) endpoint **Example of responses:** @@ -1897,7 +1897,7 @@ We've included a new field "whitepaper" under "links" section for [/coins/](/ref 🗓️ **December 13, 2023** -The following data is now deprecated for [/coins/](/reference/coins-id) endpoint: +The following data is now deprecated for [/coins/](https://docs.coingecko.com/reference/coins-id) endpoint: * coingecko\_rank * coingecko\_score @@ -1915,14 +1915,14 @@ The following data is now deprecated for [/coins/](/reference/coins-id) endpoint We've introduced Historical Total Supply data to Enterprise plan subscribers via these 2 exclusive endpoints: -* [/coins//total\_supply\_chart](/reference/coins-id-total-supply-chart) : get historical total supply of a coin, by number of days away from now. - * [/coins//total\_supply\_chart/range](/reference/coins-id-total-supply-chart-range) : get historical total supply of a coin, within a range of timestamp. +* [/coins//total\_supply\_chart](https://docs.coingecko.com/reference/coins-id-total-supply-chart) : get historical total supply of a coin, by number of days away from now. + * [/coins//total\_supply\_chart/range](https://docs.coingecko.com/reference/coins-id-total-supply-chart-range) : get historical total supply of a coin, within a range of timestamp. ## Included more trending coins 🗓️ **December 07, 2023** -We've expanded the capabilities of the [/search/trending](/reference/trending-search) endpoint. +We've expanded the capabilities of the [/search/trending](https://docs.coingecko.com/reference/trending-search) endpoint. It now supports up to 15 trending coins, a significant increase from the previous limit of 7. @@ -1940,14 +1940,14 @@ Pool data now returns transaction stats for the last 1 hour. Unique buyers and s The web\_slug data is now available in the following endpoints. -* [/coins/](/reference/coins-id) - * [/coins//contract/](/reference/coins-contract-address) +* [/coins/](https://docs.coingecko.com/reference/coins-id) + * [/coins//contract/](https://docs.coingecko.com/reference/coins-contract-address) This addition allows users to accurately link to a CoinGecko coin page using [www.coingecko.com/en/](http://www.coingecko.com/en/\{web_slug}). **Example of responses:** -For the [/asset\_platforms](/reference/asset-platforms-list) endpoint, we've introduced the native\_coin\_id data. This enables users to obtain the coin ID of different blockchain networks or asset platforms that may not have a contract address to look up +For the [/asset\_platforms](https://docs.coingecko.com/reference/asset-platforms-list) endpoint, we've introduced the native\_coin\_id data. This enables users to obtain the coin ID of different blockchain networks or asset platforms that may not have a contract address to look up **Example of responses:** @@ -1955,13 +1955,13 @@ For the [/asset\_platforms](/reference/asset-platforms-list) endpoint, we've int 🗓️ **November 10, 2023** -Inspired by CoinGecko API most popular endpoint, we have launched the [/simple/networks//token\_price/](/reference/onchain-simple-price), simple endpoint. Simply pass in addresses of any tokens on supported blockchain and get price data for it +Inspired by CoinGecko API most popular endpoint, we have launched the [/simple/networks//token\_price/](https://docs.coingecko.com/reference/onchain-simple-price), simple endpoint. Simply pass in addresses of any tokens on supported blockchain and get price data for it ## Introduced /networks/network/pools/pool\_address/trades endpoint (Onchain/GT) 🗓️ **November 08, 2023** -You can now get the latest 300 trades in the past 24 hours of a given pool from this endpoint [/networks//pools//trades](/reference/pool-trades-contract-address). You may optionally filter by trade size as well. You can now build your own telegram bot alert! +You can now get the latest 300 trades in the past 24 hours of a given pool from this endpoint [/networks//pools//trades](https://docs.coingecko.com/reference/pool-trades-contract-address). You may optionally filter by trade size as well. You can now build your own telegram bot alert! @@ -1971,9 +1971,9 @@ You can now get the latest 300 trades in the past 24 hours of a given pool from You can now fetch token information such as name, image, social links, and description via these endpoints: -* To fetch information of tokens inside a pool, use [/networks//pools//info](/reference/pool-token-info-contract-address) - * To fetch information of a specific token use [/networks//tokens//info](/reference/token-info-contract-address) - * If you like to get token information of the most recently updated tokens, use [/tokens/info\_recently\_updated](/reference/tokens-info-recent-updated) +* To fetch information of tokens inside a pool, use [/networks//pools//info](https://docs.coingecko.com/reference/pool-token-info-contract-address) + * To fetch information of a specific token use [/networks//tokens//info](https://docs.coingecko.com/reference/token-info-contract-address) + * If you like to get token information of the most recently updated tokens, use [/tokens/info\_recently\_updated](https://docs.coingecko.com/reference/tokens-info-recent-updated) @@ -1998,34 +1998,34 @@ Added new endpoints to allow querying multiple pools and tokens in a single API ## Introduced precision params for other endpoints -The uses of 'precision' parameter allows to specify price data in full or 0-18 decimals, and previously was only made available for [/simple/price](/reference/simple-price) and [/simple/token\_price/](/reference/simple-token-price) endpoints. +The uses of 'precision' parameter allows to specify price data in full or 0-18 decimals, and previously was only made available for [/simple/price](https://docs.coingecko.com/reference/simple-price) and [/simple/token\_price/](https://docs.coingecko.com/reference/simple-token-price) endpoints. This parameter is now supported for more endpoints as listed below: -* [/coins/markets](/reference/coins-markets) - * [/coins/market\_chart](/reference/coins-id-market-chart) - * [/coins/market\_chart/range](/reference/coins-id-market-chart) - * [/coins//contract//market\_chart](/reference/contract-address-market-chart) - * [/coins//contract//market\_chart/range](/reference/contract-address-market-chart-range) - * [/coins//ohlc](/reference/coins-id-ohlc) +* [/coins/markets](https://docs.coingecko.com/reference/coins-markets) + * [/coins/market\_chart](https://docs.coingecko.com/reference/coins-id-market-chart) + * [/coins/market\_chart/range](https://docs.coingecko.com/reference/coins-id-market-chart) + * [/coins//contract//market\_chart](https://docs.coingecko.com/reference/contract-address-market-chart) + * [/coins//contract//market\_chart/range](https://docs.coingecko.com/reference/contract-address-market-chart-range) + * [/coins//ohlc](https://docs.coingecko.com/reference/coins-id-ohlc) ## Multiple Improvements We've made enhancements to the /search/trending and /coins/asset\_platform\_id/contract/contract\_address endpoints: -* Top 5 trending NFT data (based on high trading volume in the last 24 hours) is now included in the [/search/trending](/reference/trending-search) endpoint - * Near Protocol contract address (e.g. wrap.near) is now supported for [/coins//contract/ ](/reference/coins-contract-address) endpoint +* Top 5 trending NFT data (based on high trading volume in the last 24 hours) is now included in the [/search/trending](https://docs.coingecko.com/reference/trending-search) endpoint + * Near Protocol contract address (e.g. wrap.near) is now supported for [/coins//contract/ ](https://docs.coingecko.com/reference/coins-contract-address) endpoint ## Multiple Improvements (Onchain/GT) * Token metadata such as name, symbol, and CoinGecko ID are now returned in the responses for pools endpoints. Users will need to pass in this attribute include=base\_token, quote\_token - * CoinGecko asset platform ID added to the response for [/networks](/reference/networks-list) endpoint + * CoinGecko asset platform ID added to the response for [/networks](https://docs.coingecko.com/reference/networks-list) endpoint ## Added interval daily params to /coins/id/ohlc -The [/coins//ohlc](/reference/coins-id-ohlc) endpoint now supports the "interval=daily" parameter for Paid Plan Subscribers +The [/coins//ohlc](https://docs.coingecko.com/reference/coins-id-ohlc) endpoint now supports the "interval=daily" parameter for Paid Plan Subscribers Users can use this parameter to retrieve OHLC (Open/High/Low/Close) data on a daily interval for up to 180 days of date range. @@ -2035,7 +2035,7 @@ Users can use this parameter to retrieve OHLC (Open/High/Low/Close) data on a da 🗓️ **April 26, 2023** -We've added 'watchlist\_portfolio\_users' field to [/coins/](/reference/coins-id) endpoint responses. +We've added 'watchlist\_portfolio\_users' field to [/coins/](https://docs.coingecko.com/reference/coins-id) endpoint responses. This refers to number of users who added the coin into a watchlist or portfolio. @@ -2055,10 +2055,10 @@ We've increased the rate limit of Public Plan from 10 calls per minute to 30 cal * reserve\_in\_usd added to the pools endpoint response. This returns the total liquidity/reserve of the pool in USD * pool\_created\_at added to the pools endpoint response -Example of responses for [/networks//pools/](/reference/pool-address) : +Example of responses for [/networks//pools/](https://docs.coingecko.com/reference/pool-address) : -* [/networks//new\_pools](/reference/latest-pools-network) endpoint added to query new pools discovered for a network - * [/networks/new\_pools](/reference/latest-pools-list) endpoint added to query new pools discovered across all networks +* [/networks//new\_pools](https://docs.coingecko.com/reference/latest-pools-network) endpoint added to query new pools discovered for a network + * [/networks/new\_pools](https://docs.coingecko.com/reference/latest-pools-list) endpoint added to query new pools discovered across all networks ## Included new fields @@ -2066,9 +2066,9 @@ Example of responses for [/networks//pools/](/reference/pool-address) : We've added "symbol" field to these NFT endpoints responses: -* [/nfts/markets](/reference/nfts-markets) - * [/nfts/ ](/reference/nfts-id) - * [/nfts//contract/](/reference/nfts-contract-address) +* [/nfts/markets](https://docs.coingecko.com/reference/nfts-markets) + * [/nfts/ ](https://docs.coingecko.com/reference/nfts-id) + * [/nfts//contract/](https://docs.coingecko.com/reference/nfts-contract-address) **Example of responses:** @@ -2079,8 +2079,8 @@ We've added "symbol" field to these NFT endpoints responses: We've added "links" field (e.g. homepage, twitter, discord) to these NFT endpoints responses: -* [/nfts/](/reference/nfts-id) - * [/nfts//contract/](/reference/nfts-contract-address) +* [/nfts/](https://docs.coingecko.com/reference/nfts-id) + * [/nfts//contract/](https://docs.coingecko.com/reference/nfts-contract-address) **Example of responses:** @@ -2088,7 +2088,7 @@ We've added "links" field (e.g. homepage, twitter, discord) to these NFT endpoin 🗓️ **March 23, 2023** -We've added [/coins/top\_gainers\_losers](/reference/coins-top-gainers-losers) endpoint exclusively for Paid Plan Subscribers. +We've added [/coins/top\_gainers\_losers](https://docs.coingecko.com/reference/coins-top-gainers-losers) endpoint exclusively for Paid Plan Subscribers. Users can now get the top 30 coins with largest price gain and loss by a specific time duration with this endpoint. @@ -2096,7 +2096,7 @@ Users can now get the top 30 coins with largest price gain and loss by a specifi 🗓️ **March 23, 2023** -[/networks//pools//ohlcv/](/reference/pool-ohlcv-contract-address) now returns more granularity `day,` `hour`, `minute` and multiple aggregates +[/networks//pools//ohlcv/](https://docs.coingecko.com/reference/pool-ohlcv-contract-address) now returns more granularity `day,` `hour`, `minute` and multiple aggregates @@ -2106,14 +2106,14 @@ Users can now get the top 30 coins with largest price gain and loss by a specifi We've made some updates to the /coins/categories and /simple/token\_price/id endpoints: -* Market cap and volume data for 'ecosystem' categories in the [/coins/categories](/reference/coins-categories) endpoint will now return 'null' until further notice. The CoinGecko team is actively working on improvements to provide more accurate data. If you have any feedback or suggestions, please reach out via [api@coingecko.com](mailto:api@coingecko.com). - * Previously, the [/simple/token\_price/](/reference/simple-token-price) endpoint was unable to return data for some Solana coins. This issue has been resolved, and users can now expect accurate data for Solana coins from this endpoint. +* Market cap and volume data for 'ecosystem' categories in the [/coins/categories](https://docs.coingecko.com/reference/coins-categories) endpoint will now return 'null' until further notice. The CoinGecko team is actively working on improvements to provide more accurate data. If you have any feedback or suggestions, please reach out via [api@coingecko.com](mailto:api@coingecko.com). + * Previously, the [/simple/token\_price/](https://docs.coingecko.com/reference/simple-token-price) endpoint was unable to return data for some Solana coins. This issue has been resolved, and users can now expect accurate data for Solana coins from this endpoint. ## Introduced /exchange/id/volume\_chart/range endpoint 🗓️ **February 15, 2023** -We've introduced the [/exchange//volume\_chart/range](/reference/exchanges-id-volume-chart-range) endpoint for Paid Plan Subscribers. +We've introduced the [/exchange//volume\_chart/range](https://docs.coingecko.com/reference/exchanges-id-volume-chart-range) endpoint for Paid Plan Subscribers. This exclusive feature allows users to query full historical volume data of an exchange. @@ -2123,7 +2123,7 @@ This exclusive feature allows users to query full historical volume data of an e 🗓️ **January 09, 2023** -We've introduced the [/coins/list/new](/reference/coins-list-new) endpoint for Paid Plan Subscribers. +We've introduced the [/coins/list/new](https://docs.coingecko.com/reference/coins-list-new) endpoint for Paid Plan Subscribers. This exclusive feature allows users to query the latest 200 coins on CoinGecko. @@ -2134,7 +2134,7 @@ Example 1 (unknown): ```unknown ### Megafilter: Ascending Sort Order for Price Change % - The [Megafilter for Pools](/reference/pools-megafilter) endpoint now supports ascending sorting for price change percentage: + The [Megafilter for Pools](https://docs.coingecko.com/reference/pools-megafilter) endpoint now supports ascending sorting for price change percentage: * `m5_price_change_percentage_asc` * `h1_price_change_percentage_asc` @@ -2143,7 +2143,7 @@ Example 1 (unknown): ### Token OHLCV Endpoint Fix to respect Specified Token Address - We've fixed an issue where the [Token OHLCV chart by Token Address](/reference/token-ohlcv-token-address) endpoint returned data for the base token of the top pool instead of the requested token. It will now always return data for the specified token address. + We've fixed an issue where the [Token OHLCV chart by Token Address](https://docs.coingecko.com/reference/token-ohlcv-token-address) endpoint returned data for the base token of the top pool instead of the requested token. It will now always return data for the specified token address. @@ -2167,17 +2167,17 @@ Example 1 (unknown): We're also surfacing new tools through the MCP to give developers a richer, faster way to query exchanges, NFTs, and onchain activity. * New tools: - * Exchange coverage with [/exchanges/list](reference/exchanges-list), [/exchanges/](reference/exchanges-id), [/exchanges//tickers](reference/exchanges-id-tickers), and [/exchanges//volume\_chart/range](reference/exchanges-id-volume-chart-range) - * NFT markets with [/nfts/markets](reference/nfts-markets) - * Multi-address queries with [/onchain/networks//pools/multi/](reference/pools-addresses) and [/onchain/networks//tokens/multi/](reference/tokens-data-contract-addresses) + * Exchange coverage with [/exchanges/list](https://docs.coingecko.com/reference/exchanges-list), [/exchanges/](https://docs.coingecko.com/reference/exchanges-id), [/exchanges//tickers](https://docs.coingecko.com/reference/exchanges-id-tickers), and [/exchanges//volume\_chart/range](https://docs.coingecko.com/reference/exchanges-id-volume-chart-range) + * NFT markets with [/nfts/markets](https://docs.coingecko.com/reference/nfts-markets) + * Multi-address queries with [/onchain/networks//pools/multi/](https://docs.coingecko.com/reference/pools-addresses) and [/onchain/networks//tokens/multi/](https://docs.coingecko.com/reference/tokens-data-contract-addresses) * Retired tools: - * We've removed endpoints such as [/coins/list](reference/coins-list), [/onchain/networks/trending\_pools](reference/trending-pools-network), and single-address pool/token queries in favor of more scalable multi-address endpoints + * We've removed endpoints such as [/coins/list](https://docs.coingecko.com/reference/coins-list), [/onchain/networks/trending\_pools](https://docs.coingecko.com/reference/trending-pools-network), and single-address pool/token queries in favor of more scalable multi-address endpoints ### Friendlier Time-related MCP Queries with ISO Support Time-based queries just got easier. MCP tools now accept **ISO date strings** (`YYYY-MM-DD` or `YYYY-MM-DDTHH:MM`) alongside UNIX timestamps. - For example, when using the [Coin Historical Chart Data within Time Range](reference/coins-id-market-chart-range) tool, you can now pass ISO date strings directly instead of converting them into UNIX timestamps for your LLM tools. + For example, when using the [Coin Historical Chart Data within Time Range](https://docs.coingecko.com/reference/coins-id-market-chart-range) tool, you can now pass ISO date strings directly instead of converting them into UNIX timestamps for your LLM tools. **CoinGecko API Team** @@ -2261,11 +2261,11 @@ Quick tips to empower your AI applications with CoinGecko API, and leverage our CoinGecko provides a powerful suite of AI-native tools to help you integrate real-time, historical, and onchain market data into your applications. Whether you're building a sophisticated trading bot, a market analysis tool, or a simple portfolio tracker, our AI toolkit is here to accelerate your development. -To help AI models interact with CoinGecko data effectively, we provide an `llms.txt` file at [/llms-full.txt](/llms-full.txt). This file gives models context on how to best query our API, ensuring more accurate and efficient data retrieval. We recommend utilizing this in your integrations of MCP and AI applications. +To help AI models interact with CoinGecko data effectively, we provide an `llms.txt` file at [/llms-full.txt](https://docs.coingecko.com/llms-full.txt). This file gives models context on how to best query our API, ensuring more accurate and efficient data retrieval. We recommend utilizing this in your integrations of MCP and AI applications. ## CoinGecko MCP Server -The **MCP (Model-Context-Protocol)** Server is your gateway for connecting AI agents and large language models, like Claude and Gemini, directly to CoinGecko's live data streams. It's ideal for building conversational applications that can perform complex, real-time crypto analysis and answer user queries with up-to-the-minute information. Learn how to connect your AI agent by checking out [CoinGecko MCP Server](/docs/mcp-server) +The **MCP (Model-Context-Protocol)** Server is your gateway for connecting AI agents and large language models, like Claude and Gemini, directly to CoinGecko's live data streams. It's ideal for building conversational applications that can perform complex, real-time crypto analysis and answer user queries with up-to-the-minute information. Learn how to connect your AI agent by checking out [CoinGecko MCP Server](https://docs.coingecko.com/docs/mcp-server) ## Tools for Your Workflow @@ -2519,16 +2519,16 @@ There are five different endpoints to get historical data of a coin: | Endpoint | Description | | ---------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- | -| [/coins/\{id}/history](/reference/coins-id-history) | Get the historical data (price, market cap, 24hrs volume, etc.) at a given date for a coin based on a particular coin ID. | -| [/coins/\{id}/market\_chart](/reference/coins-id-market-chart) | Get the historical chart data of a coin including time in UNIX, price, market cap and 24hrs volume based on particular coin ID. | -| [/coins/\{id}/market\_chart/range](/reference/coins-id-market-chart-range) | Get the historical chart data of a coin within certain time range in UNIX along with price, market cap and 24hrs volume based on particular coin ID. | -| [/coins/\{id}/contract/\{contract\_address}/market\_chart](/reference/contract-address-market-chart) | Get the historical chart data of a coin including time in UNIX, price, market cap and 24hrs volume based on token contract address. | -| [/coins/\{id}/contract/\{contract\_address}/market\_chart/range](/reference/contract-address-market-chart-range) | Get the historical chart data of a coin within certain time range in UNIX along with price, market cap and 24hrs volume based on token contract address. | +| [/coins/\{id}/history](https://docs.coingecko.com/reference/coins-id-history) | Get the historical data (price, market cap, 24hrs volume, etc.) at a given date for a coin based on a particular coin ID. | +| [/coins/\{id}/market\_chart](https://docs.coingecko.com/reference/coins-id-market-chart) | Get the historical chart data of a coin including time in UNIX, price, market cap and 24hrs volume based on particular coin ID. | +| [/coins/\{id}/market\_chart/range](https://docs.coingecko.com/reference/coins-id-market-chart-range) | Get the historical chart data of a coin within certain time range in UNIX along with price, market cap and 24hrs volume based on particular coin ID. | +| [/coins/\{id}/contract/\{contract\_address}/market\_chart](https://docs.coingecko.com/reference/contract-address-market-chart) | Get the historical chart data of a coin including time in UNIX, price, market cap and 24hrs volume based on token contract address. | +| [/coins/\{id}/contract/\{contract\_address}/market\_chart/range](https://docs.coingecko.com/reference/contract-address-market-chart-range) | Get the historical chart data of a coin within certain time range in UNIX along with price, market cap and 24hrs volume based on token contract address. | ### **Notes** -The data granularity (interval) for [/market\_chart](/reference/coins-id-market-chart) and [/market\_chart/range](/reference/coins-id-market-chart-range) endpoints is automatic and based on the date range: +The data granularity (interval) for [/market\_chart](https://docs.coingecko.com/reference/coins-id-market-chart) and [/market\_chart/range](https://docs.coingecko.com/reference/coins-id-market-chart-range) endpoints is automatic and based on the date range: * 1 day from current time = 5-minutely data * 1 day from anytime (except from current time) = hourly data @@ -2563,8 +2563,8 @@ Integrating these prompts into your workflow is simple. Copy the entire markdown Select the prompt that matches your project's tech stack. -* 🐍 **[Python](/docs/python-ai-prompts)**: A complete guide for implementing the CoinGecko API using our official [coingecko-sdk](https://pypi.org/project/coingecko-sdk/). -* 🟦 **[TypeScript](/docs/typescript-ai-prompts#/)**: The definitive prompt for integrating the CoinGecko API with our official [@coingecko/coingecko-typescript](https://www.npmjs.com/package/@coingecko/coingecko-typescript) package. +* 🐍 **[Python](https://docs.coingecko.com/docs/python-ai-prompts)**: A complete guide for implementing the CoinGecko API using our official [coingecko-sdk](https://pypi.org/project/coingecko-sdk/). +* 🟦 **[TypeScript](https://docs.coingecko.com/docs/typescript-ai-prompts#/)**: The definitive prompt for integrating the CoinGecko API with our official [@coingecko/coingecko-typescript](https://www.npmjs.com/package/@coingecko/coingecko-typescript) package. To get the most out of our AI prompts, keep these tips in mind: @@ -2583,14 +2583,14 @@ Source: https://docs.coingecko.com/docs/10-mins-tutorial-guide New to CoinGecko API? Fret not. Whether you're a programmer or someone with zero coding experience, we've got you covered! -If you are not a developer and prefer to learn only specific tutorials on Google Sheet/Excel, feel free to check [👶 Tutorials (Beginner-friendly)](/docs/tutorials-beginner-friendly) +If you are not a developer and prefer to learn only specific tutorials on Google Sheet/Excel, feel free to check [👶 Tutorials (Beginner-friendly)](https://docs.coingecko.com/docs/tutorials-beginner-friendly) | Tutorial Steps | Description | | ----------------------------------------------------------------- | ------------------------------------------------------------------------------------------------ | -| [1. Get data by ID or Address](/docs/1-get-data-by-id-or-address) | Learn how to use different endpoints by obtaining Coin ID and token's contract address at first. | -| [2. Get Historical Data](/docs/2-get-historical-data) | Learn how to get historical data of a coin by using different historical endpoints. | -| [3. Get Exchanges & NFT Data](/docs/3-get-exchanges-nft-data) | Learn how to query exchanges and NFT data by accessing different endpoints. | -| [4. Get On-chain Data](/docs/4-get-on-chain-data) | Learn how to use `/onchain` GT endpoints to query onchain data. | +| [1. Get data by ID or Address](https://docs.coingecko.com/docs/1-get-data-by-id-or-address) | Learn how to use different endpoints by obtaining Coin ID and token's contract address at first. | +| [2. Get Historical Data](https://docs.coingecko.com/docs/2-get-historical-data) | Learn how to get historical data of a coin by using different historical endpoints. | +| [3. Get Exchanges & NFT Data](https://docs.coingecko.com/docs/3-get-exchanges-nft-data) | Learn how to query exchanges and NFT data by accessing different endpoints. | +| [4. Get On-chain Data](https://docs.coingecko.com/docs/4-get-on-chain-data) | Learn how to use `/onchain` GT endpoints to query onchain data. | --- @@ -2618,73 +2618,73 @@ Discover how CoinGecko API is used at CoinGecko.com and GeckoTerminal.com -1. [/global](/reference/crypto-global) — Display global crypto data such as number of active cryptocurrencies, exchanges and etc. -2. [/search/trending](/reference/trending-search) — Display trending search coins, NFTs and categories. -3. [/coins/top\_gainers\_losers](/reference/coins-top-gainers-losers) — Display the largest gainers in 24hr. -4. [/coins/categories](/reference/coins-categories) — Display all the categories list. -5. [/coins/markets](/reference/coins-markets) — Display all the supported coins with market related data. +1. [/global](https://docs.coingecko.com/reference/crypto-global) — Display global crypto data such as number of active cryptocurrencies, exchanges and etc. +2. [/search/trending](https://docs.coingecko.com/reference/trending-search) — Display trending search coins, NFTs and categories. +3. [/coins/top\_gainers\_losers](https://docs.coingecko.com/reference/coins-top-gainers-losers) — Display the largest gainers in 24hr. +4. [/coins/categories](https://docs.coingecko.com/reference/coins-categories) — Display all the categories list. +5. [/coins/markets](https://docs.coingecko.com/reference/coins-markets) — Display all the supported coins with market related data. ### [Coin Page](https://www.coingecko.com/en/coins/bitcoin) -1. [/coins/\{id} ](/reference/coins-id)— Display all the coin data including name, price, market related data, website, explorers and etc. -2. [/simple/price](/reference/simple-price) — Display data such as latest coin price, market cap and 24hr trading volume. -3. * [/coins/\{id}/history](/reference/coins-id-history) — Display the historical price data. - * [/coins/\{id}/market\_chart](/reference/coins-id-market-chart) — Display the historical data in line chart. - * [/coins/\{id}/ohlc](/reference/coins-id-ohlc) — Display the historical data in candlestick chart. +1. [/coins/\{id} ](https://docs.coingecko.com/reference/coins-id)— Display all the coin data including name, price, market related data, website, explorers and etc. +2. [/simple/price](https://docs.coingecko.com/reference/simple-price) — Display data such as latest coin price, market cap and 24hr trading volume. +3. * [/coins/\{id}/history](https://docs.coingecko.com/reference/coins-id-history) — Display the historical price data. + * [/coins/\{id}/market\_chart](https://docs.coingecko.com/reference/coins-id-market-chart) — Display the historical data in line chart. + * [/coins/\{id}/ohlc](https://docs.coingecko.com/reference/coins-id-ohlc) — Display the historical data in candlestick chart. ### [Exchanges Page](https://www.coingecko.com/en/exchanges/hyperliquid-spot) -1. [/exchanges/\{id}](/reference/exchanges-id) — Display the exchange information such as name, type, market related data such as trading volume and etc. -2. [/exchanges/\{id}/volume\_chart](/reference/exchanges-id-volume-chart) — Display the historical volume chart data. -3. [/exchanges/\{id}/tickers](/reference/exchanges-id-tickers) — Display the exchange's tickers. +1. [/exchanges/\{id}](https://docs.coingecko.com/reference/exchanges-id) — Display the exchange information such as name, type, market related data such as trading volume and etc. +2. [/exchanges/\{id}/volume\_chart](https://docs.coingecko.com/reference/exchanges-id-volume-chart) — Display the historical volume chart data. +3. [/exchanges/\{id}/tickers](https://docs.coingecko.com/reference/exchanges-id-tickers) — Display the exchange's tickers. ### [NFTs Page](https://www.coingecko.com/en/nft/pudgy-penguins) -1. [/nfts/\{id}](/reference/nfts-id) — Display NFT data such as name, contract address, website, market related data such as floor price, market cap, volume and etc. -2. [/nfts/\{id}/market\_chart](/reference/nfts-id-market-chart) — Display the historical market data in chart. -3. [/nfts/\{id}](/reference/nfts-id) — Display the description of the NFT collection. -4. [/nfts/\{id}/tickers](/reference/nfts-id-tickers) — Display the tickers of the NFT collection on different NFT marketplace. +1. [/nfts/\{id}](https://docs.coingecko.com/reference/nfts-id) — Display NFT data such as name, contract address, website, market related data such as floor price, market cap, volume and etc. +2. [/nfts/\{id}/market\_chart](https://docs.coingecko.com/reference/nfts-id-market-chart) — Display the historical market data in chart. +3. [/nfts/\{id}](https://docs.coingecko.com/reference/nfts-id) — Display the description of the NFT collection. +4. [/nfts/\{id}/tickers](https://docs.coingecko.com/reference/nfts-id-tickers) — Display the tickers of the NFT collection on different NFT marketplace. ### [Home Page](https://www.geckoterminal.com/) -1. [/onchain/search/pools ](/reference/search-pools)— Allow users to search for pools on GeckoTerminal. -2. [/onchain/networks](/reference/networks-list) — Display a list of supported networks on GeckoTerminal. -3. [/onchain/networks/trending\_pools](/reference/trending-pools-list) — Display a list of trending pools across all networks on GeckoTerminal. -4. [/onchain/networks/new\_pools](/reference/latest-pools-list) — Display all the latest pools across all networks on GeckoTerminal. -5. [/onchain/categories](/reference/categories-list) — Display all the onchain categories on GeckoTerminal. +1. [/onchain/search/pools ](https://docs.coingecko.com/reference/search-pools)— Allow users to search for pools on GeckoTerminal. +2. [/onchain/networks](https://docs.coingecko.com/reference/networks-list) — Display a list of supported networks on GeckoTerminal. +3. [/onchain/networks/trending\_pools](https://docs.coingecko.com/reference/trending-pools-list) — Display a list of trending pools across all networks on GeckoTerminal. +4. [/onchain/networks/new\_pools](https://docs.coingecko.com/reference/latest-pools-list) — Display all the latest pools across all networks on GeckoTerminal. +5. [/onchain/categories](https://docs.coingecko.com/reference/categories-list) — Display all the onchain categories on GeckoTerminal. ### [Chain Page](https://www.geckoterminal.com/eth/pools) -1. [/onchain/networks/\{network}/dexes](/reference/dexes-list) — Display all the supported dex on a network on GeckoTerminal. -2. [/onchain/networks/\{network}/trending\_pools](/reference/trending-pools-network) — Display a list of trending pools on a network on GeckoTerminal. -3. [/onchain/networks/\{network}/new\_pools](/reference/latest-pools-network) — Display a list of new pools on a network on GeckoTerminal. -4. [/onchain/networks/\{network}/pools](/reference/top-pools-network) — Display all the top pools on a network on GeckoTerminal. -5. [/onchain/categories/\{category\_id}/pools](/reference/pools-category) — Display all the pools under a specific onchain category on GeckoTerminal. +1. [/onchain/networks/\{network}/dexes](https://docs.coingecko.com/reference/dexes-list) — Display all the supported dex on a network on GeckoTerminal. +2. [/onchain/networks/\{network}/trending\_pools](https://docs.coingecko.com/reference/trending-pools-network) — Display a list of trending pools on a network on GeckoTerminal. +3. [/onchain/networks/\{network}/new\_pools](https://docs.coingecko.com/reference/latest-pools-network) — Display a list of new pools on a network on GeckoTerminal. +4. [/onchain/networks/\{network}/pools](https://docs.coingecko.com/reference/top-pools-network) — Display all the top pools on a network on GeckoTerminal. +5. [/onchain/categories/\{category\_id}/pools](https://docs.coingecko.com/reference/pools-category) — Display all the pools under a specific onchain category on GeckoTerminal. ### [Pool Page](https://www.geckoterminal.com/eth/pools/0x88e6a0c2ddd26feeb64f039a2c41296fcb3f5640) -1. * [/onchain/networks/\{network}/pools/\{address}](/reference/pool-address) — Display pool data such as price, transactions, volume and etc. - * [/onchain/networks/\{network}/pools/\{pool\_address}/info](/reference/pool-token-info-contract-address) — Display pool information such as name, symbol, image URL, description and etc. -2. [/onchain/networks/\{network}/pools/\{pool\_address}/ohlcv/\{timeframe}](/reference/pool-ohlcv-contract-address) — Display the OHLCV chart of the pool. -3. [/onchain/networks/\{network}/pools/\{pool\_address}/trades](/reference/pool-trades-contract-address) — Display the trades of the pool in the past 24 hours. +1. * [/onchain/networks/\{network}/pools/\{address}](https://docs.coingecko.com/reference/pool-address) — Display pool data such as price, transactions, volume and etc. + * [/onchain/networks/\{network}/pools/\{pool\_address}/info](https://docs.coingecko.com/reference/pool-token-info-contract-address) — Display pool information such as name, symbol, image URL, description and etc. +2. [/onchain/networks/\{network}/pools/\{pool\_address}/ohlcv/\{timeframe}](https://docs.coingecko.com/reference/pool-ohlcv-contract-address) — Display the OHLCV chart of the pool. +3. [/onchain/networks/\{network}/pools/\{pool\_address}/trades](https://docs.coingecko.com/reference/pool-trades-contract-address) — Display the trades of the pool in the past 24 hours. ### [Categories Page](https://www.geckoterminal.com/category) -1. [/onchain/categories](/reference/categories-list) — Display list of onchain categories with market data. -2. [/onchain/categories/\{id}/pools](/reference/pools-category) — Display list of pools with market data of a specific onchain category. +1. [/onchain/categories](https://docs.coingecko.com/reference/categories-list) — Display list of onchain categories with market data. +2. [/onchain/categories/\{id}/pools](https://docs.coingecko.com/reference/pools-category) — Display list of pools with market data of a specific onchain category. --- From 098dd0415952df96c6bdb9d42105ea2c97a60b8c Mon Sep 17 00:00:00 2001 From: tukuaiai Date: Sat, 28 Feb 2026 07:23:03 +0800 Subject: [PATCH 11/43] docs: polymarket - fix doc-root links --- assets/skills/polymarket/references/api.md | 6 +- .../polymarket/references/getting_started.md | 16 ++-- assets/skills/polymarket/references/guides.md | 32 +++---- assets/skills/polymarket/references/learn.md | 24 ++--- .../skills/polymarket/references/llms-full.md | 88 +++++++++---------- assets/skills/polymarket/references/other.md | 4 +- .../skills/polymarket/references/trading.md | 20 ++--- 7 files changed, 95 insertions(+), 95 deletions(-) diff --git a/assets/skills/polymarket/references/api.md b/assets/skills/polymarket/references/api.md index a6f603a..0a19047 100644 --- a/assets/skills/polymarket/references/api.md +++ b/assets/skills/polymarket/references/api.md @@ -190,9 +190,9 @@ curl "https://gamma-api.polymarket.com/markets?tag_id=100381&closed=false&limit= 4. **Always Include `closed=false`:** Unless you specifically need historical data 5. **Implement Rate Limiting:** Respect API limits for production applications -* [Get Markets](/developers/gamma-markets-api/get-markets) - Full markets endpoint documentation -* [Get Events](/developers/gamma-markets-api/get-events) - Full events endpoint documentation -* [Search Markets](/developers/gamma-markets-api/get-public-search) - Search functionality +* [Get Markets](https://docs.polymarket.com/developers/gamma-markets-api/get-markets) - Full markets endpoint documentation +* [Get Events](https://docs.polymarket.com/developers/gamma-markets-api/get-events) - Full events endpoint documentation +* [Search Markets](https://docs.polymarket.com/developers/gamma-markets-api/get-public-search) - Search functionality --- diff --git a/assets/skills/polymarket/references/getting_started.md b/assets/skills/polymarket/references/getting_started.md index 965c631..ba0be42 100644 --- a/assets/skills/polymarket/references/getting_started.md +++ b/assets/skills/polymarket/references/getting_started.md @@ -193,7 +193,7 @@ Source: https://docs.polymarket.com/quickstart/introduction/definitions | **Token** | A token represents a stake in a specific Yes/No outcome in a Market. The price of a token can fluctuate between $0 - $1 based on the market belief in the outcome. When a market resolves, the token associated with the correct prediction can be redeemed for \$1 USDC. This is also sometimes called an *Asset Id* | | **Market** | A single event outcome. Corresponds to a pair of CLOB token IDs(Yes/No), a market address, a question ID and a condition ID. | | **Event** | A collection of related markets grouped under a common topic or theme. | -| **SLUG** | A human readable identification for a market or event. Can be found in the URL of any Polymarket Market or Event. You can use this slug to find more detailed information about a market or event by using it as a parameter in the [Get Events](/developers/gamma-markets-api/get-events) or [Get Markets](/developers/gamma-markets-api/get-markets) endpoints. | +| **SLUG** | A human readable identification for a market or event. Can be found in the URL of any Polymarket Market or Event. You can use this slug to find more detailed information about a market or event by using it as a parameter in the [Get Events](https://docs.polymarket.com/developers/gamma-markets-api/get-events) or [Get Markets](https://docs.polymarket.com/developers/gamma-markets-api/get-markets) endpoints. | | **Negative Risk (negrisk)** | A group of Markets(Event) in which only one Market can resolve as yes. For more detail see [Negrisk Details](https://docs.polymarket.com/developers/neg-risk/overview) | | **Central Limit Order Book** | The off-chain order matching system. This is where you place resting orders and market orders are matched with existing orders before being sent on-chain. | | **Polygon Network** | A scalable, multi-chain blockchain platform used by Polymarket to facilitate on-chain activities(contract creation, token transfers, etc) | @@ -247,7 +247,7 @@ Source: https://docs.polymarket.com/polymarket-learn/FAQ/does-polymarket-have-an Getting data from Polymarket -Yes! Developers can find all the information they need for interacting with Polymarket. This includes [documentation on market discovery, resolution, trading etc.](/quickstart/introduction/main) +Yes! Developers can find all the information they need for interacting with Polymarket. This includes [documentation on market discovery, resolution, trading etc.](https://docs.polymarket.com/quickstart/introduction/main) Whether you are an academic researcher a market maker or an indepedent developer, this documentation should provide you what you need to get started. All the code you find linked here and on our [GitHub](https://github.com/polymarket) is open source and free to use. @@ -267,7 +267,7 @@ This section of the documentation will provide all the essential resources to he Everything you need to start building with the Polymarket API is right here. Let’s get started. -[Not sure what to build next? Get inspired by checking out real examples from other developers using the API.](/quickstart/introduction/showcase) +[Not sure what to build next? Get inspired by checking out real examples from other developers using the API.](https://docs.polymarket.com/quickstart/introduction/showcase) --- @@ -327,13 +327,13 @@ Polymarket is the world’s largest prediction market, allowing you to stay info Studies show prediction markets are often more accurate than pundits because they combine news, polls, and expert opinions into a single value that represents the market's view of an event's odds. Our markets reflect *accurate, unbiased, and real-time probabilities* for the events that matter most to you. Markets seek truth. -* On Polymarket, you can [buy and sell shares](making-your-first-trade) representing future event outcomes (i.e. "Will TikTok be banned in the U.S. this year?") +* On Polymarket, you can [buy and sell shares](https://docs.polymarket.com/polymarket-learn/get-started/making-your-first-trade) representing future event outcomes (i.e. "Will TikTok be banned in the U.S. this year?") -* Shares in event outcomes are [always priced](what-is-polymarket/#understanding-prices) between 0.00 and 1.00 [USDC](../FAQ/why-do-i-need-crypto/#why-usdc), and every pair of event outcomes (i.e. each pair of "YES" + "NO" shares) is fully collateralized by \$1.00 USDC. +* Shares in event outcomes are [always priced](https://docs.polymarket.com/polymarket-learn/get-started/what-is-polymarket/#understanding-prices) between 0.00 and 1.00 [USDC](https://docs.polymarket.com/polymarket-learn/FAQ/why-do-i-need-crypto/#why-usdc), and every pair of event outcomes (i.e. each pair of "YES" + "NO" shares) is fully collateralized by \$1.00 USDC. -* Shares are created when [opposing sides come to an agreement on odds](../trading/limit-orders), such that the sum of what each side is willing to pay is equal to \$1.00. +* Shares are created when [opposing sides come to an agreement on odds](https://docs.polymarket.com/polymarket-learn/trading/limit-orders), such that the sum of what each side is willing to pay is equal to \$1.00. -* The shares representing the *correct, final outcome* are paid out \$1.00 USDC each upon [market resolution](../markets/how-are-markets-resolved). +* The shares representing the *correct, final outcome* are paid out \$1.00 USDC each upon [market resolution](https://docs.polymarket.com/polymarket-learn/markets/how-are-markets-resolved). * Unlike sportsbooks, you are not betting against "the house" – the counterparty to each trade is another Polymarket user. As such: @@ -351,7 +351,7 @@ Prices = Probabilities. These odds are determined by what price other Polymarket users are currently willing to buy & sell those shares at. Just how stock exchanges don't "set" the prices of stocks, Polymarket does not set prices / odds - they're a function of supply & demand. -[Learn more >](/docs/guides/trading/how-are-prices-calculated) +[Learn more >](https://docs.polymarket.com/docs/guides/trading/how-are-prices-calculated) ### Making money on markets diff --git a/assets/skills/polymarket/references/guides.md b/assets/skills/polymarket/references/guides.md index 13c3434..0f67018 100644 --- a/assets/skills/polymarket/references/guides.md +++ b/assets/skills/polymarket/references/guides.md @@ -52,9 +52,9 @@ Individual markets and events are best fetched using their unique slug identifie From any Polymarket URL, the slug is the path segment after `/event/` or `/market/`: -**For Events:** [GET /events/slug/{slug}](/api-reference/events/list-events) +**For Events:** [GET /events/slug/{slug}](https://docs.polymarket.com/api-reference/events/list-events) -**For Markets:** [GET /markets/slug/{slug}](/api-reference/markets/list-markets) +**For Markets:** [GET /markets/slug/{slug}](https://docs.polymarket.com/api-reference/markets/list-markets) **Use Case:** When you want to filter markets by category, sport, or topic. @@ -62,9 +62,9 @@ Tags provide a powerful way to categorize and filter markets. You can discover a ### Discover Available Tags -**General Tags:** [GET /tags](/api-reference/tags/list-tags) +**General Tags:** [GET /tags](https://docs.polymarket.com/api-reference/tags/list-tags) -**Sports Tags & Metadata:** [GET /sports](/api-reference/sports/get-sports-metadata-information) +**Sports Tags & Metadata:** [GET /sports](https://docs.polymarket.com/api-reference/sports/get-sports-metadata-information) The `/sports` endpoint returns comprehensive metadata for sports including tag IDs, images, resolution sources, and series information. @@ -72,9 +72,9 @@ The `/sports` endpoint returns comprehensive metadata for sports including tag I Once you have tag IDs, you can use them with the `tag_id` parameter in both markets and events endpoints. -**Markets with Tags:** [GET /markets](/api-reference/markets/list-markets) +**Markets with Tags:** [GET /markets](https://docs.polymarket.com/api-reference/markets/list-markets) -**Events with Tags:** [GET /events](/api-reference/events/list-events) +**Events with Tags:** [GET /events](https://docs.polymarket.com/api-reference/events/list-events) ### Additional Tag Filtering @@ -87,9 +87,9 @@ Once you have tag IDs, you can use them with the `tag_id` parameter in both mark The most efficient approach is to use the `/events` endpoint and work backwards, as events contain their associated markets. -**Events Endpoint:** [GET /events](/api-reference/events/list-events) +**Events Endpoint:** [GET /events](https://docs.polymarket.com/api-reference/events/list-events) -**Markets Endpoint:** [GET /markets](/api-reference/markets/list-markets) +**Markets Endpoint:** [GET /markets](https://docs.polymarket.com/api-reference/markets/list-markets) * `order=id` - Order by event ID * `ascending=false` - Get newest events first @@ -129,9 +129,9 @@ Tags provide a powerful way to categorize and filter markets. You can discover a ### Discover Available Tags -**General Tags:** [GET /tags](/api-reference/tags/list-tags) +**General Tags:** [GET /tags](https://docs.polymarket.com/api-reference/tags/list-tags) -**Sports Tags & Metadata:** [GET /sports](/api-reference/sports/get-sports-metadata-information) +**Sports Tags & Metadata:** [GET /sports](https://docs.polymarket.com/api-reference/sports/get-sports-metadata-information) The `/sports` endpoint returns comprehensive metadata for sports including tag IDs, images, resolution sources, and series information. @@ -139,9 +139,9 @@ The `/sports` endpoint returns comprehensive metadata for sports including tag I Once you have tag IDs, you can use them with the `tag_id` parameter in both markets and events endpoints. -**Markets with Tags:** [GET /markets](/api-reference/markets/list-markets) +**Markets with Tags:** [GET /markets](https://docs.polymarket.com/api-reference/markets/list-markets) -**Events with Tags:** [GET /events](/api-reference/events/list-events) +**Events with Tags:** [GET /events](https://docs.polymarket.com/api-reference/events/list-events) ``` Example 3 (unknown): @@ -161,9 +161,9 @@ You can also: The most efficient approach is to use the `/events` endpoint and work backwards, as events contain their associated markets. -**Events Endpoint:** [GET /events](/api-reference/events/list-events) +**Events Endpoint:** [GET /events](https://docs.polymarket.com/api-reference/events/list-events) -**Markets Endpoint:** [GET /markets](/api-reference/markets/list-markets) +**Markets Endpoint:** [GET /markets](https://docs.polymarket.com/api-reference/markets/list-markets) ### Key Parameters @@ -200,7 +200,7 @@ For large datasets, use pagination with `limit` and `offset` parameters: - Video Walkthrough - Placing a Market Order -Once you've [signed up](../get-started/how-to-signup) and [deposited funds](../get-started/how-to-deposit), you're ready to start trading on Polymarket. Here's a step-by-step guide to get you started. +Once you've [signed up](https://docs.polymarket.com/polymarket-learn/get-started/how-to-signup) and [deposited funds](https://docs.polymarket.com/polymarket-learn/get-started/how-to-deposit), you're ready to start trading on Polymarket. Here's a step-by-step guide to get you started.