GET /v3/financials/series
One company's values of one concept, point in time. Each identity (period, unit, dimensions) with view=latest: its last incarnation known at as_of (without as_of: the latest); view=first_reported: its first; view=revisions: every incarnation in order of acceptance, numbered, with the original value and whether the value changed. Every value as filed with its filing and acceptance time. A deleted (SEC-withdrawn) filing's facts are not an incarnation: the remaining filings decide every view (an amendment withdrawn leaves the original as latest); the deleted filings are named in excluded.
API key: required. See Authentication.
Group: Financial data (XBRL)
Parameters
| Name | In | Type | Required | Default | Description |
|---|---|---|---|---|---|
cik | query | string | yes | The entity's CIK, padded or unpadded. Required. | |
concept | query | string | yes | prefix:LocalName, e.g. us-gaap:Revenues. Required. | |
period | query | string | no | YYYY-MM-DD: an instant (frames) or periods ending that day (series); YYYY-MM-DD/YYYY-MM-DD: that exact duration. | |
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. | |
view | query | string | no | latest | Which incarnation of each identity. One of: latest, first_reported, revisions. |
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 | XbrlSeries (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 XbrlSeries object.
| Field | Type | Required | Description |
|---|---|---|---|
as_of | string | null | yes | |
cik | string | yes | |
concept | string | yes | |
data | array of object | yes | |
data[].accession | string | no | |
data[].decimals | string | null | no | |
data[].dup_inconsistent | boolean | no | |
data[].fact_seq | integer | no | |
data[].filing | object | no | |
data[].identity | object | no | |
data[].identity.dims_hash | string | null | no | |
data[].identity.period | XbrlPeriod | no | |
data[].identity.unit_norm | string | no | |
data[].is_nil | boolean | no | |
data[].revision | object | no | number: 1 = first reported; of: incarnations known at as_of; original_value: the first one's; changed: the value differs from the previous incarnation's. |
data[].value | NullableDecimal | no | |
data[].value_raw | string | null | no | |
dims | string | yes | |
excluded | Excluded | no | |
excluded_total | integer | no | |
has_more | boolean | yes | |
next_cursor | null | yes | |
view | string | yes | One of: latest, first_reported, revisions. |
Example request
curl -sS -H "Authorization: Bearer $SECBLAST_API_KEY" \
'https://api.secblast.com/v3/financials/series?cik=320193'The entity in this example is only an illustration.
Open this route in the console
More in Financial data (XBRL)
Previous: GET /v3/financials/frames · Next: GET /v3/financials/standard
Markdown version: /docs/reference/get-financials-series.md