IATI Registry API

API Documentation

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

Authentication

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>

Authorisation

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.

Response

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.

Package/Dataset Endpoints

  1. Accessing/List Of All IATI Registry Datasets
  2. Searching IATI Datasets And Accessing Datasets Metadata
  3. Accessing Metadata of the Dataset and its Resource
  4. Creating a Dataset
  5. Updating a Dataset
  6. Patch a Dataset
  7. Delete a Dataset

Resource Endpoints

  1. Accessing Metadata of the Resource
  2. Updating a Resource
  3. Patch a Resource
  4. Delete a Resource

Publisher Endpoints

  1. List of Publishers
  2. Accessing Metadata of the Publisher
  3. Creating a new Publisher
  4. Updating a Publisher
  5. Patch a Publisher
  6. Delete a Publisher