jerry/OpenBB
1
0
Fork 0
mirror of https://github.com/OpenBB-finance/OpenBB.git synced 2026-11-01 06:51:38 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
948d2ef29900c48ec26616eb48ba952aaaadd883
OpenBB/website/content/sdk/reference/portfolio/load.md
DidierRLopes 4ad995fdd0 Docs/terminalpro and improvement (#5622) 
* add first iteration of content for Terminal Pro

* Update index.md

* Update dashboards.md

* Update folders.md

* Update grouping.md

* Update report.md

* Update templates.md

* Update quick-start.md

* Update index.md

* Update index.md

* Update home.md

* Update news.md

* Update index.md

* Update index.md

* Update index.md

* Update data-provider.md

* Update chat-with-widget.md

* Update data-manipulation.md

* Update forecasting.md

* fix: images self closing tags

* fix: only pro visitors can see pro

* inter font

* improve SEO content and restructuring

* add new package for toggle on tutorials

* move folder around

* improve main page of each prod

* small updates and improvements

* fix logo above

* small improvement in headtitle for portfolio funcs

* fix typos from OpenAI's GPT-4

* fix _category_ json

* remove generic SEO words

* add script that generates SEO for documentation

* add missing file

* remove sdk warning message

* fix links for andrew

---------

Co-authored-by: jose-donato <zmcdonato@gmail.com>
Co-authored-by: jose-donato <43375532+jose-donato@users.noreply.github.com>
Co-authored-by: andrewkenreich <andrew.kenreich@gmail.com>
2023-10-30 21:01:29 +00:00

1.7 KiB
Vendored
Raw Blame History

title, description, keywords
title description keywords
load Docusaurus documentation for the load function from the openbb portfolio module. Provides details about parameters and examples of how to use this function to create a PortfolioEngine instance and perform portfolio calculations.
PortfolioEngine object
openbb portfolio
transactions file path
benchmark symbol
full shares
risk free rate
portfolio calculations
openbb_terminal sdk
Portfolio management

import HeadTitle from '@site/src/components/General/HeadTitle.tsx';

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

Returns

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

Examples

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