mirror of
https://github.com/OpenBB-finance/OpenBB.git
synced 2026-10-28 21:12:16 +00:00
4400cd9a8f
* small changes - moving provider inside the core * uptade readme * lint * remove old provider readme * leftovers * refactor website examples * ruff * fix nox * relock * fix fails_to_deliver headers * fix for tests that have renamed endpoints * fix discovery * removed test for renamed endpoint * fix broken syntax - test_search_financial_attributes * fix cash/income/balance * fix derivatives tests * fix etf tests * fix news tests * fix regulators * black * wrong test param * sort equity gainers/losers by percent * platform markdown generation import * Hotfix/fix int tests core merge (#5779) * removing tests on old endpoint * removing visualization on old endpoint * fixing equity tests * fixing examples * fix news tests * fix index test * example * add comments * example --------- Co-authored-by: Diogo Sousa <montezdesousa@gmail.com> --------- Co-authored-by: montezdesousa <79287829+montezdesousa@users.noreply.github.com> Co-authored-by: Diogo Sousa <montezdesousa@gmail.com> Co-authored-by: Danglewood <85772166+deeleeramone@users.noreply.github.com> Co-authored-by: Pratyush Shukla <ps4534@nyu.edu>
93 lines
3.0 KiB
Markdown
Vendored
93 lines
3.0 KiB
Markdown
Vendored
---
|
|
title: Price Target
|
|
description: OpenBB Platform Data Model
|
|
---
|
|
|
|
<!-- markdownlint-disable MD012 MD031 MD033 -->
|
|
|
|
import Tabs from '@theme/Tabs';
|
|
import TabItem from '@theme/TabItem';
|
|
|
|
---
|
|
|
|
## Implementation details
|
|
|
|
### Class names
|
|
|
|
| Model name | Parameters class | Data class |
|
|
| ---------- | ---------------- | ---------- |
|
|
| `PriceTarget` | `PriceTargetQueryParams` | `PriceTargetData` |
|
|
|
|
### Import Statement
|
|
|
|
```python
|
|
from openbb_core.provider.standard_models.price_target import (
|
|
PriceTargetData,
|
|
PriceTargetQueryParams,
|
|
)
|
|
```
|
|
|
|
## Parameters
|
|
|
|
<Tabs>
|
|
<TabItem value="standard" label="Standard">
|
|
|
|
| Name | Type | Description | Default | Optional |
|
|
| ---- | ---- | ----------- | ------- | -------- |
|
|
| symbol | Union[str, List[str]] | Symbol to get data for. | | False |
|
|
| provider | Literal['fmp'] | 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 |
|
|
</TabItem>
|
|
|
|
<TabItem value='fmp' label='fmp'>
|
|
|
|
| Name | Type | Description | Default | Optional |
|
|
| ---- | ---- | ----------- | ------- | -------- |
|
|
| symbol | Union[str, List[str]] | Symbol to get data for. | | False |
|
|
| provider | Literal['fmp'] | 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 |
|
|
| with_grade | bool | Include upgrades and downgrades in the response. | False | True |
|
|
</TabItem>
|
|
|
|
</Tabs>
|
|
|
|
## Data
|
|
|
|
<Tabs>
|
|
<TabItem value="standard" label="Standard">
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| symbol | str | Symbol representing the entity requested in the data. |
|
|
| published_date | datetime | Published date of the price target. |
|
|
| news_url | str | News URL of the price target. |
|
|
| news_title | str | News title of the price target. |
|
|
| analyst_name | str | Analyst name. |
|
|
| analyst_company | str | Analyst company. |
|
|
| price_target | float | Price target. |
|
|
| adj_price_target | float | Adjusted price target. |
|
|
| price_when_posted | float | Price when posted. |
|
|
| news_publisher | str | News publisher of the price target. |
|
|
| news_base_url | str | News base URL of the price target. |
|
|
</TabItem>
|
|
|
|
<TabItem value='fmp' label='fmp'>
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| symbol | str | Symbol representing the entity requested in the data. |
|
|
| published_date | datetime | Published date of the price target. |
|
|
| news_url | str | News URL of the price target. |
|
|
| news_title | str | News title of the price target. |
|
|
| analyst_name | str | Analyst name. |
|
|
| analyst_company | str | Analyst company. |
|
|
| price_target | float | Price target. |
|
|
| adj_price_target | float | Adjusted price target. |
|
|
| price_when_posted | float | Price when posted. |
|
|
| news_publisher | str | News publisher of the price target. |
|
|
| news_base_url | str | News base URL of the price target. |
|
|
| new_grade | str | New grade |
|
|
| previous_grade | str | Previous grade |
|
|
| grading_company | str | Grading company |
|
|
</TabItem>
|
|
|
|
</Tabs>
|