Skip to content

plot_vwap


function backtide.analysis.vwap.plot_vwap(data, title=None, legend="upper left", figsize=(900, 600), filename=None, display=True)[source]

Create a VWAP (Volume-Weighted Average Price) chart.

Displays the cumulative VWAP alongside the closing price (dashed line) for one or more symbols. VWAP is a key benchmark used to assess whether a security was bought or sold at a favorable price relative to volume.

Parameters

data : pd.DataFrame | pl.DataFrame

Input data containing columns symbol, close, high, low, volume and dt with the datetime.

title : str | dict | None, default=None
Title for the plot.

legend : str | dict | None, default="upper left"
Legend for the plot. See the user guide for an extended description of the choices.

  • If None: No legend is shown.
  • If str: Position to display the legend.
  • If dict: Legend configuration.

figsize : tuple[int, int], default=(900, 600)
Figure's size in pixels, format as (x, y).

filename : str | Path | None, default=None
Save the plot using this name. The type of the file depends on the provided name (.html, .png, .pdf, etc...). If filename has no file type, the plot is saved as .html. If None, the plot isn't saved.

display : bool | None, default=True
Whether to render the plot. If None, it returns the figure.

Returns

Figure | None

The Plotly figure object. Only returned if display=None.


See Also

plot_candlestick

Create a candlestick chart.

plot_price

Create a price line chart.

plot_volume

Create a trading volume bar chart.


Example

>>> import pandas as pd

>>> from backtide.storage import query_bars
>>> from backtide.analysis import plot_vwap

>>> df = query_bars(["AAPL", "MSFT"], "1d")
>>> plot_vwap(df)