jerry/OpenBB
1
0
Fork 0
mirror of https://github.com/OpenBB-finance/OpenBB.git synced 2026-11-07 01:41:17 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
e7abffee64aec08ab29107534b4e2fe49d2fe552
OpenBB/website/versioned_docs/version-v3/sdk/reference/portfolio/perf.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

1.1 KiB
Vendored
Raw Blame History

title, description
title description
perf OpenBB SDK Function

perf

Get portfolio performance vs the benchmark

Source Code: [link]

openbb.portfolio.perf(portfolio_engine: portfolio_engine.PortfolioEngine, show_all_trades: 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
show_all_trades bool Whether to also show all trades made and their performance (default is False) False True

Returns

Type Description
pd.DataFrame DataFrame with portfolio performance vs the benchmark

Examples

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