AIEquityAnalyst 📊🤖

Supercharge your investment strategy with AIEquityAnalyst! Powered by a multi-agent framework, this tool performs comprehensive fundamental analysis of companies and generates multi-modal reports—combining financial data, visual charts, and key insights—to help you make informed investment decisions. Whether you're analyzing stocks, trends, or financial health, AIEquityAnalyst compiles everything into a clear, actionable format.

🌟 Key Features

• Multi-Agent Analysis

  • Collaborative AI agents analyze financial data and market trends
  • Real-time processing of market information
  • Comprehensive fundamental analysis

• Intelligent Report Generation

  • Multi-modal reports combining text, data, and visuals
  • PDF report generation with professional formatting
  • Custom charts and financial visualizations

• Financial Data Integration

  • Integration with major financial data providers
  • Real-time market data processing
  • Historical data analysis capabilities

• Advanced Analytics

  • Fundamental analysis of company financials
  • Technical analysis of market trends
  • Predictive analytics for market insights

With AIEquityAnalyst, gain the edge you need in the world of investments, all backed by powerful, multi-modal insights! 💡📈

🚀 Installation

1. Clone the Repository

   git clone https://github.com/akhil-bot/AIEquityAnalyst.git
   cd AIEquityAnalyst

2. Set Up Python Environment

   • Requires Python 3.8 or higher

   python -m venv venv
   source venv/bin/activate  # On Windows: venv\Scripts\activate
   pip install -r requirements.txt

3. Configure API Keys

   • Create a config_api_keys file in the root directory
   • Add your API keys for:
     • OpenAI
     • Finnhub
     • SEC API
     • Other financial data providers

💡 Usage

1. Basic Analysis

   python main.py --company "Company Name" --year "YYYY"

   For example:

   python main.py --company "NVIDIA" --year "2023"

2. Output Location

   • All generated reports are automatically saved in the ./report directory
   • Reports are named in the format: {company_name}_annual_report.pdf
   • The tool creates visualizations and data files in the same directory

3. Generate Reports Each report includes:

   • Financial analysis
   • Market trends
   • Visual charts
   • Key insights

📋 Sample Output

Here's an example of a generated report for NVIDIA Corporation:

The report includes:

• Executive Summary
• Financial Analysis
• Market Position
• Risk Assessment
• Visual Analytics
• Future Outlook

Each report is automatically generated and saved in the ./report directory, providing comprehensive insights tailored to the specific company and year requested.

💡 Note: The actual report contains multiple pages of detailed analysis, charts, and insights. This is just the first page preview.

🏗️ Project Structure

AIEquityAnalyst/
├── finrobot/                 # Core functionality
│   ├── agents/              # AI agents implementation
│   ├── data_source/         # Data integration modules
│   ├── functional/          # Core business logic
│   ├── utils.py            # Utility functions
│   └── toolkits.py         # Analysis tools
├── report/                  # Generated reports
├── configs/                 # Configuration files
├── main.py                 # Main application entry
└── requirements.txt        # Project dependencies

🔧 Configuration

1. API Configuration

   The project requires several API keys to function properly. We provide template files to help you set up your configuration:

   a) Create OAI_CONFIG_LIST file

   • Copy the template below and save it as OAI_CONFIG_LIST in the root directory:

   [
       {
           "model": "gpt-4o",
           "api_key": "your-openai-api-key-here"
       },
       {
           "model": "gpt-3.5-turbo",
           "api_key": "your-openai-api-key-here"
       }
   ]

   b) Create config_api_keys file

   • Copy the template below and save it as config_api_keys in the root directory:

   {
       "OPENAI_API_KEY": "your-openai-api-key-here",
       "FINNHUB_API_KEY": "your-finnhub-api-key-here",
       "SEC_API_KEY": "your-sec-api-key-here"
   }

   c) Obtain API Keys

   • OpenAI API key: Sign up at https://platform.openai.com
   • Finnhub API key: Register at https://finnhub.io
   • SEC API key: Get from https://sec-api.io
   • Alpha Vantage API key: Register at https://www.alphavantage.co
   • Yahoo Finance API key: Available through RapidAPI

   d) Security Notes

   • Never commit your API keys to version control
   • Add both configuration files to your .gitignore
   • Keep your API keys secure and rotate them periodically

2. Report Settings

   • Modify report templates in the functional directory
   • Customize analysis parameters in config files

🔮 Future Enhancements

1. Enhanced Analytics

   • Integration with more financial data sources
   • Advanced machine learning models for prediction
   • Real-time market sentiment analysis

2. User Interface

   • Web-based dashboard
   • Interactive report customization
   • Real-time analysis updates

3. Additional Features

   • Portfolio optimization
   • Risk analysis tools
   • Automated trading strategies

📝 Dependencies

Key dependencies include:

• pyautogen: Multi-agent framework
• finnhub-python: Financial data API
• yfinance: Yahoo Finance data
• reportlab: PDF generation
• pandas & numpy: Data processing
• matplotlib: Data visualization

🤝 Contributing

Contributions are welcome! Please feel free to submit pull requests, create issues, or suggest improvements.

📄 License

This project is licensed under the MIT License - see the LICENSE file for details.

⚠️ Disclaimer

This tool is for informational purposes only. Always conduct your own research and consult with financial advisors before making investment decisions.

---

For more information or support, please open an issue on the GitHub repository.