Files
OpenBB/website/versioned_docs/version-v3/sdk/reference/ta/vwap.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.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.DataFrame, 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