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=5
HTTP 200 OK
						Allow: GET, HEAD, OPTIONS
						Content-Type: application/json
						Vary: Accept
						
					{
    "count": 254,
    "next": "https://oipa2018.unesco.org/api/countries/?page=6",
    "previous": "https://oipa2018.unesco.org/api/countries/?page=4",
    "results": [
        {
            "url": "https://oipa2018.unesco.org/api/countries/CC/",
            "code": "CC",
            "name": "Cocos (Keeling) Islands (The)"
        },
        {
            "url": "https://oipa2018.unesco.org/api/countries/CD/",
            "code": "CD",
            "name": "Congo (The Democratic Republic Of The)"
        },
        {
            "url": "https://oipa2018.unesco.org/api/countries/CF/",
            "code": "CF",
            "name": "Central African Republic (The)"
        },
        {
            "url": "https://oipa2018.unesco.org/api/countries/CG/",
            "code": "CG",
            "name": "Congo (The)"
        },
        {
            "url": "https://oipa2018.unesco.org/api/countries/CH/",
            "code": "CH",
            "name": "Switzerland"
        },
        {
            "url": "https://oipa2018.unesco.org/api/countries/CI/",
            "code": "CI",
            "name": "Côte D'Ivoire"
        },
        {
            "url": "https://oipa2018.unesco.org/api/countries/CK/",
            "code": "CK",
            "name": "Cook Islands (The)"
        },
        {
            "url": "https://oipa2018.unesco.org/api/countries/CL/",
            "code": "CL",
            "name": "Chile"
        },
        {
            "url": "https://oipa2018.unesco.org/api/countries/CM/",
            "code": "CM",
            "name": "Cameroon"
        },
        {
            "url": "https://oipa2018.unesco.org/api/countries/CN/",
            "code": "CN",
            "name": "China"
        }
    ]
}