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: str | None | list[str | None]
Default: united_states
The country to get data. Multiple items allowed for provider(s): oecd.
frequency: Literal['monthly', 'quarter', 'annual'] | None
Default: monthly
The frequency of the data.
start_date: date | None | str
Start date of the data, in YYYY-MM-DD format.
end_date: date | None | str
End date of the data, in YYYY-MM-DD format.
country: str | None
Default: united_states
The country to get data.
frequency: Literal['monthly', 'quarter', 'annual'] | None
Default: monthly
The frequency of the data.
start_date: date | None | str
Start date of the data, in YYYY-MM-DD format.
end_date: date | None | str
End date of the data, in YYYY-MM-DD format.
sex: Literal['total', 'male', 'female'] | None
Default: total
Sex to get unemployment for.
age: Literal['total', '15-24', '25+'] | None
Default: total
Age group to get unemployment for. Total indicates 15 years or over
seasonal_adjustment: bool | None
Default: False
Whether to get seasonally adjusted unemployment. Defaults to False.
Data
- standard
- oecd
date: date | None | str
The date of the data.
country: str | None
Country for which unemployment rate is given
value: float | None
Unemployment rate, as a normalized percent.
date: date | None | str
The date of the data.
country: str | None
Country for which unemployment rate is given
value: float | None
Unemployment rate, as a normalized percent.