Unemployment
Implementation details
Class names
| Model name | Parameters class | Data class |
|---|---|---|
Unemployment | UnemploymentQueryParams | UnemploymentData |
Import Statement
from openbb_core.provider.standard_models.unemployment import (
UnemploymentData,
UnemploymentQueryParams,
)
Parameters
- standard
- oecd
country: Union[str, list[str]]
The country to get data. Multiple items allowed for provider(s): oecd.
• Default: united_states
• Optional: True
frequency: Literal['monthly', 'quarter', 'annual']
The frequency of the data.
• Default: monthly
• Optional: True
start_date: Union[date, str]
Start date of the data, in YYYY-MM-DD format.
• Optional: True
end_date: Union[date, str]
End date of the data, in YYYY-MM-DD format.
• Optional: True
country: str
The country to get data.
• Default: united_states
• Optional: True
frequency: Literal['monthly', 'quarter', 'annual']
The frequency of the data.
• Default: monthly
• Optional: True
start_date: Union[date, str]
Start date of the data, in YYYY-MM-DD format.
• Optional: True
end_date: Union[date, str]
End date of the data, in YYYY-MM-DD format.
• Optional: True
sex: Literal['total', 'male', 'female']
Sex to get unemployment for.
• Default: total
• Optional: True
age: Literal['total', '15-24', '25+']
Age group to get unemployment for. Total indicates 15 years or over
• Default: total
• Optional: True
seasonal_adjustment: bool
Whether to get seasonally adjusted unemployment. Defaults to False.
• Default: False
• Optional: True
Data
- standard
- oecd
date: Union[date, str]
The date of the data.
country: str
Country for which unemployment rate is given
value: float
Unemployment rate, as a normalized percent.
date: Union[date, str]
The date of the data.
country: str
Country for which unemployment rate is given
value: float
Unemployment rate, as a normalized percent.