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/?recipient_country=RU
{ "count": 4, "next": null, "previous": null, "results": [ { "url": "https://oipa2018.unesco.org/api/activities/35654/", "iati_identifier": "XM-DAC-41304-570RUS1000", "title": { "id": 35653, "narratives": [ { "text": "Transforming Teaching and Learning at Schools for Achieving SGD4: turning theory into practice with ICT", "language": { "code": "en", "name": "English" } } ] }, "descriptions": [ { "id": 35653, "type": { "code": "1", "name": "General" }, "narratives": [ { "text": "The joint Project is aimed at supporting the promotion of the Sustainable Development Goals (SDGs), recognizing and encouraging excellence with the use of technology in schools through curriculum design, group work, seminars, projects and global interaction, teacher development and training, collection, analysis and dissemination of best practices.\nKey Project priorities:\n1.\tTo enrich educational process and experience exchange around SDG's values and priorities.\n2.\tDevelop and disseminate best practices on ICT competencies of schools.\n3.\tPromote networking and collaboration among targeted schools to meet the challenges and commitments of the interrelated SDGs.", "language": { "code": "en", "name": "English" } } ] } ], "transactions": "https://oipa2018.unesco.org/api/activities/35654/transactions/" }, { "url": "https://oipa2018.unesco.org/api/activities/35825/", "iati_identifier": "XM-DAC-41304-570INT1004", "title": { "id": 35825, "narratives": [ { "text": "IITE-UNESCO Associated Schools Network pilot project for Shanghai Cooperation Organization countries", "language": { "code": "en", "name": "English" } } ] }, "descriptions": [ { "id": 35825, "type": { "code": "1", "name": "General" }, "narratives": [ { "text": "The aim of this Project is to harness the potential of Information and Communication Technologies (ICT), particularly interactive and online tools, to enhance teaching, learning and inter-cultural dialogue so that young people become active learners, knowledge constructors and global citizens to participate fully in society.", "language": { "code": "en", "name": "English" } } ] } ], "transactions": "https://oipa2018.unesco.org/api/activities/35825/transactions/" }, { "url": "https://oipa2018.unesco.org/api/activities/36391/", "iati_identifier": "XM-DAC-41304-526RAS2015", "title": { "id": 36391, "narratives": [ { "text": "EABRN 2019-2020", "language": { "code": "en", "name": "English" } } ] }, "descriptions": [ { "id": 36391, "type": { "code": "1", "name": "General" }, "narratives": [ { "text": "The East Asian Biosphere Reserve Network (EABRN) is a regional network supporting the MAB Programme and was initially established with 3 priority themes for cooperation: eco-tourism, conservation policy, and transboundary cooperation. EABRN was officially launched in 1995 by China, the Democratic People's Republic of Korea (DPRK), Japan, Mongolia and the Republic of Korea (ROK), which were joined by the Russian Federation in 1998 and Kazakhstan in 2011. The overall goal/objective of the project is to support a strong and active network of well-managed BRs across the seven EABRN member countries, actively engaging exchanges on management, research and local development.", "language": { "code": "en", "name": "English" } } ] } ], "transactions": "https://oipa2018.unesco.org/api/activities/36391/transactions/" }, { "url": "https://oipa2018.unesco.org/api/activities/38168/", "iati_identifier": "XM-DAC-41304-39-8976", "title": { "id": 38168, "narratives": [ { "text": "EABRN and MAB Youth engagement in Biodiversity Conservation", "language": { "code": "en", "name": "English" } } ] }, "descriptions": [ { "id": 38168, "type": { "code": "1", "name": "General" }, "narratives": [ { "text": "The East Asian Biosphere Reserve Network (EABRN) is a regional network supporting the MAB Programme and was established in 1995 to develop cooperation along 3 main axes: eco-tourism, conservation policy, and transboundary cooperation. The main purpose of the present work plan is to support a strong and active network of well-managed BRs across the seven EABRN member countries, actively engaging in exchanges on management, research and local development. Particular attention will also be dedicated to engaging with Mab Youth in the region and worldwide, with the main purpose of offering them a unique opportunity to elaborate their contribution to the CBD COP 15 debates and foster their commitment to contribute to biodiversity conservation and climate action beyond 2020.", "language": { "code": "en", "name": "English" } } ] } ], "transactions": "https://oipa2018.unesco.org/api/activities/38168/transactions/" } ] }