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.

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
  • other_identifier owner ref and narratives
  • contact_info all narratives for organisation, department, person name, job title & mailing address
  • location ref of location
  • country_budget_items narrative of budget item description
  • policy_marker narratives of policy marker
  • transaction ref and narratives of description, provider organisation, receiver organisation
  • related_activity ref of related activity
  • conditions narratives of condition
  • result narratives for result title, result description, result indicator title, result indicator description, result indicator period target comment, result indicator perioda ctual comment

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

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

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/?reporting_organisation_identifier=GB-CHC-326859
HTTP 200 OK
						Allow: GET, HEAD, OPTIONS
						Content-Type: application/json
						Vary: Accept
						
					{
    "count": 2,
    "next": null,
    "previous": null,
    "results": [
        {
            "url": "https://yoda.oipa.nl/api/activities/1450623/",
            "iati_identifier": "GB-CHC-326859-GPAFINN014",
            "title": {
                "id": 1450270,
                "narratives": [
                    {
                        "text": "A Child to Child approach to inclusive education in Uganda ",
                        "language": {
                            "code": "en",
                            "name": "English"
                        }
                    }
                ]
            },
            "descriptions": [
                {
                    "id": 1568703,
                    "type": {
                        "code": "1",
                        "name": "General"
                    },
                    "narratives": [
                        {
                            "text": "This project aims to bring Inclusive Education to some of the most marginalised children using the child to child approach in the West Nile and Northern Regions of Uganda. Children are empowered to identify and engage with out of school disabled children in their communities. They will then work alongside families, teachers and communities to lobby government and advocate for inclusive education to be a priority issue and one that is main-streamed across national primary education services.;",
                            "language": {
                                "code": "en",
                                "name": "English"
                            }
                        }
                    ]
                }
            ],
            "transactions": "https://yoda.oipa.nl/api/activities/1450623/transactions/"
        },
        {
            "url": "https://yoda.oipa.nl/api/activities/2739342/",
            "iati_identifier": "GB-CHC-326859-6ZNR-CQ4P-NY",
            "title": {
                "id": 2737339,
                "narratives": [
                    {
                        "text": "Raising Aspirations: Disabled Youth Make the Sustainable Development Goals a Reality in Rwanda.",
                        "language": {
                            "code": "en",
                            "name": "English"
                        }
                    }
                ]
            },
            "descriptions": [
                {
                    "id": 2929379,
                    "type": {
                        "code": "2",
                        "name": "Objectives"
                    },
                    "narratives": [
                        {
                            "text": "Impact: Children and young people with disabilities are fully included in the 2030 Agenda for Sustainable Development in Rwanda. Outcome: 80 youth and children with disabilities in Rwanda have improved capability and a more enabling environment to hold their government to account for disability inclusion and SDG implementation in Rwanda. Output 1: 80 youth with disabilities have increased skills and knowledge to influence change and counsel others on disability rights. Output 2: Government create a more enabling environment through which youth with disabilities can hold decision makers to account in the prioritisation of disability in SDG implementation. Output 3: Community members in 5 target districts have greater understanding and awareness of disability rights and inclusion and are better able to hold government to account for stated commitments. Output 4: Improved capacity of our partner organisation (UWEZO) to create and utilise a strong evidence base of best practice inclusive approaches and influence government to deliver stated commitments to disability inclusion in the SDGs.",
                            "language": {
                                "code": "en",
                                "name": "English"
                            }
                        }
                    ]
                },
                {
                    "id": 2929378,
                    "type": {
                        "code": "1",
                        "name": "General"
                    },
                    "narratives": [
                        {
                            "text": "This project contributes to the SDGs aspiration to ‘leave no one behind’ in Rwanda by empowering children and young people with disabilities to demand inclusion in the SDGs. This project uses a tested and new youthled model whereby young PWDs are trained to mentor CWDs and are the main drivers for inclusion at a community and government level. The project aims to find youth-led solutions for meaningful inclusion and creates mechanisms whereby disabled youth can communicate evidence of best practice to policy makers. The project has been developed jointly with UWEZO Youth Empowerment, a youth led DPO in Rwanda, and AbleChildAfrica. The inspiration for the project was learning from a baseline completed by UWEZO in 2014 and outcomes of a 2 year pilot project.",
                            "language": {
                                "code": "en",
                                "name": "English"
                            }
                        }
                    ]
                }
            ],
            "transactions": "https://yoda.oipa.nl/api/activities/2739342/transactions/"
        }
    ]
}