[V5] openbb-bls: Refactor for V5 + Add Many Endpoints#7518
Merged
Conversation
Draft
piiq
approved these changes
Jun 1, 2026
piiq
left a comment
Member
There was a problem hiding this comment.
added a few notes. non-blocking. thanks for explaining the lazy imports
| <td headers="jlt_rc_ophsrates.r.4 jlt_rc_ophsrates.h.1.9"><span class="datavalue">1.3%</span></td> | ||
| <td headers="jlt_rc_ophsrates.r.4 jlt_rc_ophsrates.h.1.10"><span class="datavalue">1.2%</span></td> | ||
| </tr> | ||
|
|
Member
There was a problem hiding this comment.
I don't mind html fixtures in general, but are 100 empty lines here for a reason?
| @@ -0,0 +1,102 @@ | |||
| """Hatchling build hook for ``openbb_bls/assets/bls_cache.zip``.""" | |||
|
|
|||
| from __future__ import annotations | |||
Member
There was a problem hiding this comment.
codex likes to insert from __future__ imports everywhere - is this actually required in this script?
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This PR refactors the
openbb-blsprovider module to V5 standards:Additionally, a significant number of endpoints have been added to provider release coverage for:
Each release provides PDF versions (with historical releases), accompanying tables, supplemental tables, and chart packs where available. The extension comes with five Workspace apps and 100+ widgets. The best way to test this PR is through the UI.
An API Key is only required for the BLS Series endpoint, all other data is from XLSX and HTML files.
Coverage
Python commands are
obb.bls.<group>.<command>(...); the equivalent REST routeis
GET /api/v1/bls/<group>/<command>. Every group also exposes adocumentscommand listing the release PDFs/files for that program.
Consumer Price Index —
bls.cpit1_expenditure_category…t7_12m_analysisrelative_importanceseasonal_factorssupplemental_tablesaverage_prices,by_category,by_category_line,by_metro,by_regionEmployment Situation —
bls.employment_situationsummary_household,summary_establishmentt1_employment_changes…t7_peak_trough,confidence_intervalscivilian_unemployment_rate,civilian_unemployment,civilian_employment,employment_population_ratio,labor_force_participation_rate,labor_underutilization,duration_of_unemployment,reasons_for_unemployment,unemployment_by_education,unemployment_by_veteran_status,long_term_unemployed_share,not_in_labor_force_indicators,not_in_labor_force_want_a_jobemployment_levels_by_industry,average_weekly_hours_production,employment_change_by_industry_ci,employment_by_industry_monthly_changes,employment_and_hourly_earnings_by_industry,employment_and_weekly_earnings_by_industryProducer Price Index —
bls.ppidetailed_reportrelative_importance,seasonal_factorsfinal_demand_1m/_12m,final_demand_components_1m/_12m,intermediate_processed_1m/_12m,intermediate_services_1m/_12m,intermediate_unprocessed_1m/_12mJOLTS —
bls.joltschange_analysis,revisionsbeveridge_curve,unemp_per_opening,openings_by_industry,hires_seps_rates,openings_hires_seps_levels,openings_hires_seps_rates,openings_hires_seps_by_regionProductivity & Costs —
bls.productivitytablesby_sector,nonfarm_business_productivity/_indexes/_labor_costs,manufacturing_productivity/_indexes/_labor_costs,nonfinancial_corporations_indexestfp_output_and_inputs,tfp_combined_inputs_output,tfp_contributions,tfp_percent_change,tfp_ict_trends,tfp_fire_trendswr_productivity_change/_by_period,wr_1yr_change,wr_longterm_change,wr_indexes_by_sector,wr_labor_cost_by_sector,wr_lp_by_industrymm_productivity_change/_by_period,mm_1yr_change,mm_longterm_change,mm_indexes_by_industry,mm_labor_cost_by_industryImport / Export Price Indexes —
bls.import_exportprice_indexesimports_by_category,exports_by_category,imports_by_origin,exports_by_grains,air_passenger_faresReal Earnings —
bls.real_earningsdocumentsSearch, Series & Calendar
These cross-survey commands fetch live or cached data by series ID:
searchseriesbls_api_key)calendarWhen
openbb-economyis installed these register under the Economysurveynamespace (e.g.
obb.economy.survey.bls_search(...), and the release calendar asobb.economy.calendar(provider="bls")); otherwise they are available standaloneas
obb.bls.search(...),obb.bls.series(...), andobb.bls.calendar(...).