GET /v3/companies/{cik}/periods
One concept by fiscal period. Q4 = FY - 9M only when both are on the same basis at as_of; otherwise status basis_mismatch, no number, and the first-reported Q4 beside it (first_reported). The same rule for H2 = FY - H1 (semiannual filers), Q3 = 9M - H1 and Q2 = H1 - Q1. Per-share values, share counts and instants are never derived. Reported quarters, halves, nine months and years are served as filed (the incarnation known at as_of); derived values carry formula, inputs (accession, fact, concept, period, filed value) and rule version; TTM is the sum of four consecutive quarters and inherits a quarter's refusal. Fiscal labels come from the series' own dates. Deleted (SEC-withdrawn) filings are not read (an original stands again when its amendment is withdrawn; a derived value that used one is not served until derive:xbrl_periods has rebuilt it) and are 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. | |
concept | query | string | yes | prefix:LocalName, e.g. us-gaap:Revenues. Required. | |
unit | query | string | no | Only this unit as stored: iso4217:USD, shares, iso4217:USD/shares, ... | |
dims | query | string | no | none (default: no dimensions) 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. |
Responses
| Status | Body | Description |
|---|---|---|
200 | XbrlCompanyPeriods (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 XbrlCompanyPeriods object.
| Field | Type | Required | Description |
|---|---|---|---|
as_of | string | null | yes | |
cik | string | yes | |
concept | string | yes | |
data | array of object | yes | |
derivation | object | yes | additivity of the concept's unit (flow, per_share, share_count, ratio, stock); derived false with the refusal status for anything but a flow. |
dims | string | yes | |
excluded | Excluded | yes | |
excluded_total | integer | yes | |
has_more | boolean | yes | |
next_cursor | null | yes | |
rule | string | yes | |
rule_version | string | yes |
Example request
curl -sS -H "Authorization: Bearer $SECBLAST_API_KEY" \
'https://api.secblast.com/v3/companies/320193/periods'The entity in this example is only an illustration.
Open this route in the console
More in Financial data (XBRL)
Next: GET /v3/companies/{cik}/segments
Markdown version: /docs/reference/get-companies-cik-periods.md