Reported Financials
Implementation details
Class names
| Model name | Parameters class | Data class |
|---|---|---|
ReportedFinancials | ReportedFinancialsQueryParams | ReportedFinancialsData |
Import Statement
from openbb_core.provider.standard_models.reported_financials import (
ReportedFinancialsData,
ReportedFinancialsQueryParams,
)
Parameters
- standard
- intrinio
| Name | Type | Description | Default | Optional |
|---|---|---|---|---|
| symbol | str | Symbol to get data for. | False | |
| period | str | Time period of the data to return. | annual | True |
| statement_type | str | The type of financial statement - i.e, balance, income, cash. | balance | True |
| limit | int | The number of data entries to return. Although the response object contains multiple results, because of the variance in the fields, year-to-year and quarter-to-quarter, it is recommended to view results in small chunks. | 100 | True |
| provider | Literal['intrinio'] | The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: i, n, t, r, i, n, i, o. | None | True |
| Name | Type | Description | Default | Optional |
|---|---|---|---|---|
| symbol | str | Symbol to get data for. | False | |
| period | Literal['annual', 'quarter'] | None | annual | True |
| statement_type | Literal['balance', 'income', 'cash'] | Cash flow statements are reported as YTD, Q4 is the same as FY. | income | True |
| limit | int | The number of data entries to return. Although the response object contains multiple results, because of the variance in the fields, year-to-year and quarter-to-quarter, it is recommended to view results in small chunks. | 100 | True |
| provider | Literal['intrinio'] | The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: i, n, t, r, i, n, i, o. | None | True |
| fiscal_year | int | The specific fiscal year. Reports do not go beyond 2008. | None | True |
Data
- standard
- intrinio
| Name | Type | Description |
|---|---|---|
| period_ending | date | The ending date of the reporting period. |
| fiscal_period | str | The fiscal period of the report (e.g. FY, Q1, etc.). |
| fiscal_year | int | The fiscal year of the fiscal period. |
| Name | Type | Description |
|---|---|---|
| period_ending | date | The ending date of the reporting period. |
| fiscal_period | str | The fiscal period of the report (e.g. FY, Q1, etc.). |
| fiscal_year | int | The fiscal year of the fiscal period. |