API referenceEndpointsFinancial statements
Authorization
RanglerApiKey X-API-Key<token>
In: header
Path Parameters
company_id*Company Id
Format
uuidQuery Parameters
scope?Scope
Default
"auto"Value in
"auto" | "consolidated" | "separate" | "unspecified"scope_label?|
Narrow the scope to one named subject, as printed. A filing that reports BANK beside COMPANY carries both under scope=separate; omit to keep the whole scope. Values come from available_scopes[].scope_label.
granularity?Granularity
Default
"all"Value in
"all" | "annual" | "quarterly"display_currency?|null
reported_currency?|null
with_ratios?With Ratios
Default
trueinclude_sources?Include Sources
Include the filing source for every returned metric.
Default
truesource_detail?Source Detail
Return full source evidence or only stable filing, page, cell, and derivation references.
Default
"full"Value in
"full" | "reference"include_trailing?Include Trailing
Include derived trailing-twelve-month periods.
Default
truestatement_type?array<string>|
Return metrics from selected standard statement sections. Repeat the parameter or use a comma-separated list: income_statement, balance_sheet, cash_flow.
metric?array<string>|
Return only selected standard metric names. Repeat or provide a comma-separated list.
ratio?array<string>|
Return only selected ratio keys. Repeat or provide a comma-separated list.
period_family?array<string>|
Return selected period families. Repeat or provide a comma-separated list: annual, quarterly, semi_annual, nine_month, trailing.
latest_only?Latest Only
Return only the newest reported period and, when requested, the newest trailing period.
Default
falseinclude_metadata?Include Metadata
Embed selected metric, ratio, and growth definitions in addition to catalog_version.
Default
trueResponse Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
curl -X GET "https://api.rangler.co/v1/companies/497f6eca-6276-4993-bfeb-53cbbbba6f08/statement-financials"{
"company_id": "b2e6a1c3-1a5e-44ae-a8fd-81f76fd715cf",
"company": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"ticker": "string",
"exchange": "string",
"country_code": "string"
},
"scope": "consolidated",
"scope_label": "string",
"selected_subject": "string",
"catalog_version": "string",
"unit_convention": {
"property1": {
"label": "string",
"description": "string",
"value_representation": "string",
"scale": 1,
"currency_field": "string"
},
"property2": {
"label": "string",
"description": "string",
"value_representation": "string",
"scale": 1,
"currency_field": "string"
}
},
"available_scopes": [
{
"scope": "consolidated",
"label": "string",
"scope_label": "string"
}
],
"available_reported_currencies": [
"string"
],
"selected_reported_currency": "string",
"reported_currency": "string",
"display_currency": "string",
"periods": [
{
"period_id": "string",
"period_end_date": "2019-08-24",
"calendar_year": 0,
"calendar_quarter": 0,
"fiscal_year": 0,
"fiscal_quarter": 0,
"reporting_period": "string",
"period_type": "string",
"duration_months": 0,
"is_derived_period": false,
"is_restated": false,
"restated_metrics": [
"string"
],
"scope": "string",
"scope_label": "string",
"income_basis": "string",
"reported_currency": "string",
"display_currency": "string",
"currency_conversion": {
"source_currency": "string",
"target_currency": "string",
"rate": 0,
"rate_date": "2019-08-24",
"status": "string"
},
"currency": "string",
"metrics": {
"property1": 0,
"property2": 0
},
"metric_origins": {
"property1": "reported",
"property2": "reported"
},
"ratios": {
"property1": 0,
"property2": 0
},
"sources": {
"property1": {},
"property2": {}
},
"reconciliation": {},
"audit_status": {},
"valuation_inputs": {}
}
],
"trailing_periods": [
{
"period_id": "string",
"period_end_date": "2019-08-24",
"calendar_year": 0,
"calendar_quarter": 0,
"fiscal_year": 0,
"fiscal_quarter": 0,
"reporting_period": "string",
"period_type": "string",
"duration_months": 0,
"is_derived_period": false,
"is_restated": false,
"restated_metrics": [
"string"
],
"scope": "string",
"scope_label": "string",
"income_basis": "string",
"reported_currency": "string",
"display_currency": "string",
"currency_conversion": {
"source_currency": "string",
"target_currency": "string",
"rate": 0,
"rate_date": "2019-08-24",
"status": "string"
},
"currency": "string",
"metrics": {
"property1": 0,
"property2": 0
},
"metric_origins": {
"property1": "reported",
"property2": "reported"
},
"ratios": {
"property1": 0,
"property2": 0
},
"sources": {
"property1": {},
"property2": {}
},
"reconciliation": {},
"audit_status": {},
"valuation_inputs": {}
}
],
"metric_metadata": {
"property1": {
"key": "string",
"label": "string",
"definition": "string",
"statement_types": [
"string"
],
"unit": "string",
"display_unit": "string",
"value_representation": "string",
"source": "reported"
},
"property2": {
"key": "string",
"label": "string",
"definition": "string",
"statement_types": [
"string"
],
"unit": "string",
"display_unit": "string",
"value_representation": "string",
"source": "reported"
}
},
"ratio_metadata": {
"property1": {
"key": "string",
"label": "string",
"definition": "string",
"formula": "string",
"category": "string",
"unit": "string",
"value_representation": "string",
"dependencies": [
"string"
],
"uses_prior_period": false,
"uses_market_data": false,
"source": "derived"
},
"property2": {
"key": "string",
"label": "string",
"definition": "string",
"formula": "string",
"category": "string",
"unit": "string",
"value_representation": "string",
"dependencies": [
"string"
],
"uses_prior_period": false,
"uses_market_data": false,
"source": "derived"
}
},
"growth_metadata": {
"property1": {},
"property2": {}
},
"historical_cagrs": {}
}{
"error": {
"type": "unauthorized",
"code": "unauthorized",
"message": "Authentication required.",
"request_id": "28fa6152-7081-492e-8a7e-00beb237b689"
}
}{
"error": {
"type": "forbidden",
"code": "forbidden",
"message": "Paid access is required.",
"request_id": "5c253b3e-778e-4a58-aaf8-07cb21e03563"
}
}{
"error": {
"type": "not_found",
"code": "not_found",
"message": "Company not found",
"request_id": "9f5237bc-7d8c-4a9d-9c1f-fbd4ef236cf9"
}
}{
"error": {
"type": "validation_error",
"code": "validation_error",
"message": "Request validation failed",
"request_id": "c5964dca-d290-4465-a3dc-f92d42aa9b17",
"details": [
{
"type": "missing",
"loc": [
"query",
"ticker"
],
"msg": "Field required",
"input": null
}
]
}
}{
"error": {
"type": "rate_limit_exceeded",
"code": "rate_limit_exceeded",
"message": "Rate limit exceeded",
"request_id": "cc4d369a-2c69-4ee2-909e-985ea35d14a9"
}
}{
"error": {
"type": "internal_server_error",
"code": "internal_server_error",
"message": "Internal Server Error",
"request_id": "70b63aba-b8a3-41c2-bb0c-fbe67d84d37d"
}
}