/data/facts/dimensional-breakdown
Return 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.
Filing selection: standard (filing_id or ticker + fiscal_year + form_type + optional quarter).
Request:
filing_idintegerconditionaltickerstringconditionalform_typestringDefault 10-K.
fiscal_yearintegerconditionalquarterstringfact_idstringrequiredThe fact_id of a consolidated fact.
recursivebooleanDefault true. When false, only the immediate children are returned.
detailstringDefault "full". Full and minimal views only: "light" returns the minimal view. See Response detail.
Response:
ticker, form_type, fiscal_year, quarter, source_url_prefixFiling identity.
rootThe fact identified by fact_id: concept, value, raw_value, unit, period, dimensions, is_consolidated_total, fact_id, source_locator, plus restated and prior (as on POST /data/facts) when an amendment changed it. Slice facts have the same fields.
groupsArray of {axes, facts} entries. axes is the sorted list of XBRL axis keys shared by every fact in facts; facts is the list of slice facts. Sorted by descending fact count, ties broken lexicographically by axes.
groups[].facts[].groupsPresent only when recursive=true and that slice has slices of its own. Same shape, nested per level.
_warningsOptional.
credits_usedceil((1 + N) / 5) × 10, where N is the number of the fact's direct dimensional children.
Member granularity within a group: A single axis may carry both summary members and their detail components. Summary members overlap their detail components, so summing all facts in one group can double-count.
Credits: ceil((1 + N) / 5) × 10, where N is the number of the fact's direct dimensional children. 10 credits are charged on DATA_FACT_NOT_FOUND. A root with no breakdowns returns 200 with groups: [] and is charged 10 credits.
Errors:
| HTTP | error_code | When |
|---|---|---|
| 400 | DATA_FILING_QUARTER_REQUIRED | Ambiguous quarterly filings. |
| 404 | DATA_FILING_NOT_FOUND | Filing not found. |
| 404 | DATA_FACT_NOT_FOUND | fact_id is not present in this filing. Still charged 10 credits. |
| 403 | PLAN_TIER_INSUFFICIENT_HISTORY, PLAN_TIER_INSUFFICIENT, PLAN_TIER_INSUFFICIENT_COVERAGE | The filing is outside your plan. Not charged. |
| 402 | CREDITS_INSUFFICIENT | Not enough credits. |
| 422 | — | Validation. |