jerry/OpenBB
1
0
Fork 0
mirror of https://github.com/OpenBB-finance/OpenBB.git synced 2026-10-28 21:12:16 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
f68929fa1efaa5e9abb7911029e287c975b37fd3
OpenBB/website/content/sdk/reference/stocks/qa/beta.md
jose-donato 2e7eb4c9b6 New documentation website (#3526) 
* fix(docs): added margin between sections

* feat: removed unused files; updated ga

* fix: juan stuff doesnt work

* fix: random fix

* moon at noon

* fix: update docusaurus config

* Update controller_doc_classes.py

* fix: temp fix

* fix: temp fix

* Update controller_doc_classes.py

* fix: remove old content

* fix: taggfix

* init

* fix: styling and moved file

* Update generate_terminal_markdown.py

* fix: removed unused images

* fix: port new files

* Update generate_sdk_markdown.py

* Update controller_doc_classes.py

Co-authored-by: teh_coderer <me@tehcoderer.com>
2022-11-22 16:47:03 +00:00

2.4 KiB
Vendored
Raw Blame History

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