mirror of
https://github.com/OpenBB-finance/OpenBB.git
synced 2026-11-03 07:51:49 +00:00
4ad995fdd0
* 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>
3.0 KiB
Vendored
3.0 KiB
Vendored
title, description, keywords
| title | description | keywords | ||||||
|---|---|---|---|---|---|---|---|---|
| hist | This page provides coding tutorials on how to get hour-level sentiment data for a chosen stock symbol and display the historical sentiment data of a ticker using OpenBB tools. It also includes source codes, parameters, and return information. |
|
import HeadTitle from '@site/src/components/General/HeadTitle.tsx';
import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem';
Get hour-level sentiment data for the chosen symbol.
Source Code: [link]
openbb.stocks.ba.hist(symbol: str, start_date: Optional[str] = None, end_date: Optional[str] = None, number: int = 100)
Parameters
| Name | Type | Description | Default | Optional |
|---|---|---|---|---|
| symbol | str | Ticker to view sentiment data | None | False |
| start_date | Optional[str] | Initial date like string or unix timestamp (e.g. 12-21-2021) | None | True |
| end_date | Optional[str] | End date like string or unix timestamp (e.g. 12-21-2021) | None | True |
| number | int | Number of results returned by API call Maximum 250 per api call |
100 | True |
Returns
| Type | Description |
|---|---|
| pd.DataFrame | Dataframe of historical sentiment |
Display historical sentiment data of a ticker,
Source Code: [link]
openbb.stocks.ba.hist_chart(symbol: str, start_date: Optional[str] = None, end_date: Optional[str] = None, number: int = 100, raw: bool = False, limit: int = 10, export: str = "", external_axes: Optional[List[matplotlib.axes._axes.Axes]] = None)
Parameters
| Name | Type | Description | Default | Optional |
|---|---|---|---|---|
| symbol | str | Ticker symbol to view sentiment data | None | False |
| start_date | Optional[str] | Initial date like string or unix timestamp (e.g. 2021-12-21) | None | True |
| end_date | Optional[str] | End date like string or unix timestamp (e.g. 2022-01-15) | None | True |
| number | int | Number of results returned by API call Maximum 250 per api call |
100 | True |
| raw | boolean | Whether to display raw data, by default False | False | True |
| limit | int | Number of results display on the terminal Default: 10 |
10 | True |
| export | str | Format to export data | True | |
| external_axes | Optional[List[plt.Axes]] | External axes (2 axes are expected in the list), by default None | None | True |
Returns
This function does not return anything