mirror of
https://github.com/OpenBB-finance/OpenBB.git
synced 2026-10-28 21:12:16 +00:00
* fix(docs): added margin between sections * feat: removed unused files; updated ga * fix: juan stuff doesnt work * fix: random fix * moon at noon * fix: update docusaurus config * Update controller_doc_classes.py * fix: temp fix * fix: temp fix * Update controller_doc_classes.py * fix: remove old content * fix: taggfix * init * fix: styling and moved file * Update generate_terminal_markdown.py * fix: removed unused images * fix: port new files * Update generate_sdk_markdown.py * Update controller_doc_classes.py Co-authored-by: teh_coderer <me@tehcoderer.com>
2.0 KiB
Vendored
2.0 KiB
Vendored
title, description
| title | description |
|---|---|
| sentiment | OpenBB SDK Function |
import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem';
sentiment
Get sentiments from symbol.
Source Code: [link]
openbb.stocks.ba.sentiment(symbol: str, n_tweets: int = 15, n_days_past: int = 2)
Parameters
| Name | Type | Description | Default | Optional |
|---|---|---|---|---|
| symbol | str | Stock ticker symbol to get sentiment for | None | False |
| n_tweets | int | Number of tweets to get per hour | 15 | True |
| n_days_past | int | Number of days to extract tweets for | 2 | True |
Returns
| Type | Description |
|---|---|
| pd.DataFrame | Dataframe of sentiment |
Plots sentiments from symbol
Source Code: [link]
openbb.stocks.ba.sentiment_chart(symbol: str, n_tweets: int = 15, n_days_past: int = 2, compare: bool = False, export: str = "", external_axes: Optional[List[matplotlib.axes._axes.Axes]] = None)
Parameters
| Name | Type | Description | Default | Optional |
|---|---|---|---|---|
| symbol | str | Stock ticker symbol to get sentiment for | None | False |
| n_tweets | int | Number of tweets to get per hour | 15 | True |
| n_days_past | int | Number of days to extract tweets for | 2 | True |
| compare | bool | Show corresponding change in stock price | False | True |
| export | str | Format to export tweet dataframe | 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