Select an issuer
company accepts either an exchange ticker or a Rangler company UUID. Ticker matching is case-insensitive. countryCode disambiguates a ticker used in more than one supported market. The response’s company object contains the resolved ID, name, ticker, exchange, and country code.
Choose a statement view
Standardized routes map equivalent filing line items to consistent metric names:raw_text and, when it can be parsed safely, numeric_value.
Retrieve ratios and revenue segments separately:
ratioId accepts repeated parameters or comma-separated values. Unknown ratio IDs return an error. Revenue segments are reported values, so that route does not accept periodType=ltm.
Query parameters
Choose periods
quarterly returns standalone quarters. When an issuer reports cumulative 6M or 9M figures, Rangler can calculate Q2 or Q3 and marks the period and metric origins accordingly. ytd keeps cumulative 3M, 6M, and 9M periods. ltm returns trailing-twelve-month periods. Add latest to return only the newest period in the requested set.
periodLimit applies to each requested series. In this example, annual history does not consume the quarterly limit.
Scope and subject selection
Financial filings can report Group and Company figures together, or parallel subjects such as Group, Company, and Bank. First requestscope=auto, then use available_scopes to discover valid combinations.
scope_label, send that exact value through scopeLabel. Reporting scopes can change between filing periods.
Efficient integration pattern
- Request only the statement section or ratio set you need.
- Store the returned
company.idfor later requests. - Fetch and cache metric or ratio definitions by
catalog_version. - Use
periodType,periodLimit, andlatestto keep responses small. - Request source references only when your product needs filing evidence.