Files
OpenBB/website/content/sdk/reference/stocks/qa/beta.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.9 KiB
Vendored

title, description, keywords
title description keywords
beta Learn how to calculate beta for a ticker and a reference ticker, and display it with a scatterplot and linear regression, using OpenBB - an open source finance tool. The page includes source code and parameters to correctly perform and visualize these actions.
Docusaurus page optimization
Beta calculation
Ticker symbol
Reference ticker symbol
Stock market analysis
Quantitative analysis
Data visualization
Scatterplot
Linear regression
Open source finance

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

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

Calculate beta for a ticker and a reference ticker.

Source Code: [link]

openbb.stocks.qa.beta(symbol: str, ref_symbol: str, data: pd.DataFrame = None, ref_data: pd.DataFrame = None, interval: int = 1440)

Parameters

Name Type Description Default Optional
symbol str A ticker to calculate beta for None False
ref_symbol str A reference ticker symbol for the beta calculation (default in terminal is SPY) None False
data pd.DataFrame The selected ticker symbols price data None True
ref_data pd.DataFrame The reference ticker symbols price data None True
interval int The interval of the ref_data. This will ONLY be used if ref_data is None 1440 True

Returns

Type Description
Tuple[pd.Series, pd.Series, float, float] Stock ticker symbols close-to-close returns, Reference ticker symbols close-to-close returns, beta, alpha

Display the beta scatterplot + linear regression.

Source Code: [link]

openbb.stocks.qa.beta_chart(symbol: str, ref_symbol: str, data: pd.DataFrame = None, ref_data: pd.DataFrame = None, interval: int = 1440, export: str = "")

Parameters

Name Type Description Default Optional
symbol str A ticker to calculate beta for None False
ref_symbol str A reference ticker symbol for the beta calculation (default in terminal is SPY) None False
data pd.DataFrame The selected ticker symbols price data None True
ref_data pd.DataFrame The reference ticker symbols price data None True
interval int The interval of the ref_data. This will ONLY be used if ref_data is None 1440 True

Returns

This function does not return anything