Files
OpenBB/website/versioned_docs/version-v3/sdk/reference/crypto/dd/headlines.md
Theodore Aptekarev f72bc8ccec Add Versioned Documentation (#5470)
* Adding versioning to docs

---------

Co-authored-by: andrewkenreich <andrew.kenreich@gmail.com>
Co-authored-by: tehcoderer <me@tehcoderer.com>
2023-09-29 11:49:05 +02:00

1.7 KiB
Vendored

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.crypto.dd.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

Sentiment analysis from FinBrain for Cryptocurrencies

Source Code: [link]

openbb.crypto.dd.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 Cryptocurrency None False
raw False Display raw table data False True
export str Export dataframe data to csv,json,xlsx file 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