Skip to content

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

NameInTypeRequiredDefaultDescription
cikquerystringyesThe entity's CIK, padded or unpadded. Required.
conceptquerystringyesprefix:LocalName, e.g. us-gaap:Revenues. Required.
periodquerystringnoYYYY-MM-DD: an instant (frames) or periods ending that day (series); YYYY-MM-DD/YYYY-MM-DD: that exact duration.
unitquerystringnoOnly this unit as stored: iso4217:USD, shares, iso4217:USD/shares, ...
dimsquerystringnonone (default: no dimensions), any, or a dims_hash (32 hex digits) for one exact dimension set.
viewquerystringnolatestWhich incarnation of each identity. One of: latest, first_reported, revisions.
as_ofquerystringnoInclusive: 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

StatusBodyDescription
200XbrlSeries (application/json)OK
400Problem (application/problem+json)Invalid or unknown parameter.
401Problem (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).
503Problem (application/problem+json)Database unavailable; retry after the Retry-After delay.
defaultProblem (application/problem+json)Any other error (405, 500, 504).

Response body

A 200 carries a XbrlSeries object.

FieldTypeRequiredDescription
as_ofstring | nullyes
cikstringyes
conceptstringyes
dataarray of objectyes
data[].accessionstringno
data[].decimalsstring | nullno
data[].dup_inconsistentbooleanno
data[].fact_seqintegerno
data[].filingobjectno
data[].identityobjectno
data[].identity.dims_hashstring | nullno
data[].identity.periodXbrlPeriodno
data[].identity.unit_normstringno
data[].is_nilbooleanno
data[].revisionobjectnonumber: 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[].valueNullableDecimalno
data[].value_rawstring | nullno
dimsstringyes
excludedExcludedno
excluded_totalintegerno
has_morebooleanyes
next_cursornullyes
viewstringyesOne of: latest, first_reported, revisions.

Example request

Shell
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