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

Name	Type	Description	Default	Optional
date	Union[Union[date, str], List[Union[date, str]]]	A specific date to get data for. Default is the latest report. Multiple items allowed for provider(s): fred.	None	True

Name	Type	Description	Default	Optional
date	Union[Union[date, str], List[Union[date, str]]]	A specific date to get data for. Default is the latest report. Multiple items allowed for provider(s): fred.	None	True
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']	The category to query.	employees_nsa	True

---

Returns

OBBject
    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

Name	Type	Description
date	Union[date, str]	The date of the data.
symbol	str	Symbol representing the entity requested in the data.
value	float

Name	Type	Description
date	Union[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.