mirror of
https://github.com/OpenBB-finance/OpenBB.git
synced 2026-11-01 23:12:21 +00:00
2e7eb4c9b6
* 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>
81 lines
2.4 KiB
Markdown
Vendored
81 lines
2.4 KiB
Markdown
Vendored
---
|
|
title: beta
|
|
description: OpenBB SDK Function
|
|
---
|
|
|
|
import Tabs from '@theme/Tabs';
|
|
import TabItem from '@theme/TabItem';
|
|
|
|
# beta
|
|
|
|
<Tabs>
|
|
<TabItem value="model" label="Model" default>
|
|
|
|
Calculate beta for a ticker and a reference ticker.
|
|
|
|
Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/stocks/quantitative_analysis/beta_model.py#L11)]
|
|
|
|
```python
|
|
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 |
|
|
---
|
|
|
|
|
|
|
|
</TabItem>
|
|
<TabItem value="view" label="Chart">
|
|
|
|
Display the beta scatterplot + linear regression.
|
|
|
|
Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/stocks/quantitative_analysis/beta_view.py#L18)]
|
|
|
|
```python
|
|
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
|
|
|
|
---
|
|
|
|
|
|
|
|
</TabItem>
|
|
</Tabs> |