Compare facts across filings
compare_factsCompare specific XBRL fact_ids across multiple filings. Each row supplies its own fact_ids list, so different filings can compare different ids (e.g. when concept tagging changed between years). filings: array of rows — each uses filing_id OR ticker + form_type + fiscal_year (+ optional quarter), plus a required non-empty fact_ids list. Pricing: ceil(total_deduped_fact_ids / 5) × 10 across the whole request. light_weight_mode=true drops dimensional_breakdowns from all results — saves context when you already know exactly what you need. Each results[i] may include a caveat field; per-row caveats are auto-aggregated and deduplicated into top-level _warnings — read either, and surface to the user when present. Pro+ responses add a per-result classification block (canonical sector(s) + source); omitted for sub-Pro. POST /api/v1/data/compare/facts; FINANCIAL_API_DOCUMENTATION.md.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| filings | Yes | Filings to compare (1–25; ≤ 2500 fact_ids total). Each row: {"filing_id": …, "fact_ids": [...]} or {"ticker": …, "fiscal_year": …, "form_type": …, "fact_ids": [...]}. | |
| light_weight_mode | No | When true, return a leaner payload (drops the most verbose nested fields). Charged the same. Saves context when you already know exactly what you need. |