Dokumentasi API Wilayah Indonesia

Layanan yang menyediakan informasi data wilayah di Indonesia yang terdiri dari Propinsi, Kabupaten/Kota, Kecamatan dan Kelurahan/Desa. Data wilayah ini bisa kamu gunakan sebagai rujukan dalam mengembangkan aplikasi karena akan selalu diperbaharui sesuai data yang sesungguhnya.


API Propinsi

Endpoint ini digunakan untuk mengambil data propinsi yang ada di Indonesia.

Berikut adalah informasi yang dapat Anda gunakan untuk melakukan Request

Method URL
GET https://ruangapi.com/api/v1/provinces
Method Wajib Parameter Keterangan
Authorization Header Ya Authorization API Key
GET Tidak id ID Propinsi

Catatan: Apabila ID Propinsi dikosongkan, maka seluruh data propinsi akan ditampilkan


{
    "statusCode": 200,
    "status": "success",
    "message": "",
    "data": {
        "query": {
            "id": "1"
        },
        "results": {
            "id": 1,
            "name": "Bali"
        }
    }
}                                        

API Kota/Kabupaten

Endpoint ini digunakan untuk mengambil data kota/kabupaten yang ada di Indonesia.

Berikut adalah informasi yang dapat Anda gunakan untuk melakukan Request

Method URL
GET https://ruangapi.com/api/v1/cities
Method Wajib Parameter Keterangan
Authorization Header Ya Authorization API Key
GET Ya province ID Propinsi
GET Tidak id ID Kota/Kabupaten
GET Tidak q Query Pencarian By Teks

Catatan:

  • Jika ID Kota/Kabupaten dikosongkan, maka seluruh data Kota/Kabupaten akan ditampilkan
  • Jika q tidak sama dengan kosong, maka parameter id & province akan diabaikan.


{
    "statusCode": 200,
    "status": "success",
    "message": "",
    "data": {
        "query": {
            "id": null,
            "province": "1",
            "q": ""
        },
        "province": {
            "id": 1,
            "name": "Bali"
        },
        "results": [
            {
                "id": 17,
                "province_id": 1,
                "name": "Badung",
                "type": "Kabupaten",
                "postal_code": "80351"
            },
            {
                "id": 32,
                "province_id": 1,
                "name": "Bangli",
                "type": "Kabupaten",
                "postal_code": "80619"
            },
            {
                "id": 94,
                "province_id": 1,
                "name": "Buleleng",
                "type": "Kabupaten",
                "postal_code": "81111"
            },
            {
                "id": 114,
                "province_id": 1,
                "name": "Denpasar",
                "type": "Kota",
                "postal_code": "80227"
            },
            {
                "id": 128,
                "province_id": 1,
                "name": "Gianyar",
                "type": "Kabupaten",
                "postal_code": "80519"
            },
            {
                "id": 161,
                "province_id": 1,
                "name": "Jembrana",
                "type": "Kabupaten",
                "postal_code": "82251"
            },
            {
                "id": 170,
                "province_id": 1,
                "name": "Karangasem",
                "type": "Kabupaten",
                "postal_code": "80819"
            },
            {
                "id": 197,
                "province_id": 1,
                "name": "Klungkung",
                "type": "Kabupaten",
                "postal_code": "80719"
            },
            {
                "id": 447,
                "province_id": 1,
                "name": "Tabanan",
                "type": "Kabupaten",
                "postal_code": "82119"
            }
        ]
    }
}                                        

API Kecamatan

Endpoint ini digunakan untuk mengambil data Kecamatan yang ada di Indonesia.

Berikut adalah informasi yang dapat Anda gunakan untuk melakukan Request

Method URL
GET https://ruangapi.com/api/v1/districts
Method Wajib Parameter Keterangan
Authorization Header Ya Authorization API Key
GET Ya city ID Kota/Kabupaten
GET Tidak id ID Kecamatan
GET Tidak q Query Pencarian By Teks

Catatan:

  • Jika ID Kecamatan dikosongkan, maka seluruh data Kecamatan akan ditampilkan.
  • Jika q tidak sama dengan kosong, maka parameter id & city akan diabaikan.


