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
| Name | In | Type | Required | Default | Description |
|---|---|---|---|---|---|
cik | path | string | yes | The entity's CIK, padded or unpadded. | |
axis | query | comma-separated list of string | no | Axes, comma-separated (default: all): segment, product, geography, customer. | |
kind | query | comma-separated list of string | no | Value kinds, comma-separated (default: all): revenue, operating_income, assets, long_lived_assets, depreciation_amortization, capital_expenditure, expense. | |
periods | query | comma-separated list of string | no | annual | Period 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). |
from | query | string | no | Periods ending on or after this date (YYYY-MM-DD). | |
to | query | string | no | Periods ending on or before this date (YYYY-MM-DD). | |
period | query | string | no | One period START/END, or every period ending on END (YYYY-MM-DD); not with from / to. | |
limit | query | integer | no | 1 | Period ends per page, newest first, 1..200 (default 1: the latest fiscal year). |
cursor | query | string | no | next_cursor of the previous page (same filters). | |
view | query | string | no | latest | latest (default; as known at as_of) or first_reported (the earliest filing that stated the breakdown). One of: latest, first_reported. |
as_of | query | string | no | Inclusive: 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
| Status | Body | Description |
|---|---|---|
200 | XbrlCompanySegments (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). |
404 | Problem (application/problem+json) | Not found. |
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 XbrlCompanySegments object.
| Field | Type | Required | Description |
|---|---|---|---|
accuracy | object | no | Measured precision and coverage of each requested kind on the latest unseen holdout (static; contract 2.10). |
as_of | string | null | yes | |
axes | array of string | yes | |
cik | string | yes | |
data | array of object | yes | |
excluded | Excluded | yes | |
excluded_total | integer | yes | |
from | string | null | yes | |
has_more | boolean | yes | |
kinds | array of string | yes | |
limit | integer | yes | Period ends per page (default 1: the latest fiscal year). |
next_cursor | string | null | yes | Opaque: the next page (earlier period ends), same filters. |
period | string | null | yes | |
periods | string | yes | The period classes served, canonical (default annual: the year ends, their years and instants). |
rule | string | yes | |
rules | object | yes | |
to | string | null | yes | |
view | string | yes | One of: latest, first_reported. |
Example request
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