bayesline.api.equity.PortfolioName

model PortfolioName

A portfolio identifier enriched with metadata used by the picker UI.

The GUI uses this to render the portfolio list with awareness of fund-of-funds structure: portfolios with fof_depth > 0 are parents that can be expanded hierarchically (see PortfolioHierarchySettings.auto_decompose_levels).

Fields

Field	Type	Required	Default
fof_depth	int	No	0
name	str	Yes

field fof_depth: int [Optional]

Maximum descent depth from this portfolio in its source’s fund-of-funds graph. 0 for a leaf or a portfolio with no FoF children; N for a parent whose deepest reachable descendant is N levels below it.

field name: str [Required]

The portfolio identifier.