Skip to content

GET /v3/companies/{cik}/segments

The company's breakdowns by period from its own dimensional facts: business segment, product or service, geography and major customer; revenue, operating income, assets, long-lived assets, D&A, capital expenditure and (from 2024) segment expenses. Each member under the company's own label (standard members named: country:XX, srt regions) with the fact behind it; reconciling items with their sign; the consolidated value (L4, else the filing's own total) and the check (pass, fail: served and flagged, not_evaluable, not_applicable for major customers). One filing's breakdown per period, axis and kind: view latest (as of a time) or first_reported. Deleted (SEC-withdrawn) filings are not read and are named in excluded.

API key: required. See Authentication.

Group: Financial data (XBRL)

Parameters

NameInTypeRequiredDefaultDescription
cikpathstringyesThe entity's CIK, padded or unpadded.
axisquerycomma-separated list of stringnoAxes, comma-separated (default: all): segment, product, geography, customer.
kindquerycomma-separated list of stringnoValue kinds, comma-separated (default: all): revenue, operating_income, assets, long_lived_assets, depreciation_amortization, capital_expenditure, expense.
periodsquerycomma-separated list of stringnoannualPeriod classes, comma-separated: annual (the year ends: years and the instants on those dates), quarterly, ytd (half years, nine months), instant, or all. Default annual (all with period).
fromquerystringnoPeriods ending on or after this date (YYYY-MM-DD).
toquerystringnoPeriods ending on or before this date (YYYY-MM-DD).
periodquerystringnoOne period START/END, or every period ending on END (YYYY-MM-DD); not with from / to.
limitqueryintegerno1Period ends per page, newest first, 1..200 (default 1: the latest fiscal year).
cursorquerystringnonext_cursor of the previous page (same filters).
viewquerystringnolatestlatest (default; as known at as_of) or first_reported (the earliest filing that stated the breakdown). One of: latest, first_reported.
as_ofquerystringnoInclusive: YYYY-MM-DDTHH:MM:SSZ, YYYY-MM-DDTHH:MM:SS.ffffffZ or YYYY-MM-DD (the whole UTC day), against each incarnation's filing acceptance time; with view=latest.

Responses

StatusBodyDescription
200XbrlCompanySegments (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).
404Problem (application/problem+json)Not found.
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 XbrlCompanySegments object.

FieldTypeRequiredDescription
accuracyobjectnoMeasured precision and coverage of each requested kind on the latest unseen holdout (static; contract 2.10).
as_ofstring | nullyes
axesarray of stringyes
cikstringyes
dataarray of objectyes
excludedExcludedyes
excluded_totalintegeryes
fromstring | nullyes
has_morebooleanyes
kindsarray of stringyes
limitintegeryesPeriod ends per page (default 1: the latest fiscal year).
next_cursorstring | nullyesOpaque: the next page (earlier period ends), same filters.
periodstring | nullyes
periodsstringyesThe period classes served, canonical (default annual: the year ends, their years and instants).
rulestringyes
rulesobjectyes
tostring | nullyes
viewstringyesOne of: latest, first_reported.

Example request

Shell
curl -sS -H "Authorization: Bearer $SECBLAST_API_KEY" \
  'https://api.secblast.com/v3/companies/320193/segments'

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}/periods · Next: GET /v3/companies/{cik}/standard

Markdown version: /docs/reference/get-companies-cik-segments.md