bayesline.api.equity.PortfolioName

pydantic model bayesline.api.equity.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).

Show JSON schema

{
   "title": "PortfolioName",
   "description": "A portfolio identifier enriched with metadata used by the picker UI.\n\nThe GUI uses this to render the portfolio list with awareness of\nfund-of-funds structure: portfolios with ``fof_depth > 0`` are\nparents that can be expanded hierarchically (see\n``PortfolioHierarchySettings.auto_decompose_levels``).",
   "type": "object",
   "properties": {
      "name": {
         "description": "The portfolio identifier.",
         "title": "Name",
         "type": "string"
      },
      "fof_depth": {
         "default": 0,
         "description": "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.",
         "title": "Fof Depth",
         "type": "integer"
      }
   },
   "required": [
      "name"
   ]
}

Config:

• frozen: bool = True

Fields:

• fof_depth (int)

• name (str)

field name: str [Required]

The portfolio identifier.

field fof_depth: int = 0

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.