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=CU

HTTP 200 OK
						Allow: GET, HEAD, OPTIONS
						Content-Type: application/json
						Vary: Accept
						
					{
    "count": 7,
    "next": null,
    "previous": null,
    "results": [
        {
            "url": "https://oipa2018.unesco.org/api/activities/35233/?format=api",
            "iati_identifier": "XM-DAC-41304-513CUB4000",
            "title": {
                "id": 35233,
                "narratives": [
                    {
                        "text": "Jardines de la Reina National Park: Technical support to strengthen management & possible future World Heritage nomination file preparation",
                        "language": {
                            "code": "en",
                            "name": "English"
                        }
                    }
                ]
            },
            "descriptions": [
                {
                    "id": 35233,
                    "type": {
                        "code": "1",
                        "name": "General"
                    },
                    "narratives": [
                        {
                            "text": "The \"Reef System in the Cuban Caribbean\" was inscribed on the World Heritage Tentative List in 2003 and is composed of nine protected areas, one of which, Jardines de la Reina (2,170 km2), is considered the most pristine and natural marine ecosystem in the region. The site has a legal framework for its conservation and management but would benefit substantially from technical training especially in the development of a Statement of its Outstanding Universal Value, the procedure to prepare World Heritage Site nominations and the identification of a list of actions to enhance current conservation to substantiate future nominations.",
                            "language": {
                                "code": "en",
                                "name": "English"
                            }
                        }
                    ]
                }
            ],
            "transactions": "https://oipa2018.unesco.org/api/activities/35233/transactions/?format=api"
        },
        {
            "url": "https://oipa2018.unesco.org/api/activities/35545/?format=api",
            "iati_identifier": "XM-DAC-41304-549RLA4000",
            "title": {
                "id": 35545,
                "narratives": [
                    {
                        "text": "Transcultura",
                        "language": {
                            "code": "en",
                            "name": "English"
                        }
                    }
                ]
            },
            "descriptions": [
                {
                    "id": 35545,
                    "type": {
                        "code": "1",
                        "name": "General"
                    },
                    "narratives": [
                        {
                            "text": "This Programme seeks to deepen integration between Cuba, the Caribbean and the European Union. It aims to harness diversity and build bridges between people and cultures from different linguistic areas. This will be achieved through the establishment of a regional Cultural Training Hub in Cuba, linked to relevant Caribbean institutions and supported by scholarships to facilitate mobility. The Programme will create opportunities for entrepreneurship, socio-economic projects and collaboration in the cultural and creative sectors, heritage and tourism within the Caribbean region and with the EU.",
                            "language": {
                                "code": "en",
                                "name": "English"
                            }
                        }
                    ]
                }
            ],
            "transactions": "https://oipa2018.unesco.org/api/activities/35545/transactions/?format=api"
        },
        {
            "url": "https://oipa2018.unesco.org/api/activities/37052/?format=api",
            "iati_identifier": "XM-DAC-41304-39-815",
            "title": {
                "id": 37052,
                "narratives": [
                    {
                        "text": "Enhancing teacher training for a quality education for all.",
                        "language": {
                            "code": "en",
                            "name": "English"
                        }
                    }
                ]
            },
            "descriptions": [
                {
                    "id": 37052,
                    "type": {
                        "code": "1",
                        "name": "General"
                    },
                    "narratives": [
                        {
                            "text": "The activity will contribute to the professional development of teachers in Cluster countries by the integration of elements of Artificial Intelligence and other emerging technologies into school curricula and/or academic offers of long life learning institutions., in coordination with the Communication and Information Sector.",
                            "language": {
                                "code": "en",
                                "name": "English"
                            }
                        }
                    ]
                }
            ],
            "transactions": "https://oipa2018.unesco.org/api/activities/37052/transactions/?format=api"
        },
        {
            "url": "https://oipa2018.unesco.org/api/activities/37107/?format=api",
            "iati_identifier": "XM-DAC-41304-39-855",
            "title": {
                "id": 37107,
                "narratives": [
                    {
                        "text": "Promoting Education for Sustainable Development in schools and communities.",
                        "language": {
                            "code": "en",
                            "name": "English"
                        }
                    }
                ]
            },
            "descriptions": [
                {
                    "id": 37107,
                    "type": {
                        "code": "1",
                        "name": "General"
                    },
                    "narratives": [
                        {
                            "text": "This activity will contribute to promoting safe and secure learning spaces in schools and communities by promoting Education for Sustainable Development and Global Citizenship Education, strengthening resilience to face the effects of climate change and preventing school violence",
                            "language": {
                                "code": "en",
                                "name": "English"
                            }
                        }
                    ]
                }
            ],
            "transactions": "https://oipa2018.unesco.org/api/activities/37107/transactions/?format=api"
        },
        {
            "url": "https://oipa2018.unesco.org/api/activities/37317/?format=api",
            "iati_identifier": "XM-DAC-41304-39-1039",
            "title": {
                "id": 37317,
                "narratives": [
                    {
                        "text": "Fostering universal access to information through open and innovative ICT solutions in the Latin Caribbean",
                        "language": {
                            "code": "en",
                            "name": "English"
                        }
                    }
                ]
            },
            "descriptions": [
                {
                    "id": 37317,
                    "type": {
                        "code": "1",
                        "name": "General"
                    },
                    "narratives": [
                        {
                            "text": "The activity contributes to strengthen capacities in member states for the implementation of policy guidelines and initiatives aimed at fostering universal access to information through Open Access, Open Educational Resources and FOSS and for harnessing the potential of emerging technologies, including AI, for achieving the Sustainable Development Goals.",
                            "language": {
                                "code": "en",
                                "name": "English"
                            }
                        }
                    ]
                }
            ],
            "transactions": "https://oipa2018.unesco.org/api/activities/37317/transactions/?format=api"
        },
        {
            "url": "https://oipa2018.unesco.org/api/activities/38144/?format=api",
            "iati_identifier": "XM-DAC-41304-39-8928",
            "title": {
                "id": 38144,
                "narratives": [
                    {
                        "text": "Promoting media and information literacy in the Latin Caribbean",
                        "language": {
                            "code": "en",
                            "name": "English"
                        }
                    }
                ]
            },
            "descriptions": [
                {
                    "id": 38144,
                    "type": {
                        "code": "1",
                        "name": "General"
                    },
                    "narratives": [
                        {
                            "text": "The activity is aimed at supporting member States in the development of media and information literacy strategies",
                            "language": {
                                "code": "en",
                                "name": "English"
                            }
                        }
                    ]
                }
            ],
            "transactions": "https://oipa2018.unesco.org/api/activities/38144/transactions/?format=api"
        },
        {
            "url": "https://oipa2018.unesco.org/api/activities/38249/?format=api",
            "iati_identifier": "XM-DAC-41304-39-9253",
            "title": {
                "id": 38249,
                "narratives": [
                    {
                        "text": "Strengthening the management of natural resources, resilience to climate change and biodiversity in the Biosphere Reserves towards compliance with the SDGs.",
                        "language": {
                            "code": "en",
                            "name": "English"
                        }
                    }
                ]
            },
            "descriptions": [
                {
                    "id": 38249,
                    "type": {
                        "code": "1",
                        "name": "General"
                    },
                    "narratives": [
                        {
                            "text": "The present project aims at enhancing cooperation and networking among the six biosphere reserves in Cuba towards strengthening their management and their response to climate change ensuring the full participation of the communities for a common approach to the accomplishment of the 2030 Agenda.",
                            "language": {
                                "code": "en",
                                "name": "English"
                            }
                        }
                    ]
                }
            ],
            "transactions": "https://oipa2018.unesco.org/api/activities/38249/transactions/?format=api"
        }
    ]
}