Activity List

Returns a list of IATI Activities stored in OIPA.

Request parameters

activity_id (optional): Comma separated list of activity id's.
activity_scope (optional): Comma separated list of iso2 country codes.
recipient_country (optional): Comma separated list of iso2 country codes.
recipient_region (optional): Comma separated list of region codes.
sector (optional): Comma separated list of 5-digit sector codes.
sector_category (optional): Comma separated list of 3-digit sector codes.
reporting_organisation_identifier (optional): Comma separated list of reporting organisation IATI identifiers.
participating_organisation (optional): Comma separated list of organisation id's.
total_budget_value_lte (optional): Less then or equal total budget value
total_budget_value_gte (optional): Greater then or equal total budget value
total_child_budget_value_lte (optional): Less then or equal total child budget value
total_child_budget_value_gte (optional): Greater then or equal total child budget value
planned_start_date_lte (optional): Date in YYYY-MM-DD format, returns activities earlier or equal to the given activity date.
planned_start_date_gte (optional): Date in YYYY-MM-DD format, returns activities later or equal to the given activity date.
actual_start_date_lte (optional): Date in YYYY-MM-DD format, returns activities earlier or equal to the given activity date.
actual_start_date_gte (optional): Date in YYYY-MM-DD format, returns activities later or equal to the given activity date.
planned_end_date_lte (optional): Date in YYYY-MM-DD format, returns activities earlier or equal to the given activity date.
planned_end_date_gte (optional): Date in YYYY-MM-DD format, returns activities later or equal to the given activity date.
actual_end_date_lte (optional): Date in YYYY-MM-DD format, returns activities earlier or equal to the given activity date.
actual_end_date_gte (optional): Date in YYYY-MM-DD format, returns activities later or equal to the given activity date.
activity_status (optional): Comma separated list of activity statuses.
hierarchy (optional): Comma separated list of activity hierarchies.
related_activity_id (optional): Comma separated list of activity ids. Returns a list of all activities mentioning these activity id's.
related_activity_type (optional): Comma separated list of RelatedActivityType codes.
related_activity_recipient_country (optional): Comma separated list of iso2 country codes.
related_activity_recipient_region (optional): Comma separated list of region codes.
related_activity_sector (optional): Comma separated list of 5-digit sector codes.
related_activity_sector_category (optional): Comma separated list of 3-digit sector codes.
transaction_provider_activity (optional): Comma separated list of activity id's.
transaction_date_year (optional): Comma separated list of years in which the activity should have transactions.
transactionbalance_total_budget_gte (optional): Greater then or equal transaction balance of the total budget.
transactionbalance_total_budget_lte (optional): Less then or equal transaction balance of the total budget.
transactionbalance_total_expenditure_gte (optional): Greater then or equal transaction balance of the total expenditure.
transactionbalance_total_expenditure_lte (optional): Less then or equal transaction balance of the total expenditure.

Text search

API request may include q parameter. This parameter controls text search and contains expected value.

By default, searching is performed on:

iati_identifier the IATI identifier
title narratives
description narratives
recipient_country recipient country code and name
recipient_region recipient region code and name
reporting_org ref and narratives
sector sector code and name
document_link url, category and title narratives
participating_org ref and narratives

To search on subset of these fields the q_fields parameter can be used, like so; q_fields=iati_identifier,title,description

By default, search only return results if the hit resembles a full word. This can be altered through the q_lookup parameter. Options for this parameter are:

exact (default): Only return results when the query hit is a full word.
startswith: Also returns results when the word stars with the query.

Ordering

API request may include ordering parameter. This parameter controls the order in which results are returned.

Results can be ordered by:

title
planned_start_date
actual_start_date
planned_end_date
actual_end_date
start_date
end_date
activity_budget_value
activity_incoming_funds_value
activity_disbursement_value
activity_expenditure_value
activity_plus_child_budget_value
'transactionbalance_total_budget`
'transactionbalance_total_expenditure'

The user may also specify reverse orderings by prefixing the field name with '-', like so: -title

Aggregations

At the moment there's no direct aggregations on this endpoint.

The /activities/aggregations endpoint can be used for activity based aggregations.

Result details

Each item contains summarized information on the activity being shown, including the URI to activity details, which contain all information. To show more information in list view the fields parameter can be used. Example; fields=activity_id,title,country,any_field.

GET /api/activities/?format=api&recipient_country=TM

