Files
OpenBB/website/content/sdk/reference/stocks/ba/sentiment.md
DidierRLopes 4ad995fdd0 Docs/terminalpro and improvement (#5622)
* 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>
2023-10-30 21:01:29 +00:00

2.6 KiB
Vendored

title, description, keywords
title description keywords
sentiment This page provides documentation on extracting sentiment from a stock ticker symbol, which includes the parameters for the number of tweets per hour, number of days to extract tweets for, an optional comparison to the corresponding change in stock price, and an optional export format. Plots sentiments can also be visualized using the provided python codes.
sentiment analysis
stock ticker symbol
tweets per hour
extract tweets
stock price
dataframe
python code
plot sentiments
export format

import HeadTitle from '@site/src/components/General/HeadTitle.tsx';

import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem';

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