Forward Sales Estimates
Implementation details
Class names
| Model name | Parameters class | Data class |
|---|---|---|
ForwardSalesEstimates | ForwardSalesEstimatesQueryParams | ForwardSalesEstimatesData |
Import Statement
from openbb_core.provider.standard_models.forward_sales_estimates import (
ForwardSalesEstimatesData,
ForwardSalesEstimatesQueryParams,
)
Parameters
- standard
- intrinio
- seeking_alpha
symbol: Union[str, list[str]]
Symbol to get data for. Multiple items allowed for provider(s): intrinio, seeking_alpha.
• Optional: True
symbol: Union[str, list[str]]
Symbol to get data for. Multiple items allowed for provider(s): intrinio, seeking_alpha.
• Optional: True
fiscal_year: int
The future fiscal year to retrieve estimates for. When no symbol and year is supplied the current calendar year is used.
• Optional: True
fiscal_period: Literal['fy', 'q1', 'q2', 'q3', 'q4']
The future fiscal period to retrieve estimates for.
• Optional: True
calendar_year: int
The future calendar year to retrieve estimates for. When no symbol and year is supplied the current calendar year is used.
• Optional: True
calendar_period: Literal['q1', 'q2', 'q3', 'q4']
The future calendar period to retrieve estimates for.
• Optional: True
symbol: Union[str, list[str]]
Symbol to get data for. Multiple items allowed for provider(s): intrinio, seeking_alpha.
• Optional: True
period: Literal['annual', 'quarter']
The reporting period.
• Default: quarter
• Optional: True
Data
- standard
- intrinio
- seeking_alpha
symbol: str
Symbol representing the entity requested in the data.
name: str
Name of the entity.
date: Union[date, str]
The date of the data.
fiscal_year: int
Fiscal year for the estimate.
fiscal_period: str
Fiscal quarter for the estimate.
calendar_year: int
Calendar year for the estimate.
calendar_period: str
Calendar quarter for the estimate.
low_estimate: int
The sales estimate low for the period.
high_estimate: int
The sales estimate high for the period.
mean: int
The sales estimate mean for the period.
median: int
The sales estimate median for the period.
standard_deviation: int
The sales estimate standard deviation for the period.
number_of_analysts: int
Number of analysts providing estimates for the period.
symbol: str
Symbol representing the entity requested in the data.
name: str
Name of the entity.
date: Union[date, str]
The date of the data.
fiscal_year: int
Fiscal year for the estimate.
fiscal_period: str
Fiscal quarter for the estimate.
calendar_year: int
Calendar year for the estimate.
calendar_period: str
Calendar quarter for the estimate.
low_estimate: int
The sales estimate low for the period.
high_estimate: int
The sales estimate high for the period.
mean: int
The sales estimate mean for the period.
median: int
The sales estimate median for the period.
standard_deviation: int
The sales estimate standard deviation for the period.
number_of_analysts: int
Number of analysts providing estimates for the period.
revisions_1w_up: int
Number of revisions up in the last week.
revisions_1w_down: int
Number of revisions down in the last week.
revisions_1w_change_percent: float
The analyst revisions percent change in estimate for the period of 1 week.
revisions_1m_up: int
Number of revisions up in the last month.
revisions_1m_down: int
Number of revisions down in the last month.
revisions_1m_change_percent: float
The analyst revisions percent change in estimate for the period of 1 month.
revisions_3m_up: int
Number of revisions up in the last 3 months.
revisions_3m_down: int
Number of revisions down in the last 3 months.
revisions_3m_change_percent: float
The analyst revisions percent change in estimate for the period of 3 months.
symbol: str
Symbol representing the entity requested in the data.
name: str
Name of the entity.
date: Union[date, str]
The date of the data.
fiscal_year: int
Fiscal year for the estimate.
fiscal_period: str
Fiscal quarter for the estimate.
calendar_year: int
Calendar year for the estimate.
calendar_period: str
Calendar quarter for the estimate.
low_estimate: int
The sales estimate low for the period.
high_estimate: int
The sales estimate high for the period.
mean: int
The sales estimate mean for the period.
median: int
The sales estimate median for the period.
standard_deviation: int
The sales estimate standard deviation for the period.
number_of_analysts: int
Number of analysts providing estimates for the period.
actual: int
Actual sales (revenue) for the period.
period_growth: float
Estimated (or actual if reported) EPS growth for the period.