FRED (Federal Reserve Economic Data)

🚀 MCP - FRED 使用說明文檔

本工具藉助模型上下文協議（MCP）連接到 FRED API，能讓您輕鬆獲取經濟數據。以下將為您詳細介紹它的安裝、配置及使用方法。

🚀 快速開始

MCP - FRED 提供了簡潔接口來訪問 FRED 的數據，使用步驟如下：

1. 初始化客戶端：

from mcp_fred import FredClient

client = FredClient(api_key='your_api_key_here')

2. 發送請求：

response = client.get_series_data(series_id='GDP', sort_order='desc')

3. 處理響應：

print(response.data)

✨ 主要特性

• 藉助模型上下文協議（MCP）連接 FRED API，方便獲取經濟數據。
• 提供簡潔接口，便於用戶操作。

📦 安裝指南

2.1 安裝依賴

確保您已安裝必要的庫：

pip install requests

2.2 配置 API 密鑰

在 FRED 官網註冊並獲取 API 密鑰，將其添加到您的項目中以進行身份驗證。

💻 使用示例

基礎用法

# 初始化客戶端
from mcp_fred import FredClient

client = FredClient(api_key='your_api_key_here')
# 發送請求獲取數據
response = client.get_series_data(series_id='GDP')
# 處理響應
print(response.data)

高級用法

# 按降序獲取 GDP 數據
response = client.get_series_data(series_id='GDP', sort_order='desc')
print(response.data)

📚 詳細文檔

參數詳解

必填參數

• series_id (str): 數據系列的唯一標識符，如'GDP'。

可選參數

• sort_order (str, optional): 返回數據的排序方式。可選值為'desc'(降序) 或 'asc'(升序)，默認為'asc'。
• units (str, optional): 數據的單位表示，如'pch' 表示百分比變化。
• 其他參數包括：frequency, aggregation_method, output_type 等。

🔧 技術細節

MCP - FRED 通過模型上下文協議（MCP）與 FRED API 建立連接，利用 Python 的 requests 庫發送 HTTP 請求獲取經濟數據。用戶通過初始化 FredClient 並傳入 API 密鑰進行身份驗證，然後調用 get_series_data 方法發送請求，根據傳入的參數獲取不同的數據系列和排序方式等。

📄 許可證

本項目遵循 MIT 許可證，具體內容請參閱 LICENSE 文件。

參考資料

• FRED API 文檔
• 模型上下文協議

⚠️ 重要提示

• 確保您的 API 密鑰有效且已正確配置。
• 遵循 FRED 的使用限制，如每分鐘最多請求次數。

💡 使用建議

• 若遇到錯誤，可使用client.get_error()方法獲取詳細的錯誤信息。
• 支持的數據頻率包括：'a'(年), 'm'(月), 'q'(季) 等。

如需更多信息或遇到問題，請隨時查閱文檔或聯繫支持團隊。