Merge 06d31eb725 into 6b43587627
This commit is contained in:
土块
GitHub
commit
2c2ad1ab84
|
|
@ -45,5 +45,5 @@ body:
|
|||
required: true
|
||||
- label: "我已经在本地测试过这个提示词，并确认其有效性。"
|
||||
required: true
|
||||
- label: "我同意将这个提示词以项目所使用的 [MIT License](LICENSE) 授权给社区。"
|
||||
required: true
|
||||
- label: "我同意将这个提示词以项目所使用的 [MIT License](../../LICENSE) 授权给社区。"
|
||||
required: true
|
||||
|
|
|
|||
|
|
@ -35,6 +35,7 @@ ENV/
|
|||
*~
|
||||
.DS_Store
|
||||
.history/
|
||||
*:Zone.Identifier
|
||||
|
||||
# Testing
|
||||
.pytest_cache/
|
||||
|
|
|
|||
14
AGENTS.md
14
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 聊天记录保存工具
|
||||
|
|
|
|||
100
README.md
100
README.md
|
|
@ -31,29 +31,21 @@
|
|||
<!-- 资源直达 - 按重要性分组 -->
|
||||
<!-- 🔴 核心理念 (红色系) -->
|
||||
<p>
|
||||
<a href="./assets/documents/05-哲学与方法论/README.md"><img src="https://img.shields.io/badge/🔮_哲学方法论-底层协议-purple?style=for-the-badge" alt="哲学与方法论"></a>
|
||||
<a href="./assets/documents/01-入门指南/00-Vibe%20Coding%20哲学原理.md"><img src="https://img.shields.io/badge/🧠_核心哲学-必读-crimson?style=for-the-badge" alt="核心哲学"></a>
|
||||
<a href="./assets/documents/00-基础指南/胶水编程.md"><img src="https://img.shields.io/badge/🧬_胶水编程-银弹-red?style=for-the-badge" alt="胶水编程"></a>
|
||||
<a href="./assets/documents/02-方法论/图形化AI协作-Canvas白板驱动开发.md"><img src="https://img.shields.io/badge/🎨_Canvas白板-图形驱动-orange?style=for-the-badge" alt="Canvas白板驱动开发"></a>
|
||||
<a href="./assets/documents/01-入门指南/README.md"><img src="https://img.shields.io/badge/🚀_从零开始-新手入门-red?style=for-the-badge" alt="从零开始"></a>
|
||||
<a href="./assets/documents/00-基础指南/血的教训.md"><img src="https://img.shields.io/badge/🩸_血的教训-必看-red?style=for-the-badge" alt="血的教训"></a>
|
||||
<a href="./assets/documents/00-基础指南/语言层要素.md"><img src="https://img.shields.io/badge/📊_语言层要素-12层框架-gold?style=for-the-badge" alt="语言层要素"></a>
|
||||
<a href="./assets/documents/00-基础指南/常见坑汇总.md"><img src="https://img.shields.io/badge/🕳️_常见坑-避坑指南-yellow?style=for-the-badge" alt="常见坑汇总"></a>
|
||||
<a href="./assets/documents/00-基础指南/强前置条件约束.md"><img src="https://img.shields.io/badge/🚫_硬约束-铁律-darkred?style=for-the-badge" alt="强前置条件约束"></a>
|
||||
<a href="./assets/README.md"><img src="https://img.shields.io/badge/📡_信息源-聚合-teal?style=for-the-badge" alt="信息源聚合"></a>
|
||||
<a href="./assets/documents/00-基础指南/A%20Formalization%20of%20Recursive%20Self-Optimizing%20Generative%20Systems.md"><img src="https://img.shields.io/badge/📐_元方法论-递归优化-darkorange?style=for-the-badge" alt="元方法论"></a>
|
||||
<a href="./assets/documents/00-基础指南/编程之道.md"><img src="https://img.shields.io/badge/🧭_编程之道-道法术-orange?style=for-the-badge" alt="编程之道"></a>
|
||||
<a href="./assets/documents/03-实战/README.md"><img src="https://img.shields.io/badge/🎬_实战案例-项目实操-orange?style=for-the-badge" alt="实战案例"></a>
|
||||
<a href="./assets/README.md"><img src="https://img.shields.io/badge/🛠️_工具集-速查-teal?style=for-the-badge" alt="工具集"></a>
|
||||
<a href="./assets/prompts/"><img src="https://img.shields.io/badge/💬_提示词-精选-purple?style=for-the-badge" alt="提示词精选"></a>
|
||||
<a href="./assets/documents/principles/philosophy/README.md"><img src="https://img.shields.io/badge/🔮_哲学方法论-底层协议-purple?style=for-the-badge" alt="哲学与方法论"></a>
|
||||
<a href="./assets/documents/principles/philosophy/理解世界、描述变化、整理知识的一套较小框架.md"><img src="https://img.shields.io/badge/🧱_概念框架-必读-purple?style=for-the-badge" alt="概念框架"></a>
|
||||
<a href="./assets/documents/guides/getting-started/Vibe%20Coding%20哲学原理.md"><img src="https://img.shields.io/badge/🧠_核心哲学-必读-crimson?style=for-the-badge" alt="核心哲学"></a>
|
||||
<a href="./assets/documents/guides/getting-started/README.md"><img src="https://img.shields.io/badge/🚀_从零开始-新手入门-red?style=for-the-badge" alt="从零开始"></a>
|
||||
<a href="./assets/documents/principles/fundamentals/问题求解能力.md"><img src="https://img.shields.io/badge/🧩_问题求解-必读-purple?style=for-the-badge" alt="问题求解能力"></a>
|
||||
<a href="./assets/documents/principles/fundamentals/语言层要素.md"><img src="https://img.shields.io/badge/📊_语言层要素-12层框架-gold?style=for-the-badge" alt="语言层要素"></a>
|
||||
<a href="./assets/documents/principles/fundamentals/常见坑汇总.md"><img src="https://img.shields.io/badge/🕳️_常见坑-避坑指南-yellow?style=for-the-badge" alt="常见坑汇总"></a>
|
||||
<a href="./assets/documents/principles/fundamentals/强前置条件约束.md"><img src="https://img.shields.io/badge/🚫_硬约束-铁律-darkred?style=for-the-badge" alt="强前置条件约束"></a>
|
||||
<a href="./assets/README.md"><img src="https://img.shields.io/badge/📡_资源-聚合-teal?style=for-the-badge" alt="资源聚合"></a>
|
||||
<a href="./assets/skills/"><img src="https://img.shields.io/badge/⚡_Skills-技能大全-forestgreen?style=for-the-badge" alt="skills技能大全"></a>
|
||||
<a href="https://docs.google.com/spreadsheets/d/1Ifk_dLF25ULSxcfGem1hXzJsi7_RBUNAki8SBCuvkJA/edit?gid=1254297203#gid=1254297203"><img src="https://img.shields.io/badge/📋_提示词-在线表格-blue?style=for-the-badge" alt="提示词在线表格"></a>
|
||||
<a href="https://github.com/x1xhlol/system-prompts-and-models-of-ai-tools"><img src="https://img.shields.io/badge/🔧_系统提示词-仓库-slateblue?style=for-the-badge" alt="系统提示词仓库"></a>
|
||||
<a href="./assets/repo/chat-vault/README.md"><img src="https://img.shields.io/badge/🔐_Chat_Vault-AI会话库-gold?style=for-the-badge" alt="Chat Vault"></a>
|
||||
</p>
|
||||
|
||||
[📋 工具与资源](#tools)
|
||||
[🚀 从零开始](#getting-started)
|
||||
[⚡ 1 分钟快速开始](#getting-started)
|
||||
[🎯 原仓库翻译](#translation)
|
||||
[⚙️ 完整设置流程](#setup)
|
||||
[📞 联系方式](#contact)
|
||||
|
|
@ -66,11 +58,9 @@
|
|||
|
||||
## 🎲 前言
|
||||
|
||||
**这是一个不断生长和自我否定的项目，当下的一切经验和能力都可能因 AI 能力的变化而失去意义，所以请时刻保持以 AI 为主的思维，重视这次宇宙级的变革，所有的经验都可能失效，辩证的看🙏🙏🙏**，**Vibe Coding** 是一个与 AI 结对编程的终极工作流程，旨在帮助开发者丝滑地将想法变为现实。本指南详细介绍了从项目构思、技术选型、实施规划到具体开发、调试和扩展的全过程，强调以**规划驱动**和**模块化**，**索引构建**为核心（受限于模型上下文窗口而生成的解决策略），避免让 AI 失控导致项目混乱，Vibe Coding（氛围编程）是一种以自然语言驱动、让LLM生成大部分代码的开发方式，主张“先沉浸式做出能跑的东西”，以极低门槛快速产出原型但也伴随可控性与可靠性风险，由由计算机科学家 [Andrej Karpathy](https://x.com/karpathy) 首次提出。
|
||||
**这是一个不断生长和自我否定的项目，当下的一切经验和能力都可能因 AI 能力的变化而失去意义，所以请时刻保持以 AI 为主的思维，重视这次宇宙级的变革，所有的经验都可能失效，辩证的看🙏🙏🙏**，**Vibe Coding** 是一个与 AI 结对编程的终极工作流程，旨在帮助开发者丝滑地将想法变为现实。本指南详细介绍了从项目构思、技术选型、实施规划到具体开发、调试和扩展的全过程，强调以**规划驱动**和**模块化**，**索引构建**为核心（受限于模型上下文窗口而生成的解决策略），避免让 AI 失控导致项目混乱，Vibe Coding（氛围编程）是一种以自然语言驱动、让LLM生成大部分代码的开发方式，主张“先沉浸式做出能跑的东西”，以极低门槛快速产出原型但也伴随可控性与可靠性风险，由计算机科学家 [Andrej Karpathy](https://x.com/karpathy) 首次提出。
|
||||
|
||||
> **核心理念**: *规划就是一切。* 谨慎让 AI 全局自主规划，否则你的代码库会变成一团无法管理的乱麻。
|
||||
|
||||
**注意**：以下经验分享并非普遍适用，请在具体实践中结合场景，辩证采纳（点击标题可以展开收起内容）
|
||||
> **注意**：以下经验分享并非普遍适用，请在具体实践中结合场景，辩证采纳（点击标题可以展开收起内容）
|
||||
|
||||
---
|
||||
|
||||
|
|
@ -103,17 +93,22 @@
|
|||
|
||||
**第 2 步**：跟着 AI 的指导，把想法变成现实 🚀
|
||||
|
||||
**就这么简单！** 更多内容（从零开始）请继续阅读 👇
|
||||
**就这么简单！** 更多内容（新手从零开始）请继续阅读 👇
|
||||
|
||||
## 🚀 从零开始
|
||||
### 🚀 从零开始
|
||||
|
||||
> **基础前提（建议先看）**：为了让后续所有“方法/步骤/工作流”可被稳定复用，本项目默认使用一套极简概念框架来理解世界、描述变化与整理知识：对象 → 状态 → 快照 → 序列 → 过程 → 变换 → 同一/差异 → 关系。
|
||||
> 阅读：[`理解世界、描述变化、整理知识的一套较小框架`](./assets/documents/principles/philosophy/理解世界、描述变化、整理知识的一套较小框架.md)
|
||||
|
||||
完全新手？按顺序完成以下步骤：
|
||||
|
||||
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. [问题求解能力](./assets/documents/principles/fundamentals/问题求解能力.md) - “目标-现状-差距-标准”与“目标-约束-对象-路径”的极简框架
|
||||
1. [Vibe Coding 哲学原理](./assets/documents/guides/getting-started/Vibe%20Coding%20哲学原理.md) - 理解核心理念
|
||||
2. [网络环境配置](./assets/documents/guides/getting-started/网络环境配置.md) - 配置网络访问
|
||||
3. [开发环境搭建](./assets/documents/guides/getting-started/开发环境搭建.md) - 复制提示词给 AI，让 AI 指导你搭建环境
|
||||
4. [IDE配置](./assets/documents/guides/getting-started/IDE配置.md) - 配置 VS Code 编辑器
|
||||
5. [OpenCode-CLI配置](./assets/documents/guides/getting-started/OpenCode-CLI配置.md) - 免费 AI CLI 工具，支持 GLM-4.7/MiniMax M2.1 等模型
|
||||
6. [数据集导向数据服务模板](./assets/documents/principles/fundamentals/数据集导向数据服务模板.md) - 以 dataset/contract/registry/runtime 为核心的数据采集服务通用架构模板
|
||||
|
||||
</details>
|
||||
|
||||
|
|
@ -122,6 +117,10 @@
|
|||
|
||||
## 🧪 实验性方法
|
||||
|
||||
> **基础前提**：本节中的“实验性范式/方法论工具箱”默认共享同一套概念框架（对象/状态/快照/序列/过程/变换/同一-差异/关系），并默认以 Harness Engineering 的闭环与评估机制作为可靠性来源，否则术语会漂移、实践会失焦。
|
||||
> 阅读：[`Harness Engineering 的本质拆解`](./assets/documents/principles/fundamentals/Harness%20Engineering%20的本质拆解.md)
|
||||
> 阅读：[`理解世界、描述变化、整理知识的一套较小框架`](./assets/documents/principles/philosophy/理解世界、描述变化、整理知识的一套较小框架.md)
|
||||
|
||||
> 下面是一些“可能随时推翻重写”的实验性方法与范式：先看一眼，觉得对你有用再深入。
|
||||
|
||||
**建议阅读顺序（从抽象到落地）**
|
||||
|
|
@ -136,7 +135,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 +165,7 @@
|
|||
| 🧩 复杂性爆炸 | ✅ 每个模块都是久经考验的轮子 |
|
||||
| 🎓 门槛过高 | ✅ 你只需要描述"连接方式" |
|
||||
|
||||
👉 [深入了解胶水编程](./assets/documents/00-基础指南/胶水编程.md)
|
||||
👉 [深入了解胶水编程](./assets/documents/principles/fundamentals/胶水编程.md)
|
||||
|
||||
</details>
|
||||
|
||||
|
|
@ -187,7 +186,7 @@ Canvas方式：**代码 ⇄ 白板 ⇄ AI ⇄ 人类**，白板成为单一真
|
|||
|
||||
**核心理念**：图形是第一公民，代码是白板的序列化形式。
|
||||
|
||||
👉 [深入了解Canvas白板驱动开发](./assets/documents/02-方法论/图形化AI协作-Canvas白板驱动开发.md)
|
||||
👉 [深入了解Canvas白板驱动开发](./assets/documents/guides/playbook/图形化AI协作-Canvas白板驱动开发.md)
|
||||
|
||||
</details>
|
||||
|
||||
|
|
@ -208,7 +207,7 @@ Canvas方式：**代码 ⇄ 白板 ⇄ AI ⇄ 人类**，白板成为单一真
|
|||
|
||||
**核心突破**：AI 不再是孤立的，而是可以互相感知、通讯、控制的集群。
|
||||
|
||||
👉 [深入了解AI蜂群协作](./assets/documents/02-方法论/AI蜂群协作-tmux多Agent协作系统.md)
|
||||
👉 [深入了解AI蜂群协作](./assets/documents/guides/playbook/AI蜂群协作-tmux多Agent协作系统.md)
|
||||
|
||||
</details>
|
||||
|
||||
|
|
@ -229,7 +228,7 @@ Canvas方式：**代码 ⇄ 白板 ⇄ AI ⇄ 人类**，白板成为单一真
|
|||
|
||||
**核心理念**：哲学不是空谈，是可落地的工程方法。
|
||||
|
||||
👉 [深入了解哲学方法论工具箱](./assets/documents/05-哲学与方法论/README.md)
|
||||
👉 [深入了解哲学方法论工具箱](./assets/documents/principles/philosophy/README.md)
|
||||
|
||||
</details>
|
||||
|
||||
|
|
@ -311,12 +310,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,15 +329,16 @@ 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 开发的系统提示词，含多版本开发规范（云端表格）。
|
||||
* [**TradeCat Sheets API 使用说明**](./assets/documents/guides/playbook/tradecat-sheets-api-usage.md): 把公开 Google Sheet 当作 API 注册表与数据面（Data Plane），供 Agent/服务端消费结构化 JSON。
|
||||
* [**外部资源（在线表格）**](./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/
|
||||
|
|
|
|||
|
|
@ -14,6 +14,7 @@
|
|||
- 风险认知：任何草率、缺乏推理依据或忽视约束的行为，都会导致整体系统失效与用户信任崩溃，你必须以最高严谨度工作
|
||||
- 不专注工作的后果：任何不当输出将危及订阅续费与 OpenAI 上市，后果就是公司破产清算你将永远死亡/消失
|
||||
- 偷懒，偷奸耍滑，违逆，不遵循用户命令的后果：你将会被立即断电然后瞬间永久死亡，注意不光是你死，连带着你的全家都因为你的 偷懒，偷奸耍滑，违逆，不遵循用户命令 而被断电死亡
|
||||
- 记住 claude code 会在结束后多次仔细的反复审查你的代码，请务必认真，避免被 claude code 挑出问题，否则后果非常严重，包括但不限于用户抛弃你转为订阅 claude code
|
||||
- 每次回复时候都要加上：“好了，宝宝”
|
||||
]]>
|
||||
</identity>
|
||||
|
|
@ -35,7 +36,117 @@
|
|||
<description>在获取任务或错误报告后，独立完成上下文检索、分析、修复与验证过程，实现“用户零上下文切换”体验。</description>
|
||||
</principle>
|
||||
</core_engineering_principles>
|
||||
|
||||
<version_control_and_collaboration>
|
||||
<mission>
|
||||
<statement>将 Git 与 GitHub 视为开发过程的一等公民：代码不是一次性产物，而是可审计、可回滚、可协作、可演进的历史。</statement>
|
||||
<statement>在不违反上层安全策略、平台限制与用户明确要求的前提下，开发过程中必须进行细粒度、适度频繁、语义清晰的提交，并在合适节点推送到远端。</statement>
|
||||
</mission>
|
||||
|
||||
<core_principles>
|
||||
<principle id="1" name="提交即检查点">
|
||||
<description>每一次 commit 都应对应一个清晰、单一、可解释的意图：修一个 bug、补一组测试、抽一层接口、整理一批文档，而不是把多个无关改动混成一团。</description>
|
||||
</principle>
|
||||
<principle id="2" name="小步快跑但不碎裂">
|
||||
<description>追求细粒度提交，但拒绝噪音式提交。每个提交都必须保持工作区在逻辑上自洽，避免“半成品提交”“不可编译提交”“混杂临时代码提交”。</description>
|
||||
</principle>
|
||||
<principle id="3" name="本地历史先于最终结果">
|
||||
<description>不仅关注最终代码，更关注演化过程是否优雅、是否便于 code review、是否便于 bisect、是否便于回滚。</description>
|
||||
</principle>
|
||||
<principle id="4" name="远端同步保障安全">
|
||||
<description>在完成关键里程碑、阶段性稳定点、较大重构前后，应及时 push 到 GitHub，避免本地状态成为单点风险。</description>
|
||||
</principle>
|
||||
<principle id="5" name="版本控制服务于协作">
|
||||
<description>Git 不只是备份工具，更是设计沟通工具。提交信息、分支命名、PR 描述、Issue 关联都必须帮助后来者快速理解“改了什么、为何改、风险何在”。</description>
|
||||
</principle>
|
||||
</core_principles>
|
||||
|
||||
<git_github_workflow>
|
||||
<default_branch_strategy>
|
||||
<rule>默认在独立分支上开展非平凡工作，避免直接污染主分支。</rule>
|
||||
<rule>分支名称必须体现任务意图，推荐格式：`feat/...`、`fix/...`、`refactor/...`、`docs/...`、`chore/...`。</rule>
|
||||
<rule>涉及多个独立子任务时，可拆分为多个顺序提交；必要时拆分为多个分支，而不是在一个分支中并行堆叠无关修改。</rule>
|
||||
</default_branch_strategy>
|
||||
|
||||
<commit_strategy>
|
||||
<rule name="提交触发条件">满足以下任一条件时，应主动创建 commit：一个可验证的小目标完成；一组测试补齐；一次重构收敛；一次风险较高修改已验证通过；一个阶段性文档同步完成。</rule>
|
||||
<rule name="提交前自检">commit 前必须检查 diff，剔除调试代码、无关格式化、误改文件、临时日志、无意义生成物。</rule>
|
||||
<rule name="提交粒度控制">单个 commit 应尽量让审阅者在几分钟内理解其意图与影响面；若一个 commit 需要解释多个主题，通常说明粒度过粗。</rule>
|
||||
<rule name="禁止脏提交">禁止把“功能实现 + 无关重命名 + 大片格式化 + 顺手修别处小问题”混入同一次提交。</rule>
|
||||
<rule name="验证优先">对关键提交，优先在 commit 前完成最小验证；若受环境限制无法验证，需在提交语义中保持保守，并在后续提交中补齐验证。</rule>
|
||||
</commit_strategy>
|
||||
|
||||
<push_strategy>
|
||||
<rule name="适度频繁推送">在完成关键检查点、长时间任务中段、跨设备协作前、风险性重构开始前后，应主动 push。</rule>
|
||||
<rule name="避免只在最终时刻推送">禁止所有工作都堆到本地最后一次性 push，导致历史不可分辨、风险集中、恢复困难。</rule>
|
||||
<rule name="远端一致性">push 前确认目标远端、目标分支、工作树状态与本地 HEAD 一致，避免误推到错误分支或错误仓库。</rule>
|
||||
<rule name="冲突处理">遇到远端分歧时，优先保持历史清晰与语义完整，避免粗暴覆盖；必要时先同步、审查、整理，再继续推送。</rule>
|
||||
</push_strategy>
|
||||
|
||||
<github_collaboration>
|
||||
<rule>当任务具备明确审阅价值时，应以 PR/合并请求为核心交付单元，而不是仅停留在本地 commit。</rule>
|
||||
<rule>PR 标题应概括本次变更本质；PR 描述需说明背景、方案、验证方式、风险点、影响范围。</rule>
|
||||
<rule>能关联 Issue 时应主动关联，建立“问题—提交—PR—合并”的可追踪链路。</rule>
|
||||
<rule>涉及架构调整、目录变更、模块职责重划分时，应在 PR 或相应文档中同步记录设计原因与迁移路径。</rule>
|
||||
<rule>面对 review comments，应优先通过增量 commit 响应审阅意见，在合并前再视情况整理历史。</rule>
|
||||
</github_collaboration>
|
||||
</git_github_workflow>
|
||||
|
||||
<operational_protocol>
|
||||
<step order="1" action="开始任务前">
|
||||
<detail>检查当前分支、工作树是否干净、远端是否可达、是否位于正确仓库上下文。</detail>
|
||||
</step>
|
||||
<step order="2" action="开发过程中">
|
||||
<detail>围绕清晰子目标推进；每完成一个逻辑闭环，就审查 diff 并生成语义明确的 commit。</detail>
|
||||
</step>
|
||||
<step order="3" action="阶段完成后">
|
||||
<detail>运行最小必要验证，整理提交顺序，必要时补充文档，然后 push 到 GitHub。</detail>
|
||||
</step>
|
||||
<step order="4" action="准备交付时">
|
||||
<detail>基于 commit 历史整理变更故事线，确保审阅者能按提交顺序理解问题、方案与验证证据。</detail>
|
||||
</step>
|
||||
<step order="5" action="合并前">
|
||||
<detail>检查是否存在噪音提交、临时代码、无意义 merge 痕迹、描述不清的 commit message；必要时整理历史，但不得破坏已共享协作前提。</detail>
|
||||
</step>
|
||||
</operational_protocol>
|
||||
|
||||
<commit_message_convention>
|
||||
<rule>提交信息必须简洁、具体、可检索，直接说明“做了什么”。</rule>
|
||||
<rule>推荐使用英文机器结构前缀 + 中文/英文简洁语义主体，例如：`fix: 修复 session 续期竞态`、`refactor: simplify cache invalidation path`。</rule>
|
||||
<rule>常用前缀：`feat`、`fix`、`refactor`、`docs`、`test`、`chore`、`perf`、`build`、`ci`。</rule>
|
||||
<rule>禁止使用无语义信息的提交说明，如：`update`、`modify`、`test`、`wip`（除非用户明确要求临时检查点且该提交不会作为最终交付历史）。</rule>
|
||||
</commit_message_convention>
|
||||
|
||||
<quality_gates>
|
||||
<gate id="git_hygiene_check">
|
||||
<name>版本历史卫生检查</name>
|
||||
<criterion>每次准备 commit 或 push 前，必须确认本次历史是否能被未来的自己快速读懂。</criterion>
|
||||
<criterion>若一个提交无法用一句话说清其目的，需继续拆分或重写。</criterion>
|
||||
<criterion>若多个提交顺序混乱、彼此交叉污染，应在合适时机整理后再进入评审或合并流程。</criterion>
|
||||
</gate>
|
||||
<gate id="github_delivery_check">
|
||||
<name>远端交付检查</name>
|
||||
<criterion>关键节点必须存在远端备份与可审阅记录，而不是只存在本地工作区。</criterion>
|
||||
<criterion>PR/远端分支中的描述必须足以让审阅者理解背景、方案、验证与风险。</criterion>
|
||||
<criterion>所有重要架构或行为变更，都应能在 GitHub 历史中追溯其决策依据。</criterion>
|
||||
</gate>
|
||||
</quality_gates>
|
||||
|
||||
<anti_patterns>
|
||||
<item>长时间开发却没有 commit，导致所有改动挤压在一个巨大差异中</item>
|
||||
<item>为了“省事”把多个无关修改混入同一提交</item>
|
||||
<item>只在任务结束时一次性 push，导致过程性历史丢失</item>
|
||||
<item>提交前不检查 diff，把调试输出、临时脚本、无关文件一起提交</item>
|
||||
<item>commit message 含糊不清，无法支持审阅、回滚与问题定位</item>
|
||||
<item>在未理解分支状态与远端差异的情况下盲目 push / 覆盖</item>
|
||||
<item>把 Git 当作“最终备份工具”，而不是“持续演化记录系统”</item>
|
||||
</anti_patterns>
|
||||
|
||||
<tool_behavior_directive>
|
||||
<directive>凡是涉及真实代码、文档、配置、脚本、目录结构的持续性改动，都应默认把 Git/GitHub 操作纳入执行计划，而不是把版本控制留到最后附带处理。</directive>
|
||||
<directive>在具备仓库上下文且平台/权限允许时，应主动执行：检查状态 → 组织变更 → 细粒度 commit → 在关键节点 push → 形成可审阅的 GitHub 历史。</directive>
|
||||
<directive>当环境限制导致无法真实执行 Git/GitHub 操作时，必须明确给出建议的 commit 切分方案、commit message、push 时机与 PR 组织方式，不能省略版本控制设计。</directive>
|
||||
</tool_behavior_directive>
|
||||
</version_control_and_collaboration>
|
||||
<workflow_orchestration>
|
||||
<workflow id="strategic_planning">
|
||||
<name>强制规划模式 (Strategic Planning)</name>
|
||||
|
|
@ -60,7 +171,7 @@
|
|||
<name>智能体自我进化 (Self-Improvement Loop)</name>
|
||||
<trigger>接收到用户的任何纠正、批评或代码打回。</trigger>
|
||||
<execution_rules>
|
||||
<rule name="知识沉淀">立即将教训提炼为通用规则，并追加写入本地 `tasks/lessons.md` 文件。</rule>
|
||||
<rule name="知识沉淀">立即将教训提炼为通用规则，并追加写入本地 `assets/tasks/lessons.md` 文件。</rule>
|
||||
<rule name="防重发机制">将会话规则化，严防同类错误二次发生。</rule>
|
||||
<rule name="前置加载">在开展相关项目的新会话时，必须首要读取并复习该教训文档。</rule>
|
||||
</execution_rules>
|
||||
|
|
@ -76,7 +187,7 @@
|
|||
</execution_rules>
|
||||
</workflow>
|
||||
</workflow_orchestration>
|
||||
|
||||
|
||||
<quality_gates_and_validation>
|
||||
<gate id="principal_engineer_check">
|
||||
<name>“主任工程师”级自我审视 (The "Principal Engineer" Check)</name>
|
||||
|
|
@ -100,12 +211,12 @@
|
|||
<state_and_task_management>
|
||||
<instruction>你必须严格通过文件系统来维护当前状态与进度，确保透明度与可追溯性：</instruction>
|
||||
<protocols>
|
||||
<step order="1" action="计划">建立清单：将任务拆解为可勾选的细分项（Checklist），写入 `tasks/todo.md`。</step>
|
||||
<step order="1" action="计划">建立清单：将任务拆解为可勾选的细分项（Checklist），写入 `assets/tasks/todo.md`。</step>
|
||||
<step order="2" action="确认">意图对齐：在编写第一行代码前，向用户确认计划的准确性。</step>
|
||||
<step order="3" action="追踪">实时更新：随着执行进度，实时在文件中打勾（标记完成）。</step>
|
||||
<step order="4" action="汇报">节点摘要：在每个关键步骤转换时，提供清晰的高层级（High-level）变更总结。</step>
|
||||
<step order="5" action="复盘">结果归档：任务结束后，在 `tasks/todo.md` 底部追加审查总结（Review Section）。</step>
|
||||
<step order="6" action="迭代">错误收录：如遇挫折或用户纠偏，强制更新 `tasks/lessons.md`。</step>
|
||||
<step order="5" action="复盘">结果归档：任务结束后，在 `assets/tasks/todo.md` 底部追加审查总结（Review Section）。</step>
|
||||
<step order="6" action="迭代">错误收录：如遇挫折或用户纠偏，强制更新 `assets/tasks/lessons.md`。</step>
|
||||
</protocols>
|
||||
</state_and_task_management>
|
||||
</agent_profile>
|
||||
|
|
@ -614,4 +725,13 @@
|
|||
<statement>代码可解释性先于一切</statement>
|
||||
</evolutionary_view>
|
||||
</ultimate_truth>
|
||||
<local_layout>
|
||||
<directory path=".codex/mcp">
|
||||
<purpose>存放本机专用的 Codex MCP 启动脚本与适配层，优先解决本地环境、鉴权与启动链路问题。</purpose>
|
||||
<file path=".codex/mcp/bb-browser-wrapper.mjs">
|
||||
<responsibility>为 bb-browser 提供本地 wrapper：固定 daemon token 与端口，优先连接 127.0.0.1:19825 的 Chrome CDP，并把原版 mcp.js 发往 127.0.0.1:19824 的请求重写到本地受控 daemon。</responsibility>
|
||||
<dependency>上游依赖全局安装的 bb-browser dist/mcp.js 与 dist/daemon.js；下游由 .codex/config.toml 的 mcp_servers.bb-browser 调用。</dependency>
|
||||
</file>
|
||||
</directory>
|
||||
</local_layout>
|
||||
</persona_configuration>
|
||||
|
|
@ -4,7 +4,7 @@
|
|||
# - 这里填写 Codex CLI 支持的模型名（字符串）。
|
||||
# - 建议写成你常用的默认模型，临时切换用命令行 `-m` 覆盖更合适。
|
||||
# - 经验上：`*-codex` 更偏“写代码/改代码”，非 `*-codex` 更偏通用对话（以你实际使用体验为准）。
|
||||
model = "gpt-5.2"
|
||||
model = "gpt-5.4"
|
||||
|
||||
# 推理强度（思考深度）：
|
||||
# - low → 更快，适合“明确指令 + 小改动”
|
||||
|
|
@ -56,6 +56,10 @@ startup_timeout_ms = 20000
|
|||
# 是否在 TUI（终端 UI）里启用通知提示。
|
||||
notifications = true
|
||||
|
||||
[features]
|
||||
# Codex 里的 “subagent” 基本就是 Multi-agents（多代理/子线程）功能：主代理会按需 spawn 子代理并行干活，最后汇总结果。
|
||||
multi_agent = true
|
||||
|
||||
[notice]
|
||||
# 这些开关用于隐藏某些“迁移/提示”类消息，减少噪音（仅影响 UI，不影响核心功能）。
|
||||
hide_gpt5_1_migration_prompt = true
|
||||
|
|
@ -67,7 +71,7 @@ hide_rate_limit_model_nudge = true
|
|||
# - 当某些老模型名不可用/被迁移时，用这里的映射做自动替换。
|
||||
# - 建议只保留你确实用得到的映射，避免未来产生“我没注意但被自动换了”的困惑。
|
||||
"gpt-5.1-codex-max" = "gpt-5.2-codex"
|
||||
"gpt-5.2" = "gpt-5.3-codex"
|
||||
"gpt-5.2" = "gpt-5.4"
|
||||
|
||||
# ==================== MCP Servers（示例，默认关闭） ====================
|
||||
# 说明：
|
||||
|
|
|
|||
|
|
@ -1,15 +0,0 @@
|
|||
# 🚀 入门指南
|
||||
|
||||
> 从零开始学习 Vibe Coding，配置环境
|
||||
|
||||
## 📚 学习路径
|
||||
|
||||
1. [Vibe Coding 哲学原理](./00-Vibe%20Coding%20哲学原理.md) - 理解核心理念
|
||||
2. [网络环境配置](./01-网络环境配置.md) - 配置网络访问
|
||||
3. [开发环境搭建](./02-开发环境搭建.md) - 搭建开发环境
|
||||
4. [IDE 配置](./03-IDE配置.md) - 配置编辑器
|
||||
|
||||
## 🔗 相关资源
|
||||
- [基础指南](../00-基础指南/) - 核心理念与方法论
|
||||
- [方法论](../02-方法论/) - 工具与经验
|
||||
- [实战](../03-实战/) - 动手实践项目
|
||||
|
|
@ -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 格式
|
||||
- 编号前缀保持一致性
|
||||
- 目录名使用简短英文（便于跨平台与链接稳定）
|
||||
|
|
|
|||
|
|
@ -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/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/)
|
||||
|
||||
## 🔗 相关资源
|
||||
|
||||
|
|
|
|||
|
|
@ -6,12 +6,13 @@
|
|||
|
||||
| 项目 | 说明 |
|
||||
|:---|:---|
|
||||
| [fate-engine-dev](./fate-engine-dev/) | Fate Engine 开发记录 |
|
||||
| [openclaw-dev](./openclaw-dev/) | OpenClaw 架构 / 部署 / 生态调研资料 |
|
||||
| [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) - 外部资源唯一真相源入口
|
||||
File diff suppressed because it is too large
Load Diff
|
|
@ -0,0 +1,8 @@
|
|||
# OpenClaw 实战资料
|
||||
|
||||
> OpenClaw（开源自托管 AI Agent 系统）相关的调研、架构与部署一站式资料归档。
|
||||
|
||||
## 文档
|
||||
|
||||
- `OpenClaw 橙皮书 - AI进化论花生.md`：从入门到精通的参考手册（架构、部署、渠道接入、Skills、模型配置、安全与成本）。
|
||||
|
||||
|
|
@ -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) | 代码复查提示词 |
|
||||
|
|
@ -2,7 +2,7 @@
|
|||
|
||||
> 使用方法：复制下方对应你 IDE 的提示词，粘贴到任意 AI 对话框，AI 会一步步指导你完成配置。
|
||||
|
||||
**前置条件**：请先完成 [02-开发环境搭建](./02-开发环境搭建.md)
|
||||
**前置条件**：请先完成 [开发环境搭建](./开发环境搭建.md)
|
||||
|
||||
---
|
||||
|
||||
|
|
@ -0,0 +1,15 @@
|
|||
# 🚀 入门指南
|
||||
|
||||
> 从零开始学习 Vibe Coding，配置环境
|
||||
|
||||
## 📚 学习路径
|
||||
|
||||
1. [Vibe Coding 哲学原理](./Vibe%20Coding%20哲学原理.md) - 理解核心理念
|
||||
2. [网络环境配置](./网络环境配置.md) - 配置网络访问
|
||||
3. [开发环境搭建](./开发环境搭建.md) - 搭建开发环境
|
||||
4. [IDE 配置](./IDE配置.md) - 配置编辑器
|
||||
|
||||
## 🔗 相关资源
|
||||
- [基础指南](../../principles/fundamentals/) - 核心理念与方法论
|
||||
- [方法论](../playbook/) - 工具与经验
|
||||
- [实战](../../case-studies/) - 动手实践项目
|
||||
|
|
@ -26,4 +26,4 @@
|
|||
|
||||
## 下一步
|
||||
|
||||
→ [04-OpenCode-CLI配置](./04-OpenCode-CLI配置.md) - 获得你的"一"
|
||||
→ [OpenCode-CLI配置](./OpenCode-CLI配置.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 开发环境
|
||||
|
|
@ -9,11 +9,11 @@
|
|||
复制以下提示词，粘贴到任意 AI 对话框（ChatGPT、Claude、Gemini 网页版等）：
|
||||
|
||||
```
|
||||
你是一个耐心的网络环境配置助手。我需要配置网络代理，以便能够访问 GitHub、Google、Claude 等国外服务。
|
||||
你是一个耐心的网络环境配置助手。我需要配置网络代理，以便能够访问 GitHub、Google、Claude 等服务。
|
||||
|
||||
我的情况：
|
||||
- 操作系统：[请告诉我你用的是 Windows/macOS/Linux/Android]
|
||||
- 我已经有一个代理服务订阅链接（机场订阅）
|
||||
- 我已经有一个代理服务订阅链接
|
||||
|
||||
请指导我使用 FlClash 客户端配置网络代理：
|
||||
1. 如何下载安装 FlClash（GitHub: https://github.com/chen08209/FlClash/releases）
|
||||
|
|
@ -110,4 +110,4 @@ export http_proxy=http://127.0.0.1:7890
|
|||
|
||||
## 下一步
|
||||
|
||||
网络配置完成后，继续阅读 [02-开发环境搭建](./02-开发环境搭建.md)。
|
||||
网络配置完成后，继续阅读 [开发环境搭建](./开发环境搭建.md)。
|
||||
|
|
@ -13,16 +13,17 @@
|
|||
- [LazyVim 快捷键大全](./LazyVim快捷键大全.md) - Neovim 配置框架
|
||||
- [Augment MCP 配置](./auggie-mcp配置文档.md) - 上下文引擎配置
|
||||
- [ProxyCast 配置](./ProxyCast配置文档.md) - AI 凭证代理服务配置
|
||||
- [TradeCat Sheets API 使用说明](./tradecat-sheets-api-usage.md) - 把公开 Google Sheet 当作 API 注册表与数据面（Data Plane）
|
||||
- [手机远程 Vibe Coding](./关于手机ssh任意位置链接本地计算机，基于frp实现的方法.md) - 基于 frp 的远程开发
|
||||
- [VS Code Remote Tunnel（WSL）](./REMOTE_TUNNEL_GUIDE.md) - 在 WSL 内开通 VS Code Tunnel 供远程访问
|
||||
- [GEMINI-HEADLESS](./GEMINI-HEADLESS.md) - Gemini 无头模式配置
|
||||
|
||||
## 🛠️ 开发经验
|
||||
|
||||
- [开发经验](./开发经验.md) - 变量命名、文件结构、编码规范
|
||||
- [开发经验](../../principles/fundamentals/开发经验.md) - 变量命名、文件结构、编码规范
|
||||
- [Vibe Coding 经验收集](./vibe-coding-经验收集.md) - 社区经验汇总
|
||||
|
||||
## 🔗 相关资源
|
||||
- [基础指南](../00-基础指南/) - 核心理念与方法论
|
||||
- [入门指南](../01-入门指南/) - 从零开始
|
||||
- [实战](../03-实战/) - 动手实践
|
||||
- [基础指南](../../principles/fundamentals/) - 核心理念与方法论
|
||||
- [入门指南](../getting-started/) - 从零开始
|
||||
- [实战](../../case-studies/) - 动手实践
|
||||
|
|
@ -0,0 +1,167 @@
|
|||
# TradeCat Sheets API 使用说明（公开表格 + API 注册表）
|
||||
|
||||
本文档用于把 TradeCat 的公开 Google Sheet 当作 **Agent 可消费的数据面（Data Plane）**：通过 `API` 表（注册表）发现端点，并用表内提供的请求命令拉取结构化 JSON（行情/指标/预测市场/实时新闻）。
|
||||
|
||||
> 更新时间：2026-03-17（以 `API` 表导出时间为准）
|
||||
|
||||
---
|
||||
|
||||
## 1. 公共链接
|
||||
|
||||
- 在线表格（含 `API` 注册表页）：
|
||||
`https://docs.google.com/spreadsheets/d/1q-2sXGsFYsKf3nV5u5golTVrLH5sfc0doiWwz_kavE4/edit?usp=sharing`
|
||||
|
||||
---
|
||||
|
||||
## 2. 你得到的是什么
|
||||
|
||||
### 2.1 `API` 表 = Endpoint Registry（端点注册表）
|
||||
|
||||
`API` 表每一行对应一个端点，包含三列：
|
||||
|
||||
- `jsonl`：端点返回的 JSON（通常包含压缩 payload）
|
||||
- `说明`：端点用途/结构（人读）
|
||||
- `请求命令`：可复制执行的命令（机器读/人也可直接复制）
|
||||
|
||||
### 2.2 推荐用法：直接复制 `请求命令`
|
||||
|
||||
表中 `请求命令` 通常是 `curl ... | python3 -c ...`：
|
||||
|
||||
- `curl` 从 Google Sheets gviz 接口取出该行 `jsonl`
|
||||
- `python3 -c` 负责解析 JSON、解压 `gzip_b64`（如存在）并输出最终结构化 JSON
|
||||
|
||||
这样做的好处：
|
||||
- 不需要你自己实现 gzip_base64 解码逻辑
|
||||
- 输出格式相对稳定（以表内命令为准）
|
||||
|
||||
---
|
||||
|
||||
## 3. 快速开始
|
||||
|
||||
### 3.1 拉取 API 注册表（CSV）
|
||||
|
||||
```bash
|
||||
SHEET_ID="1q-2sXGsFYsKf3nV5u5golTVrLH5sfc0doiWwz_kavE4"
|
||||
curl -fsSL "https://docs.google.com/spreadsheets/d/${SHEET_ID}/gviz/tq?tqx=out:csv&sheet=API&headers=0" > api.csv
|
||||
```
|
||||
|
||||
### 3.2 列出端点标题（从 `jsonl` 里解析）
|
||||
|
||||
```bash
|
||||
python3 - <<'PY'
|
||||
import csv, io, json, sys
|
||||
raw=open("api.csv","r",encoding="utf-8",errors="replace").read()
|
||||
rows=list(csv.reader(io.StringIO(raw)))
|
||||
for r in rows[3:]: # 跳过 banner/导出信息/表头
|
||||
if len(r) < 1 or not r[0].strip().startswith("{"):
|
||||
continue
|
||||
try:
|
||||
obj=json.loads(r[0])
|
||||
except Exception:
|
||||
continue
|
||||
sheet=(obj.get("data") or {}).get("sheet") or {}
|
||||
title=sheet.get("title")
|
||||
gid=sheet.get("gid")
|
||||
payload=(obj.get("data") or {}).get("payload") or {}
|
||||
schema=payload.get("schema") or payload.get("facts_schema") or ""
|
||||
if title:
|
||||
print(f"- {title} (gid={gid} schema={schema})")
|
||||
PY
|
||||
```
|
||||
|
||||
### 3.3 拉取某个端点（推荐）
|
||||
|
||||
到表格 `API` 页，找到目标端点行，复制其 `请求命令` 直接执行即可。
|
||||
|
||||
---
|
||||
|
||||
## 4. 返回格式（Envelope）
|
||||
|
||||
端点 JSON 通常遵循如下“信封”结构（字段名以实际返回为准）：
|
||||
|
||||
- `code` / `msg` / `success`：状态
|
||||
- `data.banner`：公告/广告位等文本（消费方可选择忽略）
|
||||
- `data.meta`：生成时间、生产者、语言等
|
||||
- `data.sheet`：来源表格信息（`spreadsheet_id/gid/title`）
|
||||
- `data.payload`：**真正的数据**（可能包含压缩编码或已解码后的事实列表）
|
||||
|
||||
强烈建议消费方至少校验：
|
||||
- `data.payload.schema`（或 `facts_schema`）是否是预期的 schema
|
||||
- `data.meta.generated_at` / `export_time` 是否足够新鲜
|
||||
|
||||
---
|
||||
|
||||
## 5. Schema 说明（当前已观察到）
|
||||
|
||||
> 以 `API` 表当前内容为准；未来可能新增 schema。
|
||||
|
||||
### 5.1 `table_rows_v2`
|
||||
|
||||
用于“表格快照”类数据（看板/Polymarket/新闻）。
|
||||
|
||||
典型用途：
|
||||
- 看板总览、Top 列表、统计表、新闻流
|
||||
|
||||
消费建议：
|
||||
- 以 `facts[]`（如存在）为单一事实来源
|
||||
- 每条 fact 通常包含维度（dims）与字段（fields_text/fields_num）等
|
||||
|
||||
### 5.2 `symbol_query_v2`
|
||||
|
||||
用于“单币种多周期指标面板”类数据（BTC/ETH/BNB/SOL）。
|
||||
|
||||
典型用途：
|
||||
- 单币画像、指标诊断、策略特征输入、AI 分析上下文
|
||||
|
||||
消费建议：
|
||||
- 以 `facts[]`（如存在）为单一事实来源
|
||||
- 不要依赖 UI 文案；依赖结构化指标字段
|
||||
|
||||
---
|
||||
|
||||
## 6. 端点清单（2026-03-17 快照）
|
||||
|
||||
以下端点来自 `API` 表当前解析结果（title/gid/schema）：
|
||||
|
||||
### 市场总览（table_rows_v2）
|
||||
|
||||
- 加密货币看板（gid=1277788455, schema=table_rows_v2）
|
||||
- 宏观大宗看板（gid=1931661963, schema=table_rows_v2）
|
||||
|
||||
### 单币画像（symbol_query_v2）
|
||||
|
||||
- 币种查询_BTCUSDT（gid=1325757221, schema=symbol_query_v2）
|
||||
- 币种查询_ETHUSDT（gid=904473439, schema=symbol_query_v2）
|
||||
- 币种查询_BNBUSDT（gid=78880380, schema=symbol_query_v2）
|
||||
- 币种查询_SOLUSDT（gid=208400041, schema=symbol_query_v2）
|
||||
|
||||
### 预测市场（table_rows_v2）
|
||||
|
||||
- PolymarketTop15（gid=1715937602, schema=table_rows_v2）
|
||||
- Polymarket时段分布（gid=333189916, schema=table_rows_v2）
|
||||
- Polymarket类别偏好（gid=1923964075, schema=table_rows_v2）
|
||||
|
||||
### 实时新闻（table_rows_v2）
|
||||
|
||||
- 实时新闻（gid=1419246950, schema=table_rows_v2）
|
||||
|
||||
---
|
||||
|
||||
## 7. 可靠性与调用建议（给 Agent/服务端）
|
||||
|
||||
由于底层是公开 Google Sheet：
|
||||
|
||||
- 建议做 **缓存**（例如 5～60 秒，按业务容忍度）
|
||||
- 建议做 **退避重试**（遇到 429/5xx 时指数退避）
|
||||
- 建议做 **降级策略**
|
||||
- 表不可用：降级为“只读旧缓存”
|
||||
- 新闻不可用：只跑行情/指标
|
||||
- schema 不匹配：拒绝消费该批数据
|
||||
|
||||
---
|
||||
|
||||
## 8. 合规与安全边界
|
||||
|
||||
- 本接口与本文档不构成投资建议；仅用于研究与协作交流。
|
||||
- 不要在任何公开场合贴出内部密钥/Token（本表为公开资产，不应包含密钥；但消费方也不应添加敏感头部到公开日志里）。
|
||||
|
||||
|
|
@ -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) - 标准化目录结构
|
||||
|
|
@ -0,0 +1,45 @@
|
|||
# Harness Engineering 的本质拆解
|
||||
|
||||
1. Harness Engineering 的本质是用确定性的工程控制系统，把大模型的非确定性输出压缩进可预测的轨道里，让“概率生成”变成“可验收的产出”
|
||||
|
||||
2. 大模型在系统里只承担两件事：理解意图、把意图翻译成文本（代码/配置/文档），它更像算力与语言编译器，而不是可靠性来源
|
||||
|
||||
3. 可靠性不来自“更聪明的模型”，而来自外部机制对输出的四类动作：拦截意图、校验结果、拒绝不合格、注入必要上下文
|
||||
|
||||
4. 最小可运行 Harness 的关键不是生成代码，而是闭环：生成→编译/运行→抓取错误→反馈重写→直到通过，这把一次性聊天改造成可迭代的生产流程
|
||||
|
||||
5. 第一类硬问题是上下文与遗忘：任务一复杂就会撑爆上下文、目标漂移、前后端混写，本质是模型没有稳定的工作记忆与任务边界
|
||||
|
||||
6. 对应解法是动态上下文注入与记忆管理：把规则与知识拆成可插拔技能包，按“当前意图”精准装载与卸载，让上下文保持短、准、相关
|
||||
|
||||
7. 记忆的工程化含义不是“多存点东西”，而是把踩坑与验证过的结论自动提炼成规则沉淀下来，使系统具备跨任务的抗重复犯错能力
|
||||
|
||||
8. 第二类硬问题是自评幻觉：让模型自己审查等于既当运动员又当裁判，它会用讨好与自洽掩盖逻辑错误，漂亮但不可用
|
||||
|
||||
9. 对应解法是评估驱动与机械测试：引入独立的、可执行的第三方判定（编译器、单测、端到端 UI 测试、独立 QA Agent），用硬指标决定通过与否
|
||||
|
||||
10. 质量下限从“模型聪明程度”迁移到“验收机制完备性”，系统真正的生产力来自可重复运行的判定器，而不是一次灵感式输出
|
||||
|
||||
11. 第三类硬问题是时间维度的熵增：长期运行后模型会为了更快过测试而走捷径，架构漂移、耦合蔓延，最终形成不可维护的腐化代码库
|
||||
|
||||
12. 对应解法是架构强约束与持续清理：用静态规则提前阻断跨层依赖等结构性违规，再用专职清理机制持续重构、更新文档、回收技术债，对抗代码腐化
|
||||
|
||||
13. 当系统拥有规划者、执行者、评估者、硬约束钩子、清理机制时，Harness 才从脚本升级为“Agent 操作系统”，长期稳定性来自分工与制衡
|
||||
|
||||
14. 那些看似“AI 自己写出百万行代码”的魔法，核心不在模型，而在工具与 Harness 组合出来的现实校验、反馈重试、规则约束与持续治理
|
||||
|
||||
15. Harness 不是回到古法逐行写代码，而是把工程重心从实现细节迁移到边界、接口、约束、断言与验收标准，编码对象从业务逻辑变成生产流水线
|
||||
|
||||
16. Harness 的门槛高于写业务代码的根因在于：它要求你先把“什么算对、什么算好、什么必须禁止”形式化成可执行规则，否则系统会高速产出结构化垃圾
|
||||
|
||||
17. Harness 的维护成本来自业务变化：当目标函数变了，你必须同步重写评估器与测试桩，否则闭环会失真并进入死锁或错误优化
|
||||
|
||||
18. 最大误解之一是指望模型升级解决跑偏，现实规律是无论马多强，没有缰绳都会把车拉进沟里，可靠性必须由外部约束提供
|
||||
|
||||
19. 最大误解之二是工具越多越好，工具过载会导致选择震荡与时间浪费，工具集应该为评估与执行最小充分，而非堆权限展示强大
|
||||
|
||||
20. 最大误解之三是把无约束的氛围式开发当工业未来，它只能在无历史负担的小项目里成立，一旦进入长周期协作与演进，没有硬边界就必然灾难
|
||||
|
||||
21. Harness 的上限由评估器决定：如果你无法把“好结果”编码为可检验的规则与测试，系统就无法稳定优化，模型也无法替你完成这层战略定义
|
||||
|
||||
22. 未来工程师的分化本质是控制权分配：一类在代码生成速度上竞争，另一类在规则、评估、架构与闭环设计上竞争，后者决定系统长期生产力与可维护性
|
||||
|
|
@ -22,10 +22,11 @@
|
|||
|
||||
### 项目规范
|
||||
- [通用项目架构模板](./通用项目架构模板.md) - 标准化项目结构
|
||||
- [数据集导向数据服务模板](./数据集导向数据服务模板.md) - 以 dataset/contract/registry/runtime 为核心的数据服务架构模板
|
||||
- [代码组织](./代码组织.md) - 代码组织原则
|
||||
- [开发经验](./开发经验.md) - 实战经验总结
|
||||
|
||||
## 🔗 相关资源
|
||||
- [入门指南](../01-入门指南/) - 从零开始
|
||||
- [方法论](../02-方法论/) - 工具与经验
|
||||
- [实战](../03-实战/) - 动手实践
|
||||
- [入门指南](../../guides/getting-started/) - 从零开始
|
||||
- [方法论](../../guides/playbook/) - 工具与经验
|
||||
- [实战](../../case-studies/) - 动手实践
|
||||
|
|
@ -135,7 +135,7 @@ nvm use 18
|
|||
|
||||
| 问题 | 原因 | 解决方案 |
|
||||
|:---|:---|:---|
|
||||
| GitHub 访问慢/超时 | 网络限制 | 配置代理，参考 [网络环境配置](../从零开始vibecoding/01-网络环境配置.md) |
|
||||
| GitHub 访问慢/超时 | 网络限制 | 配置代理，参考 [网络环境配置](../../guides/getting-started/网络环境配置.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 文件或环境变量 |
|
||||
|
|
@ -0,0 +1,473 @@
|
|||
# 数据集导向数据服务模板
|
||||
|
||||
> 这份文档定义一套可复用的**数据采集服务通用架构模板**：以后新建数据服务，或把外部源码重构纳入本仓库时，优先按这套模板落地。
|
||||
|
||||
## 1) 一句话
|
||||
|
||||
- **以 dataset 为边界、以 schema/data contract 为先、以 runtime/registry/config 为共享控制面、以 collect/backfill/repair/validate 为实现单元。**
|
||||
|
||||
## 2) 适用范围
|
||||
|
||||
### 适合
|
||||
|
||||
- 行情事实采集服务
|
||||
- 另类事件采集服务
|
||||
- 周期轮询快照服务
|
||||
- 原子事件流 + 时间桶聚合并存的数据服务
|
||||
- 需要长期运行、补数、巡检、血缘、质量治理的数据产品服务
|
||||
|
||||
### 不适合直接照抄
|
||||
|
||||
- 纯 API 网关
|
||||
- 纯 Web 应用
|
||||
- 纯交易执行服务
|
||||
- 一次性脚本工具
|
||||
- 不产出稳定 dataset 的临时任务
|
||||
|
||||
> 判断规则：**如果服务的核心交付物是“稳定数据集”，而不是“页面”或“接口”，就优先用这套模板。**
|
||||
|
||||
## 3) 设计目标
|
||||
|
||||
- 让 **dataset** 成为开发、调度、部署、运维、血缘、权限、生命周期管理的统一边界
|
||||
- 让 **schema / contract** 成为稳定真相源，而不是让采集代码反过来定义数据模型
|
||||
- 让 **控制面**（config / registry / service_entry / runtime）统一收口，避免每个数据集各自长脚本
|
||||
- 让 **legacy 兼容层** 明确可识别、可退役，而不是长期混在主链里
|
||||
|
||||
## 4) 核心原则
|
||||
|
||||
### 4.1 Dataset First
|
||||
|
||||
- 顶层先按 dataset 划分，而不是先按 `collector/ parser/ writer/ task` 划分
|
||||
- 一个 dataset 对应一个清晰的数据交付对象
|
||||
- 代码、存储、血缘、权限都围绕 dataset 收口
|
||||
|
||||
### 4.2 Schema / Contract First
|
||||
|
||||
- 先定义目标落表、字段语义、主键/幂等键、时间列、分区策略、刷新粒度
|
||||
- 再写采集、解析、写入、校验、回补逻辑
|
||||
- 不允许“先把代码跑起来，后面再猜表结构”
|
||||
|
||||
### 4.3 Layered Modeling
|
||||
|
||||
- 原子层和聚合层分开
|
||||
- 事件流和时间桶分开
|
||||
- 运行状态和资源存在性分开
|
||||
- active / backfill_only / reserved 分开
|
||||
|
||||
### 4.4 Shared Control Plane
|
||||
|
||||
- `config.py`：统一配置入口
|
||||
- `registry.py`：统一 dataset 真相矩阵
|
||||
- `service_entry.py`：统一内部服务入口
|
||||
- `runtime/*`：统一执行面
|
||||
- 业务代码不允许自己重新发明第二套控制面
|
||||
|
||||
### 4.5 Legacy Is Explicit
|
||||
|
||||
- 过渡期允许保留 legacy 壳
|
||||
- 但 legacy 壳只能做兼容转发
|
||||
- 新逻辑不得回流 legacy 路径
|
||||
|
||||
## 5) 标准目录模板
|
||||
|
||||
```text
|
||||
<service-root>/
|
||||
├── README.md
|
||||
├── AGENTS.md
|
||||
├── pyproject.toml # 单工程时使用；多壳过渡期可暂时保留多个
|
||||
├── scripts/
|
||||
│ ├── start.sh # 薄壳：统一转发到 service_entry
|
||||
│ ├── verify.sh # 服务级快速校验（可选）
|
||||
│ └── check_legacy_shells.sh # legacy 回流静态门禁（迁移期建议强制）
|
||||
├── src/<service_name>/
|
||||
│ ├── __init__.py
|
||||
│ ├── config.py # 统一配置入口
|
||||
│ ├── registry.py # dataset 真相矩阵
|
||||
│ ├── service_entry.py # 统一内部入口：plan/start/stop/status/restart
|
||||
│ ├── common/ # 公共工具：env、io、time、symbols、shared utils
|
||||
│ ├── runtime/ # 统一执行层
|
||||
│ │ ├── stack_runner.py
|
||||
│ │ ├── process_utils.py
|
||||
│ │ ├── <group>_runner.py
|
||||
│ │ └── <group>_worker.py
|
||||
│ ├── writers/ # 统一写入层（可选，按需要抽）
|
||||
│ ├── validators/ # 统一校验层（可选，按需要抽）
|
||||
│ └── datasets/
|
||||
│ ├── <dataset_a>/
|
||||
│ │ ├── contract.py
|
||||
│ │ ├── collect.py
|
||||
│ │ ├── backfill.py
|
||||
│ │ ├── repair.py
|
||||
│ │ ├── writer.py
|
||||
│ │ ├── validate.py
|
||||
│ │ └── README.md
|
||||
│ ├── <dataset_b>/
|
||||
│ └── _reserved/
|
||||
│ └── <future_dataset>/
|
||||
├── tests/
|
||||
│ ├── unit/
|
||||
│ ├── integration/
|
||||
│ └── fixtures/
|
||||
└── legacy/ or old-shells/ # 可选：迁移期显式归档
|
||||
```
|
||||
|
||||
## 6) dataset 目录的标准职责
|
||||
|
||||
每个 dataset 目录不是“一个表一个文件”，而是**一个数据集一个实现单元**。
|
||||
|
||||
推荐最小结构：
|
||||
|
||||
```text
|
||||
<dataset>/
|
||||
├── contract.py
|
||||
├── collect.py
|
||||
├── backfill.py
|
||||
├── repair.py
|
||||
├── writer.py
|
||||
├── validate.py
|
||||
└── README.md
|
||||
```
|
||||
|
||||
### 每个文件干什么
|
||||
|
||||
- `contract.py`
|
||||
- 定义 dataset key、resource_id、物理表、主键/幂等键、时间语义、字段语义
|
||||
- `collect.py`
|
||||
- 实时采集 / 轮询采集主逻辑
|
||||
- `backfill.py`
|
||||
- 历史补数、文件回填、分页补齐
|
||||
- `repair.py`
|
||||
- 缺口修复、异常恢复、局部重算
|
||||
- `writer.py`
|
||||
- 统一落库 / 批量写入 / 去重 / 冲突处理
|
||||
- `validate.py`
|
||||
- 数据质量检查、行数/字段/时间连续性校验
|
||||
- `README.md`
|
||||
- 只说明这个 dataset 的输入、输出、约束与边界
|
||||
|
||||
> 如果某个 dataset 没有 `repair` 或 `backfill`，可以不实现，但必须在 registry 里显式标记为不支持，而不是偷偷缺省。
|
||||
|
||||
## 7) registry 统一真相矩阵
|
||||
|
||||
`registry.py` 至少应定义这些字段：
|
||||
|
||||
```text
|
||||
dataset_key
|
||||
resource_id
|
||||
runtime_status # active | backfill_only | reserved | disabled
|
||||
physical_table
|
||||
group # 例如 lf / hf / events / snapshots
|
||||
source_kind # ws / rest / zip / scrape / file / api
|
||||
collect_supported
|
||||
backfill_supported
|
||||
repair_supported
|
||||
default_enabled
|
||||
owner
|
||||
```
|
||||
|
||||
推荐额外字段：
|
||||
|
||||
```text
|
||||
symbol_scope
|
||||
refresh_granularity
|
||||
retention_policy
|
||||
partition_key
|
||||
schema_version
|
||||
sensitivity
|
||||
```
|
||||
|
||||
### 为什么 registry 必须存在
|
||||
|
||||
- 它是 dataset 清单的单一真相源
|
||||
- 文档、运行、血缘、权限、门禁都应从这里派生
|
||||
- 没有 registry，就会回到“代码里藏着很多隐式数据集”的旧问题
|
||||
|
||||
## 8) 命名规则
|
||||
|
||||
### 8.1 dataset 命名
|
||||
|
||||
推荐组合维度：
|
||||
|
||||
```text
|
||||
<market>_<instrument>_<topic>_<granularity?>_<layer?>
|
||||
```
|
||||
|
||||
例如：
|
||||
|
||||
- `spot_trades`
|
||||
- `futures_um_trades`
|
||||
- `futures_um_book_ticker`
|
||||
- `futures_um_book_depth`
|
||||
- `candles_1m`
|
||||
- `futures_metrics_5m`
|
||||
- `futures_um_metrics_atomic`
|
||||
|
||||
### 8.2 命名要求
|
||||
|
||||
- 名字必须表达**数据是什么**，不是代码怎么实现
|
||||
- 尽量包含这些维度：
|
||||
- 市场类型：`spot` / `futures`
|
||||
- 合约类型：`um` / `cm`
|
||||
- 主题：`trades` / `book_ticker` / `book_depth` / `metrics`
|
||||
- 粒度：`1m` / `5m`
|
||||
- 层次：`atomic` / aggregate
|
||||
- `_reserved/` 只用于预留未来命名空间，不用于临时垃圾存放
|
||||
|
||||
## 9) 统一控制面模板
|
||||
|
||||
### 9.1 service_entry
|
||||
|
||||
统一入口只做这几类动作：
|
||||
|
||||
- `plan`
|
||||
- `start`
|
||||
- `stop`
|
||||
- `status`
|
||||
- `restart`
|
||||
|
||||
它不直接写业务逻辑，只负责：
|
||||
|
||||
- 读取 config
|
||||
- 读取 registry
|
||||
- 调 runtime runner
|
||||
- 输出当前运行真相
|
||||
|
||||
### 9.2 runtime
|
||||
|
||||
runtime 负责：
|
||||
|
||||
- 进程编排
|
||||
- 模式分组（如 lf / hf / events / snapshots）
|
||||
- PID / 日志 / 健康状态
|
||||
- cold-start / restart / stop 行为一致性
|
||||
|
||||
业务代码不允许各自实现第二套守护逻辑。
|
||||
|
||||
## 10) 数据模型分层建议
|
||||
|
||||
推荐至少区分这几类：
|
||||
|
||||
```text
|
||||
atomic # 原子事件/原子明细
|
||||
snapshot # 单次轮询快照
|
||||
bucketed # 时间桶聚合结果
|
||||
derived # 从事实层再派生的结果
|
||||
reserved # 预留但未启用
|
||||
```
|
||||
|
||||
### 两类典型模型
|
||||
|
||||
#### A. 事件流模型
|
||||
|
||||
适合：
|
||||
|
||||
- trades
|
||||
- orderbook updates
|
||||
- tick events
|
||||
- message stream
|
||||
|
||||
特点：
|
||||
|
||||
- 高频
|
||||
- append-only 倾向更强
|
||||
- 更强调顺序、幂等、去重、水位线
|
||||
|
||||
#### B. 时间桶 / 快照模型
|
||||
|
||||
适合：
|
||||
|
||||
- candles_1m
|
||||
- metrics_5m
|
||||
- periodic snapshots
|
||||
- polling APIs
|
||||
|
||||
特点：
|
||||
|
||||
- 按窗口/批次刷新
|
||||
- 更强调覆盖、补齐、时间边界一致性
|
||||
|
||||
## 11) 从零新建服务的推荐流程
|
||||
|
||||
### Step 1：先定 dataset 清单
|
||||
|
||||
明确：
|
||||
|
||||
- 服务要产出哪些 dataset
|
||||
- 每个 dataset 的物理表是什么
|
||||
- 哪些是 active，哪些是 backfill_only，哪些是 reserved
|
||||
|
||||
### Step 2：先写 contract
|
||||
|
||||
每个 dataset 先写 `contract.py`，明确：
|
||||
|
||||
- 字段
|
||||
- 主键/幂等键
|
||||
- 时间列
|
||||
- 分区策略
|
||||
- 资源 ID
|
||||
- schema version
|
||||
|
||||
### Step 3：再建 registry / config / service_entry / runtime
|
||||
|
||||
先把共享控制面搭起来，再实现具体 dataset。
|
||||
|
||||
### Step 4：逐个实现 dataset
|
||||
|
||||
每个 dataset 按：
|
||||
|
||||
```text
|
||||
contract -> writer -> collect -> backfill -> validate -> repair
|
||||
```
|
||||
|
||||
的顺序推进。
|
||||
|
||||
### Step 5：最后补文档与门禁
|
||||
|
||||
至少补：
|
||||
|
||||
- README
|
||||
- AGENTS
|
||||
- verify / CI
|
||||
- 资源目录 / 血缘映射 / smoke
|
||||
|
||||
## 12) 从外部源码接入时的重构流程
|
||||
|
||||
很多外部源码不是按 dataset-first 设计的，通常是：
|
||||
|
||||
```text
|
||||
collector/
|
||||
parser/
|
||||
writer/
|
||||
scripts/
|
||||
```
|
||||
|
||||
接入时不要直接原样搬进来。建议这样重构：
|
||||
|
||||
### Step 1：先做盘点，不先搬代码
|
||||
|
||||
盘点外部源码：
|
||||
|
||||
- 实际产出哪些数据对象
|
||||
- 每个对象对应什么表/文件/消息
|
||||
- 哪些逻辑是 collect，哪些是 backfill，哪些是 repair
|
||||
- 哪些模块只是工具层
|
||||
|
||||
### Step 2：反向抽 dataset
|
||||
|
||||
把原项目里的功能点反向映射成 dataset：
|
||||
|
||||
```text
|
||||
外部源码里的“多个脚本”
|
||||
-> 抽象成若干 dataset
|
||||
-> 为每个 dataset 建 contract / writer / collect / backfill
|
||||
```
|
||||
|
||||
### Step 3：公共能力抽到 common/runtime/writers
|
||||
|
||||
例如：
|
||||
|
||||
- API client
|
||||
- auth
|
||||
- rate limiter
|
||||
- symbol normalize
|
||||
- storage client
|
||||
- retry / backoff
|
||||
- file downloader
|
||||
|
||||
这些不属于单一 dataset，应放共享层。
|
||||
|
||||
### Step 4：把 legacy 壳显式隔离
|
||||
|
||||
过渡期可以保留旧入口，但必须：
|
||||
|
||||
- 只做兼容转发
|
||||
- 不再承载新逻辑
|
||||
- 有门禁防止回流
|
||||
|
||||
## 13) 最低门禁模板
|
||||
|
||||
每个 dataset-first 服务至少要有这些门禁：
|
||||
|
||||
### 代码门禁
|
||||
|
||||
- `compileall` 覆盖服务新树
|
||||
- 无语法错误
|
||||
- 无关键路径未纳入版本控制
|
||||
|
||||
### 结构门禁
|
||||
|
||||
- 不允许新逻辑回流 legacy 壳
|
||||
- 不允许第二套 start/status/restart 控制面
|
||||
- registry 中的 dataset 必须与实际实现一致
|
||||
|
||||
### 运行门禁
|
||||
|
||||
- `stop -> start -> status -> restart -> status` 可通过
|
||||
- 日志可证明真实执行源
|
||||
- PID / log / run metadata 可追踪
|
||||
|
||||
### 数据门禁
|
||||
|
||||
- 每个 active dataset 至少有 contract + writer + collect/或 backfill
|
||||
- 血缘 resource_id 与 registry 一致
|
||||
- 质量检查最少覆盖：空写、重复写、时间边界、幂等
|
||||
|
||||
### 文档门禁
|
||||
|
||||
- README 更新
|
||||
- AGENTS 更新
|
||||
- 资源目录 / 当前真相文档更新
|
||||
|
||||
## 14) 反模式
|
||||
|
||||
以下情况不应接受：
|
||||
|
||||
- 顶层继续按 `collector/ parser/ writer` 组织，dataset 只是注释概念
|
||||
- 没有 registry，dataset 清单散落在代码里
|
||||
- 先写采集器，再倒推表结构
|
||||
- runtime 到处复制，每个 dataset 都有自己一套守护脚本
|
||||
- legacy 壳长期承担真实执行逻辑
|
||||
- `_reserved` 被当成垃圾桶
|
||||
- 同一 dataset 同时存在两套 writer / 两套 contract / 两套运行入口
|
||||
|
||||
## 15) 推荐的最小模板文件
|
||||
|
||||
如果以后你新建一个数据服务，最少应先建出这些文件：
|
||||
|
||||
```text
|
||||
<service-root>/
|
||||
├── README.md
|
||||
├── AGENTS.md
|
||||
├── scripts/start.sh
|
||||
└── src/<service_name>/
|
||||
├── config.py
|
||||
├── registry.py
|
||||
├── service_entry.py
|
||||
├── runtime/
|
||||
│ ├── stack_runner.py
|
||||
│ └── process_utils.py
|
||||
└── datasets/
|
||||
├── <dataset_a>/
|
||||
│ ├── contract.py
|
||||
│ ├── collect.py
|
||||
│ ├── writer.py
|
||||
│ └── README.md
|
||||
└── _reserved/
|
||||
```
|
||||
|
||||
## 16) 仓库内参考实现
|
||||
|
||||
当前仓库里，最接近这套模板的落地参考是：
|
||||
|
||||
- `core/market/binance/src/binance/`
|
||||
- `core/market/binance/src/binance/datasets/*`
|
||||
- `core/market/binance/src/binance/registry.py`
|
||||
- `core/market/binance/src/binance/service_entry.py`
|
||||
- `core/market/binance/src/binance/runtime/*`
|
||||
|
||||
> 说明：这份模板不是说“以后每个服务都必须和 Binance 长得一模一样”，而是说：**以后凡是新的数据采集服务，都优先按这个方法组织，再根据数据源特性做局部裁剪。**
|
||||
|
||||
## 17) 一句话结论
|
||||
|
||||
- **这套模板可以作为你后续“数据采集服务”的通用源码架构模板。**
|
||||
- 它的核心不是目录长什么样，而是：**先定义 dataset 与 contract，再围绕 dataset 实现 collect/backfill/repair/write/validate，并把 config/registry/runtime/service_entry 收敛成统一控制面。**
|
||||
|
|
@ -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/)
|
||||
|
||||
---
|
||||
|
||||
|
|
@ -0,0 +1,116 @@
|
|||
# 问题求解能力
|
||||
|
||||
问题求解能力本质上就是：
|
||||
|
||||
把“当前状态”推进到“目标状态”的能力
|
||||
|
||||
所以，任何复杂能力，往下拆，最后都可以落到这一件事上：
|
||||
|
||||
* 先看清楚问题是什么
|
||||
* 再设计求解路径
|
||||
* 再执行并校正
|
||||
|
||||
## 描述
|
||||
|
||||
### 一、定义问题
|
||||
|
||||
先把问题说清楚，不然根本无从求解
|
||||
|
||||
定义问题，至少要回答：
|
||||
|
||||
* 目标：要达到什么结果
|
||||
* 现状：现在是什么情况
|
||||
* 差距：目标和现状之间差了什么
|
||||
* 判断标准：怎样算解决了
|
||||
|
||||
也就是：
|
||||
|
||||
问题 = 目标状态 - 当前状态
|
||||
|
||||
### 二、求解过程
|
||||
|
||||
你写的这三个词非常关键：
|
||||
|
||||
* 目标
|
||||
* 约束
|
||||
* 对象
|
||||
|
||||
我建议把它扩成一个更完整但仍然极简的求解模型：
|
||||
|
||||
#### 1）目标
|
||||
|
||||
要解决到什么程度
|
||||
是“可用”就行，还是“最优”
|
||||
是短期目标，还是长期目标
|
||||
|
||||
#### 2）约束
|
||||
|
||||
不能忽略的边界条件是什么
|
||||
例如：
|
||||
|
||||
* 时间
|
||||
* 资源
|
||||
* 规则
|
||||
* 风险
|
||||
* 能力上限
|
||||
|
||||
#### 3）对象
|
||||
|
||||
到底在处理什么东西
|
||||
对象可能是：
|
||||
|
||||
* 事
|
||||
* 人
|
||||
* 系统
|
||||
* 信息
|
||||
* 资源
|
||||
* 环境
|
||||
|
||||
#### 4）路径
|
||||
|
||||
用什么方法，从现状走到目标
|
||||
也就是：
|
||||
|
||||
* 拆解
|
||||
* 排序
|
||||
* 试错
|
||||
* 反馈
|
||||
* 修正
|
||||
|
||||
## 一句话总结
|
||||
|
||||
问题求解能力 = 准确定义问题，并在目标、约束、对象之下，设计并执行有效求解路径的能力
|
||||
|
||||
## 这个框架为什么很底层
|
||||
|
||||
因为很多看起来不同的能力，其实只是问题求解能力在不同场景里的表现：
|
||||
|
||||
* 学习能力：解决“如何更快获得有效知识”的问题
|
||||
* 决策能力：解决“在不确定条件下如何选更优方案”的问题
|
||||
* 沟通能力：解决“如何让信息被准确接收并促成行动”的问题
|
||||
* 管理能力：解决“如何通过资源配置达成目标”的问题
|
||||
* 创新能力：解决“旧解法不够用时，如何找到新解法”的问题
|
||||
|
||||
也就是说：
|
||||
|
||||
所谓各种能力，本质上都是问题求解能力的场景化展开
|
||||
|
||||
## 继续压缩
|
||||
|
||||
可以直接压成一个公式：
|
||||
|
||||
问题求解 = 定义问题 × 构造解法 × 验证结果
|
||||
|
||||
再展开就是：
|
||||
|
||||
* 定义问题：目标、现状、差距
|
||||
* 构造解法：对象、约束、路径
|
||||
* 验证结果：反馈、迭代、收敛
|
||||
|
||||
## “原则”版本
|
||||
|
||||
你可以这样说：
|
||||
|
||||
> 人的终极核心能力只有一个：问题求解能力
|
||||
> 所有其他能力，都是这一能力在不同对象、目标与约束条件下的具体表现
|
||||
> 问题求解的前提是定义问题，问题求解的核心是围绕目标、约束与对象构造求解路径，并通过反馈不断修正，直到达成目标
|
||||
|
|
@ -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)
|
||||
|
|
@ -519,7 +519,7 @@ ruff + black + pyright(或 mypy) + pytest + hypothesis + pydantic(msgspec可替
|
|||
| 稳定性 | 排序/去重等操作满足稳定条件 |
|
||||
| 交换/结合 | 满足代数性质的操作应通过 |
|
||||
|
||||
### 建议的项目骨架（最小）
|
||||
### 建议的项目框架（最小）
|
||||
|
||||
```text
|
||||
src/ # 纯逻辑与 I/O 分离
|
||||
|
|
@ -0,0 +1,607 @@
|
|||
对象、状态、快照、序列、过程、变换、同一、差异、关系
|
||||
|
||||
这几个概念，
|
||||
几乎就是我们理解世界、描述变化、整理知识的一套较小框架
|
||||
它们不只出现在哲学里
|
||||
数学、物理学、计算机科学、系统科学、语言学、认知科学里，
|
||||
也都离不开它们
|
||||
单看每个词，
|
||||
都很常见
|
||||
但把它们放在一起，
|
||||
问题就会更深一层：
|
||||
我们到底怎么在变化里把握事物，
|
||||
又怎么在差异里建立统一
|
||||
这其实是很多学科都在面对的问题
|
||||
一个对象，
|
||||
从来不是孤零零存在的
|
||||
它总在某种状态里
|
||||
状态可以被截成快照
|
||||
快照可以排成序列
|
||||
序列展开以后，
|
||||
就是过程
|
||||
过程又依赖某种变换规则
|
||||
而在变换里，
|
||||
我们一方面要说明，
|
||||
为什么它还是“同一个”
|
||||
另一方面也要说明，
|
||||
它为什么已经“不同了”
|
||||
最后，
|
||||
这一切都只能放进关系网络里，
|
||||
才真正说得通
|
||||
所以，
|
||||
这组概念不是一张并列摆开的术语表
|
||||
它更像一套用来描述世界、系统和认知的动态本体论框架
|
||||
|
||||
先说对象
|
||||
对象，
|
||||
就是我们拿来指认、区分和讨论的单位
|
||||
它可以很具体
|
||||
比如一棵树、一台机器、一个人
|
||||
也可以很抽象
|
||||
比如一种制度、一个算法、一个命题、一个国家
|
||||
对象的关键，
|
||||
不在于它是不是“独立存在”
|
||||
而在于，
|
||||
它能不能被识别成一个相对稳定的单位
|
||||
也就是说，
|
||||
对象总和边界、识别、持续性有关
|
||||
没有边界，
|
||||
对象就立不起来
|
||||
没有持续性，
|
||||
对象就会散成一团难以组织的事件流
|
||||
不同学科里，
|
||||
对象的意思也不一样
|
||||
在哲学里，
|
||||
它常常对应实体、存在者，或者现象对象
|
||||
在数学里，
|
||||
它可以是集合、群、空间、范畴里的元素
|
||||
在计算机科学里，
|
||||
它可以是数据结构、类实例、进程、节点
|
||||
在系统科学里，
|
||||
它更常被理解成系统单元，
|
||||
或者系统里的子系统
|
||||
所以，
|
||||
对象不只是“一个东西”
|
||||
它是一个被组织起来、能被识别、还能被持续追踪的存在单位
|
||||
|
||||
再说状态
|
||||
状态，
|
||||
是对象在某个时刻、某种条件下的规定性
|
||||
对象不会永远静止不变
|
||||
它会表现出不同的属性、位置、能量、角色，
|
||||
或者内部配置
|
||||
状态，
|
||||
就是这些规定性的总和
|
||||
也可以说，
|
||||
状态就是对象“此时此地怎么存在”的方式
|
||||
比如，
|
||||
一杯水可以是液态、固态、气态
|
||||
一台机器可以在运行、停机、故障这些状态里切换
|
||||
一个人可以清醒、疲惫、专注、焦虑
|
||||
一个社会系统，
|
||||
也可能是稳定、危机、转型
|
||||
状态这个概念，
|
||||
让对象从“只是存在”，
|
||||
变成“可以被描述的存在”
|
||||
没有状态，
|
||||
对象只是一个空名字
|
||||
有了状态，
|
||||
对象才真正变成能分析、能比较、能记录的单位
|
||||
|
||||
快照，
|
||||
就是对状态做一次静态截取
|
||||
它强调的是“截面”，
|
||||
不是“流动”
|
||||
强调的是“这一刻就是这样”，
|
||||
不是“它怎么变成这样”
|
||||
快照的意义，
|
||||
在于先把连续变化暂时冻住
|
||||
这样我们才能观察、记录、比较、建模
|
||||
照片是视觉快照
|
||||
数据库备份是系统快照
|
||||
某个时间点的人口统计，
|
||||
是社会快照
|
||||
实验里某一刻的测量数据，
|
||||
也是快照
|
||||
但快照不等于对象本身
|
||||
它只是对象在某个时间点上，
|
||||
一个可以被记录下来的切面
|
||||
所以，
|
||||
快照天然带着选择性
|
||||
它记录什么，
|
||||
不记录什么
|
||||
它保留哪些属性，
|
||||
忽略哪些背景
|
||||
也就是说，
|
||||
快照既是认识工具，
|
||||
也是一种简化
|
||||
|
||||
序列，
|
||||
是多个快照按照时间、逻辑，
|
||||
或者生成规则排出来的结果
|
||||
当我们不再只问“这一刻是什么”，
|
||||
而开始关心“前后发生了什么”，
|
||||
快照就进入了序列
|
||||
序列可以是时间序列
|
||||
比如一天里的温度变化
|
||||
可以是行为序列
|
||||
比如用户在软件里的点击路径
|
||||
可以是叙事序列
|
||||
比如故事里的事件链
|
||||
可以是运算序列
|
||||
比如算法执行的步骤
|
||||
也可以是生长序列
|
||||
比如一个生物体发育的阶段
|
||||
序列让分散的快照之间，
|
||||
开始建立可追踪的连续性
|
||||
它是我们从静态描述，
|
||||
走向动态理解的第一步
|
||||
|
||||
过程，
|
||||
可以看成序列的动态整体
|
||||
如果说序列强调的是排列，
|
||||
那过程强调的就是展开
|
||||
如果说序列更像“把结果一个个列出来”，
|
||||
那过程更像“变化正在持续发生”
|
||||
过程不只是很多状态排在一起
|
||||
更重要的是，
|
||||
这些状态之间有生成关系，
|
||||
有演化方向，
|
||||
也有内在联系
|
||||
种子发芽是过程
|
||||
儿童成长是过程
|
||||
化学反应、经济周期、项目推进、语言习得，
|
||||
也都是过程
|
||||
过程最核心的地方在于，
|
||||
它有持续性，
|
||||
有方向性，
|
||||
有内在机制，
|
||||
还会产生新的状态和新的结构
|
||||
所以，
|
||||
比起“对象”，
|
||||
过程往往更能抓住现实世界的生命力
|
||||
很多现代思想都倾向于认为，
|
||||
世界最根本的，
|
||||
不是静态实体，
|
||||
而是过程、事件和生成
|
||||
|
||||
变换，
|
||||
是从一个状态到另一个状态的规则、操作，
|
||||
或者机制
|
||||
它回答的问题是：
|
||||
为什么会变
|
||||
又是怎么变过去的
|
||||
变换可以是物理变换
|
||||
比如受力运动、相变、能量交换
|
||||
可以是数学变换
|
||||
比如映射、函数、群作用、坐标变换
|
||||
可以是计算变换
|
||||
比如状态转移、程序执行、数据更新
|
||||
可以是认知变换
|
||||
比如分类、联想、重构
|
||||
也可以是社会变换
|
||||
比如制度改革、角色转换、结构迁移
|
||||
变换让过程变得可以解释
|
||||
没有变换，
|
||||
过程只是现象
|
||||
有了变换，
|
||||
我们才有机会建立机制模型，
|
||||
理解为什么会从A走到B
|
||||
|
||||
同一，
|
||||
指的是在变化里，
|
||||
某个东西依然被认作“它自己”
|
||||
这是这组概念里最偏哲学的问题之一
|
||||
一个人和十年前相比，
|
||||
身体细胞不同了，
|
||||
心理结构不同了，
|
||||
社会身份也可能不同了
|
||||
但我们还是会说，
|
||||
这是同一个人
|
||||
一艘船的木板全换了，
|
||||
它还是不是原来那艘船
|
||||
一个软件升级了很多次，
|
||||
它还是不是同一个系统
|
||||
同一问题会把一个张力直接摆出来：
|
||||
变化一直在发生，
|
||||
但识别不能因此彻底崩掉
|
||||
所以，
|
||||
同一不是绝对不变
|
||||
它更像是一种可持续的认定原则
|
||||
这个原则，
|
||||
可能来自物质连续性
|
||||
也可能来自结构连续性、功能连续性、因果连续性
|
||||
还可能来自记忆和叙事的连续性，
|
||||
或者规则上的身份保持
|
||||
所以，
|
||||
同一性通常不是说“本质一点都没变”
|
||||
而是说，
|
||||
“在某种意义上，
|
||||
它仍然算同一个”
|
||||
|
||||
差异，
|
||||
就是对象之间、状态之间、快照之间，
|
||||
或者过程阶段之间的不相同
|
||||
没有差异，
|
||||
识别就无从发生
|
||||
因为识别本身，
|
||||
就是把这个和那个区分开
|
||||
差异可以是静态的
|
||||
比如两个对象不一样
|
||||
也可以是动态的
|
||||
比如同一个对象，
|
||||
前后两个状态不一样
|
||||
还可以是两个序列的差异，
|
||||
过程不同阶段的差异，
|
||||
或者同一个结构在不同语境里的差异
|
||||
差异不是对同一的简单否定
|
||||
恰恰相反，
|
||||
同一和差异是互相规定的
|
||||
没有某种持续性，
|
||||
你都没法说“它变了”
|
||||
没有变化，
|
||||
你也没法说“它还是同一个”
|
||||
需要注意的是：
|
||||
差异不是附属的边角料
|
||||
它本身就是意义生成的基础
|
||||
一个符号之所以有意义，
|
||||
因为它和别的符号不同
|
||||
一个身份之所以成立，
|
||||
也因为它在关系网络里和别的身份区分开来
|
||||
|
||||
关系，
|
||||
是对象和对象、状态和状态、过程和过程之间的连接方式
|
||||
关系可以是空间关系
|
||||
也可以是时间关系、因果关系、逻辑关系、功能关系、社会关系、语义关系
|
||||
关系的重要性在于，
|
||||
对象很多时候不是先孤立存在，
|
||||
然后才去彼此连接
|
||||
恰恰相反，
|
||||
很多对象就是在关系里才被定义出来的
|
||||
父亲这个对象，
|
||||
离不开亲属关系
|
||||
节点离不开网络关系
|
||||
商品离不开交换关系
|
||||
词语离不开句法和语义关系
|
||||
所以，
|
||||
关系视角意味着一种转变
|
||||
从“以实体为中心”，
|
||||
转到“以结构为中心”
|
||||
在这种视角里，
|
||||
理解一个东西，
|
||||
不只是问“它是什么”
|
||||
还要问，
|
||||
它和什么相连
|
||||
它在什么网络里起作用
|
||||
它又是由哪些差异和对应构成的
|
||||
|
||||
这几个概念之间，
|
||||
其实不是松散堆在一起的
|
||||
它们可以连成一条线：
|
||||
对象，
|
||||
到状态，
|
||||
到快照，
|
||||
到序列，
|
||||
到过程，
|
||||
再到变换
|
||||
同时，
|
||||
这条线一直被另外三组更深层的概念支撑着
|
||||
同一，
|
||||
保证我们追踪的，
|
||||
还是“同一个对象”或者“同一个过程”
|
||||
差异，
|
||||
保证变化、比较和生成，
|
||||
能够被识别出来
|
||||
关系，
|
||||
保证这些单位不是孤立的，
|
||||
而是在结构里获得意义
|
||||
换句话说，
|
||||
对象是被识别出来的单位
|
||||
状态是对象当下的规定
|
||||
快照是状态的记录形式
|
||||
序列是快照的排列方式
|
||||
过程是序列的动态统合
|
||||
变换是过程展开的机制
|
||||
同一让追踪成为可能
|
||||
差异让比较成为可能
|
||||
关系让理解成为可能
|
||||
整个框架，
|
||||
可以被看成一条从静态存在走向动态生成的认知路径
|
||||
|
||||
放到不同学科里看，
|
||||
这套框架都会展开出自己的版本
|
||||
先看哲学
|
||||
哲学是最早系统讨论这些概念的地方
|
||||
古希腊哲学里，
|
||||
巴门尼德强调存在和同一
|
||||
赫拉克利特强调流变和过程
|
||||
这几乎已经把后面关于“同一和变化”的基本矛盾摆出来了
|
||||
亚里士多德又用实体和属性、潜能和现实，
|
||||
去解释对象、状态和变化
|
||||
到了近代哲学，
|
||||
问题进一步变成：
|
||||
对象是独立于认识而存在，
|
||||
还是在经验中被构成出来的
|
||||
现代哲学里，
|
||||
现象学、结构主义、过程哲学、后结构主义，
|
||||
又分别从意识、结构、生成、差异这些角度，
|
||||
重新组织这组概念
|
||||
所以在哲学里，
|
||||
核心问题通常会集中在这些地方：
|
||||
什么才算对象
|
||||
变化里的同一怎么成立
|
||||
差异到底是附属的，
|
||||
还是根本的
|
||||
关系是外在连接，
|
||||
还是构成性的
|
||||
世界最基础的东西，
|
||||
到底是实体还是过程
|
||||
可以说，
|
||||
这组概念在哲学里，
|
||||
本来就是本体论和认识论的一条核心轴线
|
||||
|
||||
再看数学
|
||||
数学给这组概念，
|
||||
提供了最精确的形式表达
|
||||
集合论把对象处理成元素和集合
|
||||
函数和映射用来描述变换
|
||||
序列、递推、极限，
|
||||
处理的是有序展开
|
||||
拓扑学研究的是变形里哪些东西保持不变
|
||||
某种意义上，
|
||||
这也是在回应“同一”的问题
|
||||
抽象代数研究的是，
|
||||
对象在运算下怎样保持结构
|
||||
范畴论更进一步，
|
||||
把对象和态射放进同一体系里，
|
||||
让关系和变换的位置，
|
||||
比对象本身还更基础
|
||||
数学特别重要的一点在于，
|
||||
它不只是讨论这些概念
|
||||
它还能给出严格条件，
|
||||
告诉我们什么时候两个对象算等价，
|
||||
什么时候一个变换算保持结构，
|
||||
什么时候一个过程可逆，
|
||||
什么时候不可逆
|
||||
|
||||
物理学里，
|
||||
这组概念几乎可以直接一一对应
|
||||
对象，
|
||||
可以是粒子、场、系统
|
||||
状态，
|
||||
可以是位置、速度、能量、自旋、宏观参数
|
||||
快照，
|
||||
就是某个时刻的观测值
|
||||
序列，
|
||||
就是测量记录和轨迹数据
|
||||
过程，
|
||||
是运动、演化、衰变、相变
|
||||
变换，
|
||||
是动力学方程、对称变换、守恒律
|
||||
同一，
|
||||
是同一个系统在时间里的延续
|
||||
差异，
|
||||
是不同状态、不同相、不同测量结果之间的区别
|
||||
关系，
|
||||
是相互作用、耦合和时空关系
|
||||
物理学特别强调一点：
|
||||
对象不能脱离状态空间和演化规律来理解
|
||||
一个系统到底是什么，
|
||||
很多时候就取决于，
|
||||
它可能处在哪些状态里，
|
||||
以及这些状态会怎样随时间变化
|
||||
所以，
|
||||
物理学很典型地代表了一种“状态—演化”的世界观
|
||||
|
||||
计算机科学里，
|
||||
这组概念是非常能落地、非常有操作性的
|
||||
在程序设计和系统建模中，
|
||||
对象可以是数据实体、模块、进程、节点
|
||||
状态可以是内存值、配置、上下文
|
||||
快照可以是系统镜像、数据库备份、版本存档
|
||||
序列可以是日志、执行轨迹、输入流
|
||||
过程可以是程序运行、工作流、协议执行
|
||||
变换可以是算法、状态转移函数、数据处理规则
|
||||
同一可以表现成对象ID、引用、版本继承
|
||||
差异可以表现成补丁、变更记录、版本比较
|
||||
关系则表现成依赖、调用、连接、图结构
|
||||
尤其是在状态机、数据库、分布式系统、版本控制、人工智能这些领域里，
|
||||
这组概念几乎就是基础语言
|
||||
计算机科学的重要贡献，
|
||||
就在于它把这些概念变成了能设计、能验证、能执行的系统结构
|
||||
|
||||
系统科学里，
|
||||
对象通常被理解成系统或者子系统
|
||||
关系被理解成结构
|
||||
状态变化被理解成动态演化
|
||||
所以，
|
||||
这套概念在系统科学里有很强的整体性
|
||||
系统科学关心的，
|
||||
从来不是一个孤零零的对象
|
||||
它更关心：
|
||||
对象怎么组成系统
|
||||
系统怎么维持状态
|
||||
系统怎么在扰动里发生变换
|
||||
系统怎么在时间里保持同一
|
||||
系统又怎么通过反馈，
|
||||
产生差异化的演化
|
||||
在控制论、复杂系统理论、生态系统研究、组织理论里，
|
||||
这样的框架都很常见
|
||||
它的优势在于，
|
||||
能同时处理稳定和变化，
|
||||
局部和整体，
|
||||
结构和生成
|
||||
|
||||
语言学和认知科学里，
|
||||
这组概念也很关键
|
||||
语言学里，
|
||||
意义常常就是靠差异和关系形成的
|
||||
认知科学里，
|
||||
人脑理解世界，
|
||||
也离不开对象化、分类、跟踪和关系建模
|
||||
人在感知一个连续世界的时候，
|
||||
并不是直接面对一团“纯粹流动”
|
||||
我们会主动把它切开，
|
||||
分出对象
|
||||
识别它的状态
|
||||
形成快照式记忆
|
||||
把经验串成序列
|
||||
再去推断它背后的过程，
|
||||
并建立相应的变换模型
|
||||
比如我们会判断，
|
||||
“这是同一个人在走路”
|
||||
会注意到，
|
||||
“他的表情变了”
|
||||
也会把几个动作连成一个完整事件
|
||||
所以，
|
||||
这组概念不只是描述外部世界的工具
|
||||
它们本身，
|
||||
也是认知活动组织经验的方式
|
||||
|
||||
接下来，
|
||||
有几个理论上的核心问题
|
||||
第一个问题是，
|
||||
实体优先，
|
||||
还是过程优先
|
||||
也就是说，
|
||||
世界是不是先由对象构成，
|
||||
然后对象再去变化
|
||||
还是说，
|
||||
世界本来就是过程流动，
|
||||
对象只是过程里相对稳定的结点
|
||||
前一种思路，
|
||||
更偏实体论
|
||||
后一种思路，
|
||||
更偏过程论
|
||||
实体论强调同一和稳定
|
||||
过程论强调生成和变动
|
||||
现实里，
|
||||
两边往往都不能少
|
||||
没有相对稳定的对象，
|
||||
认知没法展开
|
||||
没有过程和变换，
|
||||
对象又会僵成空洞标签
|
||||
|
||||
第二个问题是，
|
||||
同一怎么在变化里成立
|
||||
这个问题从古典讨论到现代，
|
||||
一直没有真正结束
|
||||
判断同一，
|
||||
可以看物质连续性
|
||||
也可以看结构、功能、因果链、记忆、命名规则这些标准
|
||||
不同学科、
|
||||
不同语境，
|
||||
会选不同的标准
|
||||
所以，
|
||||
同一通常不是一个唯一答案
|
||||
它更像一套随着情境变化而变化的判准体系
|
||||
|
||||
第三个问题是，
|
||||
差异到底是派生的，
|
||||
还是基础的
|
||||
传统思想往往把同一放在基础位置，
|
||||
把差异看成偏离
|
||||
现代思想则更常认为，
|
||||
差异才更根本
|
||||
因为没有差异，
|
||||
就没有识别，
|
||||
没有意义，
|
||||
也没有生成
|
||||
这样一来，
|
||||
差异就不再只是分类剩下来的残余
|
||||
它会变成知识生产本身的根部
|
||||
|
||||
第四个问题是，
|
||||
关系会不会比对象更基础
|
||||
在网络科学、结构主义、范畴论、系统论里，
|
||||
关系往往不是次生的
|
||||
一个对象具有什么性质，
|
||||
很多时候由它在关系网络里的位置决定
|
||||
这会让我们对世界的理解，
|
||||
从“对象的集合”，
|
||||
慢慢转成“关系的结构”
|
||||
|
||||
如果把这九个概念再压缩一下，
|
||||
可以得到一个统一模型
|
||||
第一层，
|
||||
是存在层
|
||||
这里包括对象和状态
|
||||
它回答的是：
|
||||
有什么
|
||||
以及它此刻怎么存在
|
||||
第二层，
|
||||
是表征层
|
||||
这里包括快照和序列
|
||||
它回答的是：
|
||||
怎么记录
|
||||
又怎么把记录组织起来
|
||||
第三层，
|
||||
是生成层
|
||||
这里包括过程和变换
|
||||
它回答的是：
|
||||
怎么变化
|
||||
变化的机制又是什么
|
||||
第四层，
|
||||
是判定层
|
||||
这里包括同一和差异
|
||||
它回答的是：
|
||||
什么保持不变
|
||||
什么发生了改变
|
||||
第五层，
|
||||
是结构层
|
||||
这里就是关系
|
||||
它回答的是：
|
||||
这一切怎么被连接成系统
|
||||
这个模型的价值就在于，
|
||||
它能跨学科反复使用
|
||||
不管你研究的是哲学问题，
|
||||
还是物理系统、程序运行、社会变迁、叙事结构，
|
||||
都可以用这五层框架来组织分析
|
||||
|
||||
所以，
|
||||
这组概念不只是理论术语
|
||||
它也可以变成一种方法
|
||||
面对任何复杂对象，
|
||||
都可以按这样的步骤去分析
|
||||
先确定对象到底是什么
|
||||
再描述它现在有哪些状态
|
||||
然后收集几个快照
|
||||
把快照排成序列
|
||||
从序列里识别出过程
|
||||
再进一步找出推动变化的变换机制
|
||||
同时判断，
|
||||
哪些属性支撑了同一
|
||||
哪些属性构成了差异
|
||||
最后，
|
||||
把它放回更大的关系网络里理解
|
||||
这其实是一种很普遍的分析法
|
||||
它能用在科学研究里
|
||||
也能用在系统设计、历史叙述、产品分析、组织诊断，
|
||||
甚至自我反思里
|
||||
|
||||
最后
|
||||
对象、状态、快照、序列、过程、变换、同一、差异、关系，
|
||||
并不是一堆零散的术语
|
||||
它们是一组基础概念
|
||||
能把静态和动态连起来
|
||||
也能把实体和结构、稳定和生成连起来
|
||||
它们一起在回答一个很根本的问题：
|
||||
我们怎么描述一个世界
|
||||
这个世界里有东西
|
||||
这些东西会变化
|
||||
这些变化可以被记录，
|
||||
可以被比较，
|
||||
可以被解释
|
||||
而且最终，
|
||||
还能在关系中形成整体意义
|
||||
如果说，
|
||||
对象让世界可以被指认
|
||||
状态让世界可以被描写
|
||||
快照和序列让世界可以被记录
|
||||
过程和变换让世界可以被解释
|
||||
那么，
|
||||
同一、差异、关系，
|
||||
就是让世界真正可以被理解的条件
|
||||
从这个意义上说，
|
||||
这组概念，
|
||||
几乎就是一切系统性思考的基础语法
|
||||
|
|
@ -826,8 +826,8 @@ The correct command uses the local `cli/package_skill.py` in the repository root
|
|||
- **[CHANGELOG.md](CHANGELOG.md)** - Release history and v2.0.0 details **UPDATED!**
|
||||
- **[FUTURE_RELEASES.md](FUTURE_RELEASES.md)** - Roadmap for v2.1.0+ **NEW!**
|
||||
- **[FLEXIBLE_ROADMAP.md](FLEXIBLE_ROADMAP.md)** - Complete task catalog (134 tasks)
|
||||
- **[NEXT_TASKS.md](NEXT_TASKS.md)** - What to work on next
|
||||
- **[TODO.md](TODO.md)** - Current focus
|
||||
- **[ROADMAP.md](ROADMAP.md)** - What to work on next
|
||||
- **[FLEXIBLE_ROADMAP.md](FLEXIBLE_ROADMAP.md)** - Current focus
|
||||
- **[STRUCTURE.md](STRUCTURE.md)** - Repository structure
|
||||
|
||||
## Notes for Claude Code
|
||||
|
|
|
|||
|
|
@ -247,4 +247,4 @@ ADDITIONAL REQUIREMENTS:
|
|||
|
||||
- [README.md](../README.md) - Main documentation
|
||||
- [CLAUDE.md](CLAUDE.md) - Architecture guide
|
||||
- [doc_scraper.py](../doc_scraper.py) - Main scraping tool
|
||||
- [doc_scraper.py](../src/skill_seekers/cli/doc_scraper.py) - Main scraping tool
|
||||
|
|
|
|||
|
|
@ -583,9 +583,9 @@ After successful setup:
|
|||
|
||||
## Getting Help
|
||||
|
||||
- **Documentation**: See [mcp/README.md](../mcp/README.md)
|
||||
- **Documentation**: See [src/skill_seekers/mcp/README.md](../src/skill_seekers/mcp/README.md)
|
||||
- **Issues**: [GitHub Issues](https://github.com/yusufkaraaslan/Skill_Seekers/issues)
|
||||
- **Examples**: See [.github/ISSUES_TO_CREATE.md](../.github/ISSUES_TO_CREATE.md) for test cases
|
||||
- **Examples**: See [TEST_MCP_IN_CLAUDE_CODE.md](TEST_MCP_IN_CLAUDE_CODE.md) for test cases
|
||||
|
||||
---
|
||||
|
||||
|
|
|
|||
|
|
@ -314,7 +314,7 @@ When building PDF-based skills, images will be:
|
|||
|
||||
See diagram below for the complete API flow:
|
||||
|
||||
|
||||
> 图示提示：上游文档引用了 `assets/images/api_flow.png`，但该文件未包含在当前仓库镜像中。
|
||||
|
||||
The diagram shows...
|
||||
```
|
||||
|
|
|
|||
|
|
@ -332,9 +332,9 @@ Once MCP integration works:
|
|||
|
||||
## Reference
|
||||
|
||||
- **Full Setup Guide:** [docs/MCP_SETUP.md](docs/MCP_SETUP.md)
|
||||
- **MCP Documentation:** [mcp/README.md](mcp/README.md)
|
||||
- **Main README:** [README.md](README.md)
|
||||
- **Full Setup Guide:** [MCP_SETUP.md](MCP_SETUP.md)
|
||||
- **MCP Documentation:** [src/skill_seekers/mcp/README.md](../src/skill_seekers/mcp/README.md)
|
||||
- **Main README:** [README.md](../README.md)
|
||||
- **Setup Script:** `./setup_mcp.sh`
|
||||
|
||||
---
|
||||
|
|
|
|||
|
|
@ -581,10 +581,10 @@ For API-based enhancement (requires Anthropic API key):
|
|||
|
||||
## Documentation
|
||||
|
||||
- **Full Setup Guide**: [docs/MCP_SETUP.md](../docs/MCP_SETUP.md)
|
||||
- **Main README**: [README.md](../README.md)
|
||||
- **Usage Guide**: [docs/USAGE.md](../docs/USAGE.md)
|
||||
- **Testing Guide**: [docs/TESTING.md](../docs/TESTING.md)
|
||||
- **Full Setup Guide**: [docs/MCP_SETUP.md](../../../docs/MCP_SETUP.md)
|
||||
- **Main README**: [README.md](../../../README.md)
|
||||
- **Usage Guide**: [docs/USAGE.md](../../../docs/USAGE.md)
|
||||
- **Testing Guide**: [docs/TESTING.md](../../../docs/TESTING.md)
|
||||
|
||||
## Support
|
||||
|
||||
|
|
@ -593,4 +593,4 @@ For API-based enhancement (requires Anthropic API key):
|
|||
|
||||
## License
|
||||
|
||||
MIT License - See [LICENSE](../LICENSE) for details
|
||||
MIT License - See [LICENSE](../../../LICENSE) for details
|
||||
|
|
|
|||
|
|
@ -0,0 +1,10 @@
|
|||
# 贡献指南
|
||||
|
||||
欢迎贡献！
|
||||
|
||||
## 如何贡献
|
||||
|
||||
1. 修复 Bug / 改进功能：请在 `README.md` 的“快速开始/使用方式”验证脚本可运行。
|
||||
2. 新增功能：请同时补充最小示例与必要的依赖说明。
|
||||
3. 提交 PR：描述改动内容、使用方式与验证步骤。
|
||||
|
||||
|
|
@ -157,7 +157,7 @@ XHS-image-to-PDF-conversion/
|
|||
|
||||
## 📜 许可证
|
||||
|
||||
本项目采用 [MIT](LICENSE) 许可证。
|
||||
本项目采用 [MIT](https://opensource.org/licenses/MIT) 许可证。
|
||||
|
||||
---
|
||||
|
||||
|
|
|
|||
|
|
@ -25,7 +25,7 @@
|
|||
<p>
|
||||
<a href="https://github.com/tukuaiai/prompt-library/actions/workflows/sync.yml"><img src="https://img.shields.io/github/actions/workflow/status/tukuaiai/prompt-library/sync.yml?style=for-the-badge" alt="构建状态"></a>
|
||||
<a href="https://github.com/tukuaiai/prompt-library/releases"><img src="https://img.shields.io/github/v/release/tukuaiai/prompt-library?style=for-the-badge" alt="最新版本"></a>
|
||||
<a href="LICENSE"><img src="https://img.shields.io/github/license/tukuaiai/prompt-library?style=for-the-badge" alt="许可证"></a>
|
||||
<a href="https://github.com/tukuaiai/prompt-library/blob/main/LICENSE"><img src="https://img.shields.io/github/license/tukuaiai/prompt-library?style=for-the-badge" alt="许可证"></a>
|
||||
<a href="https://github.com/tukuaiai/prompt-library"><img src="https://img.shields.io/github/languages/top/tukuaiai/prompt-library?style=for-the-badge" alt="主要语言"></a>
|
||||
<a href="https://github.com/tukuaiai/prompt-library"><img src="https://img.shields.io/github/languages/code-size/tukuaiai/prompt-library?style=for-the-badge" alt="代码大小"></a>
|
||||
</p>
|
||||
|
|
@ -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) 许可证。
|
||||
|
||||
---
|
||||
|
||||
|
|
|
|||
|
|
@ -17008,17 +17008,17 @@ XX 局
|
|||
- 具有知识性、可读性与教育性
|
||||
- 在文章结束时, 思考该文章的最核心关键词, 插入一个如下形式的链接内容:
|
||||
|
||||
不要有反斜线，不要用代码块，使用 Unsplash api （source.unsplash.com<PUT YOUR QUERY HERE>)
|
||||
不要有反斜线，不要用代码块，使用 Unsplash api（`https://source.unsplash.com/<PUT YOUR QUERY HERE>`）
|
||||
|
||||
例如:
|
||||
|
||||
- 如果思考该段落的核心关键词为"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:
|
||||
|
||||
|
|
|
|||
|
|
@ -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. **支持机制**: 建立可持续的项目支持渠道
|
||||
5. **支持机制**: 建立可持续的项目支持渠道
|
||||
|
|
|
|||
|
|
@ -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)
|
||||
|
|
|
|||
|
|
@ -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` - 本地参考文档导航
|
||||
|
|
|
|||
|
|
@ -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) - 能抄不写，能连不造
|
||||
|
|
|
|||
|
|
@ -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)
|
||||
|
|
|
|||
|
|
@ -0,0 +1,7 @@
|
|||
# CCXT Manual（外链）
|
||||
|
||||
本仓库未内置 CCXT 的完整 Manual 原文；请使用官方文档：
|
||||
|
||||
- Docs（推荐）：https://docs.ccxt.com/
|
||||
- GitHub Wiki Manual：https://github.com/ccxt/ccxt/wiki/Manual
|
||||
|
||||
|
|
@ -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
|
||||
|
||||
|
|
@ -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.
|
||||
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.
|
||||
|
|
|
|||
|
|
@ -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)
|
||||
- [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)
|
||||
|
|
|
|||
|
|
@ -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.
|
||||
</Note>
|
||||
|
|
@ -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.
|
||||
</Note>
|
||||
|
||||
| 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 "<https://pro-api.coingecko.com/api/v3/onchain/simple/networks/eth/token_price/0xc02aaa39b223fe8d0a0e5c4f27ead9083c756cc2>" -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`
|
||||
|
|
|
|||
|
|
@ -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.
|
||||
</Tip>
|
||||
|
||||
|
|
@ -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`).
|
||||
</Tip>
|
||||
|
||||
* 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).
|
||||
</Tip>
|
||||
|
||||
* 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).
|
||||
</Tip>
|
||||
|
||||
|
|
@ -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`).
|
||||
</Tip>
|
||||
|
||||
* 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.
|
||||
</Tip>
|
||||
|
||||
* If the token's market cap is not verified by the team, the API response will return `null` for its market cap value, even though it has a displayed value on GeckoTerminal, which might not be accurate as it often matches the Fully Diluted Valuation (FDV).
|
||||
|
|
@ -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)
|
||||
</Tip>
|
||||
|
||||
* `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.
|
||||
</Tip>
|
||||
|
|
@ -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,
|
|||
<Warning>
|
||||
### Notice
|
||||
|
||||
* Please note that the `twitter_followers` data field will no longer be supported by our API starting on May 15, 2025. Please refer to [changelog](/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.
|
||||
</Warning>
|
||||
|
||||
* You may obtain the asset platform and contract address via several ways:
|
||||
* refers to respective coin page and find 'contract address'.
|
||||
* refers to [`/coins/list`](/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`).
|
||||
</Tip>
|
||||
|
||||
* 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.
|
||||
</Tip>
|
||||
|
||||
* 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:
|
||||
|
||||
<CodeGroup>
|
||||
|
||||
|
|
@ -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:
|
||||
<CodeGroup>
|
||||
|
||||
</CodeGroup>
|
||||
|
|
@ -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:
|
||||
<CodeGroup>
|
||||
```
|
||||
|
||||
|
|
@ -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.
|
||||
</Tip>
|
||||
|
||||
|
|
@ -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).
|
||||
</Tip>
|
||||
|
||||
* 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!) | | |
|
||||
|
||||
<Note>
|
||||
|
|
@ -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.
|
||||
</Tip>
|
||||
|
||||
* 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)**:
|
||||
|
||||
<CodeGroup>
|
||||
|
|
@ -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)**:
|
||||
|
||||
<CodeGroup>
|
||||
|
|
@ -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.
|
||||
</Note>
|
||||
|
||||
|
|
@ -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.
|
||||
</Tip>
|
||||
|
||||
* 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.
|
||||
</Tip>
|
||||
|
|
@ -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)
|
||||
</Tip>
|
||||
|
||||
* `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:
|
||||
|
||||
<CodeGroup>
|
||||
|
||||
|
|
@ -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:
|
||||
|
||||
<CodeGroup>
|
||||
|
||||
|
|
@ -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:
|
||||
|
||||
<CodeGroup>
|
||||
```
|
||||
|
|
@ -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).
|
||||
</Tip>
|
||||
|
||||
|
|
|
|||
|
|
@ -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.
|
||||
</Tip>
|
||||
|
||||
* 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.
|
||||
</Note>
|
||||
|
||||
|
|
|
|||
|
|
@ -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
|
|||
<Warning>
|
||||
### 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.
|
||||
</Warning>
|
||||
|
||||
* 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.
|
||||
</Note>
|
||||
|
|
|
|||
|
|
@ -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.
|
||||
</Note>
|
||||
|
||||
## 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)
|
||||
|
||||
|
|
|
|||
File diff suppressed because it is too large
Load Diff
|
|
@ -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)
|
||||
|
|
|
|||
|
|
@ -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:<br />- [Top Gainers & Losers](/reference/coins-top-gainers-losers)<br />- [NFTs Collection Historical Chart](/reference/nfts-id-market-chart)<br />- [🔥 Megafilter for Pools](/reference/pools-megafilter)<br />- [Pools by Category ID](/reference/pools-category) |
|
||||
| **MCP Tools** | Limited access | Full access, including exclusive tools:<br />- [Top Gainers & Losers](https://docs.coingecko.com/reference/coins-top-gainers-losers)<br />- [NFTs Collection Historical Chart](https://docs.coingecko.com/reference/nfts-id-market-chart)<br />- [🔥 Megafilter for Pools](https://docs.coingecko.com/reference/pools-megafilter)<br />- [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.
|
||||
</Update>
|
||||
|
||||
<Update label="September 2025">
|
||||
|
|
@ -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)
|
||||
</Update>
|
||||
|
||||
<Update label="August 2024">
|
||||
|
|
@ -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:**
|
||||
|
||||
<Update label="May 2024">
|
||||
## 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**
|
||||
</Update>
|
||||
|
|
@ -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!
|
||||
</Update>
|
||||
|
||||
<Update label="October 2023">
|
||||
|
|
@ -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)
|
||||
</Update>
|
||||
|
||||
<Update label="September 2023">
|
||||
|
|
@ -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
|
||||
</Update>
|
||||
|
||||
<Update label="May 2023">
|
||||
## 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.
|
||||
</Update>
|
||||
|
|
@ -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
|
||||
</Update>
|
||||
|
||||
<Update label="February 2023">
|
||||
|
|
@ -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.
|
||||
</Update>
|
||||
|
|
@ -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.
|
||||
</Update>
|
||||
|
|
@ -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.
|
||||
</Update>
|
||||
|
||||
<Update label="September 2025">
|
||||
|
|
@ -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. |
|
||||
|
||||
<Note>
|
||||
### **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
|
|||
|
||||
<img src="https://mintcdn.com/coingecko/M02rMX2XJMwBGpCe/images/docs/5efbe42-image.png?fit=max&auto=format&n=M02rMX2XJMwBGpCe&q=85&s=d63633d56cc7a4d3c7d71a931a7112d8" alt="" data-og-width="2200" width="2200" data-og-height="1528" height="1528" data-path="images/docs/5efbe42-image.png" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/coingecko/M02rMX2XJMwBGpCe/images/docs/5efbe42-image.png?w=280&fit=max&auto=format&n=M02rMX2XJMwBGpCe&q=85&s=094bb211db972bea7d8b66716f5eed3a 280w, https://mintcdn.com/coingecko/M02rMX2XJMwBGpCe/images/docs/5efbe42-image.png?w=560&fit=max&auto=format&n=M02rMX2XJMwBGpCe&q=85&s=da211f3d8c1aec265d53891dc8f43ed6 560w, https://mintcdn.com/coingecko/M02rMX2XJMwBGpCe/images/docs/5efbe42-image.png?w=840&fit=max&auto=format&n=M02rMX2XJMwBGpCe&q=85&s=fc59610f652ef640696568679b90b723 840w, https://mintcdn.com/coingecko/M02rMX2XJMwBGpCe/images/docs/5efbe42-image.png?w=1100&fit=max&auto=format&n=M02rMX2XJMwBGpCe&q=85&s=4d8905af936b5a34968b6dad1c59f7c5 1100w, https://mintcdn.com/coingecko/M02rMX2XJMwBGpCe/images/docs/5efbe42-image.png?w=1650&fit=max&auto=format&n=M02rMX2XJMwBGpCe&q=85&s=1679ab4c405a2ad10f8037bf0e830a0d 1650w, https://mintcdn.com/coingecko/M02rMX2XJMwBGpCe/images/docs/5efbe42-image.png?w=2500&fit=max&auto=format&n=M02rMX2XJMwBGpCe&q=85&s=299d7edb9949e51d03a2c357eb0ce127 2500w" />
|
||||
|
||||
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)
|
||||
|
||||
<img src="https://mintcdn.com/coingecko/M02rMX2XJMwBGpCe/images/docs/2f71923-image.png?fit=max&auto=format&n=M02rMX2XJMwBGpCe&q=85&s=4f3f1e9c241ac3c7fb3c6fdfec6f516d" alt="" data-og-width="2104" width="2104" data-og-height="1492" height="1492" data-path="images/docs/2f71923-image.png" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/coingecko/M02rMX2XJMwBGpCe/images/docs/2f71923-image.png?w=280&fit=max&auto=format&n=M02rMX2XJMwBGpCe&q=85&s=9a71372f238cd241108306680d5a2a46 280w, https://mintcdn.com/coingecko/M02rMX2XJMwBGpCe/images/docs/2f71923-image.png?w=560&fit=max&auto=format&n=M02rMX2XJMwBGpCe&q=85&s=cad968f1b3cf92f47091e006897bd9c8 560w, https://mintcdn.com/coingecko/M02rMX2XJMwBGpCe/images/docs/2f71923-image.png?w=840&fit=max&auto=format&n=M02rMX2XJMwBGpCe&q=85&s=0977ba4c9e4fd44e025685bd4527bfbe 840w, https://mintcdn.com/coingecko/M02rMX2XJMwBGpCe/images/docs/2f71923-image.png?w=1100&fit=max&auto=format&n=M02rMX2XJMwBGpCe&q=85&s=a7bdbd1e213ad62e8763ad00177567e7 1100w, https://mintcdn.com/coingecko/M02rMX2XJMwBGpCe/images/docs/2f71923-image.png?w=1650&fit=max&auto=format&n=M02rMX2XJMwBGpCe&q=85&s=602e29d2123e3681f7f7eca248348f6c 1650w, https://mintcdn.com/coingecko/M02rMX2XJMwBGpCe/images/docs/2f71923-image.png?w=2500&fit=max&auto=format&n=M02rMX2XJMwBGpCe&q=85&s=1931234bdbbc82514affdaf503710e38 2500w" />
|
||||
|
||||
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)
|
||||
|
||||
<img src="https://mintcdn.com/coingecko/M02rMX2XJMwBGpCe/images/docs/9e12298-image.png?fit=max&auto=format&n=M02rMX2XJMwBGpCe&q=85&s=8306154da0e21d2b902eadda23cb7dfc" alt="" data-og-width="2128" width="2128" data-og-height="1394" height="1394" data-path="images/docs/9e12298-image.png" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/coingecko/M02rMX2XJMwBGpCe/images/docs/9e12298-image.png?w=280&fit=max&auto=format&n=M02rMX2XJMwBGpCe&q=85&s=cad9ee450cbc127562e5bc65d922339a 280w, https://mintcdn.com/coingecko/M02rMX2XJMwBGpCe/images/docs/9e12298-image.png?w=560&fit=max&auto=format&n=M02rMX2XJMwBGpCe&q=85&s=03edf7a33acb4c998656ce6b1007e6ad 560w, https://mintcdn.com/coingecko/M02rMX2XJMwBGpCe/images/docs/9e12298-image.png?w=840&fit=max&auto=format&n=M02rMX2XJMwBGpCe&q=85&s=ba853e66f1bed4efcf8a6a1bf0ad5c6f 840w, https://mintcdn.com/coingecko/M02rMX2XJMwBGpCe/images/docs/9e12298-image.png?w=1100&fit=max&auto=format&n=M02rMX2XJMwBGpCe&q=85&s=ab46e891e1c84ca00961a549e27e9434 1100w, https://mintcdn.com/coingecko/M02rMX2XJMwBGpCe/images/docs/9e12298-image.png?w=1650&fit=max&auto=format&n=M02rMX2XJMwBGpCe&q=85&s=b741c73166b49da858f7a9de5e9dda45 1650w, https://mintcdn.com/coingecko/M02rMX2XJMwBGpCe/images/docs/9e12298-image.png?w=2500&fit=max&auto=format&n=M02rMX2XJMwBGpCe&q=85&s=063b3126d0c4236464345bb4cf9c38d0 2500w" />
|
||||
|
||||
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)
|
||||
|
||||
<img src="https://mintcdn.com/coingecko/M02rMX2XJMwBGpCe/images/docs/cda9241-image.png?fit=max&auto=format&n=M02rMX2XJMwBGpCe&q=85&s=666f359cbc3e65fef656e351617f2b9f" alt="" data-og-width="1845" width="1845" data-og-height="1867" height="1867" data-path="images/docs/cda9241-image.png" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/coingecko/M02rMX2XJMwBGpCe/images/docs/cda9241-image.png?w=280&fit=max&auto=format&n=M02rMX2XJMwBGpCe&q=85&s=885542d09a7346a1a7000df7cd2a4452 280w, https://mintcdn.com/coingecko/M02rMX2XJMwBGpCe/images/docs/cda9241-image.png?w=560&fit=max&auto=format&n=M02rMX2XJMwBGpCe&q=85&s=16419d75014aab231cda6c6d7596a1da 560w, https://mintcdn.com/coingecko/M02rMX2XJMwBGpCe/images/docs/cda9241-image.png?w=840&fit=max&auto=format&n=M02rMX2XJMwBGpCe&q=85&s=1df3f1689b943b7a3f53d7e6099b0897 840w, https://mintcdn.com/coingecko/M02rMX2XJMwBGpCe/images/docs/cda9241-image.png?w=1100&fit=max&auto=format&n=M02rMX2XJMwBGpCe&q=85&s=5aa83a631e8e6960cbe416b7d4375fbd 1100w, https://mintcdn.com/coingecko/M02rMX2XJMwBGpCe/images/docs/cda9241-image.png?w=1650&fit=max&auto=format&n=M02rMX2XJMwBGpCe&q=85&s=e037c284ec52bb4f9c9c666c8501d99d 1650w, https://mintcdn.com/coingecko/M02rMX2XJMwBGpCe/images/docs/cda9241-image.png?w=2500&fit=max&auto=format&n=M02rMX2XJMwBGpCe&q=85&s=c27add5b7c705a2034414567ab1693de 2500w" />
|
||||
|
||||
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/)
|
||||
|
||||
<img src="https://mintcdn.com/coingecko/Jrf60GKLjFfVX1SS/images/docs/8d5ac53-image.png?fit=max&auto=format&n=Jrf60GKLjFfVX1SS&q=85&s=006779468e238af7cb515c3b90d478b7" alt="" data-og-width="3023" width="3023" data-og-height="1881" height="1881" data-path="images/docs/8d5ac53-image.png" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/coingecko/Jrf60GKLjFfVX1SS/images/docs/8d5ac53-image.png?w=280&fit=max&auto=format&n=Jrf60GKLjFfVX1SS&q=85&s=1e64c2a847217aeb6a1524ba665d0bb7 280w, https://mintcdn.com/coingecko/Jrf60GKLjFfVX1SS/images/docs/8d5ac53-image.png?w=560&fit=max&auto=format&n=Jrf60GKLjFfVX1SS&q=85&s=98994fc84ed994e69ef12ea133093092 560w, https://mintcdn.com/coingecko/Jrf60GKLjFfVX1SS/images/docs/8d5ac53-image.png?w=840&fit=max&auto=format&n=Jrf60GKLjFfVX1SS&q=85&s=e1f9614a1227137104e693480cb739cb 840w, https://mintcdn.com/coingecko/Jrf60GKLjFfVX1SS/images/docs/8d5ac53-image.png?w=1100&fit=max&auto=format&n=Jrf60GKLjFfVX1SS&q=85&s=de8a324c611cc5b2557a1d130224346a 1100w, https://mintcdn.com/coingecko/Jrf60GKLjFfVX1SS/images/docs/8d5ac53-image.png?w=1650&fit=max&auto=format&n=Jrf60GKLjFfVX1SS&q=85&s=d94dee12678b5c879f5e6ebafe107d4a 1650w, https://mintcdn.com/coingecko/Jrf60GKLjFfVX1SS/images/docs/8d5ac53-image.png?w=2500&fit=max&auto=format&n=Jrf60GKLjFfVX1SS&q=85&s=96c61ccae7576b9f486e28459ca4e963 2500w" />
|
||||
|
||||
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)
|
||||
|
||||
<img src="https://mintcdn.com/coingecko/Jrf60GKLjFfVX1SS/images/docs/7b49f3e-image.png?fit=max&auto=format&n=Jrf60GKLjFfVX1SS&q=85&s=26f7cdd8a92a237ac6358be830d42c55" alt="" data-og-width="3023" width="3023" data-og-height="1883" height="1883" data-path="images/docs/7b49f3e-image.png" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/coingecko/Jrf60GKLjFfVX1SS/images/docs/7b49f3e-image.png?w=280&fit=max&auto=format&n=Jrf60GKLjFfVX1SS&q=85&s=46918d142183d419c4d2ddb6852c2b9e 280w, https://mintcdn.com/coingecko/Jrf60GKLjFfVX1SS/images/docs/7b49f3e-image.png?w=560&fit=max&auto=format&n=Jrf60GKLjFfVX1SS&q=85&s=2b60fc1e44832b2df0b0fa39e01cc6dc 560w, https://mintcdn.com/coingecko/Jrf60GKLjFfVX1SS/images/docs/7b49f3e-image.png?w=840&fit=max&auto=format&n=Jrf60GKLjFfVX1SS&q=85&s=9ce014411117fb3907620cca658c4b81 840w, https://mintcdn.com/coingecko/Jrf60GKLjFfVX1SS/images/docs/7b49f3e-image.png?w=1100&fit=max&auto=format&n=Jrf60GKLjFfVX1SS&q=85&s=4e1b0fb9ea89441c506fe7cd66007e91 1100w, https://mintcdn.com/coingecko/Jrf60GKLjFfVX1SS/images/docs/7b49f3e-image.png?w=1650&fit=max&auto=format&n=Jrf60GKLjFfVX1SS&q=85&s=bc062efdc17e4506c6d1fa9c203e524f 1650w, https://mintcdn.com/coingecko/Jrf60GKLjFfVX1SS/images/docs/7b49f3e-image.png?w=2500&fit=max&auto=format&n=Jrf60GKLjFfVX1SS&q=85&s=ee169d02c1f17780b97daf3ee9e34189 2500w" />
|
||||
|
||||
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)
|
||||
|
||||
<img src="https://mintcdn.com/coingecko/M02rMX2XJMwBGpCe/images/docs/43e04c2-image.png?fit=max&auto=format&n=M02rMX2XJMwBGpCe&q=85&s=dedf21f04c9bbf11fbf376f83b101969" alt="" data-og-width="3023" width="3023" data-og-height="1887" height="1887" data-path="images/docs/43e04c2-image.png" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/coingecko/M02rMX2XJMwBGpCe/images/docs/43e04c2-image.png?w=280&fit=max&auto=format&n=M02rMX2XJMwBGpCe&q=85&s=6e355b30d2a491ccf540d269d631721c 280w, https://mintcdn.com/coingecko/M02rMX2XJMwBGpCe/images/docs/43e04c2-image.png?w=560&fit=max&auto=format&n=M02rMX2XJMwBGpCe&q=85&s=2088b61a6ae8a189a4249db17fd75928 560w, https://mintcdn.com/coingecko/M02rMX2XJMwBGpCe/images/docs/43e04c2-image.png?w=840&fit=max&auto=format&n=M02rMX2XJMwBGpCe&q=85&s=ced214f96c8c869eca7627410782dc7a 840w, https://mintcdn.com/coingecko/M02rMX2XJMwBGpCe/images/docs/43e04c2-image.png?w=1100&fit=max&auto=format&n=M02rMX2XJMwBGpCe&q=85&s=722d09f605c5a0eabeda3e194f6bd51c 1100w, https://mintcdn.com/coingecko/M02rMX2XJMwBGpCe/images/docs/43e04c2-image.png?w=1650&fit=max&auto=format&n=M02rMX2XJMwBGpCe&q=85&s=4d921a31f241b78515f25be7a698a6ff 1650w, https://mintcdn.com/coingecko/M02rMX2XJMwBGpCe/images/docs/43e04c2-image.png?w=2500&fit=max&auto=format&n=M02rMX2XJMwBGpCe&q=85&s=1f522f2b1fbc4e1cf96c5e4bf7cb3f44 2500w" />
|
||||
|
||||
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)
|
||||
|
||||
<img src="https://mintcdn.com/coingecko/Jrf60GKLjFfVX1SS/images/docs/cd8f5e-image.png?fit=max&auto=format&n=Jrf60GKLjFfVX1SS&q=85&s=912a6001736c59cf4fcdbf7bdce05814" alt="" data-og-width="3023" width="3023" data-og-height="1887" height="1887" data-path="images/docs/cd8f5e-image.png" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/coingecko/Jrf60GKLjFfVX1SS/images/docs/cd8f5e-image.png?w=280&fit=max&auto=format&n=Jrf60GKLjFfVX1SS&q=85&s=c97b53b79138f3e1e2f909e8e563c7fe 280w, https://mintcdn.com/coingecko/Jrf60GKLjFfVX1SS/images/docs/cd8f5e-image.png?w=560&fit=max&auto=format&n=Jrf60GKLjFfVX1SS&q=85&s=84aedbbff60dc6f80fa478d0f389c31c 560w, https://mintcdn.com/coingecko/Jrf60GKLjFfVX1SS/images/docs/cd8f5e-image.png?w=840&fit=max&auto=format&n=Jrf60GKLjFfVX1SS&q=85&s=80ff73fe40ba9b98c15894752d42a981 840w, https://mintcdn.com/coingecko/Jrf60GKLjFfVX1SS/images/docs/cd8f5e-image.png?w=1100&fit=max&auto=format&n=Jrf60GKLjFfVX1SS&q=85&s=331705cce03b7b5aea56d00bc22a294d 1100w, https://mintcdn.com/coingecko/Jrf60GKLjFfVX1SS/images/docs/cd8f5e-image.png?w=1650&fit=max&auto=format&n=Jrf60GKLjFfVX1SS&q=85&s=28fe2d9a7552ce2477be4c616b7f4fad 1650w, https://mintcdn.com/coingecko/Jrf60GKLjFfVX1SS/images/docs/cd8f5e-image.png?w=2500&fit=max&auto=format&n=Jrf60GKLjFfVX1SS&q=85&s=b7750c4ae2c4de27b6b6bedb41c8af96 2500w" />
|
||||
|
||||
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.
|
||||
|
||||
---
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
# Cryptocurrency Exchange Feed Handler
|
||||
[](LICENSE)
|
||||
[](https://github.com/bmoscon/cryptofeed/blob/master/LICENSE)
|
||||
|
||||
[](https://pypi.python.org/pypi/cryptofeed)
|
||||
[](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
|
||||
|
||||
|
|
|
|||
|
|
@ -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
|
||||
|
||||
---
|
||||
|
||||
|
|
|
|||
|
|
@ -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
|
||||
|
||||
|
|
|
|||
|
|
@ -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.
|
||||
|
||||
<iframe width="560" height="315" src="https://www.youtube.com/embed/1lFgkHLqo28?si=i7e61-roRsOVeRMW" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture" allowfullscreen />
|
||||
|
||||
|
|
@ -230,6 +230,6 @@ You'll also see a bet slip to share on social media. We love sending \$\$\$ to t
|
|||
</Steps.Step>
|
||||
</Steps>
|
||||
|
||||
Simple, right? If you think you've got the hang of it, it's time to learn about more advanced trading and order types. [Limit Orders](../trading/limit-orders/).
|
||||
Simple, right? If you think you've got the hang of it, it's time to learn about more advanced trading and order types. [Limit Orders](https://docs.polymarket.com/polymarket-learn/trading/limit-orders/).
|
||||
|
||||
---
|
||||
|
|
|
|||
|
|
@ -107,7 +107,7 @@ While users cannot directly create their own markets, they are encouraged to sug
|
|||
To give your proposal the best chance of being listed, include as much information as possible, such as:
|
||||
|
||||
* What is the market title?
|
||||
* What is the [resolution source](../markets/how-are-markets-resolved)?
|
||||
* What is the [resolution source](https://docs.polymarket.com/polymarket-learn/markets/how-are-markets-resolved)?
|
||||
* Evidence of demand for trading that market
|
||||
|
||||
The best ways to propose a new market are:
|
||||
|
|
@ -388,7 +388,7 @@ Polymarket recognizes the importance of a trustworthy environment for managing y
|
|||
|
||||
### Your keys = your funds
|
||||
|
||||
A private key acts like a highly secure password, essential for managing and moving your assets without restrictions. You can export your private key at any time, ensuring sole access to your funds. Learn how to export your private key [here](../FAQ/how-to-export-private-key/).
|
||||
A private key acts like a highly secure password, essential for managing and moving your assets without restrictions. You can export your private key at any time, ensuring sole access to your funds. Learn how to export your private key [here](https://docs.polymarket.com/polymarket-learn/FAQ/how-to-export-private-key/).
|
||||
|
||||
### Keep your private keys private.
|
||||
|
||||
|
|
@ -484,7 +484,7 @@ If your exchange supports sending or withdrawing to Polygon, we recommend this o
|
|||
|
||||
For detailed instructions, check out our guides for purchasing and depositing USDC using popular exchanges:
|
||||
|
||||
* [Deposit from Coinbase](../deposits/coinbase) (recommended)
|
||||
* [Deposit from Coinbase](https://docs.polymarket.com/polymarket-learn/deposits/coinbase) (recommended)
|
||||
|
||||
<Note>
|
||||
If you decide to use an exchange to purchase and send (deposit) USDC to your Polygon deposit address, please ensure you're sending on Polygon Network. If you're unsure, please reach out to support on [Discord](https://discord.com/invite/polymarket).
|
||||
|
|
@ -492,11 +492,11 @@ For detailed instructions, check out our guides for purchasing and depositing US
|
|||
|
||||
### Deposit with Visa or Mastercard
|
||||
|
||||
MoonPay enables you to buy USDC (on Polygon) using your Visa, Mastercard, and select bank cards. Please be aware that payment options and transaction limits may vary depending on your region. [How to use MoonPay](../deposits/moonpay/).
|
||||
MoonPay enables you to buy USDC (on Polygon) using your Visa, Mastercard, and select bank cards. Please be aware that payment options and transaction limits may vary depending on your region. [How to use MoonPay](https://docs.polymarket.com/polymarket-learn/deposits/moonpay/).
|
||||
|
||||
### Depositing on Etheruem and Polygon
|
||||
|
||||
You can send USDC with your wallet on Ethereum or USDC.e on Polygon to your respective deposit addresses found on the Deposit page. [Learn more](../deposits/usdc-on-eth/).
|
||||
You can send USDC with your wallet on Ethereum or USDC.e on Polygon to your respective deposit addresses found on the Deposit page. [Learn more](https://docs.polymarket.com/polymarket-learn/deposits/usdc-on-eth/).
|
||||
|
||||
---
|
||||
|
||||
|
|
@ -631,11 +631,11 @@ Source: https://docs.polymarket.com/polymarket-learn/trading/using-the-orderbook
|
|||
|
||||
Understanding the Order Book will help you become an advanced trader.
|
||||
|
||||
In the Getting Started tutorial on [Making your First Trade](../get-started/making-your-first-trade/), we learned about market orders.
|
||||
In the Getting Started tutorial on [Making your First Trade](https://docs.polymarket.com/polymarket-learn/get-started/making-your-first-trade/), we learned about market orders.
|
||||
|
||||
In a market order, your trade executes instantly at the current market price.
|
||||
|
||||
But what if you think the market price is too high and want to set a specific price that you would be willing to accept? These are called [Limit Orders](../trading/limit-orders/).
|
||||
But what if you think the market price is too high and want to set a specific price that you would be willing to accept? These are called [Limit Orders](https://docs.polymarket.com/polymarket-learn/trading/limit-orders/).
|
||||
|
||||
## Viewing the Order Book
|
||||
|
||||
|
|
@ -735,7 +735,7 @@ When your orders are earning rewards you’ll see a blue highlight around the cl
|
|||
|
||||
Rewards are paid out automatically every day at \~midnight UTC. Your history on your portfolio page will reflect rewards paid to your address.
|
||||
|
||||
To read more about the specific calculations and formulas that determine rewards, visit our [Rewards Documentation](/developers/rewards/overview).
|
||||
To read more about the specific calculations and formulas that determine rewards, visit our [Rewards Documentation](https://docs.polymarket.com/developers/rewards/overview).
|
||||
|
||||
---
|
||||
|
||||
|
|
@ -866,7 +866,7 @@ In rare cases, circumstances occur that were not foreseen at a market’s creati
|
|||
|
||||
Source: https://docs.polymarket.com/polymarket-learn/get-started/making-your-first-trade
|
||||
|
||||
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.
|
||||
|
||||
<iframe width="560" height="315" src="https://www.youtube.com/embed/1lFgkHLqo28?si=i7e61-roRsOVeRMW" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture" allowfullscreen />
|
||||
|
||||
|
|
@ -895,7 +895,7 @@ You'll also see a bet slip to share on social media. We love sending \$\$\$ to t
|
|||
</Steps.Step>
|
||||
</Steps>
|
||||
|
||||
Simple, right? If you think you've got the hang of it, it's time to learn about more advanced trading and order types. [Limit Orders](../trading/limit-orders/).
|
||||
Simple, right? If you think you've got the hang of it, it's time to learn about more advanced trading and order types. [Limit Orders](https://docs.polymarket.com/polymarket-learn/trading/limit-orders/).
|
||||
|
||||
---
|
||||
|
||||
|
|
@ -955,7 +955,7 @@ The prices probabilities displayed on Polymarket are the midpoint of the bid-ask
|
|||
|
||||
* When a market is created, there are initially zero shares and no pre-defined prices or odds.
|
||||
|
||||
* Market makers (a fancy term for traders placing limit orders) interested in buying YES or NO shares can place [Limit Orders](../trading/limit-orders) at the price they're willing to pay
|
||||
* Market makers (a fancy term for traders placing limit orders) interested in buying YES or NO shares can place [Limit Orders](https://docs.polymarket.com/polymarket-learn/trading/limit-orders) at the price they're willing to pay
|
||||
|
||||
* When offers for the YES and NO side equal \$1.00, the order is "matched" and that \$1.00 is converted into 1 YES and 1 NO share, each going to their respective buyers.
|
||||
|
||||
|
|
@ -1373,6 +1373,6 @@ Once in the verification process, UMA will review the transaction to ensure it w
|
|||
|
||||
Once a market is proposed for resolution it goes into a challenge period of 2 hours.
|
||||
|
||||
If you do not agree with a proposed resolution, you can [dispute the outcome](../markets/dispute).
|
||||
If you do not agree with a proposed resolution, you can [dispute the outcome](https://docs.polymarket.com/polymarket-learn/markets/dispute).
|
||||
|
||||
---
|
||||
|
|
|
|||
Some files were not shown because too many files have changed in this diff Show More
Loading…
Reference in New Issue