mirror of https://github.com/OpenBB-finance/OpenBB.git synced 2026-11-02 23:41:27 +00:00

Files

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

title, description

title	description
load	OpenBB SDK Function

load

Get PortfolioEngine object

Source Code: [link]

openbb.portfolio.load(transactions_file_path: str, benchmark_symbol: str = "SPY", full_shares: bool = False, risk_free_rate: float = 0)

Parameters

Name	Type	Description	Default	Optional
transactions_file_path	str	Path to transactions file	None	False
benchmark_symbol	str	Benchmark ticker to download data	SPY	True
full_shares	bool	Whether to mimic the portfolio trades exactly (partial shares) or round down the quantity to the nearest number	False	True
risk_free_rate	float	Risk free rate in float format	0	True

Type	Description
PortfolioEngine	PortfolioEngine class instance, this will hold transactions and perform calculations

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