Skip to main content

unemployment

Get global unemployment data.

Examples

from openbb import obb
obb.economy.unemployment(provider='oecd')
obb.economy.unemployment(country='all', frequency='quarter', provider='oecd')
# Demographics for the statistics are selected with the `age` parameter.
obb.economy.unemployment(country='all', frequency='quarter', age=total, provider='oecd')

Parameters

NameTypeDescriptionDefaultOptional
countryUnion[str, List[str]]The country to get data. Multiple items allowed for provider(s): oecd.united_statesTrue
frequencyLiteral['monthly', 'quarter', 'annual']The frequency of the data.monthlyTrue
start_dateUnion[date, str]Start date of the data, in YYYY-MM-DD format.NoneTrue
end_dateUnion[date, str]End date of the data, in YYYY-MM-DD format.NoneTrue

Returns

OBBject
results : List[Unemployment]
Serializable results.

provider : Optional[Literal['oecd']]
Provider name.

warnings : Optional[List[Warning_]]
List of warnings.

chart : Optional[Chart]
Chart object.

extra : Dict[str, Any]
Extra info.

Data

NameTypeDescription
dateUnion[date, str]The date of the data.
countrystrCountry for which unemployment rate is given
valuefloatUnemployment rate, as a normalized percent.