mret
- Model
- Chart
Get monthly returns
Source Code: [link]
openbb.portfolio.mret(portfolio_engine: portfolio_engine.PortfolioEngine, window: str = "all")
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 |
Returns
Type | Description |
---|---|
pd.DataFrame | DataFrame with monthly returns |
Examples
from openbb_terminal.sdk import openbb
p = openbb.portfolio.load("openbb_terminal/miscellaneous/portfolio/holdings_example.xlsx")
output = openbb.portfolio.mret(p)
Display monthly returns
Source Code: [link]
openbb.portfolio.mret_chart(portfolio_engine: portfolio_engine.PortfolioEngine, window: str = "all", instrument: str = "both", graph: bool = False, show_vals: bool = False, export: str = "", sheet_name: Optional[str] = None, external_axes: 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 |
window | str | interval to compare cumulative returns and benchmark | all | True |
instrument | str | Display raw data from cumulative return, default is showing both the portfolio and benchmark in one table | both | True |
show_vals | False | Show values on heatmap | False | True |
export | str | Export certain type of data | True | |
sheet_name | str | Whether to export to a specific sheet name in an Excel file | None | True |
external_axes | bool | Whether to return the figure object or not, by default False | False | True |
Returns
This function does not return anything