Grade My Investments Report Documentation
Comprehensive documentation of all report types, file formats, and data structures generated by the Grade My Investments platform.
flowchart LR
REG[(ReportDocumentation<br/>Registry)]:::sec
subgraph PERSYM[Per-Symbol Reports]
PS[symbol-report-SYMBOL<br/>12 worksheets<br/>xlsx - html - json]:::app
HRI[How-to-Read<br/>index sheet]:::app
end
subgraph GLOBAL[Global Statistics]
GC[globstats-combined<br/>9 tabs]:::data
GT[globstats-target<br/>7 tabs]:::data
GL[globstats-ListName<br/>9 tabs per list]:::data
end
subgraph MLCAT[ML Forecasts]
MF[ml-forecasts<br/>6 tabs]:::svc
MJ[ml-forecast-data<br/>json]:::ext
end
subgraph RAWCAT[Raw Data Exports]
RJ[SYMBOL-raw-data<br/>json - 13 endpoints]:::ext
end
REG --> PS
REG --> HRI
REG --> GC
PS --> GLOBAL
MF --> MLCAT
classDef app fill:#1f2630,stroke:#C0894E,color:#F3EFE8;
classDef svc fill:#241c14,stroke:#E2B583,color:#F3EFE8;
classDef data fill:#22201a,stroke:#C0894E,color:#EBD3AE;
classDef ext fill:#1b1f27,stroke:#5A616B,color:#C4C0B8;
classDef sec fill:#1d2733,stroke:#5cc8e0,color:#eafaff;
Report Categories Overview
Grade My Investments Report Ecosystem
Grade My Investments generates four categories of output, each serving different analysis needs. All reports are generated in Excel, HTML, and JSON formats for maximum compatibility and usability.
Self-Documenting Reports
Every per-symbol Excel workbook ships with a "How to Read" index sheet that explains each tab and its key columns. Column-level tooltips inside each sheet are driven by a shared ReportDocumentationRegistry, so the in-app MetricHelpIcon tooltips, the Excel column tooltips, and this documentation site all draw from the same source. If a metric definition changes in the registry, every surface picks it up.
Per-Symbol Reports
Excel + HTML + JSON per stock, with 4 forward-projection sheets
7+ sheets / symbolGlobal Statistics
Combined, target, and per-list analysis
Excel + HTMLML Forecasts
ML.NET predictive analytics
Excel + HTML + JSONRaw Data Exports
JSON per symbol + ML data
JSON filesPortfolio-Level Reports
Global Statistics Reports
Grade My Investments generates comprehensive portfolio-level reports that aggregate and analyze multiple securities simultaneously.
Purpose & Scope
The master portfolio report that combines analysis from all symbols across all selected symbol lists, providing a comprehensive view of the entire investment portfolio with trend analysis and growth rates.
Key Features
- Combined Analysis: Portfolio percentages, total value, and growth percentages across all metrics
- Trend Analysis: Revenue, equity, net income, cash flow, and debt trend tracking
- Technical Analysis: All-time growth with charts per symbol
- Projected Analysis: Growth projections using position data and sentiment scores
- Comparative Analysis: Side-by-side comparison of all symbols in the job
Excel Worksheets (9 tabs)
| Worksheet | Content | Key Metrics |
|---|---|---|
CombinedAnalysis |
Master overview | Symbol, Portfolio %, TotalValue, Revenue%, Technical%, Equity%, Net Income%, CashFlow%, Debt% |
RevenueAnalysis |
Revenue trends | Symbol, Revenue Growth%, YearsCount, Avg Per Year, Trend Increasing |
TechnicalAnalysis |
Price action | Symbol, All Time Growth%, Last 12 Months%, Avg Per Day/Year/Month (includes growth chart) |
EquityAnalysis |
Equity trends | Symbol, Equity Growth%, Years Count, Avg Per Year, Trend Increasing |
NetIncomeAnalysis |
Net income trends | Symbol, Net Income Growth%, Years Count, Avg Per Year, Trend Increasing |
CashFlowAnalysis |
Cash flow trends | Symbol, Cash Flow Growth%, Years Count, Avg Per Year, Trend Increasing |
DebtAnalysis |
Debt trends | Symbol, Debt Growth%, Years Count, Avg Per Year, Trend Increasing |
MarketCapAnalysis |
Market cap comparison | Symbol, Market Cap (includes market cap chart) |
ProjectedAnalysis |
Growth projections | Symbol, Position Value, Current Price, Sentiment Score, 3m/6m/12m/Year End Projections |
Also generated as an HTML report (globstats-combined.html).
Purpose & Scope
A focused report providing comparative analysis across all symbols in the job, with the same trend analysis structure as the combined report but without the combined analysis overview tab.
Target Analysis Features
- Revenue Trends: Growth percentage and year-over-year averages per symbol
- Technical Analysis: All-time and 12-month growth rates with charts
- Equity Analysis: Equity growth trends and direction
- Cash Flow & Debt: Cash flow and debt trajectory analysis
- Market Cap: Market capitalization comparison with chart
Excel Worksheets (7 tabs)
RevenueAnalysis- Revenue growth trends per symbolTechnicalAnalysis- Price performance with growth chartEquityAnalysis- Equity growth trendsNetIncomeAnalysis- Net income growth trendsCashFlowAnalysis- Cash flow growth trendsDebtAnalysis- Debt growth trendsMarketCapAnalysis- Market capitalization comparison
Also generated as an HTML report (globstats-target.html).
Purpose & Scope
One report is generated per symbol list selected in the job, allowing users to compare only the symbols within a specific list. Uses the same structure as the Global Stats Combined report.
Key Features
- Per-List Comparison: Compare symbols within a specific portfolio or strategy grouping
- Same 9-Tab Structure: CombinedAnalysis through ProjectedAnalysis, identical to the combined report
- Custom Lists: Users create symbol lists for different portfolios, sectors, or strategies
- Projected Analysis: Uses position data for personalized growth projections
Also generated as an HTML report (globstats-{ListName}.html).
Purpose & Scope
Machine learning predictive report powered by Microsoft ML.NET, providing time-series forecasts and anomaly detection across all symbols in the job.
ML Analysis Features
- Revenue Forecasting: 4-period revenue predictions with confidence bounds
- Debt Forecasting: Projected debt trajectory with upper/lower bounds
- Cash Flow Forecasting: Future cash flow estimates with confidence intervals
- Equity Forecasting: Equity growth predictions
- Health Scores: Composite financial health scoring with anomaly detection
- Sentiment Forecasting: Price-action-based sentiment projections
Excel Worksheets (6 tabs)
Revenue Forecast- Forecasted values with lower/upper confidence boundsDebt Forecast- Debt trajectory predictionsCashFlow Forecast- Cash flow predictionsEquity Forecast- Equity growth predictionsHealth Score- Health scores with anomaly flags and magnitudesSentiment Forecast- Sentiment-based predictions
Also generated as an HTML report and ml_forecast_data.json for programmatic access.
Per-Symbol Reports
Comprehensive Single-Company Analysis
Every stock symbol in a report job gets three files: an Excel report, an interactive HTML report, and a raw JSON data export. The reports are stored in batch subfolders within each symbol list's Reports folder.
Standard Excel Report Structure (12 worksheets per symbol)
Every individual stock report (symbol-report-{SYMBOL}.xlsx) follows a consistent multi-worksheet structure:
| Worksheet | Analysis Type | Key Data Points |
|---|---|---|
CompanyInfo |
Company snapshot | Symbol, Company Name, Industry, Sector, Exchange, Country, Website, Description, CEO, Employees |
HistoricalPrices |
Price history | Date, Open, High, Low, Close, Adj Close, Volume |
IncomeYearly |
Annual income statements | Revenue, Cost of Revenue, Gross Profit, Operating Income, Net Income, EPS, EBITDA (with chart) |
IncomeQuarterly |
Quarterly income statements | Same as IncomeYearly with quarterly chart |
BalanceYearly |
Annual balance sheets | Total Liabilities, Total Equity, Cash, Current Assets, Current Liabilities, Long Term Debt, Total Debt |
BalanceQuarterly |
Quarterly balance sheets | Same as BalanceYearly |
CashFlowYearly |
Annual cash flow | Net Income, Operating/Investing/Financing Cash Flow, Free Cash Flow, CapEx, Net Change in Cash (with chart) |
CashFlowQuarterly |
Quarterly cash flow | Same as CashFlowYearly with quarterly chart |
KeyMetrics |
Financial ratios | Revenue Per Share, Net Income Per Share, Book Value Per Share, PE Ratio, Debt to Equity, ROE, ROA |
AnalystRecommendations |
Analyst consensus | Buy, Hold, Sell, Strong Buy, Strong Sell ratings |
PriceTargets |
Analyst price targets | Published Date, Analyst Name, Analyst Company, Price Target, Price When Posted |
UpcomingEvents |
Earnings calendar | Date, EPS, EPS Estimated, Revenue, Revenue Estimated, Fiscal Date Ending |
symbol-report-{SYMBOL}.html) and a raw JSON export ({SYMBOL}_raw_data.json), stored alongside the Excel file.
Raw Data Export Files
Machine-Readable JSON Data
Each individual stock analysis includes a corresponding JSON file ({SYMBOL}_raw_data.json) containing the full serialized SymbolData object with all FMP API responses. The ML Forecasts report also exports an ml_forecast_data.json file.
Per-Symbol JSON Structure
The raw data JSON contains the complete data fetched from all 13 FMP endpoints:
{
"HistoricalPrices": [ { "Date": "...", "Open": ..., "High": ..., "Low": ..., "Close": ..., "Volume": ... } ],
"HistoricalDataDaily": [ ... ],
"CompanyInformation": [ { "Symbol": "AAPL", "CompanyName": "Apple Inc.", "Industry": "...", "Sector": "...", ... } ],
"BalanceSheetsYearly": [ { "Date": "...", "TotalLiabilities": ..., "TotalEquity": ..., "TotalDebt": ..., ... } ],
"BalanceSheetsQuarterly": [ ... ],
"CashFlowYearly": [ { "Date": "...", "NetIncome": ..., "OperatingCashFlow": ..., "FreeCashFlow": ..., ... } ],
"CashFlowQuarterly": [ ... ],
"IncomeStatementYearly": [ { "Date": "...", "Revenue": ..., "NetIncome": ..., "Eps": ..., "Ebitda": ..., ... } ],
"IncomeStatementQuarterly": [ ... ],
"KeyMetrics": [ { "Date": "...", "RevenuePerShare": ..., "PeRatio": ..., "DebtToEquity": ..., ... } ],
"AnalystRecommendations": [ { "Date": "...", "AnalystRatingsBuy": ..., "AnalystRatingsHold": ..., ... } ],
"PriceTargets": [ { "PublishedDate": "...", "AnalystName": "...", "PriceTarget": ..., ... } ],
"UpcomingEvents": [ { "Date": "...", "Eps": ..., "EpsEstimated": ..., "Revenue": ..., ... } ]
}JSON Data Usage Scenarios
Development Integration
- Custom dashboard development
- API integration with other systems
- Automated investment algorithm inputs
- Database import and storage
Analytics & Research
- Upload to Claude AI for analysis
- Python/R statistical analysis
- Machine learning model training
- Custom visualization tools
Report Statistics
- Worksheets per Stock: 12 tabs
- Raw Data: 1 JSON per symbol
- HTML Reports: per symbol + global
- Global Stats Tabs: 9 tabs (combined)
- ML Forecast Tabs: 6 tabs
- FMP Endpoints: 13 per symbol
File Formats
Excel (.xlsx)
- Multiple worksheets with formatted data
- Charts embedded in analysis tabs
- Generated with EPPlus library
- Professional business presentation
HTML (.html)
- Interactive tabbed report viewer
- Viewable inline in browser and MAUI app
- No software required to open
- Generated for every report type
JSON (.json)
- Full FMP API response data per symbol
- ML forecast data for predictions
- Easy parsing and integration
- Upload to Claude AI for analysis
Data Freshness
- On-Demand: Reports generated with live FMP data
- Historical Prices: Up to 5 years of daily data
- Financials: 4 years yearly, 12 quarters
- ML Forecasts: 4-period forward projections