Referensi API · v1

Dokumentasi

Antarmuka baca-saja untuk data wilayah administratif Indonesia. Seluruh respons berbentuk JSON, terpaginasi, dan menyertakan versi data aktif.

https://desaqu.duckcode.id/api/v1 Content-Type: application/json

Autentikasi

Sertakan kunci pada setiap permintaan melalui salah satu header berikut. Kunci melalui query string tidak didukung.

X-API-Key: dq_live_a1b2c3d4e5f6g7h8k9m0n1p2q3r4s5t6u7v8wx9y012ab34cd
Authorization: Bearer dq_live_a1b2c3d4e5f6g7h8k9m0n1p2q3r4s5t6u7v8wx9y012ab34cd
GET

cURL JavaScript PHP Python Salin


        
        
dijalankan langsung pada API DesaQu ini · demo key

Parameter Bersama

ParameterBawaanKeterangan
page 1 Nomor halaman.
per_page 50 Baris per halaman, maksimum 200.
search Pencarian pada nama, minimum 2 karakter.
sort code code atau name; awali - untuk menurun.
with Muat relasi tambahan (mis. regencies).

Kode Galat

HTTPKodeKeterangan
401 MISSING_API_KEY Header kunci tidak ada.
401 INVALID_API_KEY Kunci tidak ditemukan.
403 API_KEY_EXPIRED Kunci telah kedaluwarsa.
404 NOT_FOUND Kode wilayah tidak ditemukan.
429 RATE_LIMIT_EXCEEDED Melebihi batas permintaan per IP.

Batas Laju (per IP)

API — kunci valid 300 / menit
API — tanpa kunci 20 / menit
Halaman publik & docs 60 / menit
Login dashboard 5 / menit

Alias Bahasa Indonesia

/provinsi/provinces
/kabupaten/regencies
/kecamatan/districts
/desa/villages
/cari/search