Fred Non Farm Payrolls
Implementation details
Class names
| Model name | Parameters class | Data class |
|---|---|---|
FredNonFarmPayrolls | FredNonFarmPayrollsQueryParams | FredNonFarmPayrollsData |
Import Statement
from openbb_core.provider.standard_models. import (
FredNonFarmPayrollsData,
FredNonFarmPayrollsQueryParams,
)
Parameters
- standard
- fred
date: date | str | None | list[date | str | None]
A specific date to get data for. Default is the latest report. Multiple items allowed for provider(s): fred.
date: date | str | None | list[date | str | None]
A specific date to get data for. Default is the latest report. Multiple items allowed for provider(s): fred.
category: str | None
Default: employees_nsa
The category to query.
Choices
- 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
use_cache: bool | None
Default: True
When True, the request is served from, and written to, the FRED response cache.
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 observation.
symbol: str
The series id of the observation.
value: float
The observed value.
name: str
The name of the series.
units: str | None
The unit of measure the series is published in.
element_id: str
The element id in the parent/child relationship.
parent_id: str
The parent id in the parent/child relationship.
children: str | None
The element_id of each child, as a comma-separated string.
level: int
The indentation level of the element.