FRED (Federal Reserve Economic Data)

🚀 MCP-FRED Usage Documentation

This tool is designed to connect to the FRED API through the Model Context Protocol (MCP), enabling users to easily access economic data. This documentation provides detailed guidance on installation, configuration, and usage.

🚀 Quick Start

MCP-FRED offers a straightforward interface to access FRED data. Follow these steps to get started:

1. Initialize the client:

from mcp_fred import FredClient

client = FredClient(api_key='your_api_key_here')

2. Send a request:

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

3. Process the response:

print(response.data)

✨ Features

• Connect to the FRED API via the Model Context Protocol (MCP).
• Provide a simple and intuitive interface for accessing economic data.
• Support various parameters for data retrieval and customization.

📦 Installation

2.1 Install Dependencies

Ensure you have installed the necessary libraries:

pip install requests

2.2 Configure API Key

Register on the FRED official website to obtain an API key. Add it to your project for authentication.

💻 Usage Examples

Basic Usage

# Get US GDP data
response = client.get_series_data(series_id='GDP')

Advanced Usage

# Get GDP data in descending order
response = client.get_series_data(series_id='GDP', sort_order='desc')

📚 Documentation

Required Parameters

• series_id (str): The unique identifier for the data series, e.g., 'GDP'.

Optional Parameters

• sort_order (str, optional): The sorting order of the returned data. Available values are 'desc' (descending) or 'asc' (ascending), with 'asc' as the default.
• units (str, optional): The unit representation of the data, e.g., 'pch' for percentage change.
• Other parameters include: frequency, aggregation_method, output_type, etc.

⚠️ Important Notes

• Ensure your API key is valid and correctly configured.
• Comply with FRED's usage limits, such as the maximum number of requests per minute.

❓ Frequently Asked Questions

1. Q: How to handle errors?

   • Use the client.get_error() method to obtain detailed error information.

2. Q: What data frequencies are supported?

   • Supported frequencies include: 'a' (annual), 'm' (monthly), 'q' (quarterly), etc.

📄 License

This project is licensed under the MIT License. Please refer to the LICENSE file for details.

📚 References

• FRED API Documentation
• Model Context Protocol

For more information or if you encounter any issues, please refer to the documentation or contact the support team.