@@ -951,108 +951,6 @@ def country_profile(
951
951
)
952
952
)
953
953
954
- @exception_handler
955
- @validate
956
- def country_profile (
957
- self ,
958
- country : Annotated [
959
- Union [str , List [str ]],
960
- OpenBBField (
961
- description = "The country to get data. Multiple comma separated items allowed for provider(s): econdb."
962
- ),
963
- ],
964
- provider : Annotated [
965
- Optional [Literal ["econdb" ]],
966
- OpenBBField (
967
- description = "The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: econdb."
968
- ),
969
- ] = None ,
970
- ** kwargs
971
- ) -> OBBject :
972
- """Get a profile of country statistics and economic indicators.
973
-
974
- Parameters
975
- ----------
976
- country : Union[str, List[str]]
977
- The country to get data. Multiple comma separated items allowed for provider(s): econdb.
978
- provider : Optional[Literal['econdb']]
979
- The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: econdb.
980
- latest : bool
981
- If True, return only the latest data. If False, return all available data for each indicator. (provider: econdb)
982
- use_cache : bool
983
- If True, the request will be cached for one day.Using cache is recommended to avoid needlessly requesting the same data. (provider: econdb)
984
-
985
- Returns
986
- -------
987
- OBBject
988
- results : List[CountryProfile]
989
- Serializable results.
990
- provider : Optional[Literal['econdb']]
991
- Provider name.
992
- warnings : Optional[List[Warning_]]
993
- List of warnings.
994
- chart : Optional[Chart]
995
- Chart object.
996
- extra : Dict[str, Any]
997
- Extra info.
998
-
999
- CountryProfile
1000
- --------------
1001
- country : str
1002
-
1003
- population : Optional[int]
1004
- Population.
1005
- gdp_usd : Optional[float]
1006
- Gross Domestic Product, in billions of USD.
1007
- gdp_qoq : Optional[float]
1008
- GDP growth quarter-over-quarter change, as a normalized percent.
1009
- gdp_yoy : Optional[float]
1010
- GDP growth year-over-year change, as a normalized percent.
1011
- cpi_yoy : Optional[float]
1012
- Consumer Price Index year-over-year change, as a normalized percent.
1013
- core_yoy : Optional[float]
1014
- Core Consumer Price Index year-over-year change, as a normalized percent.
1015
- retail_sales_yoy : Optional[float]
1016
- Retail Sales year-over-year change, as a normalized percent.
1017
- industrial_production_yoy : Optional[float]
1018
- Industrial Production year-over-year change, as a normalized percent.
1019
- policy_rate : Optional[float]
1020
- Short term policy rate, as a normalized percent.
1021
- yield_10y : Optional[float]
1022
- 10-year government bond yield, as a normalized percent.
1023
- govt_debt_gdp : Optional[float]
1024
- Government debt as a percent (normalized) of GDP.
1025
- current_account_gdp : Optional[float]
1026
- Current account balance as a percent (normalized) of GDP.
1027
- jobless_rate : Optional[float]
1028
- Unemployment rate, as a normalized percent.
1029
-
1030
- Examples
1031
- --------
1032
- >>> from openbb import obb
1033
- >>> obb.economy.country_profile(provider='econdb', country='united_kingdom')
1034
- >>> # Enter the country as the full name, or iso code. If `latest` is False, the complete history for each series is returned.
1035
- >>> obb.economy.country_profile(country='united_states,jp', latest=False, provider='econdb')
1036
- """ # noqa: E501
1037
-
1038
- return self ._run (
1039
- "/economy/country_profile" ,
1040
- ** filter_inputs (
1041
- provider_choices = {
1042
- "provider" : self ._get_provider (
1043
- provider ,
1044
- "economy.country_profile" ,
1045
- ("econdb" ,),
1046
- )
1047
- },
1048
- standard_params = {
1049
- "country" : country ,
1050
- },
1051
- extra_params = kwargs ,
1052
- info = {"country" : {"econdb" : {"multiple_items_allowed" : True }}},
1053
- )
1054
- )
1055
-
1056
954
@exception_handler
1057
955
@validate
1058
956
def cpi (
0 commit comments