Data API

The following filters are available, which enable you to construct a query for the data that you are looking for.

Available filters

iati-identifier

Returns activities matching your specified IATI Identifier value. In practice, no more than one activity should be returned as each activity should contain a unique IATI Identifier value.

Parameters:
iati-identifier: String denoting an individual IATI activity ID
Example API call:
iati-identifier=NL-KVK-41177206-C-002350

recipient-country

Returns activities where the recipient-country element has a @code attribute value that matches your specified ISO country code.

Parameters:
recipient-country: 2-digit ISO country code that appears on the country codelist
Example API call:
recipient-country=SS

recipient-region

Returns activities where the recipient-region element has a @code attribute value that matches your specified region code.

Parameters:
recipient-region: A region code that appears in a recipient region @code attribute
Example API call:
recipient-region=298

reporting-org

Returns activities where the reporting-org element has a @ref attribute value that matches your specified Organisation identifier string.

Parameters:
reporting-org: Organisation identifier string.
Example API call:
reporting-org=NL-KVK-41177206

reporting-org.type

Returns activities where the reporting-org element has a @type attribute value that matches your specified value.

Parameters:
recipient-org.type: 2-digit value that appears on the `organisation type codelist<http://iatistandard.org/codelists/OrganisationType/>`__
Example API call:
reporting-org.type=10

sector

Returns activities where the sector element has a @code attribute value that matches your specified sector code.

Parameters:
sector: A sector code that appears on a sector’s @code attribute
Example API call:
sector=11110

policy-marker

Returns activities where a policy-marker element has a @code attribute value that matches your specified policy-marker value.

Parameters:
policy-marker: 1-digit value that appears on the `policy marker codelist<http://iatistandard.org/codelists/PolicyMarker/>`__
Example API call:
policy-marker=1

participating-org

Returns activities where the participating-org element has a @ref attribute value that matches your specified participating-org identification string.

Parameters:
participating-org: Identification string for the organisation who is participating
Example API call:
participating-org=NL-KVK-41177206

participating-org.role

Returns activities where the participating-org element has a @role attribute value that matches your specified value.

Parameters:
participating-org.role: 1-digit value that appears on the organisation role codelist
Example API call:
participating-org.role=1

transaction

Returns activities containing at least one transaction element where the @ref attribute matches your given string.

Parameters:
transaction: String denoting a transaction @ref attribute
Example API call:
transaction=15458

transaction_provider-org

Returns activities containing at least one transaction element where the provider-org element has a @ref attribute value that matches your specified organisation identifier string.

Parameters:
transaction_provider-org: Organisation identifier string for the organisation issuing who provided transaction funds
Example API call:
transaction_provider-org=GB-1

transaction_provider-org.provider-activity-id

Returns activities containing at least one transaction element where the provider-activity-id element matches your specified IATI activity identifier string.

Parameters:
transaction_provider-org.provider-activity-id: String denoting an IATI activity identifier
Example API call:
transaction_provider-org.provider-activity-id=GB-1-202505

transaction_receiver-org

Returns activities containing at least one transaction element where funds have been transferred to an organisation with your specified Organisation identifier string.

Parameters:
transaction_receiver-org: Organisation identifier string for the organisation issuing who received transaction funds
Example API call:
transaction_receiver-org=GB-CHC-1108464

transaction_receiver-org.receiver-activity-id

Returns activities containing at least one transaction element where the receiver-org element has an @receiver-activity-id attribute that matches your specified IATI activity identifier string.

Parameters:
transaction_receiver-org.receiver-activity-id: String denoting an IATI activity identifier
Example API call:
transaction_receiver-org.receiver-activity-id=GB-CHC-1099776-B8

start-date

Returns activities where the value of an @activity-date attribute within an @activity-date element (with @type equivalent to start-planned or start-actual) is chronologically before or after your specified query value.

To return activities before your specified date, use ‘start-date__lt’ To return activities after your specified date use ‘start-date__gt’

Parameters:
start-date: ISO format date (YYYY-MM-DD).
Example API calls:
start-date__lt=2015-01-01 start-date__gt=2015-01-01

end-date

Returns activities where the value of an @activity-date attribute within an @activity-date element (with @type equivalent to end-planned or end-actual) is chronologically before or after your specified query value.

To return activities before your specified date, use ‘end-date__lt’ To return activities after your specified date use ‘end-date__gt’

Parameters:
end-date: ISO format date (YYYY-MM-DD).
Example API calls:
end-date__lt=2015-01-01 end-date__gt=2015-01-01

last-change

Returns activities where the observed last change the of an activity is chronologically before or after your specified query value. This information is provided by Datastore update processes, rather than the actual IATI data.

To return activities before your specified date use ‘last-change__lt’ To return activities after your specified date use ‘last-change__gt’

Parameters:
last-change: ISO format date (YYYY-MM-DD).
Example API calls:
last-change__lt=2009-01-01 last-change__gt=2009-01-01

last-updated-datetime

Returns activities where the @last-updated-datetime attribute of an activity is chronologically before or after your specified query value.

To return activities less than your specified date use ‘last-updated-datetime__lt’ To return activities less than your specified date use ‘last-updated-datetime__gt’

Parameters:
last-updated-datetime: ISO format date (YYYY-MM-DD).
Example API calls:
last-updated-datetime__lt=2015-01-01 last-updated-datetime__gt=2010-01-01

registry-dataset

Returns activities contained within your specified registry dataset.

Parameters:
registry-dataset: string name of the specified registry dataset
Example API call:
registry-dataset=dfid-af