Skip to main content

country_portfolio_returns

Country portfolio returns.

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

Source

https://mba.tuck.dartmouth.edu/pages/faculty/ken.french/data_library.html

We form value and growth portfolios in each country using four valuation ratios:

  • book-to-market (B/M)
  • earnings-price (E/P)
  • cash earnings to price (CE/P)
  • dividend yield (D/P)

We form the portfolios at the end of December each year by sorting on one of the four ratios and then compute value-weighted returns for the following 12 months.

The value portfolios (High) contain firms in the top 30% of a ratio and the growth portfolios (Low) contain firms in the bottom 30%.

There are two sets of portfolios.

In one, firms are included only if we have data on all four ratios.

In the other, a firm is included in a sort variable's portfolios if we have data for that variable.

The market return (Mkt) for the first set is the value weighted average of the returns for only firms with all four ratios.

The market return for the second set includes all firms with book-to-market data, and Firms is the number of firms with B/M data.

Examples

from openbb import obb
# Get model Country portfolio returns used for constructing the Fama-French Factor models.
obb.famafrench.country_portfolio_returns(provider='famafrench')
# Parameters are different than the regional and US portfolio returns.
obb.famafrench.country_portfolio_returns(provider='famafrench', frequency=annual, measure=local, country=japan, dividends=False, all_data_items_required=False)

Parameters


Returns

results: list[FamaFrenchCountryPortfolioReturns]

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