mirror of
https://github.com/OpenBB-finance/OpenBB.git
synced 2026-11-03 16:02:04 +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>
93 lines
2.5 KiB
Markdown
Vendored
93 lines
2.5 KiB
Markdown
Vendored
---
|
|
title: trend
|
|
description: The page details functions related to behavioural analysis with OpenBB
|
|
Terminal, specifically focusing on trend analysis. The page explains how to generate
|
|
sentiment data on the most talked about stock tickers. Explained in detail with
|
|
source code and parameters.
|
|
keywords:
|
|
- sentiment data
|
|
- tickers
|
|
- trend
|
|
- behavioural analysis
|
|
- trend chart
|
|
- API call
|
|
- dataframe
|
|
- hour
|
|
- number
|
|
- limit
|
|
- export data
|
|
---
|
|
|
|
import HeadTitle from '@site/src/components/General/HeadTitle.tsx';
|
|
|
|
<HeadTitle title="stocks.ba.trend - Reference | OpenBB SDK Docs" />
|
|
|
|
import Tabs from '@theme/Tabs';
|
|
import TabItem from '@theme/TabItem';
|
|
|
|
<Tabs>
|
|
<TabItem value="model" label="Model" default>
|
|
|
|
Get sentiment data on the most talked about tickers
|
|
|
|
Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/common/behavioural_analysis/sentimentinvestor_model.py#L136)]
|
|
|
|
```python
|
|
openbb.stocks.ba.trend(start_date: Optional[str] = None, hour: int = 0, number: int = 10)
|
|
```
|
|
|
|
---
|
|
|
|
## Parameters
|
|
|
|
| Name | Type | Description | Default | Optional |
|
|
| ---- | ---- | ----------- | ------- | -------- |
|
|
| start_date | Optional[str] | Initial date, format YYYY-MM-DD | None | True |
|
|
| hour | int | Hour of the day in 24-hour notation (e.g. 14) | 0 | True |
|
|
| number | int | Number of results returned by API call<br/>Maximum 250 per api call | 10 | True |
|
|
|
|
|
|
---
|
|
|
|
## Returns
|
|
|
|
| Type | Description |
|
|
| ---- | ----------- |
|
|
| pd.DataFrame | Dataframe of trending data |
|
|
---
|
|
|
|
</TabItem>
|
|
<TabItem value="view" label="Chart">
|
|
|
|
Display most talked about tickers within
|
|
|
|
Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/common/behavioural_analysis/sentimentinvestor_view.py#L151)]
|
|
|
|
```python
|
|
openbb.stocks.ba.trend_chart(start_date: Optional[str] = None, hour: int = 0, number: int = 10, limit: int = 10, export: str = "")
|
|
```
|
|
|
|
---
|
|
|
|
## Parameters
|
|
|
|
| Name | Type | Description | Default | Optional |
|
|
| ---- | ---- | ----------- | ------- | -------- |
|
|
| start_date | Optional[str] | Initial date, format YYYY-MM-DD | None | True |
|
|
| hour | int | Hour of the day in 24-hour notation (e.g. 14) | 0 | True |
|
|
| number | int | Number of results returned by API call<br/>Maximum 250 per api call | 10 | True |
|
|
| limit | int | Number of results display on the terminal<br/>Default: 10 | 10 | True |
|
|
| export | str | Format to export data | | True |
|
|
|
|
|
|
---
|
|
|
|
## Returns
|
|
|
|
This function does not return anything
|
|
|
|
---
|
|
|
|
</TabItem>
|
|
</Tabs>
|