Search Location by Keyword

Retrieving information of location(s) based on the query

GET /v3/location

URL Query Parameter

Parameter

Value

Description

adm_level

integer

Location Administrative Level [1=country, 2=province, 3=city, 4=suburb, 5=area] integer example: 1 (default: show all)

keyword (required)

string >= 3 characters

Input Location Keyword [Min: 3 character] example: jakarta

Example Request

curl --location --request 
  GET '{{baseUrl}}/v3/location?adm_level=5&keyword=jakarta' \

Success Response

{
    "metadata": {
        "path": "/v3/location?adm_level=5&keyword=jakarta",
        "http_status_code": 200,
        "http_status": "OK",
        "timestamp": 1620370616
    },
    "data": [
        {
            "adm_level_1": {
                "id": 228,
                "level": 1,
                "type": "country",
                "name": "INDONESIA",
                "code": "ID"
            },
            "adm_level_2": {
                "id": 6,
                "level": 2,
                "type": "province",
                "name": "DKI Jakarta"
            },
            "adm_level_3": {
                "id": 38,
                "level": 3,
                "type": "city",
                "name": "Kepulauan Seribu",
                "geo_coord": {
                    "lat": -5.7985265,
                    "lng": 106.5071981
                }
            },
            "adm_level_4": {
                "id": 464,
                "level": 4,
                "type": "suburb",
                "name": "Kepulauan Seribu Utara",
                "geo_coord": {
                    "lat": -5.5017714,
                    "lng": 106.550077
                }
            },
            "adm_level_5": {
                "id": 81637,
                "level": 5,
                "type": "area",
                "name": "Pulau Pramuka",
                "geo_coord": {
                    "lat": -5.7456185,
                    "lng": 106.6094047
                },
                "postcode": "14530"
            },
            "adm_level_cur": {
                "id": 81637,
                "level": 5,
                "type": "area",
                "name": "Pulau Pramuka",
                "geo_coord": {
                    "lat": -5.7456185,
                    "lng": 106.6094047
                },
                "postcode": "14530"
            },
            "display_txt": "14530, Pulau Pramuka, Kepulauan Seribu Utara, Kepulauan Seribu, DKI Jakarta, INDONESIA",
            "postcodes": [
                "14530"
            ]
        },
        {
            "adm_level_1": {
                "id": 228,
                "level": 1,
                "type": "country",
                "name": "INDONESIA",
                "code": "ID"
            },
            "adm_level_2": {
                "id": 20,
                "level": 2,
                "type": "province",
                "name": "Maluku"
            },
            "adm_level_3": {
                "id": 232,
                "level": 3,
                "type": "city",
                "name": "Seram Bagian Timur",
                "geo_coord": {
                    "lat": -3.4233267,
                    "lng": 130.2271243
                }
            },
            "adm_level_4": {
                "id": 3683,
                "level": 4,
                "type": "suburb",
                "name": "Bula Barat",
                "geo_coord": {
                    "lat": -3.1386387,
                    "lng": 130.2680075
                }
            },
            "adm_level_5": {
                "id": 42253,
                "level": 5,
                "type": "area",
                "name": "Jakarta Baru",
                "geo_coord": {
                    "lat": -3.0628,
                    "lng": 130.260344
                },
                "postcode": "97554"
            },
            "adm_level_cur": {
                "id": 42253,
                "level": 5,
                "type": "area",
                "name": "Jakarta Baru",
                "geo_coord": {
                    "lat": -3.0628,
                    "lng": 130.260344
                },
                "postcode": "97554"
            },
            "display_txt": "97554, Jakarta Baru, Bula Barat, Seram Bagian Timur, Maluku, INDONESIA",
            "postcodes": [
                "97554"
            ]
        },
        {
            "adm_level_1": {
                "id": 228,
                "level": 1,
                "type": "country",
                "name": "INDONESIA",
                "code": "ID"
            },
            "adm_level_2": {
                "id": 18,
                "level": 2,
                "type": "province",
                "name": "Lampung"
            },
            "adm_level_3": {
                "id": 205,
                "level": 3,
                "type": "city",
                "name": "Pringsewu",
                "geo_coord": {
                    "lat": -5.3331186,
                    "lng": 104.9856176
                }
            },
            "adm_level_4": {
                "id": 3305,
                "level": 4,
                "type": "suburb",
                "name": "Gading Rejo",
                "geo_coord": {
                    "lat": -5.3626808,
                    "lng": 105.0206757
                }
            },
            "adm_level_5": {
                "id": 38241,
                "level": 5,
                "type": "area",
                "name": "Yogyakarta (Jogjakarta)",
                "geo_coord": {
                    "lat": -5.3451451,
                    "lng": 105.0119105
                },
                "postcode": "35372"
            },
            "adm_level_cur": {
                "id": 38241,
                "level": 5,
                "type": "area",
                "name": "Yogyakarta (Jogjakarta)",
                "geo_coord": {
                    "lat": -5.3451451,
                    "lng": 105.0119105
                },
                "postcode": "35372"
            },
            "display_txt": "35372, Yogyakarta (Jogjakarta), Gading Rejo, Pringsewu, Lampung, INDONESIA",
            "postcodes": [
                "35372",
                "35772"
            ]
        },
        {
            "adm_level_1": {
                "id": 228,
                "level": 1,
                "type": "country",
                "name": "INDONESIA",
                "code": "ID"
            },
            "adm_level_2": {
                "id": 6,
                "level": 2,
                "type": "province",
                "name": "DKI Jakarta"
            },
            "adm_level_3": {
                "id": 43,
                "level": 3,
                "type": "city",
                "name": "Jakarta Pusat",
                "geo_coord": {
                    "lat": -6.1864864,
                    "lng": 106.8340911
                }
            },
            "adm_level_4": {
                "id": 507,
                "level": 4,
                "type": "suburb",
                "name": "Gambir",
                "geo_coord": {
                    "lat": -6.1713426,
                    "lng": 106.8237374
                }
            },
            "adm_level_5": {
                "id": 4871,
                "level": 5,
                "type": "area",
                "name": "Kebon Kelapa",
                "geo_coord": {
                    "lat": -6.1649144,
                    "lng": 106.8252123
                },
                "postcode": "10120"
            },
            "adm_level_cur": {
                "id": 4871,
                "level": 5,
                "type": "area",
                "name": "Kebon Kelapa",
                "geo_coord": {
                    "lat": -6.1649144,
                    "lng": 106.8252123
                },
                "postcode": "10120"
            },
            "display_txt": "10120, Kebon Kelapa, Gambir, Jakarta Pusat, DKI Jakarta, INDONESIA",
            "postcodes": [
                "10120"
            ]
        },
        {
            "adm_level_1": {
                "id": 228,
                "level": 1,
                "type": "country",
                "name": "INDONESIA",
                "code": "ID"
            },
            "adm_level_2": {
                "id": 6,
                "level": 2,
                "type": "province",
                "name": "DKI Jakarta"
            },
            "adm_level_3": {
                "id": 43,
                "level": 3,
                "type": "city",
                "name": "Jakarta Pusat",
                "geo_coord": {
                    "lat": -6.1864864,
                    "lng": 106.8340911
                }
            },
            "adm_level_4": {
                "id": 507,
                "level": 4,
                "type": "suburb",
                "name": "Gambir",
                "geo_coord": {
                    "lat": -6.1713426,
                    "lng": 106.8237374
                }
            },
            "adm_level_5": {
                "id": 4870,
                "level": 5,
                "type": "area",
                "name": "Gambir",
                "geo_coord": {
                    "lat": -6.1789046,
                    "lng": 106.8266873
                },
                "postcode": "10110"
            },
            "adm_level_cur": {
                "id": 4870,
                "level": 5,
                "type": "area",
                "name": "Gambir",
                "geo_coord": {
                    "lat": -6.1789046,
                    "lng": 106.8266873
                },
                "postcode": "10110"
            },
            "display_txt": "10110, Gambir, Gambir, Jakarta Pusat, DKI Jakarta, INDONESIA",
            "postcodes": [
                "10110"
            ]
        },
        {
            "adm_level_1": {
                "id": 228,
                "level": 1,
                "type": "country",
                "name": "INDONESIA",
                "code": "ID"
            },
            "adm_level_2": {
                "id": 6,
                "level": 2,
                "type": "province",
                "name": "DKI Jakarta"
            },
            "adm_level_3": {
                "id": 43,
                "level": 3,
                "type": "city",
                "name": "Jakarta Pusat",
                "geo_coord": {
                    "lat": -6.1864864,
                    "lng": 106.8340911
                }
            },
            "adm_level_4": {
                "id": 507,
                "level": 4,
                "type": "suburb",
                "name": "Gambir",
                "geo_coord": {
                    "lat": -6.1713426,
                    "lng": 106.8237374
                }
            },
            "adm_level_5": {
                "id": 4869,
                "level": 5,
                "type": "area",
                "name": "Petojo Utara",
                "geo_coord": {
                    "lat": -6.1639716,
                    "lng": 106.8148879
                },
                "postcode": "10130"
            },
            "adm_level_cur": {
                "id": 4869,
                "level": 5,
                "type": "area",
                "name": "Petojo Utara",
                "geo_coord": {
                    "lat": -6.1639716,
                    "lng": 106.8148879
                },
                "postcode": "10130"
            },
            "display_txt": "10130, Petojo Utara, Gambir, Jakarta Pusat, DKI Jakarta, INDONESIA",
            "postcodes": [
                "10130"
            ]
        },
        {
            "adm_level_1": {
                "id": 228,
                "level": 1,
                "type": "country",
                "name": "INDONESIA",
                "code": "ID"
            },
            "adm_level_2": {
                "id": 6,
                "level": 2,
                "type": "province",
                "name": "DKI Jakarta"
            },
            "adm_level_3": {
                "id": 43,
                "level": 3,
                "type": "city",
                "name": "Jakarta Pusat",
                "geo_coord": {
                    "lat": -6.1864864,
                    "lng": 106.8340911
                }
            },
            "adm_level_4": {
                "id": 507,
                "level": 4,
                "type": "suburb",
                "name": "Gambir",
                "geo_coord": {
                    "lat": -6.1713426,
                    "lng": 106.8237374
                }
            },
            "adm_level_5": {
                "id": 4868,
                "level": 5,
                "type": "area",
                "name": "Cideng",
                "geo_coord": {
                    "lat": -6.1705904,
                    "lng": 106.8075136
                },
                "postcode": "10150"
            },
            "adm_level_cur": {
                "id": 4868,
                "level": 5,
                "type": "area",
                "name": "Cideng",
                "geo_coord": {
                    "lat": -6.1705904,
                    "lng": 106.8075136
                },
                "postcode": "10150"
            },
            "display_txt": "10150, Cideng, Gambir, Jakarta Pusat, DKI Jakarta, INDONESIA",
            "postcodes": [
                "10150"
            ]
        },
        {
            "adm_level_1": {
                "id": 228,
                "level": 1,
                "type": "country",
                "name": "INDONESIA",
                "code": "ID"
            },
            "adm_level_2": {
                "id": 6,
                "level": 2,
                "type": "province",
                "name": "DKI Jakarta"
            },
            "adm_level_3": {
                "id": 43,
                "level": 3,
                "type": "city",
                "name": "Jakarta Pusat",
                "geo_coord": {
                    "lat": -6.1864864,
                    "lng": 106.8340911
                }
            },
            "adm_level_4": {
                "id": 507,
                "level": 4,
                "type": "suburb",
                "name": "Gambir",
                "geo_coord": {
                    "lat": -6.1713426,
                    "lng": 106.8237374
                }
            },
            "adm_level_5": {
                "id": 4867,
                "level": 5,
                "type": "area",
                "name": "Duri Pulo",
                "geo_coord": {
                    "lat": -6.1631235,
                    "lng": 106.8016144
                },
                "postcode": "10140"
            },
            "adm_level_cur": {
                "id": 4867,
                "level": 5,
                "type": "area",
                "name": "Duri Pulo",
                "geo_coord": {
                    "lat": -6.1631235,
                    "lng": 106.8016144
                },
                "postcode": "10140"
            },
            "display_txt": "10140, Duri Pulo, Gambir, Jakarta Pusat, DKI Jakarta, INDONESIA",
            "postcodes": [
                "10140"
            ]
        },
        {
            "adm_level_1": {
                "id": 228,
                "level": 1,
                "type": "country",
                "name": "INDONESIA",
                "code": "ID"
            },
            "adm_level_2": {
                "id": 6,
                "level": 2,
                "type": "province",
                "name": "DKI Jakarta"
            },
            "adm_level_3": {
                "id": 43,
                "level": 3,
                "type": "city",
                "name": "Jakarta Pusat",
                "geo_coord": {
                    "lat": -6.1864864,
                    "lng": 106.8340911
                }
            },
            "adm_level_4": {
                "id": 507,
                "level": 4,
                "type": "suburb",
                "name": "Gambir",
                "geo_coord": {
                    "lat": -6.1713426,
                    "lng": 106.8237374
                }
            },
            "adm_level_5": {
                "id": 4866,
                "level": 5,
                "type": "area",
                "name": "Petojo Selatan",
                "geo_coord": {
                    "lat": -6.1754096,
                    "lng": 106.8163628
                },
                "postcode": "10160"
            },
            "adm_level_cur": {
                "id": 4866,
                "level": 5,
                "type": "area",
                "name": "Petojo Selatan",
                "geo_coord": {
                    "lat": -6.1754096,
                    "lng": 106.8163628
                },
                "postcode": "10160"
            },
            "display_txt": "10160, Petojo Selatan, Gambir, Jakarta Pusat, DKI Jakarta, INDONESIA",
            "postcodes": [
                "10160"
            ]
        },
        {
            "adm_level_1": {
                "id": 228,
                "level": 1,
                "type": "country",
                "name": "INDONESIA",
                "code": "ID"
            },
            "adm_level_2": {
                "id": 6,
                "level": 2,
                "type": "province",
                "name": "DKI Jakarta"
            },
            "adm_level_3": {
                "id": 43,
                "level": 3,
                "type": "city",
                "name": "Jakarta Pusat",
                "geo_coord": {
                    "lat": -6.1864864,
                    "lng": 106.8340911
                }
            },
            "adm_level_4": {
                "id": 506,
                "level": 4,
                "type": "suburb",
                "name": "Tanah Abang",
                "geo_coord": {
                    "lat": -6.2023616,
                    "lng": 106.8119382
                }
            },
            "adm_level_5": {
                "id": 4865,
                "level": 5,
                "type": "area",
                "name": "Bendungan Hilir",
                "geo_coord": {
                    "lat": -6.2088902,
                    "lng": 106.8075136
                },
                "postcode": "10210"
            },
            "adm_level_cur": {
                "id": 4865,
                "level": 5,
                "type": "area",
                "name": "Bendungan Hilir",
                "geo_coord": {
                    "lat": -6.2088902,
                    "lng": 106.8075136
                },
                "postcode": "10210"
            },
            "display_txt": "10210, Bendungan Hilir, Tanah Abang, Jakarta Pusat, DKI Jakarta, INDONESIA",
            "postcodes": [
                "10210"
            ]
        }
    ],
    "pagination": {
        "current_page": 1,
        "current_elements": 10,
        "total_pages": 27,
        "total_elements": 270
    }
}

