OpenBB Platform v4.6.0

Thank you and welcome to our new contributors 🔥

• @ChimdumebiNebolisa made their first contribution in #7289
• @VeroDomenico made their first contribution in #7299

Summary 🎉

Version 4.6.0 of the ODP Python Package removes support for Python 3.9, introduces new commodities and economics data sets, fixes bugs, updates dependencies, and other general enhancements.

🚨 Breaking Changes

• [Feature] Remove Python 3.9 by @deeleeramone in #7235
• [Feature] Remove Account Module and HubService by @deeleeramone in #7236

🆕 What's New

OpenBB Cookie Cutter

The openbb-cookiecutter package generates a structured project folder for creating new OpenBB Python package extensions. Everything you need to get started building with, and using, the ODP framework.

• [Feature] openbb-cookiecutter: Extension Template by @deeleeramone in #7261

From FastAPI

You can now instantly generate Workspace, MCP, CLI, and Python interfaces all from existing FastAPI apps and files, with no additional code required. You can also make OpenBB extensions from scratch with standard FastAPI conventions. Build once, deploy everywhere.

• [Feature] Add Python Package Builder Support for FastAPI and APIRouter EntryPoints by @deeleeramone in #7252

OpenBB Plugins

OpenBB Plugin Extensions let you control last-mile delivery of the response object, and step into the execution loop with on_command_output patterns. Build it once, then adapt to any scenario with repeatable and non-destructive outcomes.

• [Feature] OpenBB Plugin Extensions by @deeleeramone in #7247

IMF Data Explorer

Refactors the openbb-imf and expands the coverage to include all public data from data.imf.org.

• [Feature] Refactor IMF for SDMX 3 by @deeleeramone in #7282

USDA Production, Supply, Distribution & Weekly Weather and Crop Report

Adds 4 new endpoints to the commodities router.

• [Feature] Add USDA FAS Agriculture Commodity Endpoints by @deeleeramone in #7298

🦋 Other PRs From This Release

