Dimensional breakdown by line item
get_dimensional_breakdown_by_line_itemResolve a line-item name (e.g. 'revenue', 'net income') and return the dimensional breakdown of every consolidated fact that matches. Each match is one root with axis-grouped slice facts. Multi-concept matches come pre-ordered (Akkru smart ranking); the order is a recommendation only — review all matches and judge which one you need. duplicate_root_fact_ids lists other fact_id values that resolved to the same logical fact as root. Scope: filing_id OR ticker + fiscal_year (+ optional quarter). recursive defaults to true. Pricing: tier credit (10–50 by match tier) + ceil(N/5)×10 for returned slice facts across roots; partial billing applies. POST /api/v1/data/line-items/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. | |
| 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 |
| line_item | Yes | Line-item name to expand, e.g. "revenue" (≤ 256 chars). | |
| 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. |