Equity: Financials
This package requires additional request parameters and has package-specific request limits.
Supporting Documentation
| Document | Description |
|---|---|
| Equity Data: Financial Statements Guidance for Investment Details API | Guide to retrieving financial statements data. |
| Equity Data: Financial Statements Templates for Investment Details API | Financial statements templates. |
Request Limits
When requesting Equity: Financials data, only a single view ID can be passed in the request i.e. "equity-financials".
Parameters
period
| Attribute | Value |
|---|---|
| Type | Request Payload (views[].parameters) |
| Data Type | string |
| Possible Values | a (Annual), sa1 (First semi-annual), sa2 (Second semi-annual), q1–q4 (Quarters), ir (Irregular report) |
| Example | a |
Required Filters results by the duration period of financial statements reported by the company.
reportType
| Attribute | Value |
|---|---|
| Type | Request Payload (views[].parameters) |
| Data Type | string |
| Possible Values | a (As originally reported), r (Restated), d (Preliminary restated), p (Preliminary as reported), ta, td, tr, tp (Trailing 12-month variants) |
| Example | a |
Required Filters results by report type.
segmentType
| Attribute | Value |
|---|---|
| Type | Request Payload (views[].parameters) |
| Data Type | string |
| Possible Values | Business, Brands/Franchise, Geographic, Market or Industry, Product/Services, Sales/distribution Channels, Timing of Revenue Recognition, Other |
| Example | Geographic |
Optional parameter for viewId=equity-financials. Required only when requesting financial segmentation data; filters results by segment type.
numberOfMonths
| Attribute | Value |
|---|---|
| Type | Request Payload (views[].parameters) |
| Data Type | string |
| Possible Values | 3, 6, 9, 12, 15, 18, 21 |
| Example | 3 |
Filters results by the duration period of financial statements reported by the company.