Dimensional breakdown by fact ID
get_dimensional_breakdown_by_fact_idReturn one consolidated fact plus every slice fact it breaks down into. Slice facts are grouped by the set of XBRL axes their dimensions sit on. Scope: filing_id OR ticker + fiscal_year (+ optional quarter). recursive defaults to true; set recursive=false to return only the immediate children. Pricing: ceil((1+N)/5)×10 where N = returned slice facts (the root counts as one fact in the same batch). Returns 404 (still charged 10 credits) when fact_id is not in this filing. POST /api/v1/data/facts/dimensional-breakdown; FINANCIAL_API_DOCUMENTATION.md.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| ticker | No | Company ticker, e.g. "AAPL" (US), "000100" (Korea), "1332" (Japan), "VIRI_F" (Europe), "600519_CN" (China A-share). Use with fiscal_year when filing_id is omitted. | |
| fact_id | Yes | fact_id of the consolidated fact to expand (≤ 128 chars). | |
| quarter | No | Quarter label, e.g. "Q1"–"Q4" or "FY". Only needed to disambiguate quarterly filings. | |
| filing_id | No | Numeric filing id (from list_filings). Provide either filing_id, or ticker + fiscal_year. | |
| form_type | No | Filing form. US: "10-K" / "10-Q"; foreign annual: "20-F" / "40-F"; Korean (DART): "10-K" (annual) / "10-Q" (quarterly). Defaults to "10-K". | 10-K |
| recursive | No | When true (default), expand every level of dimensional children; when false, only the immediate children. | |
| fiscal_year | No | Reporting fiscal year (1990–2100). Required together with ticker when filing_id is omitted. |