Technical Notice: IATI Datastore Search was released on 8 March 2022 as the user interface of the IATI Datastore version 3.
The IATI Registry API is an HTTP-based API that you can use to programmatically query all the metadata held on the Registry, create and manage datasets, and perform a wide variety of other tasks. The IATI Registry API is an implementation of the CKAN API - see the full CKAN API documentation.
Accessing the API
The API authentication is done using the IATI Registry API token. The API token can be obtained by going to the IATI registry UI and navigating to your account. URL: https://iatiregistry.org/user/<your username>
Some API functions require authorisation. When calling an API function that requires authorisation, you must authenticate yourself by adding the following authorisation header to the request: ('Authorization', 'Your API Token'). Further details on the API authentication can be found in the CKAN user guide.
All IATI Registry API requests return data in JSON format.
API Endpoint List
This section lists all of the IATI Registry API endpoints. By clicking the individual endpoints you can see further details about how to use each of them.
- Accessing/List Of All IATI Registry Datasets
- Searching IATI Datasets And Accessing Datasets Metadata
- Accessing Metadata of the Dataset and its Resource
- Creating a Dataset
- Updating a Dataset
- Patch a Dataset
- Delete a Dataset