mirror of
https://github.com/OpenBB-finance/OpenBB.git
synced 2026-10-28 13:01:38 +00:00
79046608b6
* Update generate_terminal_markdown.py * updates * update workflows * Automated Change * tests * tests * Automated Change * Update test_generate_docs.py * Automated Change * updates * Automated Change * Update gen-docs.yml * Update test.yml * Automated Change * Update test.yml * Automated Change * Update generate_sdk_markdown.py * Automated Change * test * Automated Change * testtt23 * Automated Change * Update generate_sdk_markdown.py * Automated Change * Automated Change * added empting reference folders before autogen docs * updates * Automated Change * update tests gitactions * Automated Change * up * Automated Change * Automated Change * update pytest * Automated Change * tests * Automated Change * examples update * Automated Change * Update generate_sdk_markdown.py * Automated Change * Update test.yml * Update generate_sdk_markdown.py * strip * Automated Change * Workflow : check test update * Automated Change * Automated Change * Automated Change * Update test.yml * Automated Change * Update test.yml * Automated Change * Automated Change * up * Automated Change * Update generate_sdk_markdown.py * Automated Change * update workflows * fix guides * testing * Update gh-pages.yml * Update gh-pages.yml Co-authored-by: tehcoderer <tehcoderer@users.noreply.github.com> Co-authored-by: Jeroen Bouma <jer.bouma@gmail.com> Co-authored-by: Chavithra PARANA <chavithra@gmail.com> Co-authored-by: Chavithra <Chavithra@users.noreply.github.com> Co-authored-by: jose-donato <43375532+jose-donato@users.noreply.github.com> Co-authored-by: jose-donato <jose-donato@users.noreply.github.com>
2.0 KiB
Vendored
2.0 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: Optional[str] = None, end_date: Optional[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 | Optional[str] | Initial date, format YYYY-MM-DD | None | True |
| end_date | Optional[str] | Final date, format YYYY-MM-DD | 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