Income Statement
Implementation details
Class names
Model name | Parameters class | Data class |
---|---|---|
IncomeStatement | IncomeStatementQueryParams | IncomeStatementData |
Import Statement
from openbb_core.provider.standard_models.income_statement import (
IncomeStatementData,
IncomeStatementQueryParams,
)
Parameters
- standard
- fmp
- intrinio
- polygon
- yfinance
symbol
: str
Symbol to get data for.
• Optional: False
limit
: Annotated[int, Ge(ge=0)]
The number of data entries to return.
• Default: 5
• Optional: True
symbol
: str
Symbol to get data for.
• Optional: False
limit
: Annotated[int, Ge(ge=0)]
The number of data entries to return.
• Default: 5
• Optional: True
period
: Literal['annual', 'quarter']
Time period of the data to return.
• Default: annual
• Optional: True
symbol
: str
Symbol to get data for.
• Optional: False
limit
: Annotated[int, Ge(ge=0)]
The number of data entries to return.
• Default: 5
• Optional: True
period
: Literal['annual', 'quarter', 'ttm', 'ytd']
Time period of the data to return.
• Default: annual
• Optional: True
fiscal_year
: int
The specific fiscal year. Reports do not go beyond 2008.
• Optional: True
symbol
: str
Symbol to get data for.
• Optional: False
limit
: Annotated[int, Ge(ge=0)]
The number of data entries to return.
• Default: 5
• Optional: True
period
: Literal['annual', 'quarter', 'ttm']
Time period of the data to return.
• Default: annual
• Optional: True
filing_date
: date
Filing date of the financial statement.
• Optional: True
filing_date_lt
: date
Filing date less than the given date.
• Optional: True
filing_date_lte
: date
Filing date less than or equal to the given date.
• Optional: True
filing_date_gt
: date
Filing date greater than the given date.
• Optional: True
filing_date_gte
: date
Filing date greater than or equal to the given date.
• Optional: True
period_of_report_date
: date
Period of report date of the financial statement.
• Optional: True
period_of_report_date_lt
: date
Period of report date less than the given date.
• Optional: True
period_of_report_date_lte
: date
Period of report date less than or equal to the given date.
• Optional: True
period_of_report_date_gt
: date
Period of report date greater than the given date.
• Optional: True
period_of_report_date_gte
: date
Period of report date greater than or equal to the given date.
• Optional: True
include_sources
: bool
Whether to include the sources of the financial statement.
• Optional: True
order
: Literal['asc', 'desc']
Order of the financial statement.
• Optional: True
sort
: Literal['filing_date', 'period_of_report_date']
Sort of the financial statement.
• Optional: True
symbol
: str
Symbol to get data for.
• Optional: False
limit
: int
The number of data entries to return.