GET rest/dhs/data

dhsprogram.com:dhs-program-api

Summary: Get survey data
Operation ID: getData
Auth: unknown
Description

Returns actual survey data values for specified indicators, countries, and years. This is the primary endpoint for retrieving statistical data.

Parameters (5)

breakdown (string, query, optional)

Data breakdown level (e.g., 'subnational' for regional data, 'total' for national aggregates)

Constraints: {'enum': ['total', 'subnational']}

countryIds (string, query, required)

Comma-separated list of DHS country codes (e.g., 'GH,KE,NG')

f (string, query, optional, default: json)

Response format (json or xml)

Constraints: {'enum': ['json', 'xml']}

indicatorIds (string, query, required)

Comma-separated list of indicator IDs (e.g., 'FE_FRTR_W_A15,FE_FRTR_W_A20')

surveyYear (string, query, required)

Survey year to retrieve data for

Examples (2)

TitleTypeURLAction
Get fertility rate data for Nigeria probe-gate https://api.dhsprogram.com/rest/dhs/data?f=json&countryIds=NG&indicatorIds=FE_FRTR_W_TFR&surveyYear=2018
Get malaria indicator data probe-gate https://api.dhsprogram.com/rest/dhs/data?f=json&countryIds=UG&indicatorIds=ML_PMAL_C_RDT&perpage=10

No probe data for this endpoint yet.