{
    "statusCode": 200,
    "status": "success",
    "message": "",
    "data": {
        "query": {
            "id": null,
            "city": "1",
            "q": ""
        },
        "city": {
            "id": 1,
            "name": "Aceh Barat",
            "province": "Nanggroe Aceh Darussalam (NAD)"
        },
        "results": [
            {
                "id": 1,
                "name": "Arongan Lambalek"
            },
            {
                "id": 2,
                "name": "Bubon"
            },
            {
                "id": 3,
                "name": "Johan Pahlawan"
            },
            {
                "id": 4,
                "name": "Kaway XVI"
            },
            {
                "id": 5,
                "name": "Meureubo"
            },
            {
                "id": 6,
                "name": "Pante Ceureumen (Pantai Ceuremen)"
            },
            {
                "id": 7,
                "name": "Panton Reu"
            },
            {
                "id": 8,
                "name": "Samatiga"
            },
            {
                "id": 9,
                "name": "Sungai Mas"
            },
            {
                "id": 10,
                "name": "Woyla"
            },
            {
                "id": 11,
                "name": "Woyla Barat"
            },
            {
                "id": 12,
                "name": "Woyla Timur"
            }
        ]
    }
}                                        

API Desa/Kelurahan

Endpoint ini digunakan untuk mengambil data Desa/Kelurahan yang ada di Indonesia.

Berikut adalah informasi yang dapat Anda gunakan untuk melakukan Request

Method URL
GET https://ruangapi.com/api/v1/villages
Method Wajib Parameter Keterangan
Authorization Header Ya Authorization API Key
GET Ya district ID Kecamatan
GET Tidak id ID Desa/Kelurahan
GET Tidak q Query Pencarian By Teks

Catatan:

  • Jika ID Desa/Kelurahan dikosongkan, maka seluruh data Kecamatan akan ditampilkan.
  • Jika q tidak sama dengan kosong, maka parameter id & district akan diabaikan.


{
    "statusCode": 200,
    "status": "success",
    "message": "",
    "data": {
        "query": {
            "id": null,
            "district": "1",
            "q": null
        },
        "district": {
            "id": 1,
            "name": "Arongan Lambalek",
            "city": "Aceh Barat"
        },
        "results": [
            {
                "id": 1394,
                "name": "Arongan"
            },
            {
                "id": 1395,
                "name": "Alue Bagok"
            },
            {
                "id": 1396,
                "name": "Alue Sundak"
            },
            {
                "id": 1397,
                "name": "Alue Batee"
            },
            {
                "id": 1398,
                "name": "Cot Buloh"
            },
            {
                "id": 1399,
                "name": "Cot Kumbang"
            },
            {
                "id": 1400,
                "name": "Cot Juru Mudi"
            },
            {
                "id": 1401,
                "name": "Drien Rampak"
            },
            {
                "id": 1402,
                "name": "Kubu"
            },
            {
                "id": 1403,
                "name": "Keub"
            },
            {
                "id": 1404,
                "name": "Pante Mutia"
            },
            {
                "id": 1405,
                "name": "Peribu"
            },
            {
                "id": 1406,
                "name": "Panton Makmu"
            },
            {
                "id": 1407,
                "name": "Panton Bahagia"
            },
            {
                "id": 1408,
                "name": "Peulanteu Lb."
            },
            {
                "id": 1409,
                "name": "Rimba Langgeh"
            },
            {
                "id": 1410,
                "name": "Suak Keumudee"
            },
            {
                "id": 1411,
                "name": "Seuneubok Lhong"
            },
            {
                "id": 1412,
                "name": "Suak Ie Beuso"
            },
            {
                "id": 1413,
                "name": "Suak Bidok"
            },
            {
                "id": 1414,
                "name": "Simpang Peut"
            },
            {
                "id": 1415,
                "name": "Seuneubok Teungoh"
            },
            {
                "id": 1416,
                "name": "Teupin Peraho"
            },
            {
                "id": 1417,
                "name": "Ujong Beusa"
            },
            {
                "id": 1418,
                "name": "Ujong Simpang"
            },
            {
                "id": 1419,
                "name": "Gunong Pulo"
            },
            {
                "id": 1420,
                "name": "Karang Hampa"
            }
        ]
    }
}