dtmapi 0.0.11

A Python package for fetching data from the IOM's Displacement Tracking Matrix (DTM).

---

dtmapi

About

dtmapi is a Python package developed by Displacement Tracking Matrix (DTM). This package allows the humanitarian community, academia, media, government, and non-governmental organizations to utilize the data collected by DTM. It provides non-sensitive Internally Displaced Person (IDP) figures, aggregated at the country, Admin 1 (states, provinces, or equivalent), and Admin 2 (smaller subnational administrative areas) levels.

Please find more information about DTM API here.

Installation

dtmapi is available on PyPI. It can be installed as below:

pip install dtmapi

Usage

Here's a quick example to get you started:

import dtmapi

# Get all countries for which DTM data is publicly available through the API.
all_country_list = dtmapi.get_all_countries()
all_country_list.head()

# Get all operations for which DTM data is publicly available through the API.
all_operation_list = dtmapi.get_all_operations()
all_operation_list.head()

# Get IDP Admin 0 Data for Ethiopia from Round 1 to Round 10
idp_admin0_data = dtmapi.get_idp_admin0_data(CountryName='Ethiopia', FromRoundNumber=1, ToRoundNumber=10, to_pandas=True)
idp_admin0_data.head()

# Get IDP Admin 1 Data for Sudan from reporting date 2020-01-01 to 2024-08-15
idp_admin1_data = dtmapi.get_idp_admin1_data(CountryName='Sudan', Admin1Name="Blue Nile", FromReportingDate='2020-01-01', ToReportingDate='2024-08-15', to_pandas=True)
idp_admin1_data.head()

# Get IDP Admin 2 Data for Lebanon
idp_admin2_data = dtmapi.get_idp_admin2_data(Operation="Displacement due to conflict", CountryName='Lebanon', to_pandas=True)
idp_admin2_data.head()

Documentation

Comprehensive documentation is available at dtmapi.readthedocs.io.

Source Code

The source code for dtmapi is available on GitHub.

Feel free to explore the repository, contribute, or raise any issues you may encounter.

License

This project is licensed under the MIT License. See the LICENSE file for details.

Contact

For any questions or feedback, please reach out to us at [e-mail].