nonfarm_payrolls
Get Nonfarm Payrolls Survey.
Examples
from openbb import obb
obb.economy.survey.nonfarm_payrolls(provider='fred')
obb.economy.survey.nonfarm_payrolls(category=avg_hours, provider='fred')
Parameters
- standard
- fred
date: Union[date | str, list[date | str]]
A specific date to get data for. Default is the latest report. Multiple items allowed for provider(s): fred.
date: Union[date | str, list[date | str]]
A specific date to get data for. Default is the latest report. Multiple items allowed for provider(s): fred.
category: Literal['employees_nsa', 'employees_sa', 'employees_production_and_nonsupervisory', 'employees_women', 'employees_women_percent', 'avg_hours', 'avg_hours_production_and_nonsupervisory', 'avg_hours_overtime', 'avg_hours_overtime_production_and_nonsupervisory', 'avg_earnings_hourly', 'avg_earnings_hourly_production_and_nonsupervisory', 'avg_earnings_weekly', 'avg_earnings_weekly_production_and_nonsupervisory', 'index_weekly_hours', 'index_weekly_hours_production_and_nonsupervisory', 'index_weekly_payrolls', 'index_weekly_payrolls_production_and_nonsupervisory']
Default: employees_nsa
The category to query.
Returns
results: list[NonFarmPayrolls]
Serializable results.
provider: Optional[Literal['fred']]
Provider name.
warnings: Optional[list[Warning_]]
list of warnings.
chart: Optional[Chart]
Chart object.
extra: dict[str, Any]
Extra info.
Data
- standard
- fred
date: date | str
The date of the data.
symbol: str
Symbol representing the entity requested in the data.
value: float
date: date | str
The date of the data.
symbol: str
Symbol representing the entity requested in the data.
value: float
name: str
The name of the series.
element_id: str
The element id in the parent/child relationship.
parent_id: str
The parent id in the parent/child relationship.
children: str
The element_id of each child, as a comma-separated string.
level: int
The indentation level of the element.