mirror of
https://github.com/OpenBB-finance/OpenBB.git
synced 2026-11-05 00:42:19 +00:00
* 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>
1.9 KiB
Vendored
1.9 KiB
Vendored
title, description
| title | description |
|---|---|
| vwap | OpenBB SDK Function |
import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem';
vwap
Gets volume weighted average price (VWAP)
Source Code: [link]
openbb.ta.vwap(data: pd.Series, offset: int = 0)
Parameters
| Name | Type | Description | Default | Optional |
|---|---|---|---|---|
| data | pd.DataFrame | Dataframe of dates and prices | None | False |
| offset | int | Length of offset | 0 | True |
Returns
| Type | Description |
|---|---|
| pd.DataFrame | Dataframe with VWAP data |
Plots VWMA technical indicator
Source Code: [link]
openbb.ta.vwap_chart(data: pd.DataFrame, symbol: str = "", start_date: str = None, end_date: str = None, offset: int = 0, interval: str = "", export: str = "", external_axes: Optional[List[matplotlib.axes._axes.Axes]] = None)
Parameters
| Name | Type | Description | Default | Optional |
|---|---|---|---|---|
| data | pd.DataFrame | Dataframe of OHLC prices | None | False |
| symbol | str | Ticker | True | |
| offset | int | Offset variable | 0 | True |
| start_date | datetime | Start date to get data from with | None | True |
| end_date | datetime | End date to get data from with | None | True |
| interval | str | Interval of data | True | |
| export | str | Format to export data | True | |
| external_axes | Optional[List[plt.Axes]] | External axes (3 axes are expected in the list), by default None | None | True |
Returns
This function does not return anything