MCP Fredapi

🚀 MCP-FRED API Integration Documentation

MCP-FRED is a tool that integrates the FRED (Federal Reserve Economic Data) API and the Model Context Protocol. This document aims to provide you with detailed usage instructions and technical details.

🚀 Quick Start

MCP-FRED is a powerful tool that combines the FRED API and the Model Context Protocol. It allows you to easily access economic data and perform various operations.

✨ Features

• Retrieve economic data from the FRED API.
• Support multiple data formats and filtering conditions.

📦 Installation

Prerequisites

• Python 3.6+
• requests library: Used for HTTP requests.
• json library: Used for JSON data processing.

Installation Steps

1. Clone the repository:

git clone https://github.com/your-repository/mcp-fred.git

2. Install the dependencies:

pip install requests json

💻 Usage Examples

Basic Usage

from mcp_fred import FredAPI

# Initialize the API object (replace with your API Key)
fred = FredAPI(api_key="your_api_key_here")

# Get GDP data
gdp_data = fred.get_series_data(series_id="GDP")
print(gdp_data)

# Get CPI data and specify units and frequency
cpi_data = fred.get_series_data(
    series_id="CPIAUCSL",
    units="pch",  # Represents annualized percentage change
    frequency="m"  # Represents monthly aggregation
)
print(cpi_data)

Advanced Usage

# Get GDP data and aggregate it annually
gdp_annual = fred.get_series_data(
    series_id="GDP",
    frequency="a",
    aggregation_method="sum"
)
print(gdp_annual)

# Get CPI data and specify units and frequency
cpi_monthly = fred.get_series_data(
    series_id="CPIAUCSL",
    units="pch",
    frequency="m"
)
print(cpi_monthly)

📚 Documentation

Available Parameters

🤝 Contributing

We welcome contributions from the community! Please follow these steps:

1. Fork this repository.
2. Create a feature branch: git checkout -b feature/your-feature
3. Commit your code changes: git commit -m 'Add new feature'
4. Push to the remote branch: git push origin feature/your-feature
5. Submit a Pull Request.

📄 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, please feel free to refer to the project's GitHub repository or contact the maintenance team.