jerry/OpenBB
1
0
Fork 0
mirror of https://github.com/OpenBB-finance/OpenBB.git synced 2026-11-03 07:51:49 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
9a9cc14ec145f4133e69a389f8a032e35fee2ea3
OpenBB/website/versioned_docs/version-v3/sdk/reference/portfolio/summary.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.2 KiB
Vendored
Raw Blame History

title, description
title description
summary OpenBB SDK Function

summary

Get portfolio and benchmark returns summary

Source Code: [link]

openbb.portfolio.summary(portfolio_engine: portfolio_engine.PortfolioEngine, window: str = "all", risk_free_rate: float = 0)

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
window str interval to compare cumulative returns and benchmark all True
risk_free_rate float Risk free rate for calculations 0 True

Returns

Type Description
pd.DataFrame DataFrame with portfolio and benchmark returns summary

Examples

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