Skip to main content

regional_portfolio_returns

Regional portfolio returns.

Metadata for the selected dataset are returned in the extra['results_metadata'] field of the response.

See the us_portfolio_returns endpoint for more details.

Examples

from openbb import obb
# Get model Regional portfolio returns used for constructing the Fama-French Factor models.
obb.famafrench.regional_portfolio_returns(provider='famafrench')
# Get portfolios formed by equal-weight, with annual returns.
obb.famafrench.regional_portfolio_returns(provider='famafrench', frequency=annual, measure=equal)

Parameters


Returns

results: list[FamaFrenchRegionalPortfolioReturns]

Serializable results.


provider: Optional[Literal['famafrench']]

Provider name.


warnings: Optional[list[Warning_]]

list of warnings.


chart: Optional[Chart]

Chart object.


extra: dict[str, Any]

Extra info.


Data