GET /v3/financials/standard
One standard field across companies for a calendar frame (CY2024Q4, CY2024; CY2024Q4I for balance-sheet fields): each company's reported value (view latest as of a time, or first_reported) with its facts, rule, map pin and flags; in a quarter frame, a company without a reported quarter gets its quarter derived from its year, nine months, half or first quarter on one basis (monetary flows); ttm=true gives the trailing twelve months ending in the quarter. Companies whose answer is not ok are counted in refused, never a number. Deleted (SEC-withdrawn) filings are not read and are named in excluded.
API key: required. See Authentication.
Group: Financial data (XBRL)
Parameters
| Name | In | Type | Required | Default | Description |
|---|---|---|---|---|---|
field | query | string | yes | A standard field (as for /v3/companies/{cik}/standard). Required. | |
frame | query | string | yes | CY2024Q4 (a quarter), CY2024 (a year) or CY2024Q4I (an instant). Required. | |
ttm | query | string | no | false | true: the sum of the four consecutive quarters ending in the frame's quarter (a quarter frame, a monetary flow field). One of: true, false. |
view | query | string | no | latest | latest (default; as known at as_of) or first_reported (the earliest filing that stated the value). One of: latest, first_reported. |
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; with view=latest. | |
limit | query | integer | no | 100 | Companies with a value per page, CIK order, 1..10000. |
cursor | query | string | no | next_cursor of the previous page (opaque; same filters). |
Responses
| Status | Body | Description |
|---|---|---|
200 | XbrlStandardFrame (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). |
404 | Problem (application/problem+json) | Not found. |
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 XbrlStandardFrame object.
| Field | Type | Required | Description |
|---|---|---|---|
accuracy | object | no | Measured precision and coverage of the field on the named map version (static; contract 2.9). |
as_of | string | null | yes | |
data | array of XbrlStdValue | yes | One ok value per company, CIK order, with entity_cik, period and links.company: reported, or derived (a quarter of a quarter frame, a TTM) with formula and inputs. |
excluded | Excluded | yes | |
excluded_total | integer | yes | |
field | string | yes | |
frame | string | yes | |
has_more | boolean | yes | |
limit | integer | yes | Companies with a value per page. |
map | object | yes | |
next_cursor | string | null | yes | Opaque: the companies after this page, same filters. |
period | string | yes | |
refused | object | yes | Companies left out by status: ambiguous, not_reported, not_applicable, basis_mismatch, refused_*. |
rule | string | yes | |
ttm | boolean | yes | true: each value is the trailing twelve months ending in the frame's quarter. |
view | string | yes |
Example request
curl -sS -H "Authorization: Bearer $SECBLAST_API_KEY" \
'https://api.secblast.com/v3/financials/standard'Open this route in the console
More in Financial data (XBRL)
Previous: GET /v3/financials/series
Markdown version: /docs/reference/get-financials-standard.md