bls_search

Search BLS surveys by category and keyword or phrase to identify BLS series IDs.

Examples

from openbb import obb
obb.economy.survey.bls_search(provider='bls', category=cpi)
# Use semi-colon to separate multiple queries as an & operator.
obb.economy.survey.bls_search(provider='bls', category=cpi, query='seattle;gasoline')

---

Parameters

• standard
• bls

Name	Type	Description	Default	Optional
query	str	The search word(s). Use semi-colon to separate multiple queries as an & operator.		True

Name	Type	Description	Default	Optional
query	str	The search word(s). Use semi-colon to separate multiple queries as an & operator.		True
category	Literal['cpi', 'pce', 'ppi', 'ip', 'jolts', 'nfp', 'cps', 'lfs', 'wages', 'ec', 'sla', 'bed', 'tu']	The category of BLS survey to search within. An empty search query will return all series within the category. Options are:; ; cpi - Consumer Price Index; ; pce - Personal Consumption Expenditure; ; ppi - Producer Price Index; ; ip - Industry Productivity; ; jolts - Job Openings and Labor Turnover Survey; ; nfp - Nonfarm Payrolls; ; cps - Current Population Survey; ; lfs - Labor Force Statistics; ; wages - Wages; ; ec - Employer Costs; ; sla - State and Local Area Employment; ; bed - Business Employment Dynamics; ; tu - Time Use		False
include_extras	bool	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'.	False	True
include_code_map	bool	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.	False	True

---

Returns

OBBject
    results : List[BlsSearch]
        Serializable results.

    provider : Optional[Literal['bls']]
        Provider name.

    warnings : Optional[List[Warning_]]
        List of warnings.

    chart : Optional[Chart]
        Chart object.

    extra : Dict[str, Any]
        Extra info.

---

Data

• standard
• bls

Name	Type	Description
symbol	str	Symbol representing the entity requested in the data.
title	str	The title of the series.
survey_name	str	The name of the survey.

Name	Type	Description
symbol	str	Symbol representing the entity requested in the data.
title	str	The title of the series.
survey_name	str	The name of the survey.