mirror of
https://github.com/OpenBB-finance/OpenBB.git
synced 2026-11-04 00:12:29 +00:00
4ad995fdd0
* add first iteration of content for Terminal Pro * Update index.md * Update dashboards.md * Update folders.md * Update grouping.md * Update report.md * Update templates.md * Update quick-start.md * Update index.md * Update index.md * Update home.md * Update news.md * Update index.md * Update index.md * Update index.md * Update data-provider.md * Update chat-with-widget.md * Update data-manipulation.md * Update forecasting.md * fix: images self closing tags * fix: only pro visitors can see pro * inter font * improve SEO content and restructuring * add new package for toggle on tutorials * move folder around * improve main page of each prod * small updates and improvements * fix logo above * small improvement in headtitle for portfolio funcs * fix typos from OpenAI's GPT-4 * fix _category_ json * remove generic SEO words * add script that generates SEO for documentation * add missing file * remove sdk warning message * fix links for andrew --------- Co-authored-by: jose-donato <zmcdonato@gmail.com> Co-authored-by: jose-donato <43375532+jose-donato@users.noreply.github.com> Co-authored-by: andrewkenreich <andrew.kenreich@gmail.com>
104 lines
2.6 KiB
Markdown
Vendored
104 lines
2.6 KiB
Markdown
Vendored
---
|
|
title: pt
|
|
description: This documentation pertains to OpenBB's APIs for retrieving and visualizing
|
|
analysts' price targets for stocks. Two key functions are discussed, one to retrieve
|
|
the data and the other to generate charts.
|
|
keywords:
|
|
- API documentation
|
|
- stock price targets
|
|
- data retrieval
|
|
- data visualization
|
|
- analysts' price targets
|
|
---
|
|
|
|
import HeadTitle from '@site/src/components/General/HeadTitle.tsx';
|
|
|
|
<HeadTitle title="stocks.dd.pt - Reference | OpenBB SDK Docs" />
|
|
|
|
import Tabs from '@theme/Tabs';
|
|
import TabItem from '@theme/TabItem';
|
|
|
|
<Tabs>
|
|
<TabItem value="model" label="Model" default>
|
|
|
|
Get analysts' price targets for a given stock. [Source: Business Insider]
|
|
|
|
Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/stocks/due_diligence/business_insider_model.py#L20)]
|
|
|
|
```python
|
|
openbb.stocks.dd.pt(symbol: str)
|
|
```
|
|
|
|
---
|
|
|
|
## Parameters
|
|
|
|
| Name | Type | Description | Default | Optional |
|
|
| ---- | ---- | ----------- | ------- | -------- |
|
|
| symbol | str | Ticker symbol | None | False |
|
|
|
|
|
|
---
|
|
|
|
## Returns
|
|
|
|
| Type | Description |
|
|
| ---- | ----------- |
|
|
| pd.DataFrame | Analysts data |
|
|
---
|
|
|
|
## Examples
|
|
|
|
```python
|
|
from openbb_terminal.sdk import openbb
|
|
df = openbb.stocks.dd.pt(symbol="AAPL")
|
|
```
|
|
|
|
---
|
|
|
|
</TabItem>
|
|
<TabItem value="view" label="Chart">
|
|
|
|
Display analysts' price targets for a given stock. [Source: Business Insider]
|
|
|
|
Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/stocks/due_diligence/business_insider_view.py#L32)]
|
|
|
|
```python
|
|
openbb.stocks.dd.pt_chart(symbol: str, data: Optional[pd.DataFrame] = None, start_date: Optional[str] = None, limit: int = 10, raw: bool = False, export: str = "", external_axes: Optional[List[matplotlib.axes._axes.Axes]] = None)
|
|
```
|
|
|
|
---
|
|
|
|
## Parameters
|
|
|
|
| Name | Type | Description | Default | Optional |
|
|
| ---- | ---- | ----------- | ------- | -------- |
|
|
| symbol | str | Due diligence ticker symbol | None | False |
|
|
| data | Optional[DataFrame] | Price target DataFrame | None | True |
|
|
| start_date | Optional[str] | Start date of the stock data, format YYYY-MM-DD | None | True |
|
|
| limit | int | Number of latest price targets from analysts to print | 10 | True |
|
|
| raw | bool | Display raw data only | False | True |
|
|
| export | str | Export dataframe data to csv,json,xlsx file | | True |
|
|
| external_axes | Optional[List[plt.Axes]] | External axes (1 axis is expected in the list), by default None | None | True |
|
|
|
|
|
|
---
|
|
|
|
## Returns
|
|
|
|
This function does not return anything
|
|
|
|
---
|
|
|
|
## Examples
|
|
|
|
```python
|
|
from openbb_terminal.sdk import openbb
|
|
openbb.stocks.dd.pt_chart(symbol="AAPL")
|
|
```
|
|
|
|
---
|
|
|
|
</TabItem>
|
|
</Tabs>
|