Skip to content

rahmate2003/indonesia-regions-api

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

7 Commits
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

Indonesia Regional API

API lengkap untuk data wilayah administratif Indonesia, meliputi 38 provinsi, kota/kabupaten, kecamatan, dan desa/kelurahan.

Indonesia Regional API

🌟 Fitur Utama

  • Data lengkap 38 provinsi, 514 kota/kabupaten, 7.201 kecamatan, dan 83.436 desa/kelurahan
  • API RESTful dengan format JSON yang konsisten
  • Dokumentasi lengkap dan contoh penggunaan
  • Dioptimalkan untuk kecepatan dan keandalan
  • Mendukung sorting data berdasarkan nama

πŸ“š Dokumentasi API

Format Respons

{
  "status": boolean,
  "message": string,
  "data": array | null
}

Endpoint

1. Mendapatkan Semua Provinsi

GET /api/provinces
GET /api/provinces?sort=name  # Untuk mengurutkan berdasarkan nama

Contoh Respons:

{
  "status": true,
  "message": "Provinces retrieved successfully",
  "data": [
    {
      "id": "11",
      "name": "Aceh"
    },
    {
      "id": "12",
      "name": "Sumatera Utara"
    }
    // ...
  ]
}

2. Mendapatkan Provinsi berdasarkan ID

GET /api/provinces/{provinceId}

Contoh Respons:

{
  "status": true,
  "message": "Province retrieved successfully",
  "data": {
    "id": "11",
    "name": "Aceh"
  }
}

3. Mendapatkan Kota/Kabupaten berdasarkan ID Provinsi

GET /api/cities/{provinceId}
GET /api/cities/{provinceId}?sort=name  # Untuk mengurutkan berdasarkan nama

Contoh Respons:

{
  "status": true,
  "message": "Cities in province Aceh retrieved successfully",
  "data": [
    {
      "id": "1101",
      "provinceId": "11",
      "name": "Kabupaten Simeulue"
    },
    {
      "id": "1102",
      "provinceId": "11",
      "name": "Kabupaten Aceh Singkil"
    }
    // ...
  ]
}

4. Mendapatkan Kecamatan berdasarkan ID Kota/Kabupaten

GET /api/districts/{cityId}
GET /api/districts/{cityId}?sort=name  # Untuk mengurutkan berdasarkan nama

Contoh Respons:

{
  "status": true,
  "message": "Districts in city Kabupaten Simeulue retrieved successfully",
  "data": [
    {
      "id": "1101010",
      "cityId": "1101",
      "name": "Teupah Selatan"
    },
    {
      "id": "1101020",
      "cityId": "1101",
      "name": "Simeulue Timur"
    }
    // ...
  ]
}

5. Mendapatkan Desa/Kelurahan berdasarkan ID Kecamatan

GET /api/villages/{districtId}
GET /api/villages/{districtId}?sort=name  # Untuk mengurutkan berdasarkan nama

Contoh Respons:

{
  "status": true,
  "message": "Villages in district Teupah Selatan retrieved successfully",
  "data": [
    {
      "id": "1101010001",
      "districtId": "1101010",
      "name": "Latiung"
    },
    {
      "id": "1101010002",
      "districtId": "1101010",
      "name": "Labuhan Bajau"
    }
    // ...
  ]
}

πŸš€ Penggunaan

Contoh dengan JavaScript Fetch API

// Mendapatkan semua provinsi
fetch("https://api-regional-indonesia.vercel.app/api/provinces")
  .then((response) => response.json())
  .then((data) => console.log(data));

// Mendapatkan kota/kabupaten berdasarkan ID provinsi
fetch("https://api-regional-indonesia.vercel.app/api/cities/11")
  .then((response) => response.json())
  .then((data) => console.log(data));

Contoh dengan Axios

// Mendapatkan semua provinsi
axios
  .get("https://api-regional-indonesia.vercel.app/api/provinces")
  .then((response) => console.log(response.data));

// Mendapatkan kota/kabupaten berdasarkan ID provinsi
axios
  .get("https://api-regional-indonesia.vercel.app/api/cities/11")
  .then((response) => console.log(response.data));

πŸ› οΈ Teknologi yang Digunakan

πŸ“Š Sumber Data

Data wilayah administratif Indonesia yang digunakan dalam API ini bersumber dari data resmi Badan Pusat Statistik (BPS) dan Kementerian Dalam Negeri Republik Indonesia, yang telah diproses dan diformat untuk kemudahan penggunaan.

πŸ“ Lisensi

Proyek ini dilisensikan di bawah MIT License.

🀝 Kontribusi

Kontribusi selalu diterima! Jika Anda ingin berkontribusi pada proyek ini, silakan buat pull request atau buka issue untuk diskusi.


Dibuat dengan ❀️ untuk Indonesia

Releases

No releases published

Packages

No packages published