GET /v3/financials/frames
One concept and period across companies: each company's latest incarnation known at as_of (one per CIK, unit and dimension set), from one index range per filing year, the period being the filed dates. With frame instead of period, a CALENDAR frame (layer L3): CY2024Q4 (durations of 91 +/- 30 days whose midpoint is in the quarter), CY2024 (365 +/- 30 days, midpoint in the year) or CY2024Q4I (instants nearest the quarter's end), one value per company as known at as_of -- reported before derived (a derived Q4 = FY - 9M); a derived quarter refused as basis_mismatch is never a number in the frame, only counted in refused.basis_mismatch. Frames hold facts without dimensions only. Deleted (SEC-withdrawn) filings are left out (each company's latest remaining incarnation) and named in excluded.
API key: required. See Authentication.
Group: Financial data (XBRL)
Parameters
| Name | In | Type | Required | Default | Description |
|---|---|---|---|---|---|
concept | query | string | yes | prefix:LocalName, e.g. us-gaap:Assets. Required. | |
period | query | string | no | YYYY-MM-DD: the instant; YYYY-MM-DD/YYYY-MM-DD: the duration (the filed dates). Required unless frame is given. | |
frame | query | string | no | A calendar frame instead of period: CY2024Q4, CY2024 or CY2024Q4I. | |
unit | query | string | no | Only this unit as stored: iso4217:USD, shares, iso4217:USD/shares, ... | |
dims | query | string | no | none (default: no dimensions), any, or a dims_hash (32 hex digits) for one exact dimension set. | |
as_of | query | string | no | Inclusive: YYYY-MM-DDTHH:MM:SSZ (UTC, through the end of that second), YYYY-MM-DDTHH:MM:SS.ffffffZ (exact) or YYYY-MM-DD (the whole UTC day). Against each incarnation's filing acceptance time. | |
limit | query | integer | no | 500 | Page size, 1..50000: rows in CIK, unit and dimension order. |
cursor | query | string | no | Opaque cursor from a previous page's next_cursor; bound to the other parameters. |
Responses
| Status | Body | Description |
|---|---|---|
200 | XbrlFrame (application/json) | OK |
400 | Problem (application/problem+json) | Invalid or unknown parameter. |
401 | Problem (application/problem+json) | Missing, invalid or inactive API key (code unauthorized), or a refused access token (code invalid_token: malformed, unknown key, bad signature, expired, wrong issuer or audience, revoked grant). WWW-Authenticate names the protected-resource metadata (RFC 9728). |
503 | Problem (application/problem+json) | Database unavailable; retry after the Retry-After delay. |
default | Problem (application/problem+json) | Any other error (405, 500, 504). |
Response body
A 200 carries a XbrlFrame object.
| Field | Type | Required | Description |
|---|---|---|---|
as_of | string | null | yes | |
concept | string | yes | |
data | array of object | yes | |
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 | With frame only: the fact's own start and end. |
data[].source | string | no | With frame only. 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 | |
excluded_total | integer | no | |
frame | string | no | With frame only: CY2024Q4, CY2024 or CY2024Q4I. |
has_more | boolean | yes | |
next_cursor | string | null | yes | Pass as cursor for the next page; null on the last. |
period | string | yes | As requested; with frame, the calendar period's dates (YYYY-MM-DD/YYYY-MM-DD, or the instant). |
refused | object | no | With frame only: basis_mismatch, the number of companies whose only value for the frame is a derived quarter refused as basis_mismatch (no number in the frame). |
rule | string | no | |
rule_version | string | no | |
unit | string | null | no |
Example request
curl -sS -H "Authorization: Bearer $SECBLAST_API_KEY" \
'https://api.secblast.com/v3/financials/frames'Open this route in the console
More in Financial data (XBRL)
Previous: GET /v3/financials/facts · Next: GET /v3/financials/series
Markdown version: /docs/reference/get-financials-frames.md