Releases: OpenBB-finance/OpenBB
4.4.5
Thank you and welcome to our new contributors 🔥
Summary 🎉
The release of 4.4.5 includes new extensions, endpoints, and functionality; security and package updates; along with general bug fixes.
🚨 OpenBB Platform Breaking Changes
- This version introduces a deprecation warning for Python 3.9 - support for this version will be dropped later this year.
- File logging service is now disabled by default, the logging module is no longer initialized on startup.
- Set
"logging_suppress": false
, insystem_settings.json
, to enable.
- Set
- The endpoint,
obb.economy.port_volume
, is now deprecated and moved to:obb.economy.shipping.port_volume
🚨 Dependency Changes
openbb-charting
has been updated to use Plotly V6pytest-recorder
now has arecord_curl
marker for capturing unit test cassettes for HTTP requests via curl-adapter- Code for Posthog has been completely removed from
openbb-core
, dependency was removed. - Requests library has been bumped to the latest, addressing security vulnerabilities.
- Ruff has been bumped to the latest.
🆕 New Extensions
-
openbb-famafrench
- Implementation of the Ken French Data Library- Combined Provider and Router extension
- Adds route,
obb.famafrench
, with endpoints:- 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
-
openbb-mcp-server
- Implementation of FastMCP- Wraps the OpenBB API endpoints as MCP tools.
- Launch with the default config,
openbb-mcp
- See README for details.
🆕 New Endpoints
openbb-imf
has been expanded to include data from Port Watch
-
A
shipping
route to theobb.economy
router, includes 4 endpoints:- obb.economy.shipping.chokepoint_info (chart)
- obb.economy.shipping.chokepoint_volume
- obb.economy.shipping.port_info (chart)
- obb.economy.shipping.port_volume
-
A POST endpoint has been added to the
obb.derivatives.options
router:- obb.derivatives.options.surface
- POST the
chains
data response object to the endpoint and return a table suitable for constructing 3-D surface charts. - Optionally, return a chart (requires
openbb-charting
) - Import the chart function directly:
from openbb_charting.charts.generic_charts import surface3d
- POST the
- obb.derivatives.options.surface
🆕 New OpenBB Workspace App
openbb-nasdaq
now has a standalone application for OpenBB Workspace, with a focus on SEC filing documents - formatted as PDF.- Start with:
openbb-api --app openbb_nasdaq.app:main --factory
- Start with:
🦋 OpenBB Platform Enhancements
- API keys and credentials can now be defined as environment variables.
- Use the UPPER_CASE equivalent to the provider's credential.
- Enhancements to the
openbb-api
backend launcher. See the README
🚀 Pull Requests
- [Feature] IMF Port Watch in #7134
- [Feature] Add Workspace App To openbb-nasdaq For Company Filings As PDFs in #7135
- [BugFix] Fix TMX Request Timeout Configuration in #7142
- [BugFix] Update
openbb-yfinance
tests to use new pytest curl adapter extension by @deeleeramone in #7151 - [BugFix]
openbb-build
Catch CalledProcessError and improve error handling. by @deeleeramone in #7150 - [Feature] Update FOMC Documents Workspace App by @deeleeramone in #7153
- [BugFix] Fix Failing Yield Curve Chart by @deeleeramone in #7154
- [Feature] Disable LoggingService by Default by @deeleeramone in #7157
- [Feature] Add
mcp_server
toopenbb_core
api by @MagnusS0 in #7094 - [Feature] Add Omni Widget Input and Response Models to
openbb-platform-api
. by @deeleeramone in #7155 - [Feature] Add Credentials From Environment If Provided by @deeleeramone in #7159
- [BugFix] Nasdaq Company Filings Workspace App: Fix Multi-File Viewer Deprecation Warning by @deeleeramone in #7152
- [Feature] Future Warning For Discontinued Support For Python 3.9 by @deeleeramone in #7158
- [BugFix] Fix
obb.quantitative.capm
: Name inzipfile.open
is Case-Sensitive by @deeleeramone in #7161 - [BugFix] Cleanup Test Imports by @deeleeramone in #7162
- [BugFix]
openbb-charting
: Fix Margin In Serialized Chart Output by @deeleeramone in #7164 - [Feature] Bump Ruff To 0.12 by @deeleeramone in #7165
- [Feature] Add Volatility Surface POST processing and Chart by @deeleeramone in #7143
- [BugFix] MCP - expose correct header for session id by @MagnusS0 in #7160
- [Feature] Add Fama-French Data Library by @deeleeramone in #7163
- [Feature] Add PLC0415 To Ruff Ignore by @deeleeramone in #7166
- [BugFix]
obb.famafrench.breakpoints
- Fix Bad Widget Param Options by @deeleeramone in #7168 - [BugFix] Fix
SecForm13FHRFetcher
: TypeError: Expected numeric dtype, got object instead. by @deeleeramone in #7171
Full Changelog: 4.4.4...4.4.5
We are proud of our community contributors and staunch supporters of open-source ecosystems.
Help us promote our community by tagging @openbb_finance
on X with a link to your pull request,
and join our Discord server to chat about your contribution! We want to hear about your experience!
Links 🦋
4.4.4
Summary 🎉
OpenBB 4.4.4 includes bug fixes, package updates, and a small expansion of data coverage.
🚨 OpenBB Platform Breaking Changes
- Users with OpenBB Platform Installer < 1.0.3 should follow instructions here to update the packages for the latest versions.
🆕 New Endpoints
-
obb.equity.fundamental.filings
- Adds provider:
nasdaq
- Download filings formatted as PDF, XLSX, DOC, or HTML.
- Adds provider:
-
obb.economy.survey.manufacturing_outlook_ny
- Provider:
fred
- Adds Empire State Manufacturing Survey from FRED.
- Provider:
🐛 OpenBB Platform Bug Fixes
yFinance
has been adapted to usecurl-cffi
by mounting the Requests Session object withcurl-adapter
.to_df
/to_dataframe
have been update to handle a wider variety of response shapes, which will reduce failures with conversion.- FOMC Documents Workspace App definition fixed to include the new, required, 'roles' key in
widgets.json
- Docstring examples have been restored in the Python Interface, which will repair the missing examples on the Docs pages.
frontend-components
have had their package versions bumped for security fixes.
🦋 Pull Requests Included:
- [Feature] Add
openbb-nasdaq
toCompanyFilings
Endpoint @deeleeramone (#7085) - [Feature] Adds Empire State Manufacturing Survey (FRED) @deeleeramone (#7086)
- [BugFix] Fix
to_df
inOptionsChainsData
@deeleeramone (#7109) - [BugFix] Patch yFinance For The Change To
curl-cffi
@deeleeramone (#7107) - [Security] Bump Vite in
frontend-components
@deeleeramone (#7105) - [BugFix] Fix FOMC Minutes App and Default App Images @deeleeramone (#7104)
- [BugFix] Replace Broken Predefined yFinance Screeners With Actual POST Request + Bump yFinance Version @deeleeramone (#7102)
- [BugFix] Fixes For FutureWarning Items @deeleeramone (#7103)
- [BugFix] Fix Some Bugs Before Release @deeleeramone (#7101)
- [BugFix] Handle Dictionaries & Single Model Results Better In
to_dataframe
@deeleeramone (#7099) - [BugFix] Fix missing docstring examples from
openbb-build
script. @deeleeramone (#7093) - [BugFix]
openbb-platform-api
: Fix Empty Default Templates @deeleeramone (#7089) - [Security] Bump
vite
infrontend-components
@deeleeramone (#7090) - Patch vulnerabilites in frontend components @piiq (#7088)
We are proud of our community contributors and staunch supporters of open-source ecosystems.
Help us promote our community by tagging @openbb_finance
on X with a link to your pull request,
and join our Discord server to chat about your contribution! We want to hear about your experience!
Links 🦋
OpenBB Platform v4.4.2
Thank you and welcome to our new contributors 🔥
@Olexandr88, @ozzy35410 and @sadikkuzu
Summary 🎉
This release includes several enhancements to the developer experience, along with some general bug fixes.
🚀 What's Changed
- Refactored PackageBuilder to support dependency injection via positional arguments that are
fastapi.Depends
instances. - Improved docstring and reference generation.
- Improved handling of custom apps by the
openbb-platform-api
launcher.
🆕 New Endpoints
obb.economy.fomc_documents
- Provider: Federal Reserve
- Get current, and historical, FOMC documents.
- Includes an OpenBB Workspace template, and widget, with document viewer.
🦋 Pull Requests Included:
- Run "pre-commit autoupdate" @sadikkuzu (#7080)
- docs: (contributing) @Olexandr88 (#7033)
- Fix typo: MacOS to macOS @ozzy35410 (#7062)
- fix typos @ozzy35410 (#7063)
- [Feature] FOMC Documents With Workspace Multi-File Viewer Widget @deeleeramone (#7065)
- [BugFix] Safely Access
openapi_extra
When None @deeleeramone (#7077) - [Enhacement] Cleanup CompanyFilings @deeleeramone (#7074)
- [BugFix]
etf.sectors(provider='tmx')
- Fix Key Error When No Info Found @deeleeramone (#7075) - [BugFix] Fixes Docstring Generator Broken By #7066 @deeleeramone (#7069)
- [Feature]
openbb-platform-api
- Create Entry Inwidgets.json
For Forms @deeleeramone (#7055) - [BugFix] Compatibility With
Depends
Parameters. @deeleeramone (#7066) - [BugFix] Move
showwarning
To Outsidecatch_warnings
Context Block @deeleeramone (#7058) - Improve openbb api launcher @piiq (#7060)
- [BugFix] Fix yFinance Intraday "end_date" Filter @deeleeramone (#7059)
- [BugFix]
obb.regulators.sec.filing_headers
Fix Accessing Local Before Assignment @deeleeramone (#7057) - [BugFix] Fix Biztoc With No Params @deeleeramone (#7056)
- Release/4.4.1 - Merge Release From Main Into Develop @deeleeramone (#7053)
We are proud of our community contributors and staunch supporters of open-source ecosystems.
Help us promote our community by tagging @openbb_finance
on X with a link to your pull request,
and join our Discord server to chat about your contribution! We want to hear about your experience!
Links 🦋
OpenBB Platform v4.4.1
Thank you and welcome to our new contributors 🔥
Summary 🎉
This minor release fixes small bugs, enhances the developer experience, and updates some dependencies.
What's changed 🚀
- Numpy 2 now fully supported by the charting, technical, quantitative, and econometrics extensions.
- Plotly has been downgraded to 5.24.1 due to changes in V6 to JSON serialization of Figure objects.
- API output of
derivatives.options.chains
is now oriented as 'records'. - Router extension endpoints no longer require returning an
OBBject
as the response model. - Arbitrary credentials stored in
user_settings.json
are now passed to theobb
app and made available, as defined. - Various enhancements to the
openbb-platform-api
app launcher and Workspace backend. See the README - Legacy SDK example notebooks have been removed.
🆕 New Endpoints
- obb.regulators.sec.filing_headers
- Provider: SEC
- Downloads and parses the index headers and cover page, if available, for any SEC filing.
- obb.regulators.sec.open_html
- Provider: SEC
- Downloads and returns the raw HTM/HTML content from a SEC url.
🦋 Pull Requests Included:
- docs: fix typo @dijonkitchen (#7047)
- Small bugfix on launch args @jmaslek (#7028)
- Release/openbb core 1.4.2 @deeleeramone (#7051)
- [Feature] Custom Serializer For OptionsChainsData For Outputting List Of Records @deeleeramone (#7035)
- [BugFix] Downgrade Plotly To 5.24.1 For JSON Output Formatting @deeleeramone (#7048)
- [BugFix]
openbb-platform-api
- Fix$.
References Being Deleted Outside Of Loop @deeleeramone (#7046) - upload-artifact? @deeleeramone (#7049)
- [Release] Patch Release
openbb-platform-api
With New Runtime Flags & Readme @deeleeramone (#7045) - [BugFix] Surface FMP Error Message In
etf.info
@deeleeramone (#7044) - [BugFix] Fix Coverage Router @deeleeramone (#7036)
- [Feature] Deletes V3 API Example Notebooks @deeleeramone (#7041)
- [Feature]
openbb-sec
&openbb-regulators
: Add New Path:regulators.sec.filing_headers
@deeleeramone (#7034) - add factory flag to openbb-api launcher @deeleeramone (#7030)
- [Feature] Allow Arbitrary Credentials From
user_settings.json
To Populate Credentials Model @deeleeramone (#7040) - [BugFix] API: Reverse Output Of Wrapper Checking Object To Pass Custom Response Model @deeleeramone (#7039)
- [Feature] Align Python Interface With API - Stop Requiring
OBBject
As Output Type InPackageBuilder
As Default @deeleeramone (#7031) - [Feature] Use Forked Release Of Pandas-TA To Support Numpy2 @deeleeramone (#7032)
- [BugFix] Bump yFinance @deeleeramone (#7037)
- [Release] Merge 4.4.0 Release From Main Into Develop @deeleeramone (#7027)
We are proud of our community contributors and staunch supporters of open-source ecosystems.
Help us promote our community by tagging @openbb_finance
on X with a link to your pull request,
and join our Discord server to chat about your contribution! We want to hear about your experience!
Links 🦋
OpenBB Platform v4.4.0
Thank you and welcome to our new contributors 🔥
Summary 🎉
The first release of 2025, V4.4.0 comes with improved system/environment controls, new endpoints and data provider, and simplifies creating an OpenBB Workspace custom backend from an existing FastAPI app.
What's changed 🚀
-
Update LICENSE @maximevtush (#7020)
-
HTTP configurations can now be defined in
system_settings.json
.- See the docs
-
Output validation can be completely disabled in the
router.command
decorator by settingno_validate = True
- See the docs
-
FastAPI app instances can now be used by the
openbb-api
launcher to create custom Workspace backends for instant dashboarding.- See the docs for a quick start example.
-
openbb-sec
adds two new dependencies for handling HTML-to-Text:- trafilatura
- inscriptis
-
openbb-charting
updates the version ofplotly.json
used in the PyWry window to the current one. -
openbb-yfinance
fixes for recent breaking changes. -
openbb-imf
adds the Financial Soundness Indicators database.
❌ Deprecations
Two previously consolidated endpoints marked for deprecation since V4.2 have been removed:
obb.fixedincome.government.us_yield_curve
obb.fixedincome.government.eu_yield_curve
All providers now share the same government yield curve endpoint, with chart when openbb-charting
is installed:
obb.fixedincome.government.yield_curve
🆕 New Endpoints
obb.equity.fundamental.management_discussion_analysis
- Provider: SEC
- Gets the MD&A section from 10-K/Q filings, with the option to return the raw, complete HTML.
obb.equity.calendar.events
- Provider: FMP
- Corporate events calendar.
obb.derivatives.futures.info
(needsopenbb-deribit
to populate)- Provider: Deribit
- Current stats for a given contract.
obb.derivatives.futures.instruments
(needsopenbb-deribit
to populate)- Provider: Deribit
- Reference info for all traded futures instruments on the exchange.
obb.equity.ownership.government_trades
- Provider: FMP
- US elected representatives trade disclosures, Senate and House.
🆕 New Data Provider
openbb-deribit
- https://pypi.org/project/openbb-deribit/- Options and Futures coverage, no API key or signup required.
🦋 Pull Requests Included:
- [Feature] Company Events Calendar @deeleeramone (#7021)
- [Feature] SEC - Management Discussion & Analysis Sections @deeleeramone (#7006)
- [Enhancement] Improve Docstring
obb.equity.compare.groups
@deeleeramone (#6995) - [Feature] Add Deribit Futures Data @deeleeramone (#6998)
- [Feature] Add Deribit Provider Extension For Crypto Options Data @deeleeramone (#6985)
- [BugFix] Run
ruff check --fix
@deeleeramone (#6984) - [BugFix] Fix Chart Widgets Not Overwriting '{"type": "table"}' @deeleeramone (#7024)
- [BugFix]
openbb-yfinance
: Remove Duplicated Line In Screener Causing Double Results For First Pass @deeleeramone (#7022) - [Feature] Company Events Calendar @deeleeramone (#7021)
- [Feature] Allow Passing Custom FastAPI Instance To
openbb-api
From File @deeleeramone (#7016) - [Feature] SEC - Management Discussion & Analysis Sections @deeleeramone (#7006)
- [Feature]
openbb-platform-api
: Adds Configurations Supplied In Router Decorator Towidgets.json
@deeleeramone (#7014) - [BugFix] Remove Crashing Elements That Attempt To Limit X-Range Displayed In Candles @deeleeramone (#7015)
- [BugFix]
openbb-platform-api
: Fix Unsafe Property Access Inget_data_schema_for_widget
@deeleeramone (#7013) - [BugFix]
obb.equity.profile(provider='fmp')
- Fix 'NoneType' object has no attribute 'split' where symbol is untraded. @deeleeramone (#7012) - [BugFix] FMP - Fix missing exchange choices in
equity.screener
@deeleeramone (#7008) - [Feature] openbb-platform-api: Add column header tooltips and templates.json route. @deeleeramone (#7009)
- [BugFix] Fix Missing 'title' In IMF Economic Indicators @deeleeramone (#7010)
- [BugFix] update frontend-components and build new plotly and table html assets @deeleeramone (#7007)
- [Feature] Add SSL Certificate Context And Setting For Async/Sync HTTP Requests @deeleeramone (#6976)
- [Feature] Add
no_validate
Flag To@router.command
@deeleeramone (#6988) - [BugFix] Fix
obb.news.company(provider="yfinance")
@deeleeramone (#7003) - [BugFix] Installer: Force lower version of
poetry
inpost_install
script. @deeleeramone (#7002) - [Release] openbb-devtools-1.3.4: Bumps
pytest-recorder
Version @deeleeramone (#7000) - [Enhancement] Improve Docstring
obb.equity.compare.groups
@deeleeramone (#6995) - [Feature] Add Deribit Futures Data @deeleeramone (#6998)
- [Feature] Bump Websockets to Version 14 @deeleeramone (#6994)
- [Feature] Add Deribit Provider Extension For Crypto Options Data @deeleeramone (#6985)
- [Security] Update
package.json
Infrontend-components
@deeleeramone (#6989) - [Enhancement] Improve Docstring For
obb.fixedincome.bond_indices
@deeleeramone (#6986) - [Feature]try to add fmp senate trading data api @joshuaBri (#6957)
- [BugFix] Run
ruff check --fix
@deeleeramone (#6984) - [BugFix] Update Lock File Making CI Fail @deeleeramone (#6983)
- [Enhancement] Add IMF Financial Soundness Indicators Set @deeleeramone (#6960)
- [Security] Update Repo
.lock
Files Forpython-multipart
Bump @deeleeramone (#6981) - [Release] Version Bumps To
python-multipart
&pyjwt
@deeleeramone (#6980) - [BugFix] Fix Chart Widgets Not Overwriting '{"type": "table"}' @deeleeramone (#7024)
- [BugFix]
openbb-yfinance
: Remove Duplicated Line In Screener Causing Double Results For First Pass @deeleeramone (#7022) - [BugFix] Remove Crashing Elements That Attempt To Limit X-Range Displayed In Candles @deeleeramone (#7015)
- [BugFix]
openbb-platform-api
: Fix Unsafe Property Access Inget_data_schema_for_widget
@deeleeramone (#7013) - [BugFix]
obb.equity.profile(provider='fmp')
- Fix 'NoneType' object has no attribute 'split' where symbol is untraded. @deeleeramone (#7012) - [BugFix] FMP - Fix missing exchange choices in
equity.screener
@deeleeramone (#7008) - [BugFix] Fix Missing 'title' In IMF Economic Indicators @deeleeramone (#7010)
- [BugFix] update frontend-components and build new plotly and table html assets @deeleeramone (#7007)
- [BugFix] Fix
obb.news.company(provider="yfinance")
@deeleeramone (#7003) - [BugFix] Installer: Force lower version of
poetry
inpost_install
script. @deeleeramone (#7002) - [Security] Update
package.json
Infrontend-components
@deeleeramone (#6989) - [BugFix] Run
ruff check --fix
@deeleeramone (#6984) - [BugFix] Update Lock File Making CI Fail @deeleeramone (#6983)
- [Security] Update Repo
.lock
Files Forpython-multipart
Bump @deeleeramone (#6981)
❤️
We are proud of our community contributors and staunch supporters of open-source ecosystems.
Help us promote our community by tagging @openbb_finance
on X with a link to your pull request,
and join our Discord server to chat about your contribution! We want to hear about your experience!
Links 🦋
4.3.5
Thank you and welcome to our new contributors 🔥
@Atharva-3000, @HemuManju, @Khaan25, @NabidAkhtar, @Naprila, @Yash-1511, @adilkadivala, @adityadeshlahre, @emmanuel-ferdman and @harshsbhat
Summary 🎉
V4.3.5 includes bug fixes, security updates, new data and endpoints, as well as additions to the example library.
🚨 OpenBB Platform Breaking Changes
V1.0.0 Mac/Windows OpenBB Platform Installer users need to manually apply this change:
- In Finder/Explorer, open the folder where it was installed - probably in a folder, named "OpenBB", at the root of the operating system user account.
- From the main installation folder, navigate into the subdirectory, "extensions/openbb_platform_installer".
- Open, "pyproject.toml", in any text editor, and update line 21:
- From: openbb-core = "^1"
- To: openbb-core = ">=1.3.5"
- Save the file, close it, and then run the "Update" shortcut.
💂 🔒 Security
- [Security] Bump
aiohttp
To V3.10.11 @deeleeramone (#6951)- Resolves CVE-2024-52304 & CVE-2024-52303
- Updates
openbb-devtools
to resolve CVE-2024-52804
🦋 OpenBB Platform Enhancements
- [Feature] Econometrics: Added Variance Inflation Factor @HemuManju (#5866)
- New POST endpoint added:
obb.econometrics.variance_inflation_factor
- New POST endpoint added:
- [Feature] Add SEC As Provider To
equity.ownership.insider_trading
@deeleeramone (#6947)- Adds
provider='sec'
toobb.equity.ownership.insider_trading
- Adds
- [Feature] Add
yfinance
Toequity.screener
@deeleeramone (#6949)- Adds
provider='yfinance'
toobb.equity.screener
- Filters for: country, exchange, sector, industry, marketcap min/max, price min/max, volume min/max, beta min/max
- Adds
- [Enhancement] Add Multi-Country Support & ECB Yield Curves To
fixedincome.goverment.yield_curve(provider='econdb')
@deeleeramone (#6946)- In
obb.fixedincome.goverment.yield_curve(provider='econdb')
:- Adds support for multiple countries.
- Adds ECB yield curves as: 'ecb_spot_rate', 'ecb_par_yield', 'ecb_instantaneous_forward'
- In
- [Feature] Add Endpoint For The Latest Financial Reports Filed With The SEC @deeleeramone (#6936)
- New endpoint added:
obb.equity.discovery.latest_financial_reports
- SEC feed of the most recent quarterly, annual, and current reports for all companies - or by historical date.
- New endpoint added:
- [Feature] Add Intrinio to
equity.historical_market_cap
@deeleeramone (#6932)- Adds
provider='intrinio'
toobb.equity.historical_market_cap
- Adds
- Intrinio realtime (delayed) options @jmaslek (#6931)
- In
obb.derivatives.options.chains(provider='intrinio')
:- Adds
delay
parameter with choices: 'eod', 'realtime', 'delayed'
- Adds
- In
- [Feature] Add EIA Provider & Weekly Petroleum Status Report #6693
- Adds a new provider extension:
openbb-us-eia
- Adds new endpoints:
- obb.commodity.petroleum_status_report
- obb.commodity.short_term_energy_outlook (free API key required - https://www.eia.gov/opendata/register.php)
- Adds a new provider extension:
🐛 OpenBB Platform Bug Fixes
- [BugFix] Fix
openbb-yfinance
forequity.discovery
Functions @deeleeramone (#6945)- Fixes all
yfinance
provider functions withinobb.equity.discovery
- Additional data fields are now returned.
- Fixes all
- [BugFix] Handle ValidationError Better @deeleeramone (#6955)
- [BugFix] Fix Limit Param For yFinance Financials @deeleeramone (#6962)
- [BugFix] Fix Parsing Error In SEC Form13F @deeleeramone (#6961)
- In
obb.equity.ownership.form_13f(provider='sec')
:- Fixes data aggregation error when filing contained a security type labeled as OPTIONS
- In
- [BugFix]
equity.peers
: Handle Empty Values Within FMP Response @deeleeramone (#6963)- Empty values discarded from response in
obb.equity.peers(provider="fmp")
- Empty values discarded from response in
- [BugFix] CFTC COT - Make All Columns All Lowercase @deeleeramone (#6950)
- All returned columns now conform to lower_snake_case
- [BugFix] Fix OECD CPI Return Not Sorted By Date @deeleeramone (#6930)
- Fixes OECD data response to be sorted by date in:
obb.economy.cpi(provider='oecd')
obb.economy.short_term_interest_rate(provider='oecd')
obb.economy.long_term_interest_rate(provider='oecd')
- Fixes OECD data response to be sorted by date in:
- [BugFix] Make "logging_suppress" in
SystemSettings
Mutable and Then Actually Suppress Logging Service @deeleeramone (#6933)- Allows "logging_suppress" boolean to be set in
system_settings.json
.
- Allows "logging_suppress" boolean to be set in
- [BugFix] Clean Out Files From Already Deprecated Endpoint @deeleeramone (#6953)
- Removes unused files from the repository.
- [BugFix] Tests: Fix Some Bad Integration Test Params @deeleeramone (#6964)
- Updates some invalid integration test params.
📖 Documentation
- docs: update CONTRIBUTING.md @emmanuel-ferdman (#6952)
- Update README.md @DidierRLopes (#6937)
- add: M&A impact example notebook @NabidAkhtar (#6893)
- Cleanup example nb titles @jmaslek (#6934)
We are proud of our community contributors and staunch supporters of open-source ecosystems.
Help us promote our community by tagging @openbb_finance
on X with a link to your pull request,
and join our Discord server to chat about your contribution! We want to hear about your experience!
Links 🦋
OpenBB Platform v4.3.4
Thank you and welcome to our new contributors 🔥
@Anjalisharma3463, @HmbleCreator, @Khaan25, @Manish-k723, @SanchitMahajan236, @adilkadivala, @ambroseikpele, @aritradevelops, @bravesasha, @harshraj1512, @newcomer119, @sateshcharan, @theghostmac and @vamus092
Summary 🎉
V4.3.4 features security updates, bug fixes, small enhancements, and new example notebooks.
🚨 OpenBB Platform Breaking Changes
-
[BugFix] Remove Dead Endpoints From Nasdaq Data Link @deeleeramone (#6773)
- Functions are deprecated by the source and no longer work. All have endpoints continue to work via new provider extensions.
- Removes
openbb-nasdaq
as a provider to:- obb.index.sp500_multiples
- obb.regulators.cftc.cot
- obb.regulators.cftc.cot_search
-
[Enhancement] Improve FRED Search @deeleeramone (#6785)
- In
obb.economy.fred_search
:is_release
boolean changed to besearch_type
, with choices:- "full_text", "series_id", "release"
- In
💂 🔒 Security
- [BugFix] Bump
openbb-core
Dependencies Inpyproject.toml
@deeleeramone (#6794)- Resolves CVE-2024-47874
🦋 OpenBB Platform Enhancements
-
Create OpenBB Platform Installer with conda constructor @piiq (#6587)
- Scripts for building OpenBB Platform installers with Conda Constructor.
-
[Feature] Add
openbb-platform-api
To Mainpyproject.toml
@deeleeramone (#6818)- Package for launching the Platform API and widgets builder as a Terminal backend connector is now included with
pip install openbb
- Package for launching the Platform API and widgets builder as a Terminal backend connector is now included with
-
Add a Dockerfile for easy platform-api install @jmaslek (#6753)
- DockerFile that utilizes the
openbb-platform-api
for building images compatible with OpenBB Terminal Backend connectors.
- DockerFile that utilizes the
-
[Enhancement] Add Start/End Date Filters To SecCompanyFilingsFetcher @deeleeramone (#6757)
- In,
obb.equity.fundamental.filings
:- Adds start/end date filters to
openbb-sec
provider and improves theform_type
filter to match exactly.- [BugFix] SecCompanyFilings: Purge
nan
Values & Makeform_type
Match @deeleeramone (#6846)
- [BugFix] SecCompanyFilings: Purge
- Adds start/end date filters to
- In,
-
[Enhancement] Improve FRED Search @deeleeramone (#6785)
- In
obb.economy.fred_search
:- Improved search query results.
- Adds a new parameter,
order_by
, with choices:- 'search_rank', 'series_id', 'title', 'units', 'frequency', 'seasonal_adjustment', 'realtime_start', 'realtime_end', 'last_updated', 'observation_start', 'observation_end', 'popularity', 'group_popularity'
- In
-
[BugFix] Add Exception Handling For Unauthorized API Key Error. @deeleeramone (#6800)
- Adds a new error class, UnauthorizedError, that raises a 502 status code from the API, for provider requests that are rejected because of invalid credentials.
- Adds historical price intraday intervals to
openbb-tiingo
provider fetchers.
-
[Feature] Add Chart To
econometrics.correlation_matrix
@deeleeramone (#6750)- In,
openbb-charting
andobb.econometrics.correlation_matrix
:- Adds a built-in chart (
chart=True
) to the router path, and accessible from the OBBject extension via:res.charting.create_correlation_matrix
- [BugFix] Handle Abusively Large Correlation Matrix. @deeleeramone (#6807)
- Adds a built-in chart (
- In,
Example Library Additions
- [🕹️]Added the notebook for Sector Rotation Strategies Analysis @SanchitMahajan236 (#6844)
- [task] created a cryptocurrency trend analysis notebook | closes #6709 @theghostmac (#6728)
- [🕹️]Added the notebook for Backtesting Momentum Strategies @SanchitMahajan236 (#6759)
- [🕹️]Added the notebook for currency exchange rate prediction @Manish-k723 (#6743)
- Added file : Created Notebook for Portfolio Optimization Using Modern Portfolio Theory (Hacktoberfest) @ambroseikpele (#6726)
- Risk-Return Tradeoff Model Notebook #6710 @HmbleCreator (#6739)
🐛 Other OpenBB Platform Bug Fixes
- [BugFix] Pre-Release Bug Fixes @deeleeramone (#6869)
- [BugFix]
openbb-yfinance
- Fix Key Error From Change In Response Fromyf.download()
@deeleeramone (#6852) - Docs: README @bravesasha (#6755)
We are proud of our community contributors and staunch supporters of open-source ecosystems.
Help us promote our community by tagging @openbb_finance
on X with a link to your pull request,
and join our Discord server to chat about your contribution! We want to hear about your experience!
Links 🦋
OpenBB Platform v4.3.3
Thank you and welcome to our new contributors 🔥
Summary 🎉
This update includes bug fixes, new router paths, a new provider extension, and an addition to the example library.
Hacktoberfest
This month marks Hacktoberfest 2024, and you can participate by self-assigning one of the tagged - [🕹️] - issues
🚨 OpenBB Platform Breaking Changes
- [Feature] Add EIA Daily Spot Prices Data via FRED @deeleeramone (#6677)
- Removed:
obb.commodity.lbma_fixing
- Reason: No longer supported by Nasdaq Data Link; 410 HTTP status code.
- Removed:
🦋 OpenBB Platform Enhancements
-
[Feature] Add IMF Provider Extension and Extend
obb.economic.indicators
@deeleeramone (#6666)- New provider extension:
openbb-imf
- No API key or registration required.
- Adds
imf
as a provider to:obb.economy.indicators
&obb.economy.available_indicators
- Flat representations of all tables from the IRFCL dataset, or individual series from within.
- New provider extension:
-
[Feature] Add Direction Of Trade Statistics From IMF @deeleeramone (#6683)
- New router path:
obb.economy.direction_of_trade
- Bilateral trade, represented in US dollars, between countries or regions.
- New router path:
-
[Feature] Add Port Volume Data From EconDB @deeleeramone (#6668)
- New router path:
obb.economy.port_volume
- Import/Export container volume and dwelling times for the 20 highest-volume ports globally.
- New router path:
-
[Feature] Add EIA Daily Spot Prices Data via FRED @deeleeramone (#6677)
- New router path:
obb.commodity.price.spot
- Adds curated daily spot price time series from the EIA via
openbb-fred
.
- Adds curated daily spot price time series from the EIA via
- New router path:
-
[Feature] Adds Primary Dealer Fails Data From NY Federal Reserve @deeleeramone (#6670)
- New router path:
obb.economy.primary_dealer_fails
- Adds the Primary Dealer Fails To Deliver/Receive dataset from the NY Federal Reserve.
- New router path:
-
[Feature] Add An
openbb-build
Script Toopenbb-core
Package @deeleeramone (#6692)- Adds a command line script to
openbb-core
for building the static assets and Python interface.- Executable:
openbb-build
- Executable:
- Adds a command line script to
-
[Enhancement] Add
x-unit_measurement
To A Few Items @deeleeramone (#6722)- Adds percent normalization to:
obb.fixedincome.government.treasury_auctions
obb.fixedincome.government.treasury_prices
obb.fixedincome.corporate.bond_prices
- Adds percent normalization to:
-
Feature/openbb apachebeam @mmistroni (#6679)
- Adds an example OpenBB workflow for Apache Beam data collection.
🐛 OpenBB Platform Bug Fixes
-
[BugFix] - LoggingService changing default logging configuration @montezdesousa (#6681)
- Converts the logging service to use a custom logger instead of the root.
-
[BugFix] API: Handle EmptyDataError As Status Code 204 @deeleeramone (#6682)
- EmptyDataError was previously creating an unknown error in the API, now returns as status code 204.
-
[BugFix] Make User Preferences -> Defaults Work With Any Parameter @deeleeramone (#6687)
- In
user_settings.json
, thedefaults
section now accepts function parameters. Previously accepted only providers.
- In
-
[BugFix]
obb.derivatives.futures.historical
: Fix Start/End Filters Not Being Applied. @deeleeramone (#6721)- In, `obb.derivatives.futures.historical(provider="yfinance"), the start/end dates are now correctly applied.
-
[BugFix] Fixes #6688 BLS Title String Concatenation @deeleeramone (#6690)
- Fixes an error In,
obb.economy.survey.bls_series
, when no metadata for the series exists.
- Fixes an error In,
-
[BugFix] Fix BLS Error and API Exception Handling - Resolves #6661 and #6662 @deeleeramone (#6665)
- Handles exceptions in the API that were previously returning a 500 status code.
-
[BugFix] Handle Options Skew Error From Zero/Empty IV Value @deeleeramone (#6701)
- Fixes a key error when zero/empty values are present in the chain.
-
[BugFix] Bar Chart Fixes @deeleeramone (#6667)
- Fixes an error when supplying
bar_kwargs
that were already defined in the function, user supplied parameters take precedence.
- Fixes an error when supplying
-
[BugFix] Enforce User Preference For Dark/Light Mode In Chart Output To API @deeleeramone (#6664)
- Fixes charting output to the API so that user preference for dark/light mode is respected.
-
[BugFix] Use
__alias_dict__
instead of Field(alias) for data fields. @deeleeramone (#6673)- Fixes inconsistent field names in data model schemas from the API vs. Python interface.
-
[BugFix] Add Validators For
date
Fields For Multiple Items Allowed. @deeleeramone (#6671)- Fixes the "date" field to allow multiple items as a
datetime.date
orYYYY-MM-DD
string in:obb.economy.fred_release_table
obb.derivatives.futures.curve
obb.fixedincome.government.yield_curve
- Fixes the "date" field to allow multiple items as a
-
[BugFix] Fix Some Tests @deeleeramone (#6736)
- Fixes a few failing tests.
- Fixes error parses invalid XML character in:
obb.regulators.sec.rss_litigation
-
[BugFix] Update missed URLs from repo name change. @deeleeramone (#6695)
-
[BugFix] Fix bad key in
__json_schema_extra__
of IntrinioEquityHistorical @deeleeramone (#6669)- Fixes incorrect key names in "choices" mappings for:
IntrinioEquityHistoricalQueryParams
TEEconomicCalendarQueryParams
- Fixes incorrect key names in "choices" mappings for:
💂 🔒 Security
- [BugFix] Update vite in
package.json
@deeleeramone (#6678) - [BugFix] Update Frontend Components package.json and locks for Dependabot @deeleeramone (#6691)
We are proud of our community contributors and staunch supporters of open-source ecosystems.
Help us promote our community by tagging @openbb_finance
on X with a link to your pull request,
and join our Discord server to chat about your contribution! We want to hear about your experience!
Links 🦋
4.3.2
Thank you and welcome to our new contributors 🔥
@mmistroni and @nnsW3
Summary 🎉
This release provides bug fixes, example notebook updates, security updates, additional screener presets, as well as new public data provider extensions for the Commodity Futures Trading Commission (CFTC), and The Bureau of Labor Statistics (BLS).
What's changed 🚀
🚨 OpenBB Platform Breaking Changes
- [Feature] Flatten Revenue By Geography and Business Line @deeleeramone (#6624)
- In,
obb.equity.fundamental.revenue_per_geography
andrevenue_per_segment
:- The breakdown of revenue is now a flat response instead of a nested dictionary, formatted more favorably for Excel, SQL, and pivot tables.
- In,
🦋 OpenBB Platform Enhancements
-
[Feature] Add CFTC Provider and Replace Nasdaq Datalink For COT Reports @deeleeramone (#6643)
-
[Feature] Add BLS Provider Extension With Endpoints For Search and Time Series @deeleeramone (#6630)
- The
openbb-bls
extension provides public access to the BLS V2 series API with multi-series output and metadata. - Requires simple email registration and each key is limited to 500 calls per day, where calls are bucketed into groups of 50 symbols in 20 year historical windows. Register here
- The extension comes with an assets folder containing series IDS and applied metadata maps representing millions of unique time series.
- Endpoints:
obb.economy.survey.bls_search
- no registration or key is required for this endpoint.obb.economy.survey.bls_series
- built-in chart whenchart=True
andopenbb-charting
is installed.
- The
-
[Feature] Add Top Export Destinations By Country From UN Comtrade International Trade Statistics Database (EconDB) @deeleeramone (#6644)
- Extends the
openbb-econdb
provider with a new function. - New endpoint:
obb.economy.export_destinations
- Extends the
-
[Feature] adding extra presets @mmistroni (#6623)
- Adds to the library of
openbb-finviz
screener presets. - The new presets will populate in:
~/OpenBBUserData/presets/finviz
- Added to
obb.equity.screener(preset=%s, provider="finviz")
:canslim
fastgrowths
newhigh
- All presets can be modified by the user in any text editor, with changes applied to the next function call.
- Adds to the library of
🐛 OpenBB Platform Bug Fixes
-
[BugFix] VIX Curve - fixes
reset_index
erasing the name of the field. @deeleeramone (#6619)- Fixes the error when using:
obb.derivatives.futures.curve("VX", provider="cboe")
- [BugFix] Fix Pandas FutureWarning In
derivatives.futures.curve
Chart @deeleeramone (#6626)
- Fixes the error when using:
-
[Release] Patch:
openbb-yfinance-1.3.2
@deeleeramone (#6647)- [BugFix] Fix Date In Output Of
yfinance.download
For Google Colab @deeleeramone (#6645)
- [BugFix] Fix Date In Output Of
-
[BugFix] Add
trust_env
to AIOHTTP ClientSession Initialization to Read.env
for Proxy Mapping @deeleeramone (#6640)- Applies the setting to enable environment variable proxy mapping in
aiohttp
async requests. - [BugFix] Update
aiohttp
for Dependabot @deeleeramone (#6621)
- Applies the setting to enable environment variable proxy mapping in
-
[BugFix] Allow lowercase
symbol
for EconDB EconomicIndicators @deeleeramone (#6642)- Fixes a UX issue where the symbol -
GDP
- must be entered as uppercase. - EconDB symbols are not case-sensitive, converted to upper.
- Fixes a UX issue where the symbol -
-
[BugFix] Fix Tests & Related Bugs @deeleeramone (#6657)
- Fixes interactive tables (CLI) outputting only white window from
obb.news
, and similar. - Fixes unreliable connection/output with
openbb-seeking-alpha
toobb.equity.estimates.forward_sales
andforward_eps
. - Updates some unit and integration tests.
- Fixes interactive tables (CLI) outputting only white window from
General
- [BugFix]
obb.news.world
Add Validators To Providers Where Symbol Is Mandatory @deeleeramone (#6625) - [BugFix] Improve Warning For Invalid Defaults Key In
user_settings.json
@deeleeramone (#6651) - [BugFix] Replace
Optional[bool]
withbool
as type in Equity Search @deeleeramone (#6633) - [BugFix]
__fields__
is deprecated, usemodel_fields
instead @deeleeramone (#6629)
📚 OpenBB Documentation Changes
-
[BugFix] Example Notebook Syntax Updates @deeleeramone (#6639)
- Outdated syntax in the example notebooks has been updated to reflect recent modifications.
We are proud of our community contributors and staunch supporters of open-source ecosystems.
Help us promote our community by tagging @openbb_finance
on X with a link to your pull request,
and join our Discord server to chat about your contribution! We want to hear about your experience!
Links 🦋
OpenBB Platform v4.3.1
Thank you and welcome to our new contributors 🔥
Thanks to, mmistroni, for contributing to the Finviz screener endpoint.
Summary 🎉
This release includes some bug fixes, dependency version bumps, new router paths and functionality, and a new provider extension.
What's changed 🚀
A new version of openbb-cli
resolves the issue of "nothing happening" when a command is run. The tables now engage the backend window creation directly.
🚨 OpenBB Platform Breaking Changes
-
[Feature] PyWry Optional With Charting @deeleeramone (#6590)
- PyWry is now an optional dependency of the
openbb-charting
extension. This decouples window creation from the charting features and makes the installation slimmer.- To retain the old configuration,
pip install openbb-charting["pywry"]
- To retain the old configuration,
- PyWry is now an optional dependency of the
-
[BugFix] Bump
linearmodels
andarch
Version @deeleeramone (#6600)- Versions pulled are now 6 & 7, respectively.
-
[Feature] Remove Deprecated Fields From Equity Historical @deeleeramone (#6598)
- Previously deprecated parameters have been removed.
- In
obb.equity.price.historical
:- Removed:
adjusted
prepost
- All providers now use the
adjustment
enum to select the price adjustment factor for historical prices, andextended_hours
replaces,prepost
.
- Removed:
-
[BugFix] Fix ReferenceGenerator Unions and Choices @deeleeramone (#6599)
- Structure of
reference.json
andopenapi.json
has changed to group all parameter "choices" by provider.
- Structure of
-
[Feature] OptionsChains Properties @deeleeramone (#6564)
- Response object from
obb.derivatives.options.chains
is now a single model, structured as aDict[List]
. Previously was a[List[Dict]
- Response object from
-
OECD function parameters have changed to reflect new updated structures at the source:
- [BugFix] Fix OECD GDP Real + Add EconDB To Endpoint @deeleeramone (#6589)
- [BugFix] Fix
gdp.forecast
@deeleeramone (#6585) - [Feature] Cleanup OECD CLI Endpoint. @deeleeramone (#6584)
- [BugFix] Clean Up Nominal GDP & Add EconDB As Provider @deeleeramone (#6581)
-
[BugFix] Update Missed Lock Files for
certifi 2024.7.4
@deeleeramone (#6583)- Alll extensions have been updated for
certifi 2024.7.4
.
- Alll extensions have been updated for
-
[BugFix] Delete Dev Container @deeleeramone (#6582)
- Removes the Dev Container from the repository.
🦋 OpenBB Platform Enhancements
-
[Feature] Add Nonfarm Payrolls To
economy.survey
@deeleeramone (#6571)- New router path:
obb.economy.survey.nonfarm_payrolls
- Supported providers:
openbb-fred
- Supported providers:
- New router path:
-
[Feature] Add Fred Release Tables @deeleeramone (#6595)
- New router path:
obb.economy.fred_release_table
- Supported providers:
openbb-fred
- Supported providers:
- New router path:
-
[Feature] Add PCE (Personal Consumption Expenditures) reports to Economy @deeleeramone (#6578)
- New router path:
obb.economy.pce
- Supported providers:
openbb-fred
- Supported providers:
- New router path:
-
[Feature] Add Historical Market Cap @deeleeramone (#6603)
- New router path:
obb.equity.historical_market_cap
- Supported providers:
openbb-fmp
- Built-in view, "chart=True".
- Supported providers:
- New router path:
-
[Feature] Add TIPS Yields (to maturity) @deeleeramone (#6597)
- New router path:
obb.fixedincome.government.tips_yields
- Supported providers:
openbb-fred
- Supported providers:
- New router path:
-
[Feature] Replace Nasdaq SP500 Multiples With Direct Source @deeleeramone (#6609)
- New provider extension - "openbb-multpl" - to replace
nasdaq
forobb.index.sp500_multiples
. - Deprecated:
nasdaq
as provider toobb.index.sp500_multiples
.- Reason: Data no longer updated by Nasdaq Data Link.
- New provider extension - "openbb-multpl" - to replace
-
[Enhancement] Consolidate OECD Interest Rate Endpoints as a Single Function @deeleeramone (#6602)
- Three routes have been consolidated into one:
- New router path:
obb.economy.interest_rates
- Deprecated:
obb.economy.short_term_interest_rate
obb.economy.long_term_interest_rate
obb.economy.immediate_interest_rate
- New router path:
- Three routes have been consolidated into one:
-
[BugFix] Fix OECD GDP Real + Add EconDB To Endpoint @deeleeramone (#6589)
- Adds
econdb
as provider to:obb.economy.gpd.nominal
obb.economy.gdp.real
- Adds
-
[Feature] OptionsChains Properties @deeleeramone (#6564)
- Adds properties and class methods to the output of
obb.derivatives.options.chains
. results
is now a single instance as a dictionary of arrays.- Refer to the docstring of
results
for a description of properties and functions.
- Adds properties and class methods to the output of
-
[Feature] Add Finviz Screener Presets (V3 Compatible) @deeleeramone (#6601)
- Adds
finviz
as a provider to:obb.equity.screener
. - Support for legacy V3 SDK/Terminal stock screener presets.
- Adds
🐛 OpenBB Platform Bug Fixes
- [BugFix] Fix Yfinance Discovery Percent Values @deeleeramone (#6611)
- [BugFix] Fix ReferenceGenerator Unions and Choices @deeleeramone (#6599)
- [BugFix] FRED Release Table: Fix Date Parsing For Format Variation @deeleeramone (#6608)
- [BugFix] Fix Rogue Percent Value In FMP ETF Info @deeleeramone (#6607)
- [BugFix] Bump
linearmodels
andarch
Version @deeleeramone (#6600) - [BugFix] CLI: /technical/sma --chart @deeleeramone (#6594)
- [BugFix] Raise EmptyDataError When No Results Returned From
obb.economy.fred_search()
@deeleeramone (#6592) - [BugFix] Yield Curve Chart: Fix Syntax Where Pandas Drops Column Name After
reset_index()
@deeleeramone (#6591) - [BugFix] Fix OECD GDP Real + Add EconDB To Endpoint @deeleeramone (#6589)
- [BugFix] Fix CLI Interactive Tables Not Opening @deeleeramone (#6588)
- [BugFix] Fix
gdp.forecast
@deeleeramone (#6585) - [BugFix] Update Missed Lock Files for
certifi 2024.7.4
@deeleeramone (#6583) - [BugFix] Delete Dev Container @deeleeramone (#6582)
- [BugFix] Clean Up Nominal GDP & Add EconDB As Provider @deeleeramone (#6581)
- [BugFix] Update Extension
lock
Files Forcertifi 2024.7.4
@deeleeramone (#6580) - [BugFix] Fix GitHub Actions Branch Check URL that 404s @deeleeramone (#6579)
📚 OpenBB Documentation Changes
- Highlight agents repo on README @DidierRLopes (#6596)
We are proud of our community contributors and staunch supporters of open-source ecosystems.
Help us promote our community by tagging @openbb_finance
on X with a link to your pull request,
and join our Discord server to chat about your contribution! We want to hear about your experience!