consensus
Get consensus price target and recommendation.
Example
from openbb import obb
obb.equity.estimates.consensus("AAPL,MSFT", provider="yfinance").to_df()
Parameters
- standard
- fmp
- tmx
- yfinance
| Name | Type | Description | Default | Optional |
|---|---|---|---|---|
| symbol | Union[str, List[str]] | Symbol to get data for. Multiple items allowed for provider(s): tmx, yfinance. | False | |
| provider | Literal['fmp', 'tmx', 'yfinance'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'fmp' if there is no default. | fmp | True |
| Name | Type | Description | Default | Optional |
|---|---|---|---|---|
| symbol | Union[str, List[str]] | Symbol to get data for. Multiple items allowed for provider(s): tmx, yfinance. | False | |
| provider | Literal['fmp', 'tmx', 'yfinance'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'fmp' if there is no default. | fmp | True |
| Name | Type | Description | Default | Optional |
|---|---|---|---|---|
| symbol | Union[str, List[str]] | Symbol to get data for. Multiple items allowed for provider(s): tmx, yfinance. | False | |
| provider | Literal['fmp', 'tmx', 'yfinance'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'fmp' if there is no default. | fmp | True |
| Name | Type | Description | Default | Optional |
|---|---|---|---|---|
| symbol | Union[str, List[str]] | Symbol to get data for. Multiple items allowed for provider(s): tmx, yfinance. | False | |
| provider | Literal['fmp', 'tmx', 'yfinance'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'fmp' if there is no default. | fmp | True |
Returns
OBBject
results : List[PriceTargetConsensus]
Serializable results.
provider : Optional[Literal['fmp', 'tmx', 'yfinance']]
Provider name.
warnings : Optional[List[Warning_]]
List of warnings.
chart : Optional[Chart]
Chart object.
extra : Dict[str, Any]
Extra info.
Data
- standard
- fmp
- tmx
- yfinance
| Name | Type | Description |
|---|---|---|
| symbol | str | Symbol representing the entity requested in the data. |
| target_high | float | High target of the price target consensus. |
| target_low | float | Low target of the price target consensus. |
| target_consensus | float | Consensus target of the price target consensus. |
| target_median | float | Median target of the price target consensus. |
| Name | Type | Description |
|---|---|---|
| symbol | str | Symbol representing the entity requested in the data. |
| target_high | float | High target of the price target consensus. |
| target_low | float | Low target of the price target consensus. |
| target_consensus | float | Consensus target of the price target consensus. |
| target_median | float | Median target of the price target consensus. |
| Name | Type | Description |
|---|---|---|
| symbol | str | Symbol representing the entity requested in the data. |
| target_high | float | High target of the price target consensus. |
| target_low | float | Low target of the price target consensus. |
| target_consensus | float | Consensus target of the price target consensus. |
| target_median | float | Median target of the price target consensus. |
| target_upside | float | Percent of upside, as a normalized percent. |
| total_analysts | int | Total number of analyst. |
| buy_ratings | int | Number of buy ratings. |
| sell_ratings | int | Number of sell ratings. |
| hold_ratings | int | Number of hold ratings. |
| consensus_action | str | Consensus action. |
| Name | Type | Description |
|---|---|---|
| symbol | str | Symbol representing the entity requested in the data. |
| target_high | float | High target of the price target consensus. |
| target_low | float | Low target of the price target consensus. |
| target_consensus | float | Consensus target of the price target consensus. |
| target_median | float | Median target of the price target consensus. |
| recommendation | str | Recommendation - buy, sell, etc. |
| recommendation_mean | float | Mean recommendation score where 1 is strong buy and 5 is strong sell. |
| number_of_analysts | int | Number of analysts providing opinions. |
| current_price | float | Current price of the stock. |
| currency | str | Currency the stock is priced in. |