Skip to main content
GET
Get a standardized cash flow statement

Authorizations

X-API-Key
string
header
required

Query Parameters

company
string
required

Rangler company UUID or exchange ticker, matched case-insensitively.

Required string length: 1 - 64
countryCode
string | null

ISO 3166-1 alpha-2 market code. Use it when a ticker is shared across markets.

Required string length: 2
currency
string | null

Display currency. Use native or an ISO 4217 currency code.

Pattern: ^(?:native|[A-Za-z]{3})$
periodType
string[] | null

Period filter. Repeat or use a comma-separated list: annual, quarterly, semi-annual, ltm, ytd, latest. Defaults to annual.

scope
enum<string>
default:auto

Statement scope. Auto selects the strongest available company or group view.

Available options:
auto,
consolidated,
separate,
unspecified
scopeLabel
string | null

Optional reported subject label used to disambiguate statement scope.

Required string length: 1 - 160
includeSources
boolean
default:true

Include source-cell references for the returned metrics.

includeMetadata
boolean
default:false

Embed definitions for the returned metrics.

periodLimit
integer
default:12

Maximum periods returned from each requested series.

Required range: 1 <= x <= 40

Response

Successful Response

Standardized company financials with metric definitions and filing sources.

company_id
string<uuid>
required
company
StatementCompanyReference · object
required

Resolved issuer identity for a financial response.

scope
enum<string>
required
Available options:
consolidated,
separate,
unspecified
catalog_version
string
required

Version of the metric catalog used to produce this response.

unit_convention
Unit Convention · object
required

Rules for interpreting the unit and scale of every value in the response.

issuer_company
StatementCompanyReference · object | null

Issuer that owns the statements when the selected company is a separate listed security.

scope_label
string | null
selected_subject
string | null
available_scopes
StatementScopeOption · object[]
available_reported_currencies
string[]
available_display_currencies
string[]

Display modes the server can produce without mixing currencies or inventing FX rates.

selected_reported_currency
string | null
reported_currency
string | null
display_currency
string | null
periods
StatementFinancialPeriod · object[]
trailing_periods
StatementFinancialPeriod · object[]
metric_metadata
Metric Metadata · object
ratio_metadata
Ratio Metadata · object
growth_metadata
Growth Metadata · object
historical_cagrs
Historical Cagrs · object