breakpoints
Fama-French breakpoints.
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#Breakpoints
Examples
from openbb import obb
# Get US breakpoints used for constructing the research portfolios.
obb.famafrench.breakpoints(provider='famafrench')
# See the parameters description for details on the breakpoints.
obb.famafrench.breakpoints(provider='famafrench', breakpoint=op, start_date=1998-01-01)
Parameters
- standard
- famafrench
breakpoint_type: Literal['me', 'be-me', 'op', 'inv', 'e-p', 'cf-p', 'd-p', '2-12']
Description
Type of breakpoint to fetch.
The breakpoints for month t use all NYSE stocks that have a CRSP share code of 10 or 11
and have good shares and price data. We exclude closed end funds and REITs.
Breakpoints are computed either monthly or annually, see the description of each breakpoint type below.
Data contains every fifth percentile, from 5% to 100%.
ME
--
Market Equity. Market equity (size) is price times shares outstanding.
Price and shares outstanding are from CRSP.
ME breakpoints are computed for each month.
It is price times shares outstanding (divided by 1,000,000) at month end.
BE/ME
-----
BE/ME breakpoints are computed at the end of each June.
The BE used in June of year t is the book equity for the last fiscal year end in t-1.
ME is price times shares outstanding at the end of December of t-1.
The breakpoints for year t use all NYSE stocks for which we have ME for December of t-1
and (positive) BE for the last fiscal year end in t-1.
Operating Profitability
-----------------------
Operating Profitability breakpoints are computed at the end of each June.
OP for June of year t is annual revenues minus
- cost of goods sold
- interest expense
- selling, general, and administrative expenses
divided by book equity for the last fiscal year end in t-1.
Please be aware that some of the value-weight averages of operating profitability for deciles 1 and 10 are extreme.
These are driven by extraordinary values of OP for individual firms.
We have spot checked the accounting data that produce the extraordinary values
and all the numbers we examined accurately reflect the data in the firm's accounting statements.
The breakpoints for year t use all NYSE stocks for which we have (positive) book equity data for t-1,
non-missing revenues data for t-1, and non-missing data for at least one of the following:
- cost of goods sold
- selling, general and administrative expenses
- interest expense for t-1.
Investment
----------
Investment breakpoints are computed at the end of each June.
Inv used in June of year t is the change in total assets from the fiscal year ending in year t-2
to the fiscal year ending in t-1, divided by t-2 total assets.
The breakpoints for year t use all NYSE stocks for which we have total assets data for t-2 and t-1.
E/P
---
E/P (in percent) breakpoints are computed at the end of each June.
The E used in June of year t is the earnings for the last fiscal year end in t-1.
P (actually ME) is price times shares outstanding at the end of December of t-1.
The breakpoints for year t use all NYSE stocks for which we have ME for December of t-1
and (positive) earnings for the last fiscal year end in t-1.
CF/P
----
CF/P (in percent) breakpoints is computed at the end of each June.
The CF used in June of year t is the cash flow for the last fiscal year end in t-1.
P (actually ME) is price times shares outstanding at the end of December of t-1.
The breakpoints for year t use all NYSE stocks for which we have ME for December of t-1
and (positive) cash flow for the last fiscal year end in t-1.
D/P
---
D/P (in percent) breakpoints are computed at the end of each June.
The dividend yield in June of year t is the total dividends paid from July of t-1
to June of t per dollar of equity in June of t.
The breakpoints for year t use NYSE stocks for which we have at least
seven months (to compute the dividend yield) from July of t-1 to June of t.
(Only six monthly returns are required in June 1926.)
We do not include stocks that pay no dividends from July of t-1 to June of t.
Prior 2-12
----------
Prior return breakpoints are computed for each month.
The prior return at the end of month t is the cumulative return from month t-11 to month t-1.
The breakpoints for month t use NYSE stocks.
To be included, a stock must have a price for the end of month t-12 and a good return for t-1.
In addition, any missing returns from t-11 to t-2 must be -99.0, CRSP's code for a missing price.
• Default: me
• Optional: True
start_date: Union[date, str]
Start date for the data.
• Optional: True
end_date: Union[date, str]
End date for the data.
• Optional: True
Returns
results: list[FamaFrenchBreakpoints]
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
- standard
- famafrench
date: Union[date, str]
Date of the data.
num_firms: int
Number of firms in the sample. Not returned for BE/ME breakpoints.
num_firms_less_than_0: int
Number of firms with ratio less than or equal to 0. This is only applicable for ratio breakpoints.
num_firms_greater_than_0: int
Number of firms with ratio greater than 0. This is only applicable for ratio breakpoints.
percentile_5: float
Fifth percentile of the sample.
percentile_10: float
Tenth percentile of the sample.
percentile_15: float
Fifteenth percentile of the sample.
percentile_20: float
Twentieth percentile of the sample.
percentile_25: float
Twenty-fifth percentile of the sample.
percentile_30: float
Thirtieth percentile of the sample.
percentile_35: float
Thirty-fifth percentile of the sample.
percentile_40: float
Fortieth percentile of the sample.
percentile_45: float
Forty-fifth percentile of the sample.
percentile_50: float
Fiftieth percentile of the sample.
percentile_55: float
Fifty-fifth percentile of the sample.
percentile_60: float
Sixtieth percentile of the sample.
percentile_65: float
Sixty-fifth percentile of the sample.
percentile_70: float
Seventieth percentile of the sample.
percentile_75: float
Seventy-fifth percentile of the sample.
percentile_80: float
Eightieth percentile of the sample.
percentile_85: float
Eighty-fifth percentile of the sample.
percentile_90: float
Ninetieth percentile of the sample.
percentile_95: float
Ninety-fifth percentile of the sample.
percentile_100: float
Hundredth percentile of the sample.