Skip to content

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

NameInTypeRequiredDefaultDescription
cikpathstringyesThe entity's CIK, padded or unpadded.
conceptquerystringyesprefix:LocalName, e.g. us-gaap:Revenues. Required.
unitquerystringnoOnly this unit as stored: iso4217:USD, shares, iso4217:USD/shares, ...
dimsquerystringnonone (default: no dimensions) or a dims_hash (32 hex digits) for one exact dimension set.
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
200XbrlCompanyPeriods (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 XbrlCompanyPeriods object.

FieldTypeRequiredDescription
as_ofstring | nullyes
cikstringyes
conceptstringyes
dataarray of objectyes
derivationobjectyesadditivity of the concept's unit (flow, per_share, share_count, ratio, stock); derived false with the refusal status for anything but a flow.
dimsstringyes
excludedExcludedyes
excluded_totalintegeryes
has_morebooleanyes
next_cursornullyes
rulestringyes
rule_versionstringyes

Example request

Shell
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