XbrlFrame
Fields
Nested fields are written with dots; [] marks the items of an array.
| Field | Type | Always present | Description |
|---|---|---|---|
as_of | string | null | yes | — |
concept | string | yes | — |
data | array of object | yes | Each item's fields follow, as data[].…. |
data[].accepted_at | string | no | — |
data[].accession | string | no | — |
data[].decimals | string | null | no | — |
data[].derived_key | string | null | no | — |
data[].dims_hash | string | null | no | — |
data[].entity_cik | string | no | — |
data[].fact_seq | integer | null | no | — |
data[].from_accession | string | no | — |
data[].period | object | no | Only with frame. The fact's own start and end dates. |
data[].source | string | no | Only with frame. reported: as filed. derived: computed from filed values. One of: reported, derived. |
data[].unit_norm | string | no | — |
data[].valid_from | string | no | — |
data[].value | NullableDecimal | no | — |
data[].value_raw | string | null | no | — |
dims | string | yes | — |
excluded | Excluded | no | Deleted 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_total | integer | no | — |
frame | string | no | Only with frame. The calendar frame, such as CY2024Q4, CY2024, or CY2024Q4I (an instant). |
has_more | boolean | yes | — |
next_cursor | string | null | yes | Send this as cursor to get the next page. Null on the last page. |
period | string | yes | The period you asked for. With frame, the calendar period's dates: YYYY-MM-DD/YYYY-MM-DD, or one date for an instant. |
refused | object | no | Only with frame. basis_mismatch counts the companies left out of the frame because their only value was a computed quarter on a different basis. |
rule | string | no | — |
rule_version | string | no | — |
unit | string | null | no | — |
Used by
- Returned by
GET /v3/financials/frames.
Markdown version: /docs/reference/schemas/xbrl-frame.md