Proyek API Wilayah menyediakan API statis untuk mengambil data wilayah di Indonesia, termasuk Provinsi, Kabupaten/Kota, Kecamatan, dan Kelurahan/Desa.
Berikut adalah endpoint API yang tersedia dan cara penggunaannya:
- Tingkat:
https://elc-api-wilayah.vercel.app/api
- Pencarian:
https://elc-api-wilayah.vercel.app/api?q=<NAMA_PROVINSI>
Contoh:https://elc-api-wilayah.vercel.app/api?q=DKI%20Jakarta
- Tingkat:
https://elc-api-wilayah.vercel.app/api/<ID_PROVINSI>
Contoh:https://elc-api-wilayah.vercel.app/api/31
- Pencarian:
https://elc-api-wilayah.vercel.app/api/31?q=<NAMA_KABUPATEN_KOTA>
Contoh:https://elc-api-wilayah.vercel.app/api/31?q=Jakarta%20Selatan
- Tingkat:
https://elc-api-wilayah.vercel.app/api/<ID_PROVINSI>/<ID_KABUPATEN_KOTA>
Contoh:https://elc-api-wilayah.vercel.app/api/31/74
- Pencarian:
https://elc-api-wilayah.vercel.app/api/31/74?q=<NAMA_KECAMATAN>
Contoh:https://elc-api-wilayah.vercel.app/api/31/74?q=Tebet
- Tingkat:
https://elc-api-wilayah.vercel.app/api/<ID_PROVINSI>/<ID_KABUPATEN_KOTA>/<ID_KECAMATAN>
Contoh:https://elc-api-wilayah.vercel.app/api/31/74/01
- Pencarian:
https://elc-api-wilayah.vercel.app/api/31/74/01?q=<NAMA_KELURAHAN>
Contoh:https://elc-api-wilayah.vercel.app/api/31/74/01?q=Manggarai%20Selatan
Gunakan permintaan HTTP GET untuk mengambil data wilayah berdasarkan ID.
Contoh: Mencari Provinsi "Jawa Barat"
curl -X GET "https://elc-api-wilayah.vercel.app/api?q=Jawa%20Barat"
Contoh Respon:
[
{
"id": "1",
"nama": "Jawa Barat"
},
{
"id": "2",
"nama": "Jawa Tengah"
}
]
Untuk menjalankan proyek ini secara lokal, ikuti langkah-langkah berikut:
- Clone repository:
git clone https://github.com/elhakimyasya/api-wilayah.git
- Masuk ke direktori proyek:
cd api-wilayah
- Install dependencies:
npm install
- Jalankan server:
npm start
Dataset wilayah tersedia dalam format CSV, yang dapat diakses di folder /data
:
- Provinsi:
provinsi.csv
- Kabupaten/Kota:
kabupaten.csv
- Kecamatan:
kecamatan.csv
- Kelurahan:
kelurahan.csv
Silakan edit atau gunakan dataset ini sesuai kebutuhan.
Kontribusi sangat disambut! Jika ingin berkontribusi, ikuti langkah-langkah berikut:
- Fork repo ini ke akun GitHub kalian.
- Buat branch baru untuk perubahan:
git checkout -b fitur-baru
- Lakukan perubahan dan commit:
git commit -m "Menambahkan fitur baru"
- Push ke repository kalian:
git push origin fitur-baru
- Buat Pull Request (PR) ke repository utama.
Harap pastikan perubahan yang diajukan sudah diuji dengan baik sebelum membuat PR. ✨
Jika proyek ini bermanfaat, dukung dengan berdonasi melalui:
Proyek ini dilisensikan di bawah MIT License. Lihat file LICENSE
untuk informasi lebih lanjut.