country_profile
Get a profile of country statistics and economic indicators.
Examples
from openbb import obb
obb.economy.country_profile(provider='econdb', country='united_kingdom')
# Enter the country as the full name, or iso code. If `latest` is False, the complete history for each series is returned.
obb.economy.country_profile(country='united_states,jp', latest=False, provider='econdb')
Parameters
- standard
- econdb
Name | Type | Description | Default | Optional |
---|---|---|---|---|
country | Union[str, List[str]] | The country to get data. Multiple items allowed for provider(s): econdb. | False |
Name | Type | Description | Default | Optional |
---|---|---|---|---|
country | Union[str, List[str]] | The country to get data. Multiple items allowed for provider(s): econdb. | False | |
latest | bool | If True, return only the latest data. If False, return all available data for each indicator. | True | True |
use_cache | bool | If True, the request will be cached for one day.Using cache is recommended to avoid needlessly requesting the same data. | True | True |
Returns
OBBject
results : List[CountryProfile]
Serializable results.
provider : Optional[Literal['econdb']]
Provider name.
warnings : Optional[List[Warning_]]
List of warnings.
chart : Optional[Chart]
Chart object.
extra : Dict[str, Any]
Extra info.
Data
- standard
- econdb
Name | Type | Description |
---|---|---|
country | str | |
population | int | Population. |
gdp_usd | float | Gross Domestic Product, in billions of USD. |
gdp_qoq | float | GDP growth quarter-over-quarter change, as a normalized percent. |
gdp_yoy | float | GDP growth year-over-year change, as a normalized percent. |
cpi_yoy | float | Consumer Price Index year-over-year change, as a normalized percent. |
core_yoy | float | Core Consumer Price Index year-over-year change, as a normalized percent. |
retail_sales_yoy | float | Retail Sales year-over-year change, as a normalized percent. |
industrial_production_yoy | float | Industrial Production year-over-year change, as a normalized percent. |
policy_rate | float | Short term policy rate, as a normalized percent. |
yield_10y | float | 10-year government bond yield, as a normalized percent. |
govt_debt_gdp | float | Government debt as a percent (normalized) of GDP. |
current_account_gdp | float | Current account balance as a percent (normalized) of GDP. |
jobless_rate | float | Unemployment rate, as a normalized percent. |
Name | Type | Description |
---|---|---|
country | str | |
population | int | Population. |
gdp_usd | float | Gross Domestic Product, in billions of USD. |
gdp_qoq | float | GDP growth quarter-over-quarter change, as a normalized percent. |
gdp_yoy | float | GDP growth year-over-year change, as a normalized percent. |
cpi_yoy | float | Consumer Price Index year-over-year change, as a normalized percent. |
core_yoy | float | Core Consumer Price Index year-over-year change, as a normalized percent. |
retail_sales_yoy | float | Retail Sales year-over-year change, as a normalized percent. |
industrial_production_yoy | float | Industrial Production year-over-year change, as a normalized percent. |
policy_rate | float | Short term policy rate, as a normalized percent. |
yield_10y | float | 10-year government bond yield, as a normalized percent. |
govt_debt_gdp | float | Government debt as a percent (normalized) of GDP. |
current_account_gdp | float | Current account balance as a percent (normalized) of GDP. |
jobless_rate | float | Unemployment rate, as a normalized percent. |