Bls Search

Implementation details

Model name	Parameters class	Data class
`BlsSearch`	`BlsSearchQueryParams`	`BlsSearchData`

from openbb_core.provider.standard_models. import (
BlsSearchData,
BlsSearchQueryParams,
)

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

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.