Kodeposku

Pencarian

Fitur pencarian wilayah.

GET /pencarian

Endpoint yang digunakan untuk mencari wilayah berdasarkan kata kunci dan parameter tertentu. Parameter yang tersedia adalah sebagai berikut:

ParameterTipeWajibKeteranganNilai Bawaan
queryStringYaKata kunci pencarian.-
pageStringTidakHalaman yang diminta.1
limitStringTidakJumlah data yang diminta.10..100

Penggunaan

Berikut contoh penggunaan endpoint:

curl https://kodeposku.com/api/pencarian?query=cikutra&page=1&limit=10 \
    -H 'Authorization: Bearer xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx' \
    -H 'Content-Type: application/json' \
    -H 'Accept: application/json'

Respons

Berikut contoh respons endpoint:

1{
2  "code": 200,
3  "message": "success",
4  "data": [
5    {
6      "id": 31452,
7      "kode_kemendagri": "32.73.14.1002",
8      "kode_pos": 40124,
9      "kelurahan": "Cikutra",
10      "kecamatan": "Cibeunying Kidul",
11      "kota": "Kota Bandung",
12      "provinsi": "Jawa Barat",
13      "zona_waktu": "WIB",
14      "lintang": -6.9031224,
15      "bujur": 107.6393432,
16      "eleveasi": 700
17    }
18  ],
19  "meta": {
20    "count": 1,
21    "query": "cikutra",
22    "page": 1,
23    "limit": 10,
24    "timestamp": "2021-01-01T00:00:00.000Z"
25  }
26}

GET /pencarian/provinsi

Endpoint yang digunakan untuk mencari provinsi berdasarkan kata kunci. Penggunaan dan query parameter yang tersedia sama seperti endpoint /pencarian.

GET /pencarian/kota

Endpoint yang digunakan untuk mencari kota/kabupaten berdasarkan kata kunci. Penggunaan dan query parameter yang tersedia sama seperti endpoint /pencarian.

GET /pencarian/kecamatan

Endpoint yang digunakan untuk mencari kecamatan berdasarkan kata kunci. Penggunaan dan query parameter yang tersedia sama seperti endpoint /pencarian.

GET /pencarian/kelurahan

Endpoint yang digunakan untuk mencari kelurahan berdasarkan kata kunci. Penggunaan dan query parameter yang tersedia sama seperti endpoint /pencarian.