Country List

Returns a list of IATI Countries stored in OIPA.

Request parameters

  • code (optional): Country code to search for.
  • name (optional): Country name to search for.
  • region_code (optional): Filter countries by Region code.
  • fields (optional): List of fields to display.
  • fields[aggregations] (optional): Aggregate available information. See Available aggregations section for details.

Available aggregations

API request may include fields[aggregations] parameter. This parameter controls result aggregations and can be one or more (comma separated values) of:

  • total_budget: Calculate total budget of activities presented in countries activities list.
  • disbursement: Calculate total disbursement of activities presented in countries activities list.
  • commitment: Calculate total commitment of activities presented in countries activities list.

Result details

Each result item contains short information about country including URI to country details.

URI is constructed as follows: /api/counties/{country_id}

GET /api/countries/?page=2
HTTP 200 OK
						Allow: GET, HEAD, OPTIONS
						Content-Type: application/json
						Vary: Accept
						
					{
    "count": 254,
    "next": "https://yoda.oipa.nl/api/countries/?page=3",
    "previous": "https://yoda.oipa.nl/api/countries/",
    "results": [
        {
            "url": "https://yoda.oipa.nl/api/countries/AQ/",
            "code": "AQ",
            "name": "Antarctica"
        },
        {
            "url": "https://yoda.oipa.nl/api/countries/AR/",
            "code": "AR",
            "name": "Argentina"
        },
        {
            "url": "https://yoda.oipa.nl/api/countries/AS/",
            "code": "AS",
            "name": "American Samoa"
        },
        {
            "url": "https://yoda.oipa.nl/api/countries/AT/",
            "code": "AT",
            "name": "Austria"
        },
        {
            "url": "https://yoda.oipa.nl/api/countries/AU/",
            "code": "AU",
            "name": "Australia"
        },
        {
            "url": "https://yoda.oipa.nl/api/countries/AW/",
            "code": "AW",
            "name": "Aruba"
        },
        {
            "url": "https://yoda.oipa.nl/api/countries/AX/",
            "code": "AX",
            "name": "Ă…land Islands"
        },
        {
            "url": "https://yoda.oipa.nl/api/countries/AZ/",
            "code": "AZ",
            "name": "Azerbaijan"
        },
        {
            "url": "https://yoda.oipa.nl/api/countries/BA/",
            "code": "BA",
            "name": "Bosnia And Herzegovina"
        },
        {
            "url": "https://yoda.oipa.nl/api/countries/BB/",
            "code": "BB",
            "name": "Barbados"
        }
    ]
}