Response List

Parameter

Description

metadata

Metadata information

metadata.path

API endpoint path

metadata.http_status_code

HTTP status code

metadata.http_status

HTTP status

metadata.timestamp

Timestamp

pagination

Paging information

pagination.current_page

Current page

pagination.current_elements

Total item per page

pagination.total_pages

Total pages

pagination.total_elements

Total datas

data

All important information about search location placed on this param

data.[].adm_level_x

Location level: 1=country, 2=province, 3=city, 4=suburb, 5=area.

data.[].adm_level_x.id

Location ID

data.[].adm_level_x.level

Location level. 1=country, 2=province, 3=city, 4=suburb, 5=area.

data.[].adm_level_x.type

Location level type. 1=country, 2=province, 3=city, 4=suburb, 5=area.

data.[].adm_level_x.name

Location name

data.[].adm_level_x.code

Location code

data.[].adm_level_x.geo_coord

Location coordinate

data.[].adm_level_x.geo_coord.lat

Location latitude

data.[].adm_level_x.geo_coord.lng

Location longitude

data.[].adm_level_x.postcode

Location post code

data.[].display_txt

Location full name

data.[].postcodes

Location postcode

This endpoint enables user to retrieve information of the location up to area (kelurahan) administrative level.
In this example, the adm_level is 5. Therefore, the response returned details up to the area level.

If the adm_level_cur level is 5, the id (adm_level_cur.id) can be use to get pricing and create order.