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.

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/?reporting_organisation_identifier=NL-KVK-3427895
HTTP 200 OK
						Allow: GET, HEAD, OPTIONS
						Content-Type: application/json
						Vary: Accept
						
					{
    "count": 0,
    "next": null,
    "previous": null,
    "results": []
}