search

Search the BLS series catalog by category, keyword, or code.

Examples

from openbb import obb
# Search the CPI category for series matching a query.
obb.bls.search(provider='bls', category='cpi', query='urban')
# List every series in the JOLTS category.
obb.bls.search(provider='bls', category='jolts')

Parameters

• standard
• bls

query: str | None
The search word(s). Use semi-colon to separate multiple queries as an & operator.

query: str | None
The search word(s). Use semi-colon to separate multiple queries as an & operator.

symbol: str | None | list[str | None]
Bound to the Series widget via cell-click grouping; clicking a row's symbol loads it there. Does not filter the search results. Multiple items allowed.

category: str

Description

The category of BLS survey to search within. An empty search query returns every series within the category. Options are:

cpi - Consumer Price Index
ixp - Import/Export Price Indexes
pce - Consumer Expenditure Survey
ppi - Producer Price Index
ip - Productivity (Industry, Major Sector & Total Factor)
jolts - Job Openings and Labor Turnover Survey
nfp - Nonfarm Payrolls (Current Employment Statistics)
cps - Current Population Survey
lfs - Labor Force Statistics & International Comparisons
wages - Employment Cost Index & Wage Estimates
ec - Employer Costs for Employee Compensation
sla - State & Local Area Employment & Unemployment
bed - Business Employment Dynamics
tu - American Time Use Survey

include_extras: bool | None
Default: False
Include additional information in the search results. Extra fields returned are metadata and vary by survey. Fields are undefined strings that typically have names ending with '_code'.

include_code_map: bool | None
Default: False
When True, includes the complete code map for eaçh survey in the category, returned separately as a nested JSON to the extras['results_metadata'] property of the response. Example content is the NAICS industry map for PPI surveys. Each code is a value within the 'symbol' of the time series.

---

Returns

results: BlsSearch

Serializable results.

provider: str | None

Provider name.

warnings: Optional[list[Warning_]]

List of warnings.

chart: Optional[Chart]

Chart object.

extra: dict[str, Any]

Extra info.

---

Data

• standard
• bls

symbol: str
Symbol representing the entity requested in the data.

title: str | None
The title of the series.

survey_name: str | None
The name of the survey.

symbol: str
BLS series identifier. Click a cell to load it into the linked BLS Series widget.

title: str | None
The title of the series.

survey_name: str | None
The name of the survey.