mirror of https://github.com/OpenBB-finance/OpenBB.git synced 2026-10-30 14:02:06 +00:00

Files

Danglewood 3160a84ad0 [Release] openbb-core: Pin Version of FastAPI to 0.136.3 (#7531 )

* bump minimum version of fastapi to get starlette > 1

* fix test fixture broken by newer version of vitest

* another round of lock file syncs

* need to pin fastapi until breaking changes in 0.137 can be dealt with

* relock cli

* cli needs to run openbb-build before running test suite

* wrong solution, cli needs fastapi pin until handled. revert nox

2026-06-24 15:27:50 +00:00

openbb_famafrench

[Feature] Pandas 3.0 - Update Library For Syntax (#7336 )

2026-01-29 00:41:55 +00:00

tests

[Feature] Remove Python 3.9 (#7235 )

2025-10-10 23:16:16 +00:00

__init__.py

[Feature] Remove Static Assets For Distribution (#7212 )

2025-09-09 17:05:33 +00:00

poetry.lock

[Release] openbb-core: Pin Version of FastAPI to 0.136.3 (#7531 )

2026-06-24 15:27:50 +00:00

pyproject.toml

[Release] Merge Release From Main (#7516 )

2026-05-27 19:20:59 +00:00

README.md

[Feature] Add Fama-French Data Library (#7163 )

2025-07-12 22:26:56 +00:00

README.md

OpenBB Fama-French Extension

This extension implements the Ken French data library (Source: https://mba.tuck.dartmouth.edu/pages/faculty/ken.french/data_library.html) as an OpenBB Platform Provider and Router extension.

Installation

Install this extension with:

pip install openbb-famafrench

Coverage

The extension provides six API endpoints:

In [1]: from openbb import obb

In [2]: obb.famafrench
Out[2]:
/famafrench
    breakpoints
    country_portfolio_returns
    factor_choices  <-- Utility function serving choices to the OpenBB Workspace widget
    factors
    international_index_returns
    regional_portfolio_returns
    us_portfolio_returns

Usage

The most common use will be for retrieving the 3 and 5-factor models, default state is 3-factors, at a monthly interval, for the United States.

from openbb import obb

factors = obb.famafrench.factors()

Or, by region and factor:

momentum = obb.famafrench.factors(factor="momentum", region="europe")

Metadata corresponding to the file downloaded is available under, extra["results_metadata"], of the results object.

factors.extra["results_metadata"]

{
    'description': '### \n\nThis file was created using the 202504 CRSP database. The 1-month TBill rate data until 202405 are from Ibbotson Associates. Starting from 202406, the 1-month TBill rate is from ICE BofA US 1-Month Treasury Bill Index.\n\n',
    'frequency': 'monthly',
    'formations': ['Mkt-RF', 'SMB', 'HML', 'RF']
}

Refer to the endpoint's docstring for detailed descriptions.