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
Name | Type | Description | Default | Optional |
---|---|---|---|---|
country | Union[str, List[str]] | The country to get data. Multiple items allowed for provider(s): oecd. | united_states | True |
frequency | Literal['monthly', 'quarter', 'annual'] | The frequency of the data. | monthly | True |
start_date | Union[date, str] | Start date of the data, in YYYY-MM-DD format. | None | True |
end_date | Union[date, str] | End date of the data, in YYYY-MM-DD format. | None | True |
Name | Type | Description | Default | Optional |
---|---|---|---|---|
country | str | The country to get data. | united_states | True |
frequency | Literal['monthly', 'quarter', 'annual'] | The frequency of the data. | monthly | True |
start_date | Union[date, str] | Start date of the data, in YYYY-MM-DD format. | None | True |
end_date | Union[date, str] | End date of the data, in YYYY-MM-DD format. | None | True |
sex | Literal['total', 'male', 'female'] | Sex to get unemployment for. | total | True |
age | Literal['total', '15-24', '25+'] | Age group to get unemployment for. Total indicates 15 years or over | total | True |
seasonal_adjustment | bool | Whether to get seasonally adjusted unemployment. Defaults to False. | False | True |
Data
- standard
- oecd
Name | Type | Description |
---|---|---|
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. |
Name | Type | Description |
---|---|---|
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. |