Query line items by name
query_line_itemsFetch XBRL facts for a single filing by line-item name (e.g. revenue, net income, operating expenses). Identify the filing with filing_id, OR with ticker + fiscal_year (+ optional quarter). line_items: non-empty list of names; resolved through L0-L3 tiers. Each result carries _resolution_level ("L0"-"L3") showing which tier matched; L0-L3 cost 10 / 20 / 30 / 50 credits per line item, itemised in credits_by_line_item. form_type defaults to 10-K — for foreign issuers pass 20-F or 40-F; Korean (DART) filings use 10-K / 10-Q. Returns consolidated totals only — dimension slices (a single product line, segment, or region) are not served here, even when a printed statement row carries that name. By default each result lists its dimensional_breakdowns and a _warnings entry names the results that have them. To get slice values: get_dimensional_breakdown_by_fact_id (from the total's fact_id) / get_dimensional_breakdown_by_line_item, or get_filing_statement to read the full statement table. light_weight_mode=true (bool, default false) omits results[*].dimensional_breakdowns — saves context when you already know exactly what you need. Charged identically. A result may appear at multiple positions in the source filing; fact_ids lists every position as {fact_id, source_locator} pairs. If unsure of a line item name or fact_id, use list_filing_statements / get_filing_statement to read the whole statement. Multi-concept matches come pre-ordered (Akkru smart ranking); the order is a recommendation only — review all returned results and judge which one you need. To fetch by fact_id use get_filing_facts. POST /api/v1/data/line-items; see 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_items | Yes | Line-item names to fetch, e.g. ["revenue", "net income"] (1–50; each ≤ 256 chars). | |
| fiscal_year | No | Reporting fiscal year (1990–2100). Required together with ticker when filing_id is omitted. | |
| 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. |