mirror of
https://github.com/OpenBB-finance/OpenBB.git
synced 2026-11-03 07:51:49 +00:00
4ad995fdd0
* 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>
61 lines
1.8 KiB
Markdown
Vendored
61 lines
1.8 KiB
Markdown
Vendored
---
|
|
title: summary
|
|
description: OpenBB finance page detailing the functionality to gather portfolio and
|
|
benchmark return summaries. Documentation includes function parameters, return types
|
|
and examples. The core function openbb.portfolio.summary can perform complex calculations
|
|
and return a data frame of portfolio and benchmark returns summary.
|
|
keywords:
|
|
- OpenBB finance
|
|
- portfolio summary
|
|
- benchmark returns
|
|
- portfolio transactions
|
|
- portfolio calculations
|
|
- cumulative returns
|
|
- risk free rate
|
|
- data frame
|
|
- openbb.portfolio
|
|
- portfolio engine
|
|
---
|
|
|
|
import HeadTitle from '@site/src/components/General/HeadTitle.tsx';
|
|
|
|
<HeadTitle title="portfolio.summary - Reference | OpenBB SDK Docs" />
|
|
|
|
Get portfolio and benchmark returns summary
|
|
|
|
Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/portfolio/portfolio_model.py#L692)]
|
|
|
|
```python
|
|
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.<br/>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
|
|
|
|
```python
|
|
from openbb_terminal.sdk import openbb
|
|
p = openbb.portfolio.load("openbb_terminal/miscellaneous/portfolio_examples/holdings/example.csv")
|
|
output = openbb.portfolio.summary(p)
|
|
```
|
|
|
|
---
|