• [BugFix] openbb-platform-api: Fix use of removed positional arguments by @deeleeramone in #7237
• [BugFIx] Fix PackageBuilder to Handle Platform Agnostic File Lock by @deeleeramone in #7242
• [BugFix] openbb-charting: Get ChartStyle.plt_style Default Value From UserSettings by @deeleeramone in #7243
• [BugFix] Remove Unused Router Endpoint/Model by @deeleeramone in #7244
• [BugFix] openbb-fmp: Fix Missing Entry in FMP fetcher_dict by @deeleeramone in #7246
• Update readme by @piiq in #7248
• Invert ODP logos by @piiq in #7249
• [BugFix] openbb-cli: Handle Pipe Union Types in argparse_translator by @deeleeramone in #7257
• [Release] openbb-core-1.5.3: Patch for Higher Version of Starlette by @deeleeramone in #7255
• Update Image File in README.md by @deeleeramone in #7253
• [[BugFix] Fix Depends Type Change in Lastest FastAPI Version by @deeleeramone in https://github.com//pull/7258
• [BugFix] Fix dev_install.py To Use Poetry V2 Syntax --regenerate by @deeleeramone in #7259
• [BugFix] Fix Credentials Model Accepting Update From Environment Variable on Load by @deeleeramone in #7263
• [BugFix] Re-lock for brotli-1.2.0; Add Encoding Param to dev_install.py by @deeleeramone in #7269
• [Release] openbb-core-1.5.6 by @deeleeramone in #7273
• [Security] Regenerate All poetry.lock Files by @deeleeramone in #7278
• [BugFiux] openbb-platform-api: Fix Semi-Colon Splitting in Provider Descriptions by @deeleeramone in #7280
• [BugFix] openbb-core: Fix Merging Provider Descriptions in Package Builder by @deeleeramone in #7281
• [Security] openbb-devtools: Regenerate poetry.lock by @deeleeramone in #7284
• [BugFix] openbb-mcp-server: Fix Mock OpenAPITool Instance Parameters For New Positional Argument by @deeleeramone in #7288
• Fix/yfinance stop session injection by @ChimdumebiNebolisa in #7289
• [BugFix] openbb-core: API - Convert dataclass to dict in API Wrapper Outside of Defaults Block by @deeleeramone in #7283
• [BugFix] openbb-econdb: Fix Implicit None type for Parameter, 'frequency' by @deeleeramone in #7295
• Modify ENTRYPOINT in platformAPI Dockerfile by @VeroDomenico in #7299

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 🦋

Website, Twitter, Linkedin, Instagram, Reddit, Discord

Full Changelog: v4.5.0...v4.6.0

ODP Desktop v1.0.0

This releases version 1.0.0 of the Open Data Platform Desktop Application.

Go to https://docs.openbb.co/desktop for user documentation.

ODP Desktop (Latest Stable)

This is the latest stable release (v1.0.0)

This release always points to the most recent stable version.
For version-specific details and release notes, see: ODP Desktop v1.0.0

The latest.json file in this release is used by the auto-updater to check for new versions.

ODP Desktop v0.9.1

This is a test pre-release for the Open Data Platform Desktop Application.

ODP Desktop v0.9.2

This is a test release of the Open Data Platform Desktop Application.

ODP Desktop v0.9.0

This is a test pre-release of the Open Data Platform Desktop Application.

OpenBB Platform v4.5.0

Thank you and welcome to our new contributors 🔥

@Olexandr88 and @kaya70875

Summary 🎉

Version 4.5.0 introduces support for Python 3.13, and will be the final release supporting Python 3.9.

There are new endpoints and data, deprecation removals, a complete refactoring of the openbb-fmp provider extension, enhancements to openbb-mcp-server, as well as general maintenance and minor enhancements.

🚨 OpenBB Platform Breaking Changes

OpenBB Hub is being retired, and the Account module will be removed in a future version. All API keys must be set via configuration files, environment variables, or directly in the Python session.

[Feature] Remove Endpoints Marked For Removal In V4.5 @deeleeramone (#7225)

Use obb.economy.interest_rates instead of:

• obb.economy.short_term_interest_rate
• obb.economy.long_term_interest_rate
• obb.economy.immediate_interest_rate

Use obb.fixedincome.rate.sofr instead of:

• obb.fixedincome.sofr

Use obb.fixedincome.bond_indices instead of:

• obb.fixedincome.corporate.ice_bofa
• obb.fixedincome.corporate.moody

[Feature] Refactor FMP @deeleeramone (#7217)

This introduces a number of changes to the FMP provider, and some of the resulting functions.

Items removed:

• obb.equity.fundamental.multiples: This is a duplicate of metrics, which is also used by other providers.
• CompanyOverview standard model: This was not used, and is redundant. The same as EquityProfile.
• obb.etf.holdings_date: No longer necessary. FMP's ETF Holdings do not have historical data, it was actually NPORT-P data.

Items created:

• obb.equity.fundamental.esg_score
• obb.etf.nport_disclosure: Migrates sec, and the historical part of fmp, from obb.etf.holdings.

Adds FMP as a provider to:

• obb.equity.discovery.gainers
• obb.equity.discovery.losers
• obb.equity.discover.active

Parameter Changes:

• obb.equity.fundamental.metrics & .ratios:
  • For FMP, adds ttm parameter with choices: [include', 'exclude', 'only'].
    • Default is only, and this setting overrides the limit and period parameters.
• obb.news.world:
  • For FMP, adds topic parameter with choices: ['fmp_articles', 'general', 'press_releases', 'stocks', 'forex', 'crypto']
• obb.equity.price.historical:
  • For FMP, adds adjustment parameter with choices: ['splits_only', 'splits_and_dividends', 'unadjusted']

Other FMP Changes:

FMP has changed the free tier, and the returned data may have a different definition now.

Downstream functions receiving output from openbb-fmp should check that the output of Platform conforms with the expected input.

All associated models have been updated.

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

The Python Interface now ships without static assets, and they will be built on first import, or when invoked from the command line with, openbb-build.

When you install openbb-core, and not, openbb, you import a bare interface with, from openbb import obb.

This change makes it easier to create custom combinations of installed extensions, and ensures a light-weight package is distributed to developers building their own.

🆕 New Additions

[Feature] Add congress.gov provider extension @DidierRLopes (#7141)

This adds a new provider and router extension for US Congressional bill text and information.

The best way to try out this new extension is by running openbb-api and connecting as a Workspace backend.

[Feature] Support Python 3.13 @deeleeramone (#7193)

Adds support for Python 3.13 across the entire library.

[Feature] Expand MCP Server Configurability @deeleeramone (#7202)

You can now define, or configure, MCP server tools directly in the openapi_extra dictionary in the router function definition.

Additionally, the server can be configured with system and server prompts. See the README for the openbb-mcp-server package for details and examples.

🦋 Other OpenBB Platform Enhancements, Fixes, and PRs

• [Docs] Fix typo @Olexandr88 (#7228)
• [Docs] improve documentation for logging_service file @kaya70875 (#7206)
• [Docs] remove hub from README file, and update the extension tables @deeleeramone (#7230)
• [Feature] Add CodeQL Workflow @deeleeramone (#7221)
• [Feature] openbb-platform-api: Add MCP Tool ID To Autogenerated Widget Spec @deeleeramone (#7222)
• [Release] Release/openbb-core-1.5.0 @deeleeramone (#7214)
• [Feature] openbb-platform-api: Adds Marker in Headers of Workspace Config File Endpoints @deeleeramone (#7211)
• [Feature] openbb-platform-api Better POST Params Discovery @deeleeramone (#7204)
• [Feature] Add Deprecation Warning For Account Module. @deeleeramone (#7209)
• [BugFix] Fix Hub Session Not Being Set After Login @deeleeramone (#7197)
• [BugFix] openbb-platform-api: Fix check_for_platform_extensions Filter @deeleeramone (#7184)
• [BugFix] economy.calendar(provider='nasdaq'): Fix 'No record found' Error Raising Instead Of Returning @deeleeramone (#7178)
• [Release] Merges Release 4.4.5 From Main Into Develop @deeleeramone (#7176)

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 🦋

Website, Twitter, Linkedin, Instagram, Reddit, Discord

4.4.5

Thank you and welcome to our new contributors 🔥

@MagnusS0

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, in system_settings.json, to enable.
• 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 V6
• pytest-recorder now has a record_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 the obb.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

🆕 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

🦋 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 to openbb_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 in zipfile.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] FixSecForm13FHRFetcher: 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 🦋

Website, Twitter, Linkedin, Instagram, Reddit, Discord

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.

• obb.economy.survey.manufacturing_outlook_ny

  • Provider: fred
  • Adds Empire State Manufacturing Survey from FRED.

🐛 OpenBB Platform Bug Fixes

• yFinance has been adapted to use curl-cffi by mounting the Requests Session object with curl-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 to CompanyFilings Endpoint @deeleeramone (#7085)
• [Feature] Adds Empire State Manufacturing Survey (FRED) @deeleeramone (#7086)
• [BugFix] Fix to_df in OptionsChainsData @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 in frontend-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 🦋

Website, Twitter, Linkedin, Instagram, Reddit, Discord

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 In widgets.json For Forms @deeleeramone (#7055)
• [BugFix] Compatibility With Depends Parameters. @deeleeramone (#7066)
• [BugFix] Move showwarning To Outside catch_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 🦋

Website, Twitter, Linkedin, Instagram, Reddit, Discord