The IATI Registry holds meta-data on files published in the IATI XML format. The files themselves are stored in different places across the web, and you will need to fetch and process the original files yourself. If you are looking for an API directly onto IATI data, you can use the IATI DataStore or consult the Open Development Toolkit to learn about other third-party platforms. If in doubt, ask on IATI Discuss or email the technical team on firstname.lastname@example.org.
You can interact with the registry via its API, an implementation of the CKAN API. Full CKAN API documentation is available here.
The API returns data in JSON format.
To fetch organisation files:
To fetch activity files:
These calls will not return all results by default. Page through results with the offset and limit parameters. For example:
To fetch an individual dataset use its identifier. Full dataset details contain information on downloadable resources (i.e. the IATI XML files)
The downloadable file details can be found in the resource.url field of the JSON response.
You can filter the responses on the basis of country (by ISO 2-digit code) or publisher (known as ‘organizations’ internally in the registry).
For example, to fetch all the activity files from DFID use:
To fetch all the activity files which have Ghana as their primary segment, use:
Note: Querying for all the activity files with a country as their primary segment does not guarantee you will get all the activities in that country due to the way activities are split into files. For example, an activity that is 60% in Nigeria, and 40% in Ghana would be in a Nigeria file. It is not currently possible to be sure you have all the activities for a country without processing all files. Work is ongoing to address this.