jerry/OpenBB
1
0
Fork 0
mirror of https://github.com/OpenBB-finance/OpenBB.git synced 2026-10-28 13:01:38 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
f68929fa1efaa5e9abb7911029e287c975b37fd3
OpenBB/website/content/sdk/reference/stocks/ba/headlines.md
jose-donato 2e7eb4c9b6 New documentation website (#3526) 
* 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>
2022-11-22 16:47:03 +00:00

1.7 KiB
Vendored
Raw Blame History

title, description
title description
headlines OpenBB SDK Function

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

headlines

Gets Sentiment analysis provided by FinBrain's API [Source: finbrain].

Source Code: [link]

openbb.stocks.ba.headlines(symbol: str)

Parameters

Name Type Description Default Optional
symbol str Ticker symbol to get the sentiment analysis from None False

Returns

Type Description
pd.DataFrame Empty if there was an issue with data retrieval

Plots Sentiment analysis from FinBrain. Prints table if raw is True. [Source: FinBrain]

Source Code: [link]

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

Parameters

Name Type Description Default Optional
symbol str Ticker symbol to get the sentiment analysis from None False
raw False Display raw table data 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