Get financial segments
Break down a company's reported revenue, operating income, assets and other financial figures by product, business or geography.
How it works
-
Choose a breakdown. For questions about iPhone sales or revenue by region, use this tool. For company-wide amounts, use
get_financials. Available metrics depend on the filing and can include revenue, operating income, assets, goodwill, non-current assets, property, plant and equipment, depreciation, depreciation and amortization, capital expenditure and asset additions. - Read each group's dates and labels. Quarterly and year-to-date flows can end on the same day. Point-in-time balances have a null start date. Reported subtotals can appear beside their components, so adding every value can double-count revenue.
-
Select the report. Use
fromandtofor the report date, andfiling_dateorfiling_date_gteandfiling_date_ltefor its publication date. Publication filters require a known date. Pass adocument_idreturned alongside a previous result to choose that exact report. Setinclude_sources=trueto return the filing identifier and a direct link when available. - Check coverage. Sales channels can appear as a business breakdown. The dimension identifies the channel or geographic scope. An empty breakdown means figures are unavailable for the selected report. Pages count reports, including those with empty breakdowns. Fund share classes can return an empty report list.
Request
GET /api/v1/financials/segments with your API key. AI assistants call it as the get_financial_segments tool, with the same parameters.
Parameters
qstringrequired
Ticker with its exchange code or MIC (AAPL:US, AAPL:XNAS, TSCO:XLON), ISIN, CUSIP, SEDOL, WKN, FIGI, LEI, CIK or company registration number. Any ticker and mic a listing returns work as ticker:mic.
More parameters
include_sourcesboolean
Include available source documents and supporting evidence. Omit for data only.
Default: false
periodstring
Report frequency. Interim includes quarterly and half-year reports.
Default: annual · One of: annual, quarterly, interim, all
document_idstring
Select this exact filing regardless of period.
fromdate
Earliest report date, inclusive.
YYYY-MM-DD
todate
Latest report date, inclusive.
YYYY-MM-DD
known_bydate
Only reports known to be available by this date.
YYYY-MM-DD
filing_datedate
Published on this date.
YYYY-MM-DD
filing_date_gtedate
Published on or after this date.
YYYY-MM-DD
filing_date_gtdate
Published after this date.
YYYY-MM-DD
filing_date_ltedate
Published on or before this date.
YYYY-MM-DD
filing_date_ltdate
Published before this date.
YYYY-MM-DD
limitinteger
Maximum number of reports.
Default: 2 · From 1 to 100
offsetinteger
Reports to skip.
Default: 0 · From 0 to 9007199254740991
Response
JSON with these fields. A field the source doesn't report is null or left out.
queryRequested identifier
next_offsetOffset of the next page, or null
reportsarray of objectsrequired
Show child attributes
document_idWith include_sources=true, the identifier of the filing
filing_urlWith include_sources=true, the direct URL of the filing, or null when unavailable
report_dateDate covered by the filing
periodReport frequency, when known
currencyReport currency, when known
segmentsarray of objectsrequired
Show child attributes
metricFinancial measure
categoryproduct, business or geography
dimensionReported breakdown label
start_dateFirst day of the period, or null for a balance
end_dateLast day of the period or balance date
currencyCurrency of the segment values
valuesarray of objectsrequired
Show child attributes
labelReported segment label
valueAmount in currency units, or null for conflicting disclosures
matchIdentifier lookup outcome. A found match can still have an empty page.
Errors
| Status | Meaning |
|---|---|
| 400 | Missing, unknown or invalid parameter, or an identifier that can't be looked up |
| 401 | Missing, unknown or revoked API key |
| 402 | No active plan or trial, or the included request allowance is used |
| 403 | API access of the account is suspended |
| 404 | The identifier matches nothing or is ambiguous. The match field identifies the outcome |
| 429 | Over the plan's rate limit; Retry-After says when to retry |
| 500 | Internal error; the same request is unlikely to succeed on retry |
| 503 | The data couldn't be loaded right now; Retry-After says when to retry, when known |
Errors are JSON with an error message saying what to fix. Errors are free. See Errors and limits.