Openaid IATI Parser and API

OIPA is an IATI data-engine providing a rich and usable API for managing IATI compliant data.

OIPA on Github

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 (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

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

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/
HTTP 200 OK
						Allow: GET, HEAD, OPTIONS
						Content-Type: application/json
						Vary: Accept
						
					{
    "count": 1005317,
    "next": "https://www.oipa.nl/api/activities/?page=2",
    "previous": null,
    "results": [
        {
            "url": "https://www.oipa.nl/api/activities/61303/",
            "iati_identifier": "DE-1-201336551",
            "title": {
                "id": 61251,
                "narratives": [
                    {
                        "text": "KMU Fonds für naturschutzrelevante Privatinvestitionen",
                        "language": {
                            "code": "de",
                            "name": "German"
                        }
                    }
                ]
            },
            "descriptions": [
                {
                    "id": 44600,
                    "type": {
                        "code": "1",
                        "name": "General"
                    },
                    "narratives": [
                        {
                            "text": "Steigerung privater Investitionen in Ressourcen- und Naturschutz",
                            "language": {
                                "code": "de",
                                "name": "German"
                            }
                        }
                    ]
                }
            ],
            "transactions": "https://www.oipa.nl/api/activities/61303/transactions/"
        },
        {
            "url": "https://www.oipa.nl/api/activities/63342/",
            "iati_identifier": "DE-1-201740950",
            "title": {
                "id": 63290,
                "narratives": [
                    {
                        "text": "Contributions to stabilization and development of North Africa and the Near East: New forms of co-operation with a world region in the change",
                        "language": {
                            "code": "en",
                            "name": "English"
                        }
                    },
                    {
                        "text": "Beiträge zu Stabilisierung und Entwicklung in Nordafrika und dem Nahen Osten: Neue Formen der Kooperation mit einer Weltregion im Wandel",
                        "language": {
                            "code": "de",
                            "name": "German"
                        }
                    }
                ]
            },
            "descriptions": [
                {
                    "id": 47675,
                    "type": {
                        "code": "1",
                        "name": "General"
                    },
                    "narratives": [
                        {
                            "text": "Beiträge zu Stabilisierung und Entwicklung in Nordafrika und dem Nahen Osten: Neue Formen der Kooperation mit einer Weltregion im Wandel",
                            "language": {
                                "code": "de",
                                "name": "German"
                            }
                        }
                    ]
                },
                {
                    "id": 47676,
                    "type": {
                        "code": "1",
                        "name": "General"
                    },
                    "narratives": [
                        {
                            "text": "Contributions to stabilization and development of North Africa and the Near East: New forms of co-operation with a world region in the change",
                            "language": {
                                "code": "en",
                                "name": "English"
                            }
                        }
                    ]
                }
            ],
            "transactions": "https://www.oipa.nl/api/activities/63342/transactions/"
        },
        {
            "url": "https://www.oipa.nl/api/activities/262429/",
            "iati_identifier": "US-EIN-941655673-39711",
            "title": {
                "id": 262377,
                "narratives": [
                    {
                        "text": "for general operating support",
                        "language": {
                            "code": "en",
                            "name": "English"
                        }
                    }
                ]
            },
            "descriptions": [
                {
                    "id": 252336,
                    "type": {
                        "code": "1",
                        "name": "General"
                    },
                    "narratives": [
                        {
                            "text": "for general operating support",
                            "language": {
                                "code": "en",
                                "name": "English"
                            }
                        }
                    ]
                }
            ],
            "transactions": "https://www.oipa.nl/api/activities/262429/transactions/"
        },
        {
            "url": "https://www.oipa.nl/api/activities/262440/",
            "iati_identifier": "US-EIN-941655673-39649",
            "title": {
                "id": 262388,
                "narratives": [
                    {
                        "text": "for support of dissemination about U.S. policies to local advocacy organizations",
                        "language": {
                            "code": "en",
                            "name": "English"
                        }
                    }
                ]
            },
            "descriptions": [
                {
                    "id": 252347,
                    "type": {
                        "code": "1",
                        "name": "General"
                    },
                    "narratives": [
                        {
                            "text": "for support of dissemination about U.S. policies to local advocacy organizations",
                            "language": {
                                "code": "en",
                                "name": "English"
                            }
                        }
                    ]
                }
            ],
            "transactions": "https://www.oipa.nl/api/activities/262440/transactions/"
        },
        {
            "url": "https://www.oipa.nl/api/activities/262442/",
            "iati_identifier": "US-EIN-941655673-39650",
            "title": {
                "id": 262389,
                "narratives": [
                    {
                        "text": "for support for the Mexico City Policy tracking study",
                        "language": {
                            "code": "en",
                            "name": "English"
                        }
                    }
                ]
            },
            "descriptions": [
                {
                    "id": 252348,
                    "type": {
                        "code": "1",
                        "name": "General"
                    },
                    "narratives": [
                        {
                            "text": "for support for the Mexico City Policy tracking study",
                            "language": {
                                "code": "en",
                                "name": "English"
                            }
                        }
                    ]
                }
            ],
            "transactions": "https://www.oipa.nl/api/activities/262442/transactions/"
        },
        {
            "url": "https://www.oipa.nl/api/activities/262462/",
            "iati_identifier": "US-EIN-941655673-39501",
            "title": {
                "id": 262409,
                "narratives": [
                    {
                        "text": "for general operating support",
                        "language": {
                            "code": "en",
                            "name": "English"
                        }
                    }
                ]
            },
            "descriptions": [
                {
                    "id": 252384,
                    "type": {
                        "code": "1",
                        "name": "General"
                    },
                    "narratives": [
                        {
                            "text": "for general operating support",
                            "language": {
                                "code": "en",
                                "name": "English"
                            }
                        }
                    ]
                }
            ],
            "transactions": "https://www.oipa.nl/api/activities/262462/transactions/"
        },
        {
            "url": "https://www.oipa.nl/api/activities/262473/",
            "iati_identifier": "US-EIN-941655673-39141",
            "title": {
                "id": 262420,
                "narratives": [
                    {
                        "text": "for support of assessing the impact of the Mexico City Policy",
                        "language": {
                            "code": "en",
                            "name": "English"
                        }
                    }
                ]
            },
            "descriptions": [
                {
                    "id": 252395,
                    "type": {
                        "code": "1",
                        "name": "General"
                    },
                    "narratives": [
                        {
                            "text": "for support of assessing the impact of the Mexico City Policy",
                            "language": {
                                "code": "en",
                                "name": "English"
                            }
                        }
                    ]
                }
            ],
            "transactions": "https://www.oipa.nl/api/activities/262473/transactions/"
        },
        {
            "url": "https://www.oipa.nl/api/activities/262485/",
            "iati_identifier": "US-EIN-941655673-39179",
            "title": {
                "id": 262433,
                "narratives": [
                    {
                        "text": "for support of the in-country advocacy global partnership work",
                        "language": {
                            "code": "en",
                            "name": "English"
                        }
                    }
                ]
            },
            "descriptions": [
                {
                    "id": 252413,
                    "type": {
                        "code": "1",
                        "name": "General"
                    },
                    "narratives": [
                        {
                            "text": "This grant will support the International Women?s Health Coalition to sustain and expand its work to advance women?s rights, in particular their sexual and reproductive health and rights.  This grant is intended to support the coalition?s grantmaking and technical assistance to organizations in developing countries that conduct advocacy to ensure access to safe and legal abortion in their home countries, and to mitigate the effects of the reinstated Mexico City Policy.   ",
                            "language": {
                                "code": "en",
                                "name": "English"
                            }
                        }
                    ]
                }
            ],
            "transactions": "https://www.oipa.nl/api/activities/262485/transactions/"
        },
        {
            "url": "https://www.oipa.nl/api/activities/262824/",
            "iati_identifier": "US-EIN-941655673-36295",
            "title": {
                "id": 262772,
                "narratives": [
                    {
                        "text": "for testing new sources of data to monitor the 2030 Sustainable Development Goals",
                        "language": {
                            "code": "en",
                            "name": "English"
                        }
                    }
                ]
            },
            "descriptions": [
                {
                    "id": 252812,
                    "type": {
                        "code": "1",
                        "name": "General"
                    },
                    "narratives": [
                        {
                            "text": "Through this grant, the Civicus will contribute to discussions on monitoring and measuring the 2030 Sustainable Development Goals through three related activities. First, Civicus will conduct pilots in Tanzania and Kenya to identify ways in which nontraditional sources of data can be used to measure the goal on gender equality. Second, Civicus will work to facilitate discussions among members of civil society to contribute to data collection, harness new kinds of data, and coordinate monitoring and accountability efforts. Finally, Civicus will participate in the Global Partnership for Sustainable Development Data, supporting the launch, participating in the coordinating and planning team, and commencing the rollout of a civil society outreach plan for the Partnership.",
                            "language": {
                                "code": "en",
                                "name": "English"
                            }
                        }
                    ]
                }
            ],
            "transactions": "https://www.oipa.nl/api/activities/262824/transactions/"
        },
        {
            "url": "https://www.oipa.nl/api/activities/262868/",
            "iati_identifier": "US-EIN-941655673-35569",
            "title": {
                "id": 262815,
                "narratives": [
                    {
                        "text": "for grants to innovative programs that improve children?s learning in Africa (Phase II)",
                        "language": {
                            "code": "en",
                            "name": "English"
                        }
                    }
                ]
            },
            "descriptions": [
                {
                    "id": 252864,
                    "type": {
                        "code": "1",
                        "name": "General"
                    },
                    "narratives": [
                        {
                            "text": "This grant will support Phase II of TrustAfrica?s Early Learning Innovations Fund, which sought to identify local organizations with effective approaches for improving learning and provide them financial and technical support to demonstrate and document their impact. Under Phase II, TrustAfrica will continue its support for the most promising innovations from Phase I. TrustAfrica will assist these organizations in telling their story and will connect them to existing regional and country-level education networks and local decision makers to facilitate uptake and support from government and from other donors. ",
                            "language": {
                                "code": "en",
                                "name": "English"
                            }
                        }
                    ]
                }
            ],
            "transactions": "https://www.oipa.nl/api/activities/262868/transactions/"
        }
    ]
}