HTTP 200 OK
						Allow: GET, HEAD, OPTIONS
						Content-Type: application/json
						Vary: Accept
						
					{
    "count": 5,
    "next": null,
    "previous": null,
    "results": [
        {
            "url": "https://oipa2018.unesco.org/api/activities/36932/?format=api",
            "iati_identifier": "XM-DAC-41304-39-736",
            "title": {
                "id": 36932,
                "narratives": [
                    {
                        "text": "Supporting Improved Use of Education Data and ICT for Education Planning in Iran and Turkmenistan",
                        "language": {
                            "code": "en",
                            "name": "English"
                        }
                    }
                ]
            },
            "descriptions": [
                {
                    "id": 36932,
                    "type": {
                        "code": "1",
                        "name": "General"
                    },
                    "narratives": [
                        {
                            "text": "UNESCO Tehran, with the support of UNESCO Bangkok, will build on the completed activities of the 39 C/5 by continuing to provide technical support in advancement of EMIS and ICT in education. UNESCO Tehran, in collaboration with UNESCO Bangkok, will conduct follow-up activities to build national capacities in strengthening EMIS. In addition, in line with the expressed needs and priorities of Iran and Turkmenistan, support will be provided to both Member States in the strengthening of ICT in ED policies.",
                            "language": {
                                "code": "en",
                                "name": "English"
                            }
                        }
                    ]
                }
            ],
            "transactions": "https://oipa2018.unesco.org/api/activities/36932/transactions/?format=api"
        },
        {
            "url": "https://oipa2018.unesco.org/api/activities/37142/?format=api",
            "iati_identifier": "XM-DAC-41304-39-893",
            "title": {
                "id": 37142,
                "narratives": [
                    {
                        "text": "National Capacity Building on Safeguarding Intangible Cultural Heritage in Iran and Turkmenistan",
                        "language": {
                            "code": "en",
                            "name": "English"
                        }
                    }
                ]
            },
            "descriptions": [
                {
                    "id": 37142,
                    "type": {
                        "code": "1",
                        "name": "General"
                    },
                    "narratives": [
                        {
                            "text": "Activities under ER 6 will contribute to awareness raising and safeguarding of Intangible Cultural Heritage through several capacity-building workshops in both Iran and Turkmenistan. UNESCO Tehran also enhance the capacities of the Government of I.R. of Iran in response to ICH and emergencies.\nI.R of Iran has established a Category 2 Centre: Tehran ICH Centre. Iran is keen on further promoting ICH. In Turkmenistan, these activities respond to an important national priority of the Government of capacity-building for government officials, NGOs, community-based organizations and ICH practitioners.\n",
                            "language": {
                                "code": "en",
                                "name": "English"
                            }
                        }
                    ]
                }
            ],
            "transactions": "https://oipa2018.unesco.org/api/activities/37142/transactions/?format=api"
        },
        {
            "url": "https://oipa2018.unesco.org/api/activities/37189/?format=api",
            "iati_identifier": "XM-DAC-41304-39-926",
            "title": {
                "id": 37189,
                "narratives": [
                    {
                        "text": "Promoting TVET for Employment and Entrepreneurship in Iran and Turkmenistan",
                        "language": {
                            "code": "en",
                            "name": "English"
                        }
                    }
                ]
            },
            "descriptions": [
                {
                    "id": 37189,
                    "type": {
                        "code": "1",
                        "name": "General"
                    },
                    "narratives": [
                        {
                            "text": "With the high percentage of young people entering the labor market in both Iran and Turkmenistan, adequate levels of quality and relevance of TVET needs to be ensured in order to develop young people's employability and advance the socio-economic development of the country. At the same time, attention should be paid to how TVET can contribute to environmental sustainability and preparing the next generation to be stewards of the environment while contributing to economic development. The changing nature of the global economy and job market and the need to diversify the national economy away from excessive dependence on natural resources and towards sustainability are factors driving the need for high levels of skills and competencies in both countries' workforce.",
                            "language": {
                                "code": "en",
                                "name": "English"
                            }
                        }
                    ]
                }
            ],
            "transactions": "https://oipa2018.unesco.org/api/activities/37189/transactions/?format=api"
        },
        {
            "url": "https://oipa2018.unesco.org/api/activities/37745/?format=api",
            "iati_identifier": "XM-DAC-41304-39-1435",
            "title": {
                "id": 37745,
                "narratives": [
                    {
                        "text": "Strengthening the national capacities of the four countries of UNESCO Tehran Cluster Office in developing sustainable water policies and water development acts",
                        "language": {
                            "code": "en",
                            "name": "English"
                        }
                    }
                ]
            },
            "descriptions": [
                {
                    "id": 37745,
                    "type": {
                        "code": "1",
                        "name": "General"
                    },
                    "narratives": [
                        {
                            "text": "This activity is built on the years of active contribution of UNESCO Tehran Cluster Office (UTCO) and the reputation which the office has gained in promoting the sustainable development of the water sector within UTCO countries. The overall objective of the activity is to strengthen the national capacities of the four countries of UTCO in developing sustainable water policies and water development acts to meet their emerging challenges through UNESCO IHP programmes and initiatives; especially G-WADI, IDI, Groundwater management, PCCP, and advocacy for Climate Change, with focus on developing cluster wide initiatives.",
                            "language": {
                                "code": "en",
                                "name": "English"
                            }
                        }
                    ]
                }
            ],
            "transactions": "https://oipa2018.unesco.org/api/activities/37745/transactions/?format=api"
        },
        {
            "url": "https://oipa2018.unesco.org/api/activities/38200/?format=api",
            "iati_identifier": "XM-DAC-41304-39-9026",
            "title": {
                "id": 38200,
                "narratives": [
                    {
                        "text": "Strengthening Geosciences and Geohazard Risk Reduction in Tehran Cluster Countries",
                        "language": {
                            "code": "en",
                            "name": "English"
                        }
                    }
                ]
            },
            "descriptions": [
                {
                    "id": 38200,
                    "type": {
                        "code": "1",
                        "name": "General"
                    },
                    "narratives": [
                        {
                            "text": "Tehran Cluster countries are prone to a number of natural disasters including earthquake, floods, droughts, landslides, volcanos, avalanches and tsunamis. The activities will contribute to the achievement of the Agenda 2030 by making its member countries be more resilient and better prepared to manage and mitigate Natural Disaster Risks and putting at the centre of territorial development its natural, cultural and geological assets incorporated into various UNESCO Designation schemes.",
                            "language": {
                                "code": "en",
                                "name": "English"
                            }
                        }
                    ]
                }
            ],
            "transactions": "https://oipa2018.unesco.org/api/activities/38200/transactions/?format=api"
        }
    ]
}