GET /v3/companies/{cik}/standard
The company's standard fields by period (fields x periods), from each filing's own statements through a pinned concept map: each value with its status (ok, not_reported, ambiguous, not_applicable; a blank is never a zero), the facts behind it, the rule (candidate:<priority> or rollup), the map version and fingerprint, and flags (failed identities, scale outliers). Every filing's statement of a period is an incarnation: view latest (as of a time) or first_reported. Q4, Q3, Q2 and H2 of monetary flow fields are derived at read time only on one basis (else basis_mismatch with the first-reported value beside it). Banks, insurers, REITs, BDCs and IFRS filers: not_applicable. Pages of period ends, newest first (default: annual and quarterly periods of the 8 latest ends); each filing once in filings. Deleted (SEC-withdrawn) filings among those read are skipped and named in excluded.
API key: required. See Authentication.
Group: Financial data (XBRL)
Parameters
| Name | In | Type | Required | Default | Description |
|---|---|---|---|---|---|
cik | path | string | yes | The entity's CIK, padded or unpadded. | |
fields | query | comma-separated list of string | no | Standard fields, comma-separated (default: all core fields): revenue, cost_of_revenue, gross_profit, operating_income, pretax_income, net_income, eps_basic, eps_diluted, total_assets, total_liabilities, total_equity, cash_and_equivalents, operating_cash_flow, capital_expenditure, shares_outstanding, and the full template's measured fields (the accuracy object names each served field with its precision and coverage). | |
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. | |
periods | query | comma-separated list of string | no | annual,quarterly | Period classes, comma-separated: annual (years), quarterly (quarters, reported or derived), ytd (half years, nine months), instant (instants on no duration's end), or all. Default annual,quarterly (all with period). |
from | query | string | no | Periods ending on or after this date (YYYY-MM-DD). | |
to | query | string | no | Periods ending on or before this date (YYYY-MM-DD). | |
period | query | string | no | One period START/END, or every period ending on END (YYYY-MM-DD); not with from / to. | |
limit | query | integer | no | 8 | Period ends per page, newest first, 1..1000. |
cursor | query | string | no | next_cursor of the previous page (same filters). | |
ttm | query | string | no | false | true: also the trailing twelve months ending at each quarter end of the monetary flow fields (class ttm, Q1+Q2+Q3+Q4). One of: true, false. |
Responses
| Status | Body | Description |
|---|---|---|
200 | XbrlCompanyStandard (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 XbrlCompanyStandard object.
| Field | Type | Required | Description |
|---|---|---|---|
accuracy | object | no | Measured precision and coverage of each requested field on the named map version (static; contract 2.9). |
as_of | string | null | yes | |
cik | string | yes | |
data | array of object | yes | |
data[].values | object | no | |
excluded | Excluded | yes | |
excluded_total | integer | yes | |
fields | array of string | yes | |
filings | object | yes | By accession, each filing a value of the page comes from (or a derived value's input): form_type, filing_date, accepted_at, template, map {version, fingerprint}. |
from | string | null | yes | |
has_more | boolean | yes | |
limit | integer | yes | Period ends per page. |
map | object | yes | |
next_cursor | string | null | yes | Opaque: the next page (earlier period ends), same filters. |
period | string | null | yes | |
periods | string | yes | The period classes served, canonical (default annual,quarterly). |
rule | string | yes | |
to | string | null | yes | |
ttm | boolean | no | true: TTM rows (class ttm) at each quarter end of the monetary flow fields. |
view | string | yes | One of: latest, first_reported. |
Example request
curl -sS -H "Authorization: Bearer $SECBLAST_API_KEY" \
'https://api.secblast.com/v3/companies/320193/standard'The entity in this example is only an illustration.
Open this route in the console
More in Financial data (XBRL)
Previous: GET /v3/companies/{cik}/segments · Next: GET /v3/companies/{cik}/statements
Markdown version: /docs/reference/get-companies-cik-standard.md