Files
OpenBB/website/versioned_docs/version-v3/sdk/reference/stocks/qa/beta.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

2.4 KiB
Vendored

title, description
title description
beta OpenBB SDK Function

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

beta

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