Examples

Installation

pip install pydtm

Query country (admin0) level data

from pydtm.api import countryLevelData
# Query country level data for Yemen from January 2000 to December 2023
response_country = countryLevelData(admin0Pcode="YEM", monthFrom_month= "1", monthFrom_year=2000, monthTo_month= "12", monthTo_year=2023, to_pandas=True)
print(response_country)

Query admin1 level data

from pydtm.api import admin1LevelData
# Query admin1 level data for Yemen from January 2000 to December 2023
response_admin1 = admin1LevelData(admin0Pcode="YEM", monthFrom_month= "1", monthFrom_year=2000, monthTo_month= "12", monthTo_year=2023, to_pandas=True)
print(response_admin1)

Query admin2 level data

from pydtm.api import admin2LevelData
# Query admin2 level data for Yemen from January 2000 to December 2023
response_admin2 = admin2LevelData(admin0Pcode="YEM", monthFrom_month= "1", monthFrom_year=2000, monthTo_month= "12", monthTo_year=2023, to_pandas=True)
print(response_admin2)

Use the utils module to convert country names to pcode and vice versa

from pydtm.utils import ISO3166_A3ToCountry, countryToISO3166_A3, load_ISO3166_data

# Display all the countries and their ISO3166_A3 codes
print(load_ISO3166_data())

# Convert ISO3166_A3 code to country name
print(ISO3166_A3ToCountry("YEM"))

# Convert country name to ISO3166_A3 code
print(countryToISO3166_A3("Yemen"))