Skip to content

XbrlFrame

Fields

Nested fields are written with dots; [] marks the items of an array.

FieldTypeAlways presentDescription
as_ofstring | nullyes—
conceptstringyes—
dataarray of objectyesEach item's fields follow, as data[].….
data[].accepted_atstringno—
data[].accessionstringno—
data[].decimalsstring | nullno—
data[].derived_keystring | nullno—
data[].dims_hashstring | nullno—
data[].entity_cikstringno—
data[].fact_seqinteger | nullno—
data[].from_accessionstringno—
data[].periodobjectnoOnly with frame. The fact's own start and end dates.
data[].sourcestringnoOnly with frame. reported: as filed. derived: computed from filed values. One of: reported, derived.
data[].unit_normstringno—
data[].valid_fromstringno—
data[].valueNullableDecimalno—
data[].value_rawstring | nullno—
dimsstringyes—
excludedExcludednoDeleted filings left out of this answer, by accession number, at most 20. The SEC deletes a filing when the filer withdraws it. excluded_total counts them all. Empty when none were left out.
excluded_totalintegerno—
framestringnoOnly with frame. The calendar frame, such as CY2024Q4, CY2024, or CY2024Q4I (an instant).
has_morebooleanyes—
next_cursorstring | nullyesSend this as cursor to get the next page. Null on the last page.
periodstringyesThe period you asked for. With frame, the calendar period's dates: YYYY-MM-DD/YYYY-MM-DD, or one date for an instant.
refusedobjectnoOnly with frame. basis_mismatch counts the companies left out of the frame because their only value was a computed quarter on a different basis.
rulestringno—
rule_versionstringno—
unitstring | nullno—

Used by

Markdown version: /docs/reference/schemas/xbrl-frame.md