README
🚀 CoinGecko API 服务器 MCP
这是一个强大且灵活的 Node.js Express 服务器,为 CoinGecko 加密货币数据 API 提供了全面的接口。该服务器支持免费公共 API 和 Pro API,还具备自动回退功能。
🚀 快速开始
# 使用 npx 安装并运行
npx coingecko-api-server
# 或者克隆并手动安装
git clone https://github.com/GaplyDev01/coingecko-api-server.git
cd coingecko-api-server
npm install
npm run setup
npm start
✨ 主要特性
- 🔄 双 API 支持:无缝支持 CoinGecko 免费和 Pro API。
- 🔙 自动回退:开发期间可自动回退到免费 API。
- 🔌 RESTful 端点:提供简单直观的 API 接口。
- 🛡️ 强大的错误处理:输出详细的错误消息和正确的状态码。
- 🧩 简单的设置:能快速安装,并带有引导式设置。
- 📝 全面的文档:提供清晰的使用说明。
📦 安装指南
选项 1:使用 npx(推荐)
这是最快的安装方式:
npx coingecko-api-server
交互式设置流程如下:
- 询问安装服务器的位置。
- 克隆仓库。
- 安装依赖项。
- 提示输入你的 CoinGecko API 密钥(可选)。
- 配置服务器端口。
选项 2:手动设置
如果你更喜欢手动设置:
# 克隆仓库
git clone https://github.com/GaplyDev01/coingecko-api-server.git
cd coingecko-api-server
# 安装依赖项
npm install
# 运行设置脚本
npm run setup
# 启动服务器
npm start
📚 详细文档
配置
服务器可以通过 .env 文件中的环境变量进行配置:
| 变量 | 描述 | 默认值 |
|----------|-------------|---------|
| PORT | 服务器监听的端口 | 3000 |
| COINGECKO_API_KEY | 你的 CoinGecko Pro API 密钥 | - |
API 端点
服务器提供了对所有必要的 CoinGecko API 端点的访问:
基本端点
GET /api/ping- 检查 CoinGecko API 状态。
价格数据
GET /api/simple/price- 获取指定硬币的价格数据。- 查询参数:
ids,vs_currencies,include_market_cap,include_24hr_vol,include_24hr_change,include_last_updated_at,precision。
- 查询参数:
GET /api/simple/supported_vs_currencies- 获取支持的 vs 货币列表。
硬币数据
GET /api/coins/markets- 获取硬币市场数据。- 查询参数:
vs_currency,ids,category,order,per_page,page,sparkline,price_change_percentage。
- 查询参数:
市场数据
GET /api/global- 获取全球加密货币数据。GET /api/search/trending- 获取趋势币。
完整的 API 文档可以在 CoinGecko API 文档 中找到。
MCP 集成信息
这是一个与 AI 系统(如 Claude)兼容的 MCP(市场组件计划)服务器。要在 Claude Desktop 中使用此服务器:
- 在本地启动 CoinGecko API 服务器。
- 在 Claude Desktop 中,通过提供服务器 URL(例如
http://localhost:3000)安装 MCP。 - Claude 现在可以通过 MCP 接口访问数据。
# 以开发模式运行,带有热重载
npm run dev
该服务器使用直接的 fetch 调用访问 CoinGecko API,确保与免费和 Pro 版本兼容。
📄 许可证
该项目根据 MIT 许可证进行许可 - 有关详细信息,请参阅 LICENSE 文件。
扫码联系在线客服