Documentation for HAPI V1 is available here including code example:
https://hdx-hapi.readthedocs.io/en/latest/
The read the docs for HDX HAPI is public and so does not contain the API URL in both the text and the code examples. Please replace https://placeholder.url with https://hapi-testing.innovation.humdata.org/ to get the testing links.
Technical documentation is available and includes a test environment for query the API
https://hapi-testing.innovation.humdata.org/docs
The root of the API is: https://hapi-testing.innovation.humdata.org/
Current status
In HAPI V1 two themes have been added, 3W and Population for 3 countries. In addition supporting tables such as admin divisions, sector names and age ranges are also present.
The data in the API represents the most current data. It is not yet possible to query by date to get historical data.
Please do not use the API in any public facing products and please note that as the product is still under development the endpoints should not be considered stable and are subject to change.
Approach
Please make use of the documentation to get started on the API. It should contain all you need, but it is a work in progress. If anything in the documentation is not clear, please ask in the slack channel for guidance.
The API can either be queried via a script or using the test environment here:
https://stage.hapi-humdata-org.ahconu.org/docs
Possible queries to make
Here are some suggested queries to make use of the API.
Queries | Result |
What countries are currently supported? | |
Get a dataset of all the projects in Kabul (adm1) in the health sector? | |
What are the sector names? | |
What is the under 5, female population of Awka North in Nigeria? |
Possible analysis using data from the API
These suggestions would require further processing of the data
Which areas of Afghanistan have more females than males? |
Which are the 5 most populous in Nigeria areas for children as a percentage? |
What sector has the most organisations working in Mali? |
How many admin2 levels are there in Afghanistan? |
Feedback
Please provide feedback in the feedback document on what you tried and any problems you encountered