holdv
- Model
- Chart
Get holdings of assets (absolute value)
Source Code: [link]
openbb.portfolio.holdv(portfolio_engine: portfolio_engine.PortfolioEngine)
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 |
Returns
Type | Description |
---|---|
pd.DataFrame | DataFrame of holdings value |
Examples
from openbb_terminal.sdk import openbb
p = openbb.portfolio.load("openbb_terminal/miscellaneous/portfolio/holdings_example.xlsx")
output = openbb.portfolio.holdv(p)
Display holdings of assets (absolute value)
Source Code: [link]
openbb.portfolio.holdv_chart(portfolio_engine: portfolio_engine.PortfolioEngine, unstack: bool = False, raw: bool = False, limit: int = 10, 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 |
unstack | bool | Individual assets over time | False | True |
raw | bool | To display raw data | False | True |
limit | int | Number of past market days to display holdings | 10 | True |
sheet_name | str | Optionally specify the name of the sheet the data is exported to. | None | True |
export | str | Format to export plot | True | |
external_axes | bool | Whether to return the figure object or not, by default False | False | True |
Returns
This function does not return anything