The DHS Program User Forum      
Discussions regarding The DHS Program data and results
Home » Dissemination and Capacity Strengthening » Application Programming Interface (API)  » Welcome to The DHS Program API
Welcome to The DHS Program API [message #2687] Fri, 08 August 2014 12:02
Trevor-DHS is currently offline  Trevor-DHS
Messages: 527
Registered: January 2013
Senior Member
Do you have questions about the DHS Program API?

API Basics:
• What is an API?
An application programming interface (API) specifies how some software components should interact with each other. Simply put, for DHS it is a set of web service commands that users can include in their programs to access DHS indicator data directly. For example, http://api.dhsprogram.com/rest/dhs/data/20171000,ke?f=html will provide the total fertility rate for each of the DHS surveys in Kenya. Try it in your web browser.

• What can I get from the API?
The DHS Program indicator data are statistics for key population, health, HIV and nutrition indicators. You can get national, subnational or disaggregated data for almost 1500 indicators collected in more than 90 low and middle income countries.

• What can I do with the data from the API?
The API can be used to create various applications to help analyze, visualize, explore and disseminate data on population, health, HIV, and nutrition from more than 90 countries.
For ideas and inspiration, check out our sample applications at http://api.dhsprogram.com/#/sample-apps.html.

• How does the data in the API compare to the data that can be accessed via STATcompiler?
The data returned from the API is exactly the same data that is available from the STATcompiler - in fact the STATcompiler uses the API to get access to the data.

API Details:
• Where can I find the API Documentation?
All of the documentation is available at http://api.dhsprogram.com/#/index.html

• Where should I begin?
A good place to start is with the introduction to the data at http://api.dhsprogram.com/#/introdata.html

• What countries does the API cover
You can see the full list of DHS countries with data available here: http://api.dhsprogram.com/rest/dhs/countries/?f=html

• What indicators can I get through the API
For a full list of the indicators included in the API see http://api.dhsprogram.com/rest/dhs/indicators?f=html

• Do I need a key to access the API?
The DHS Program API provides open access to DHS indicator data for all users. You are free to begin using the API to develop applications to support your activities, however:
* You can register at this link (http://api.dhsprogram.com/#/introdevelop.html) to be an official DHS API partner.
* When you register with The DHS Program as an API user:
-- You will receive an API key, allowing you a larger number of entries per page returned;
-- The DHS Program may be available to assist you in the development of your application and adapt the API to better fit the needs of your project;
-- Your applications may be featured and promoted as good examples of DHS data use, on the API and DHS Program websites and social media channels;
-- Your feedback will influence further API developments, making it a richer tool for all.

API Updates:
• Where can I find the latest updates to the API?
Here: http://api.dhsprogram.com/#/releasenotes.html
And follow us on Twitter: @DHSprogramAPI
Next Topic: getting indicator by only selected background characteristics
Goto Forum:
  


Current Time: Sun Sep 24 17:02:20 Eastern Daylight Time 2017