Documentation for HAPI V1 is available here including code exampleexamples:
https://hdx-hapi.readthedocs.io/en/latest/
The read the docs ReadTheDocs 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 querying 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 as of the time of deployment. It is not yet possible to query by date to get historical data, and the data is not automatically updated in this testing version.
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.
...
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 Slack channel (see the email you received) for guidance.
The API can either be queried via a script or using the test environment here:
...
Queries | Result |
What countries are currently supported? | |
Get a dataset of all the 3W operational presence 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
...
Please provide feedback in the feedback documenton what you tried and any problems you encounteredSlack channel (see the email you received for the link). The HAPI team will convert them into tickets.