Financial2API / README.md
Shivam4096's picture
Upload folder using huggingface_hub
558d330 verified
|
Raw History Blame Contribute Delete
2.57 kB
---
title: Financial Statement Analyzer
emoji: ๐Ÿ“ˆ
colorFrom: blue
colorTo: green
sdk: docker
pinned: false
app_port: 7860
short_description: AI financial analysis portal with free BYOK models.
---
# ๐Ÿ“ˆ Financial Statement Analyzer
Cloud-hosted AI analysis portal. Fetches financial statements for any listed company (Indian NSE/BSE or global NYSE/NASDAQ), computes ratios, generates AI narratives, and produces downloadable Excel, Word, and PowerPoint reports.
**Bring Your Own Key (BYOK)** โ€” keys stay in your browser session only, never stored.
## ๐Ÿ†“ Free AI Options (No Credit Card Needed)
| Provider | Model | Where to get key |
|---|---|---|
| **Groq** *(recommended)* | Llama 3.3 70B | [console.groq.com](https://console.groq.com/keys) โ€” instant signup |
| **Google Gemini** | Gemini 2.0 Flash | [aistudio.google.com](https://aistudio.google.com/app/apikey) โ€” free tier |
## ๐Ÿ’ณ Optional Paid AIs
| Provider | Model | Where to get key |
|---|---|---|
| Anthropic Claude | Claude Haiku | [console.anthropic.com](https://console.anthropic.com/) |
| OpenAI | GPT-4o mini | [platform.openai.com](https://platform.openai.com/api-keys) |
## How to Use
1. Open the app โ†’ paste a **free Groq or Gemini key** in the sidebar
2. Enter a company name/ticker (e.g. TCS, Reliance, AAPL)
3. Pick formats (Excel / Word / PowerPoint) and click **Analyze**
4. Download your reports instantly
## Features
- ๐Ÿ” **Smart Ticker Resolution** โ€” resolves company names via yfinance + FMP
- ๐Ÿ“Š **Financial Data** โ€” Income statement, balance sheet, cash flow, 5โ€“10 year history
- ๐Ÿงฎ **Ratio Engine** โ€” 30+ ratios + DuPont decomposition
- ๐Ÿค– **Multi-Model AI** โ€” Use multiple providers simultaneously; outputs combined with attribution
- ๐Ÿ“ฅ **Export Reports** โ€” Excel workbook, Word summary, PowerPoint pitch deck
- ๐Ÿ“œ **Audit Trail** โ€” Every run logged with user, ticker, formats, and AI models used
## Optional: Persistent Audit Logs (Supabase)
Without Supabase, logs reset on redeploy. To persist them:
| Secret | Value |
|---|---|
| `SUPABASE_URL` | Your Supabase project URL |
| `SUPABASE_KEY` | Supabase anon public key |
## Tech Stack
- **Frontend**: Streamlit with custom dark glassmorphism CSS
- **Data**: yfinance (primary), FMP API (secondary), screener.in (Indian fallback)
- **AI**: Groq/Llama (free), Gemini (free tier), Claude, ChatGPT
- **Reports**: openpyxl (Excel), python-docx (Word), python-pptx (PowerPoint)
- **Audit**: SQLite (local) or Supabase (cloud persistent)
- **Container**: Docker on Python 3.11-slim