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

City List

Returns a list of IATI Cities stored in OIPA.

Request parameters

  • 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 cities activities list.
  • disbursement: Calculate total disbursement of activities presented in cities activities list.
  • commitment: Calculate total commitment of activities presented in cities activities list.

Result details

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

URI is constructed as follows: /api/cities/{city_id}

GET /api/cities/?country=AS
HTTP 200 OK
						Allow: GET, HEAD, OPTIONS
						Content-Type: application/json
						Vary: Accept
						
					{
    "count": 6207,
    "next": "https://www.oipa.nl/api/cities/?country=AS&page=2",
    "previous": null,
    "results": [
        {
            "url": "https://www.oipa.nl/api/cities/1/",
            "id": 1,
            "geoname_id": 3443013,
            "name": "Colonia del Sacramento",
            "country": {
                "url": "https://www.oipa.nl/api/countries/UY/",
                "code": "UY",
                "name": "Uruguay"
            },
            "location": {
                "type": "Point",
                "coordinates": [
                    -57.840002,
                    -34.479999
                ]
            },
            "is_capital": false
        },
        {
            "url": "https://www.oipa.nl/api/cities/2/",
            "id": 2,
            "geoname_id": 3439749,
            "name": "Trinidad",
            "country": {
                "url": "https://www.oipa.nl/api/countries/UY/",
                "code": "UY",
                "name": "Uruguay"
            },
            "location": {
                "type": "Point",
                "coordinates": [
                    -56.900997,
                    -33.543999
                ]
            },
            "is_capital": false
        },
        {
            "url": "https://www.oipa.nl/api/cities/3/",
            "id": 3,
            "geoname_id": 3442568,
            "name": "Fray Bentos",
            "country": {
                "url": "https://www.oipa.nl/api/countries/UY/",
                "code": "UY",
                "name": "Uruguay"
            },
            "location": {
                "type": "Point",
                "coordinates": [
                    -58.303997,
                    -33.138999
                ]
            },
            "is_capital": false
        },
        {
            "url": "https://www.oipa.nl/api/cities/4/",
            "id": 4,
            "geoname_id": 3443413,
            "name": "Canelones",
            "country": {
                "url": "https://www.oipa.nl/api/countries/UY/",
                "code": "UY",
                "name": "Uruguay"
            },
            "location": {
                "type": "Point",
                "coordinates": [
                    -56.284001,
                    -34.538004
                ]
            },
            "is_capital": false
        },
        {
            "url": "https://www.oipa.nl/api/cities/5/",
            "id": 5,
            "geoname_id": 3442585,
            "name": "Florida",
            "country": {
                "url": "https://www.oipa.nl/api/countries/UY/",
                "code": "UY",
                "name": "Uruguay"
            },
            "location": {
                "type": "Point",
                "coordinates": [
                    -56.214998,
                    -34.099002
                ]
            },
            "is_capital": false
        },
        {
            "url": "https://www.oipa.nl/api/cities/6/",
            "id": 6,
            "geoname_id": 2367568,
            "name": "Bassar",
            "country": {
                "url": "https://www.oipa.nl/api/countries/TG/",
                "code": "TG",
                "name": "Togo"
            },
            "location": {
                "type": "Point",
                "coordinates": [
                    0.789004,
                    9.261
                ]
            },
            "is_capital": false
        },
        {
            "url": "https://www.oipa.nl/api/cities/7/",
            "id": 7,
            "geoname_id": 2364079,
            "name": "Sotouboua",
            "country": {
                "url": "https://www.oipa.nl/api/countries/TG/",
                "code": "TG",
                "name": "Togo"
            },
            "location": {
                "type": "Point",
                "coordinates": [
                    0.984996,
                    8.557002
                ]
            },
            "is_capital": false
        },
        {
            "url": "https://www.oipa.nl/api/cities/8/",
            "id": 8,
            "geoname_id": -1,
            "name": "Medenine",
            "country": {
                "url": "https://www.oipa.nl/api/countries/TN/",
                "code": "TN",
                "name": "Tunisia"
            },
            "location": {
                "type": "Point",
                "coordinates": [
                    10.4167,
                    33.399999
                ]
            },
            "is_capital": false
        },
        {
            "url": "https://www.oipa.nl/api/cities/9/",
            "id": 9,
            "geoname_id": 2468018,
            "name": "Kebili",
            "country": {
                "url": "https://www.oipa.nl/api/countries/TN/",
                "code": "TN",
                "name": "Tunisia"
            },
            "location": {
                "type": "Point",
                "coordinates": [
                    8.971003,
                    33.689997
                ]
            },
            "is_capital": false
        },
        {
            "url": "https://www.oipa.nl/api/cities/10/",
            "id": 10,
            "geoname_id": 2464701,
            "name": "Tataouine",
            "country": {
                "url": "https://www.oipa.nl/api/countries/TN/",
                "code": "TN",
                "name": "Tunisia"
            },
            "location": {
                "type": "Point",
                "coordinates": [
                    10.466704,
                    33.000003
                ]
            },
            "is_capital": false
        }
    ]
}