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 valuetotal_budget_value_gte(optional): Greater then or equal total budget valuetotal_child_budget_value_lte(optional): Less then or equal total child budget valuetotal_child_budget_value_gte(optional): Greater then or equal total child budget valueplanned_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_identifierthe IATI identifiertitlenarrativesdescriptionnarrativesrecipient_countryrecipient country code and namerecipient_regionrecipient region code and namereporting_orgref and narrativessectorsector code and namedocument_linkurl, category and title narrativesparticipating_orgref 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:
titleplanned_start_dateactual_start_dateplanned_end_dateactual_end_datestart_dateend_dateactivity_budget_valueactivity_incoming_funds_valueactivity_disbursement_valueactivity_expenditure_valueactivity_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=JM
{ "count": 3, "next": null, "previous": null, "results": [ { "url": "https://oipa2018.unesco.org/api/activities/35518/?format=api", "iati_identifier": "XM-DAC-41304-549GLO4001", "title": { "id": 35519, "narratives": [ { "text": "EU/UNESCO Expert Facility on the Governance of Culture in Developing Countries: Creating a new regulatory environment for the cultural and creative industries and South-South cooperation", "language": { "code": "en", "name": "English" } } ] }, "descriptions": [ { "id": 35519, "type": { "code": "1", "name": "General" }, "narratives": [ { "text": "Building upon the EU-funded project implemented between 2010-2015, the project provides, through EU/UNESCO Expert Facility, on-demand provision of expertise including support for designing policies and implementation plans. It will build on local expertise and reinforce human and institutional capacities in order to achieve ownership, sustainability of results and policy change in developing countries through targeted mentoring, capacity-building and advocacy work. It will also facilitate peer-to-peer learning, among government officials and experts, with a focus on South-South cooperation, to share experiences and transfer knowledge on governance of culture.", "language": { "code": "en", "name": "English" } } ] } ], "transactions": "https://oipa2018.unesco.org/api/activities/35518/transactions/?format=api" }, { "url": "https://oipa2018.unesco.org/api/activities/35542/?format=api", "iati_identifier": "XM-DAC-41304-503GLO4001", "title": { "id": 35542, "narratives": [ { "text": "Reshaping cultural policies for the promotion of fundamental freedoms and the diversity of cultural expressions", "language": { "code": "en", "name": "English" } } ] }, "descriptions": [ { "id": 35542, "type": { "code": "1", "name": "General" }, "narratives": [ { "text": "This project aims to raise the level and quality of knowledge and bridge capacity gaps on the 2005 Convention through the capacity development interventions on policy monitoring, information and data collection, indicator building involving a diverse stakeholders in 16 developing countries, and the production of a 3rd edition of the Global Report (planned publication in June 2021). It is expected that governmental and non-governmental actors will work together to better highlight effective policies and strategies that promote fundamental freedoms. This will serve to support evidenced-based policy, also strengthening transparent, participatory and democratic systems of governance.", "language": { "code": "en", "name": "English" } } ] } ], "transactions": "https://oipa2018.unesco.org/api/activities/35542/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" } ] }