symbol

property Portfolio.symbol

Return a text symbol of portfolio.

Symbols are similar to tickers but have a namespace information:

  • SPY.US is a symbol

  • SPY is a ticker

Portfolios have ‘.PF’ as a namespace.

Returns:
str

Text symbol of the portfolio.

Examples

>>> p = ok.Portfolio()
>>> p.symbol  # a randomly generated symbol will be shown
'portfolio_5312.PF'

>>> p.symbol = "spy_portfolo.PF"  # The symbol can be customized after initialization

New Portfolio can have a custom symbol.

>>> p = ok.Portfolio(symbol="aggressive.PF")
>>> p.symbol
'aggressive.PF'