🚀 MCP-FRED API 集成文档
MCP-FRED 是一款将 FRED（美联储经济数据）API 与 Model Context Protocol（模型上下文协议）集成的工具。它能帮助用户从 FRED API 获取经济数据，还支持多种数据格式和筛选条件，为经济数据的获取和处理提供了便利。
🚀 快速开始
MCP-FRED 集成了 FRED API 和 Model Context Protocol，让您可以轻松获取和处理经济数据。接下来将为您介绍详细的安装和使用方法。
📦 安装指南
必要依赖
- Python 3.6+
requests库：用于 HTTP 请求。json库：用于 JSON 数据处理。
安装步骤
- 克隆仓库：
git clone https://github.com/your-repository/mcp-fred.git - 安装依赖：
pip install requests json
✨ 主要特性
- 从 FRED API 获取经济数据。
- 支持多种数据格式和筛选条件。
💻 使用示例
基础用法
from mcp_fred import FredAPI
# 初始化 API 对象（需要替换为您的 API Key）
fred = FredAPI(api_key="your_api_key_here")
# 获取 GDP 数据
gdp_data = fred.get_series_data(series_id="GDP")
print(gdp_data)
# 获取 CPI 数据并指定单位和频率
cpi_data = fred.get_series_data(
series_id="CPIAUCSL",
units="pch", # 表示年化百分比变化
frequency="m" # 表示按月聚合
)
print(cpi_data)
高级用法
# 获取 GDP 数据并按年度聚合
gdp_annual = fred.get_series_data(
series_id="GDP",
frequency="a",
aggregation_method="sum"
)
print(gdp_annual)
# 获取 CPI 数据并指定单位和频率
cpi_monthly = fred.get_series_data(
series_id="CPIAUCSL",
units="pch",
frequency="m"
)
print(cpi_monthly)
📚 详细文档
可用参数
| 参数名 | 类型 | 描述 | 示例值 |
|---|---|---|---|
| series_id | str | 数据系列的唯一标识符 | "GDP", "CPIAUCSL" |
| sort_order | str | 结果排序方式 | "asc", "desc" |
| units | str | 数据单位表示方式 | "pch"（年化百分比变化），"tanim"（同比） |
| frequency | str | 数据频率 | "a"（年度），"m"（月度） |
| aggregation_method | str | 聚合方法 | "avg"（平均值），"sum"（总和） |
| output_type | int | 输出格式类型 | 1（JSON 标准输出），2（CSV 格式） |
🔧 技术细节
MCP-FRED 集成了 FRED API 和 Model Context Protocol，通过 Python 的 requests 库进行 HTTP 请求，使用 json 库处理 JSON 数据。用户可以通过初始化 FredAPI 对象并传入 API Key，调用 get_series_data 方法获取经济数据，同时可以通过传入不同的参数来指定数据系列、排序方式、单位、频率、聚合方法和输出格式等。
📄 许可证
本项目遵循 MIT 许可证，具体内容请参见 LICENSE 文件。
参考资料
如需更多信息，请随时查阅本项目的 GitHub 仓库或联系维护团队。
项目贡献
欢迎社区贡献！请遵循以下步骤：
- Fork 本仓库。
- 创建功能分支：
git checkout -b feature/your-feature - 提交代码更改：
git commit -m '添加新功能' - 推送到远程分支：
git push origin feature/your-feature - 提交 Pull Request。