README
🚀 MCP - FRED 使用说明文档
MCP - FRED 工具借助模型上下文协议(MCP)连接 FRED API,能让您轻松获取经济数据。以下将为您详细介绍该工具的安装、配置及使用方法。
🚀 快速开始
MCP - FRED 提供了简洁的接口来访问 FRED 的数据。您可以按以下步骤开始使用:
- 初始化客户端:
from mcp_fred import FredClient
client = FredClient(api_key='your_api_key_here')
- 发送请求:
response = client.get_series_data(series_id='GDP', sort_order='desc')
- 处理响应:
print(response.data)
✨ 主要特性
- 通过模型上下文协议(MCP)连接 FRED API,方便获取经济数据。
- 提供简洁的接口,便于用户操作。
📦 安装指南
2.1 安装依赖
确保您已安装必要的库:
pip install requests
2.2 配置 API 密钥
在 FRED 官网注册并获取 API 密钥,将其添加到您的项目中以进行身份验证。
💻 使用示例
基础用法
# 获取美国 GDP 数据
response = client.get_series_data(series_id='GDP')
高级用法
# 按降序获取 GDP 数据
response = client.get_series_data(series_id='GDP', sort_order='desc')
📚 详细文档
参数详解
必填参数
series_id(str): 数据系列的唯一标识符,如'GDP'。
可选参数
sort_order(str, optional): 返回数据的排序方式。可选值为'desc'(降序) 或 'asc'(升序),默认为'asc'。units(str, optional): 数据的单位表示,如'pch' 表示百分比变化。- 其他参数包括:
frequency,aggregation_method,output_type等。
🔧 技术细节
常见问题
- Q: 如何处理错误?
- 使用
client.get_error()方法获取详细的错误信息。
- 使用
- Q: 支持哪些数据频率?
- 支持的频率包括:'a'(年), 'm'(月), 'q'(季) 等。
📄 许可证
本项目遵循 MIT 许可证,具体内容请参阅 LICENSE 文件。
🔗 参考资料
⚠️ 重要提示
确保您的 API 密钥有效且已正确配置,同时遵循 FRED 的使用限制,如每分钟最多请求次数。
如需更多信息或遇到问题,请随时查阅文档或联系支持团队。
Scan to contact