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 |
---|---|---|---|---|
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 |
provider | Literal['oecd'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'oecd' if there is no default. | oecd | True |
Name | Type | Description | Default | Optional |
---|---|---|---|---|
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 |
provider | Literal['oecd'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'oecd' if there is no default. | oecd | True |
country | Literal['colombia', 'new_zealand', 'united_kingdom', 'italy', 'luxembourg', 'euro_area19', 'sweden', 'oecd', 'south_africa', 'denmark', 'canada', 'switzerland', 'slovakia', 'hungary', 'portugal', 'spain', 'france', 'czech_republic', 'costa_rica', 'japan', 'slovenia', 'russia', 'austria', 'latvia', 'netherlands', 'israel', 'iceland', 'united_states', 'ireland', 'mexico', 'germany', 'greece', 'turkey', 'australia', 'poland', 'south_korea', 'chile', 'finland', 'european_union27_2020', 'norway', 'lithuania', 'euro_area20', 'estonia', 'belgium', 'brazil', 'indonesia', 'all'] | Country to get GDP for. | united_states | True |
sex | Literal['total', 'male', 'female'] | Sex to get unemployment for. | total | True |
frequency | Literal['monthly', 'quarterly', 'annual'] | Frequency to get unemployment for. | monthly | True |
age | Literal['total', '15-24', '15-64', '25-54', '55-64'] | 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 | date | The date of the data. |
value | float | Unemployment rate (given as a whole number, i.e 10=10%) |
country | str | Country for which unemployment rate is given |
Name | Type | Description |
---|---|---|
date | date | The date of the data. |
value | float | Unemployment rate (given as a whole number, i.e 10=10%) |
country | str | Country for which unemployment rate is given |