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/hist.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

3.2 KiB
Vendored
Raw Blame History

title, description, keywords
title description keywords
hist Python code examples using OpenBB Terminal to retrieve, visualize and manipulate historical stock prices from Yahoo Finance for a list of comparison stocks. The code covers data acquisition, charting of historical prices, and export functionalities.
stock comparison
historical stock prices
data visualization
Python code
Yahoo Finance
stock market analysis
stock price chart
stock data export
data manipulation
stock data normalization
Comparable companies
Finnhub peers
Finnviz peers
Polygon peers

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

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

Get historical prices for all comparison stocks

Source Code: [link]

openbb.stocks.ca.hist(similar: List[str], start_date: Optional[str] = None, candle_type: str = "a")

Parameters

Name Type Description Default Optional
similar List[str] List of similar tickers.
Comparable companies can be accessed through
finnhub_peers(), finviz_peers(), polygon_peers().		 None False
start_date Optional[str] Initial date (e.g., 2021-10-01). Defaults to 1 year back None True
candle_type str Candle variable to compare, by default "a" for Adjusted Close. Possible values are: o, h, l, c, a, v, r a True

Returns

Type Description
pd.DataFrame Dataframe containing candle type variable for each ticker

Display historical stock prices. [Source: Yahoo Finance]

Source Code: [link]

openbb.stocks.ca.hist_chart(similar: List[str], start_date: Optional[str] = None, candle_type: str = "a", normalize: bool = True, export: str = "", external_axes: Optional[List[matplotlib.axes._axes.Axes]] = None)

Parameters

Name Type Description Default Optional
similar List[str] List of similar tickers.
Comparable companies can be accessed through
finnhub_peers(), finviz_peers(), polygon_peers().		 None False
start_date Optional[str] Initial date (e.g., 2021-10-01). Defaults to 1 year back None True
candle_type str OHLCA column to use or R to use daily returns calculated from Adjusted Close, by default "a" for Adjusted Close a True
normalize bool Boolean to normalize all stock prices using MinMax defaults True True True
export str Format to export historical prices, by default "" 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