bench

Load benchmark into portfolio

Source Code: [link]

openbb.portfolio.bench(portfolio_engine: portfolio_engine.PortfolioEngine, symbol: str, full_shares: bool = False)

---

Parameters

Name	Type	Description	Default	Optional
portfolio_engine	PortfolioEngine	PortfolioEngine class instance, this will hold transactions and perform calculations. Use portfolio.load to create a PortfolioEngine.	None	False
symbol	str	Benchmark symbol to download data	None	False
full_shares	bool	Whether to mimic the portfolio trades exactly (partial shares) or round down the quantity to the nearest number	False	True

---

Returns

This function does not return anything

---

Examples

from openbb_terminal.sdk import openbb
p = openbb.portfolio.load("openbb_terminal/miscellaneous/portfolio_examples/holdings/example.csv")
output = openbb.portfolio.bench(p, symbol="SPY")

---