Releases: OpenBB-finance/OpenBB
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!
Links 🦋
4.3.0
Summary 🎉
Introducing Release 4.3.0!
We've streamlined import processes, cutting load times by ~40% and revamped our code style for efficiency.
Renaming our repository to OpenBB signals a new era of accessibility and clarity. Security has been bolstered with dropped support for Python 3.8 and enhanced error handling.
Explore our expanded data access with New York Federal Reserve's Primary Dealer Statistics and Nasdaq on the Equity Screener. Experience upgraded charting capabilities including futures curves and derivatives historical charts.
This release isn't just an update—it's a leap forward in performance, security, and user experience.
🦋 OpenBB Platform Enhancements
Import processes have been streamlined to improve load and build times, with the code style fundamentally changed to incorporate this pattern. Another feature added is the optimization of logging.
In addition, access to more data has been facilitated through the Primary Dealer Statistics by the New York Federal Reserve, further expanding the data resources. The charting capability has also been expanded with the addition of futures curve chart and derivates historical chart to improve user experience and charting coverage.
Improvements have been made to the PyPi publishing tool to support Ruff 0.5.0 and to simplify the process of doing a release. Nasdaq has been added to the Equity Screener for increased coverage.
- [Feature] Delay/Optimize Imports @deeleeramone (#6532)
- [Feature] Extract provider to logs @jmaslek (#6565)
- [Feature] Add Primary Dealer Positioning To Economy @deeleeramone (#6566)
- [Feature] Add Futures Curve Chart @IgorWounds (#6547)
- [Feature] Improve PyPi publishing tool @montezdesousa (#6542)
- [Feature] Merge main with dev @hjoaquim (#6552)
- [Feature] Add derivates historical chart @IgorWounds (#6520)
- [Feature] Add Nasdaq To Equity Screener @deeleeramone (#6521)
- [Feature] Improvements to handling charts on the CLI
results
@hjoaquim (#6544) - [Feature] CLI integration tests @IgorWounds (#6533)
- [Enhancement] Clarify how to run the action @IgorWounds (#6518)
🐛 OpenBB Platform Bug Fixes
Key updates in the latest release: Adjusted warning display settings for clarity on large commands. Fine-tuned charting integration tests for reliability. Resolved issues with Dict-Type query parameters in Provider Interface models. Updated OECD's Unemployment data age brackets. Updated Python versions in toml files and dropped support for Python 3.8 for security enhancements. Fixed issues with local variable 'export' and streamlined operations by removing the 'website' folder. Improved error messaging with OpenBBError for FMP Econ Calendar.
- [Bugfix] Uncover cmd len warn @hjoaquim (#6536)
- [BugFix] Charting Integration Tests @hjoaquim (#6569)
- [BugFix] Fix Provider Interface Body Assignment Of Dict-Like Parameters @deeleeramone (#6561)
- [BugFix] Fix OECD Unemployment Age Brackets & Fix
No module named 'pkg_resources'
@deeleeramone (#6563) - [BugFix] Update openbb-charting With Numpy Dependency. @deeleeramone (#6562)
- [BugFix] Release fixes @montezdesousa (#6560)
- [BugFix] Bump supported python version in toml files @piiq (#6556)
- [BugFix] Security updates @piiq (#6531)
- [BugFix] Fixing local variable 'export' referenced before assignment @hjoaquim (#6545)
- [BugFix] Delete website folder @montezdesousa (#6541)
- [BugFix] Raise on "Error Message" with FMP Econ Calendar @deeleeramone (#6534)
- [BugFix] test openapi.json @montezdesousa (#6530)
- [BugFix] Patch test @IgorWounds (#6523)
📚 OpenBB Documentation Changes
- [Docs] Fix gh stars chart history + mention pro at the top @DidierRLopes (#6568)
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.2.3
Summary 🎉
Announcing Release 4.2.3! Enjoy enhanced Fixed Income features, revamped data endpoints, and new capabilities like storing defaults and options chains. Upgrade now for enhanced functionality and expanded features! 🚀
Thank you and welcome to our new contributors 🔥
🦋 OpenBB Platform Enhancements
Enhanced Fixed Income with renamed models, EFFR & SOFR data standardization, and expanded fields. Revamped Federal Reserve and FRED data endpoints, and removed deprecated Ameribor series. New features include storing defaults, Economic Surveys router path, Intrinio Delayed Options, and Mortgage Indices endpoint.
- [Enhancement] Fixed Income Enhancements @deeleeramone (#6490)
- [Feature] Store defaults in hub account @montezdesousa (#6491)
- [Feature] Adds Router Path For Economic Surveys @deeleeramone (#6498)
- [Feature] Intrinio Delayed Options @deeleeramone (#6505)
- [Feature] Add Mortgage Indices @deeleeramone (#6501)
- [Enhancement] Convert Params Models To Dictionary Before Assigning As Private Attribute In OBBject. @deeleeramone (#6492)
- [Feature] Improved cached results @hjoaquim (#6506)
- [Feature] No prints when exporting @hjoaquim (#6497)
- [Feature] Remove remember contexts setting @hjoaquim (#6496)
- [Feature] Create openbb-cli .dockerfile and update docs @montezdesousa (#6485)
- [Feature] Generate settings menu from pydantic model @montezdesousa (#6489)
🐛 OpenBB Platform Bug Fixes
The new release includes three significant changes:
-
A bug in the Econdb JSON loads context has been fixed, enhancing the functionality of the static assets by adding a context manager to json.load. The fix will address the issue documented in #6508.
-
Base exceptions have been substituted with OpenBBError to align with new exception handlers. This step will ensure more meaningful error messages across Python, CLI, or API for users.
-
Lastly, an issue preventing the retrieval of FY 2025 in the earnings transcript has been fixed, changing the validation to allow values less than the current year + 1. This adjustment allows mapping of FY 2025 to 2025, instead of 2024 as it did before, for example in NVDA.
- [BugFix] Econdb JSON loads context @deeleeramone (#6512)
- [BugFix] Replace some base exceptions by OpenBBError @montezdesousa (#6502)
- [BugFix] Fix issue in earnings transcript not allowing FY 2025 to be retrieved @jmaslek (#6500)
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 🦋
v4.2.2
Summary 🎉
This new release adds new endpoints to the economy menu, namely retail_prices
, house_price_index
, immediate_interest_rate
, central_bank_holdings
and share_price_index
. Additionaly, yfinance
is now supported by the `derivatives/options/chains/ endpoint. A new configuration was added to the user settings and it's now possible to define a priority list of providers per command, where the program falls back to the next when there is no credential for the prior.
🦋 Enhancements
- [Feature] Add Retail Prices to Economy @deeleeramone (#6474)
- [Feature] More OECD - House Price Index, Immediate Interest Rate @deeleeramone (#6473)
- [Feature] Adding OECD Endpoints (CPI + Share Price Index) @jmaslek (#6157)
- [Feature] Add Central Bank Holdings (Federal Reserve) @deeleeramone (#6469)
- [Feature] Set provider fallback based on credentials @montezdesousa (#6446)
- [Feature] Options Chains From YFinance @deeleeramone (#6468)
🐛 Bug Fixes
- [BugFix] Pre release fixes @montezdesousa (#6478)
- [Bugfix] Remove svg export @hjoaquim (#6476)
- [BugFix] Fix Empty Build Fail @deeleeramone (#6462)
- [BugFix] Fix Intrinio Balance Sheet Q4 Labeling @deeleeramone (#6465)
- [BugFix] Default API Settings @deeleeramone (#6466)
- [BugFix] Add
json_schema_extra
With Choices To Provider 'period' Field @deeleeramone (#6451) - [BugFix] Fix Seeking Alpha @deeleeramone (#6461)
📚 Documentation
- [Docs] Make Same PR as the to Main @deeleeramone (#6472)
- [Docs] Refactor Docs Pages For Diataxis @deeleeramone (#6315)
- [Feature] Small CLI docs style improvements @hjoaquim (#6429)
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 🦋
v4.2.1
🌟 What's New in This Release
Explore the enhanced documentation layout and style for a smoother user experience of the OpenBB Platform. Tighten security with upgraded dependencies and refined error handling. Upgrade now for a safer and more streamlined experience! 🚀
🦋 OpenBB Platform Enhancements
Release 4.2.1 introduces new features and improvements in the system. The first addition is the "Compare Company Facts" feature, allowing users to compare line items in financial statements across different companies. The new "Forward EBITDA" route has been added to the equity estimates route. This release also sees the removal of the deprecated etf.holdings_performance
endpoint. The Exception handlers have been improved to ensure more consistent error returns by the API. Lastly, the balance of payments for FRED has been added to expand the macroeconomics data collection. These changes are tested thoroughly for various conditions and parameters to ensure effective performance.
- [Release] 4.2.1 @hjoaquim (#6453)
- [Feature] OpenBB Platform DevContainer @hjoaquim (#6426)
- [Feature] Compare Company Facts (SEC) @deeleeramone (#6444)
- [Feature] Forward EBITDA @deeleeramone (#6433)
- [Feature] Deprecate
etf.holdings_performance
endpoint @hjoaquim (#6441) - [Feature] Improve Exception handlers @montezdesousa (#6430)
- [Feature] Balance Of Payments For FRED @deeleeramone (#6431)
🐛 OpenBB Platform Bug Fixes
This new release implemented software updates, including bug fixes and security improvements. The list syntax was revamped within routines, making the '-i/--input' argument initially treated as a string and skipping on split comma-separated arguments. Security updates included upgrades to the idna
and requests
to patched versions. The dependency on PDF and XLSX export capabilities was removed due to bugs and security vulnerabilities. Other updates improved user interaction, such as handling space-separated arguments better. Certain credentials are only updated on login, preventing unnecessary resetting of user preferences.
- [BugFix] Move api.dockerfile @montezdesousa (#6454)
- [BugFix] Revamp the usage of list syntax on routines @hjoaquim (#6450)
- Update requests and idna to patched versions @piiq (#6448)
- [BugFix] Add back api.dockerfile @montezdesousa (#6449)
- Remove PDF export capabilities @piiq (#6442)
- Remove xlsx export from CLI's interactive tables @piiq (#6439)
- [BugFix] Bump anyio & sync pre-commit, openbb-devtools and GitHub workflows @montezdesousa (#6443)
- [BugFix] Add bs4 to SEC pyproject.toml @deeleeramone (#6440)
- [BugFix] Remove space from literals @hjoaquim (#6438)
- [BugFix] Only update credentials on login @montezdesousa (#6437)
- [BugFix] Handle space separated arguments @hjoaquim (#6436)
- [BugFix] FMP Screener - Convert sector param choices to lower_snake_case @deeleeramone (#6432)
- [BugFix] FMP Key Metrics @deeleeramone (#6428)
- [BugFix] Do Intrinio News TO-DOs -> Remove workaround because they fixed it. @deeleeramone (#6427)
- [BugFix] Clear Linting Items @deeleeramone (#6423)
- [BugFix] -
dev_install.py
updates @montezdesousa (#6424)
📚 OpenBB Documentation Changes
The new release introduces considerable UI and layout changes to the OpenBB Platform documentation and a series of minor style improvements to the OpenBB Platform CLI documentation for enhanced consistency and coherence. All references now uniformly use "OpenBB Platform CLI". The modifications have been thoroughly tested on the documentation website.
- [Feature] Small CLI docs style improvements @hjoaquim (#6429)
- [Docs] Refactor Docs Pages For Diataxis @deeleeramone (#6315)
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 🦋
v4.2.0
🌟 What's New in This Release
🚀 Legacy Code Removal
Legacy Code Removal: We removed the legacy OpenBB Terminal code. Don’t worry, you can still access this legacy code! It's safely archived in our Legacy Terminal Repository and preserved in the git history for any nostalgic devs.
📜 License Transition
AGPL License Adoption: We've upgraded to the AGPL license to better align with our community's values and future goals. Learn more by checking out our insightful blog post and our detailed licensing FAQ.
🔒 Security Improvements
Major Security Upgrade: With the legacy code in the rearview, we've upgraded our defenses. This major security enhancement ensures that your experience on the OpenBB Platform is safer and more secure than ever.
🦋 OpenBB Platform Enhancements
Release 4.2.0 introduces a number of features and improvements to OpenBB Platform. Web security has been enhanced by updating frontend components and dependencies to patched versions. The OpenBB Platform CLI's testing coverage has been expanded through the addition of unit tests and the update of GitHub workflows.
The release also brings new enhancements to the 'reference.json'. Now, custom provider choices are available in the reference, which can be leveraged by clients for diverse purposes. Additional functionalities include Forward PE estimates to the equity.estimates router, update to the CLI README documentation, and removal of old code.
A notable feature is the creation of a 'repo assets directory'. The intention behind this is to define instructions and credentials in the Provider class to avoid downstream applications scraping the repo and potentially encountering randomly deleted files.
- Improve web security @piiq (#6405)
- [Feature] OpenBB Platform CLI Unit tests @IgorWounds (#6397)
- [Feature] Custom Provider choices available on the
reference.json
@hjoaquim (#6409) - [Feature] Add Forward PE Estimates @deeleeramone (#6398)
- [Feature] CLI README @hjoaquim (#6402)
- remove hold command and its references @hjoaquim (#6399)
- Security updates @piiq (#6387)
- [Feature] Create repo assets directory @montezdesousa (#6384)
- [Feature] Fallback to to_df() method when results are a string @hjoaquim (#6388)
- [Feature] Update chart creation so it doesn't break the command execution @hjoaquim (#6382)
- [Feature] Redefined standard fields & multiple_items_allowed property changes @montezdesousa (#6377)
- [Feature] EconDB Main Indicators @deeleeramone (#6365)
- Move files used in gh actions from root @montezdesousa (#6346)
- [Feature] Summarize Changelog @IgorWounds (#6335)
- [Feature] Warn limit number of countries in TE request @hjoaquim (#6334)
- [Feature] Polygon Currency Snapshots @deeleeramone (#6333)
- [Feature] Main README @hjoaquim (#6403)
- [Feature] Adds Platform images @hjoaquim (#6410)
- [Feature] Styling adjustments @hjoaquim (#6408)
- [BugFix] Fix broken
--sheet-name
argument @hjoaquim (#6401) - [Feature] Update CLI dependencies @hjoaquim (#6389)
- [Feature] Remove i18n @hjoaquim (#6390)
- [Feature] Misc improvements on the Platform CLI @hjoaquim (#6370)
- Sync main and develop @piiq (#6373)
- [Feature] Handle repeated non standard arguments @hjoaquim (#6366)
- [Feature] Improve
OBBject
Registry @hjoaquim (#6364) - [Enhancement] - Sanitize sensitive data from
.cli.his
@IgorWounds (#6361) - [Feature] Display command providers @montezdesousa (#6355)
- [Feature] Named tables on CLI @hjoaquim (#6356)
- [Feature] Rename terminal folder @montezdesousa (#6349)
- Move linting rules from pyproject.toml to ruff.toml @montezdesousa (#6350)
🐛 OpenBB Platform Bug Fixes
The new release corrects a variety of bugs. Key corrections include updating GitHub workflows, replacing python-jose by PyJWT due to security concerns, fixing errors in the Econ Calendar, making paper_bgcolor
transparent in the PyWry backend, and exposing error messages on request failure in AV Historical EPS. Auxiliary corrections include case-insensitive credentials, and more. Additional testing was done to ensure the proper functioning of these corrections.
- [BugFix] Update GitHub workflows @montezdesousa (#6418)
- [HotFix] Fix missed unit_measurements @deeleeramone (#6416)
- [BugFix] Replace python-jose by PyJWT @montezdesousa (#6407)
- [BugFix] Econ Calendar @deeleeramone (#6392)
- [BugFix] Make
paper_bgcolor
transparent in PyWry backend @deeleeramone (#6385) - [BugFix] AV Historical EPS - Expose Error Message On Request Fail @deeleeramone (#6406)
- [BugFix] Explicit error message when return type is not an OBBject @IgorWounds (#6394)
- [BugFix] Remove logos @montezdesousa (#6404)
- [BugFix] Case insensitive credentials @montezdesousa (#6400)
- [BugFix] Remove unused old code @IgorWounds (#6395)
- [BugFix] Fix FMP Currency/Crypto Historical Prices @deeleeramone (#6383)
- [BugFix] Update SEC pyproject.toml @deeleeramone (#6379)
- [BugFix] Fix Currency Search @deeleeramone (#6380)
- [BugFix] Treasury Rates Pandas Warnings @deeleeramone (#6375)
- [BugFix] Ad 'x-' to json_schema_extra in Fields with unit_measurement @deeleeramone (#6376)
- [BugFix] Fix tests for release @IgorWounds (#6372)
- [BugFix] Fix lowercase symbols @IgorWounds (#6342)
- [BugFix] Set Chart Style Before Output @deeleeramone (#6367)
- [BugFix] Remove
Literal[None,...]
@hjoaquim (#6371) - [BugFix] SEC ETF Holdings - Try Catch for RemoteDisconnect Error @deeleeramone (#6359)
- [BugFix] Remove multiple .envs @montezdesousa (#6363)
- [BugFix] @hjoaquim (#6360)
- [BugFix] Intrinio EquityPriceHistorical - Return Error Message When Invalid Key @deeleeramone (#6357)
- [BugFix] Empty views on
econometrics
andquantitative
@hjoaquim (#6353) - [BugFix] Empty views on the CLI @hjoaquim (#6351)
- [BugFix] Filtered provider arguments @hjoaquim (#6348)
- Clean .gitignore @montezdesousa (#6347)
- [BugFix] Intrinio Balance Sheet Period @deeleeramone (#6343)
- [BugFix] fix the dependencies issues on the changelog summary workflow @luqmanbello (#6341)
- [BugFix] Correct the filename of the
summarize_changelog.py
file @luqmanbello (#6338) - [BugFix] Intrinio News @deeleeramone (#6336)
- [BugFix] Sync ruff in dev_tools with openbb_core @montezdesousa (#6331)
📚 OpenBB Documentation Changes
In this new release, several updates were made across various areas including licensing, package upgrades, and documentation changes. The license for the codebase is now AGPL, with a dedicated FAQ page for licensing added to platform documentation. The CLI Installation Pre-Requisites now include guidelines for Linux, while new pages have been created for CLI docs keeping with the familiar Terminal structure. Docusaurus, was upgraded to v3 for improved security and new features. The discontinued OpenBB Terminal was removed from the main docs page and relocated under the Legacy section. Specifics on these changes can be found in the detailed change-log.
- Update the license of the code in this repo to AGPL @piiq (#6415)
- [HotFix] Add Linux instructions to CLI Installation Pre-Requisites @deeleeramone (#6411)
- [Feature] CLI docs @hjoaquim (#6362)
- [BugFix] Fix Excel Data Slicer page. @IgorWounds (#6396)
- [Docs] Upgrade Docusaurus to v3 @Disorrder (#6386)
- [Docs] Remove OpenBB Terminal from docs page @IgorWounds (#6354)
- [Docs] Update excel docs @montezdesousa (#6329)
- [Docs] Update excel docs @montezdesousa (#6328)
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!