jerry/OpenBB
1
0
Fork 0
mirror of https://github.com/OpenBB-finance/OpenBB.git synced 2026-11-03 07:51:49 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
cd08218c35aed534ad59309ff2ca99d08e94de6a
OpenBB/website/content/sdk/reference/stocks/ca/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.5 KiB
Vendored
Raw Blame History

title, description, keywords
title description keywords
sentiment The page provides detailed information about Sentiment Analysis functions provided by the OpenBB Finance Terminal. It guides users on how to retrieve sentiment analysis for several symbols using FinBrain's API and how to display the sentiment for all ticker.
API
Sentiment Analysis
Finance
Terminal
FinBrain
Ticker
Symbols
Finviz_peers
Finnhub_peers
Polygon_peers
Data visualization
matplotlib
Data Export
Sentiment chart

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

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

Gets Sentiment analysis from several symbols provided by FinBrain's API.

Source Code: [link]

openbb.stocks.ca.sentiment(symbols: List[str])

Parameters

Name Type Description Default Optional
symbols List[str] List of tickers to get sentiment.
Comparable companies can be accessed through
finnhub_peers(), finviz_peers(), polygon_peers().		 None False

Returns

Type Description
pd.DataFrame Contains sentiment analysis from several tickers

Display sentiment for all ticker. [Source: FinBrain].

Source Code: [link]

openbb.stocks.ca.sentiment_chart(similar: List[str], raw: bool = False, export: str = "", external_axes: Optional[List[matplotlib.axes._axes.Axes]] = None)

Parameters

Name Type Description Default Optional
similar List[str] Similar companies to compare income with.
Comparable companies can be accessed through
finviz_peers(), finnhub_peers() or polygon_peers().		 None False
raw bool Output raw values, by default False False True
export str Format to export data 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