mirror of
https://github.com/OpenBB-finance/OpenBB.git
synced 2026-10-30 22:11:55 +00:00
f72bc8ccec
* Adding versioning to docs --------- Co-authored-by: andrewkenreich <andrew.kenreich@gmail.com> Co-authored-by: tehcoderer <me@tehcoderer.com>
94 lines
2.2 KiB
Markdown
Vendored
94 lines
2.2 KiB
Markdown
Vendored
---
|
|
title: pta
|
|
description: OpenBB Platform Function
|
|
---
|
|
|
|
import Tabs from '@theme/Tabs';
|
|
import TabItem from '@theme/TabItem';
|
|
|
|
# pta
|
|
|
|
Price Target.
|
|
|
|
```python wordwrap
|
|
pta(symbol: Union[str, List[str]], provider: Literal[str] = fmp)
|
|
```
|
|
|
|
---
|
|
|
|
## 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 |
|
|
| ---- | ---- | ----------- | ------- | -------- |
|
|
| with_grade | bool | Include upgrades and downgrades in the response. | False | True |
|
|
</TabItem>
|
|
|
|
</Tabs>
|
|
|
|
---
|
|
|
|
## Returns
|
|
|
|
```python wordwrap
|
|
OBBject
|
|
results : List[PriceTarget]
|
|
Serializable results.
|
|
|
|
provider : Optional[Literal['fmp']]
|
|
Provider name.
|
|
|
|
warnings : Optional[List[Warning_]]
|
|
List of warnings.
|
|
|
|
chart : Optional[Chart]
|
|
Chart object.
|
|
|
|
metadata: Optional[Metadata]
|
|
Metadata info about the command execution.
|
|
```
|
|
|
|
---
|
|
|
|
## Data
|
|
|
|
<Tabs>
|
|
<TabItem value="standard" label="Standard">
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| symbol | str | Symbol to get data for. |
|
|
| 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 |
|
|
| ---- | ---- | ----------- |
|
|
| new_grade | str | None |
|
|
| previous_grade | str | None |
|
|
| grading_company | str | None |
|
|
</TabItem>
|
|
|
|
</Tabs>
|
|
|