Search Location Complete Step

In this section, you'll be guided to obtain the area id of a specific location starting from country administration level to the specific area administration level.

Authorizations : X-API-Key_Header

Steps to obtain area_id required for get pricing and creating order.

  • GET Countries (Indonesia = 228)
  • GET Provinces by Country ID
  • GET Cities by Province ID
  • GET Suburbs by City ID
  • GET Area by Suburb ID
398398

Example Interface

GET Countries

Returns a list of countries

GET /v3/location/countries

URL Query Parameter

Parameter

Value

Description

country_id

integer

Shipper’s Country ID integer (default: 228)

limit

integer

Limit data for each page, integer example:30 (default: 30)

page

integer

Page Number integer example: 1 (default: 1)

Sample Request & Response

curl --location 
--request GET '{{baseUrl}}/v3/location/countries?country_id=228&limit=100&page=1'
{
    "metadata": {
        "path": "/v3/location/countries?country_id=228&limit=100&page=1",
        "http_status_code": 200,
        "http_status": "OK",
        "timestamp": 1620374762
    },
    "data": [
        {
            "id": 228,
            "name": "INDONESIA",
            "code": "ID"
        }
    ],
    "pagination": {
        "current_page": 1,
        "current_elements": 1,
        "total_pages": 1,
        "total_elements": 1
    }
}

Response List

Parameter

Description

metadata

Metadata information

metadata.path

API endpoint path

metadata.http_status_code

HTTP status code

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 location

data.[].id

Country ID

data.[].name

Country Name

data.[].code

Country Code Name

GET Provinces by Country ID

Returns a list of Provinces based on the Country ID.

GET /v3/location/country/{country_id}/provinces

URL Query Parameter

Parameter

Value

Description

country_id
(required)

integer

Shipper’s Country ID integer example:228

limit

integer

Limit data for each page, integer example:30 (default: 30)

page

integer

Page Number integer example: 1 (default: 1)

province_id

integer

Shipper’s Province ID integer example: 6 (default: show all)

Sample Request & Response

curl --location 
--request GET '{{baseUrl}}/v3/location/country/228/provinces'
{
    "metadata": {
        "path": "/v3/location/country/228/provinces?%3Acountry_id=228&",
        "http_status_code": 200,
        "http_status": "OK",
        "timestamp": 1620375664
    },
    "data": [
        {
            "id": 1,
            "name": "Bali",
            "lat": -8.4095178,
            "lng": 115.188916,
            "country": {
                "id": 228,
                "name": "INDONESIA",
                "code": "ID"
            }
        },
        {
            "id": 2,
            "name": "Bangka Belitung",
            "lat": -2.7410513,
            "lng": 106.4405872,
            "country": {
                "id": 228,
                "name": "INDONESIA",
                "code": "ID"
            }
        },
        {
            "id": 3,
            "name": "Banten",
            "lat": -6.4058172,
            "lng": 106.0640179,
            "country": {
                "id": 228,
                "name": "INDONESIA",
                "code": "ID"
            }
        },
        {
            "id": 4,
            "name": "Bengkulu",
            "lat": -3.7928451,
            "lng": 102.2607641,
            "country": {
                "id": 228,
                "name": "INDONESIA",
                "code": "ID"
            }
        },
        {
            "id": 5,
            "name": "DI Yogyakarta",
            "lat": -7.7975915,
            "lng": 110.3707141,
            "country": {
                "id": 228,
                "name": "INDONESIA",
                "code": "ID"
            }
        },
        {
            "id": 6,
            "name": "DKI Jakarta",
            "lat": -6.1744651,
            "lng": 106.822745,
            "country": {
                "id": 228,
                "name": "INDONESIA",
                "code": "ID"
            }
        },
        {
            "id": 7,
            "name": "Gorontalo",
            "lat": 0.5435442,
            "lng": 123.0567693,
            "country": {
                "id": 228,
                "name": "INDONESIA",
                "code": "ID"
            }
        },
        {
            "id": 8,
            "name": "Jambi",
            "lat": -1.6101229,
            "lng": 103.6131203,
            "country": {
                "id": 228,
                "name": "INDONESIA",
                "code": "ID"
            }
        },
        {
            "id": 9,
            "name": "Jawa Barat",
            "lat": -7.090911,
            "lng": 107.668887,
            "country": {
                "id": 228,
                "name": "INDONESIA",
                "code": "ID"
            }
        },
        {
            "id": 10,
            "name": "Jawa Tengah",
            "lat": -7.150975,
            "lng": 110.1402594,
            "country": {
                "id": 228,
                "name": "INDONESIA",
                "code": "ID"
            }
        },
        {
            "id": 11,
            "name": "Jawa Timur",
            "lat": -7.5360639,
            "lng": 112.2384017,
            "country": {
                "id": 228,
                "name": "INDONESIA",
                "code": "ID"
            }
        },
        {
            "id": 12,
            "name": "Kalimantan Barat",
            "lat": -0.2787808,
            "lng": 111.4752851,
            "country": {
                "id": 228,
                "name": "INDONESIA",
                "code": "ID"
            }
        },
        {
            "id": 13,
            "name": "Kalimantan Selatan",
            "lat": -3.0926415,
            "lng": 115.2837585,
            "country": {
                "id": 228,
                "name": "INDONESIA",
                "code": "ID"
            }
        },
        {
            "id": 14,
            "name": "Kalimantan Tengah",
            "lat": -1.6814878,
            "lng": 113.3823545,
            "country": {
                "id": 228,
                "name": "INDONESIA",
                "code": "ID"
            }
        },
        {
            "id": 15,
            "name": "Kalimantan Timur",
            "lat": 0.5386586,
            "lng": 116.419389,
            "country": {
                "id": 228,
                "name": "INDONESIA",
                "code": "ID"
            }
        },
        {
            "id": 16,
            "name": "Kalimantan Utara",
            "lat": 3.0730929,
            "lng": 116.0413889,
            "country": {
                "id": 228,
                "name": "INDONESIA",
                "code": "ID"
            }
        },
        {
            "id": 17,
            "name": "Kepulauan Riau",
            "lat": 3.9456514,
            "lng": 108.1428669,
            "country": {
                "id": 228,
                "name": "INDONESIA",
                "code": "ID"
            }
        },
        {
            "id": 18,
            "name": "Lampung",
            "lat": -4.5585849,
            "lng": 105.4068079,
            "country": {
                "id": 228,
                "name": "INDONESIA",
                "code": "ID"
            }
        },
        {
            "id": 19,
            "name": "Maluku Utara",
            "lat": -3.2384616,
            "lng": 130.1452734,
            "country": {
                "id": 228,
                "name": "INDONESIA",
                "code": "ID"
            }
        },
        {
            "id": 20,
            "name": "Maluku",
            "lat": 1.5709993,
            "lng": 127.8087693,
            "country": {
                "id": 228,
                "name": "INDONESIA",
                "code": "ID"
            }
        },
        {
            "id": 21,
            "name": "Aceh",
            "lat": 4.695135,
            "lng": 96.7493993,
            "country": {
                "id": 228,
                "name": "INDONESIA",
                "code": "ID"
            }
        },
        {
            "id": 22,
            "name": "Nusa Tenggara Barat",
            "lat": -8.6529334,
            "lng": 117.3616476,
            "country": {
                "id": 228,
                "name": "INDONESIA",
                "code": "ID"
            }
        },
        {
            "id": 23,
            "name": "Nusa Tenggara Timur",
            "lat": -8.6573819,
            "lng": 121.0793705,
            "country": {
                "id": 228,
                "name": "INDONESIA",
                "code": "ID"
            }
        },
        {
            "id": 24,
            "name": "Papua Barat",
            "lat": -4.269928,
            "lng": 138.0803529,
            "country": {
                "id": 228,
                "name": "INDONESIA",
                "code": "ID"
            }
        },
        {
            "id": 25,
            "name": "Papua",
            "lat": -1.3361154,
            "lng": 133.1747162,
            "country": {
                "id": 228,
                "name": "INDONESIA",
                "code": "ID"
            }
        },
        {
            "id": 26,
            "name": "Riau",
            "lat": 0.2933469,
            "lng": 101.7068294,
            "country": {
                "id": 228,
                "name": "INDONESIA",
                "code": "ID"
            }
        },
        {
            "id": 27,
            "name": "Sulawesi Barat",
            "lat": -2.8441371,
            "lng": 119.2320784,
            "country": {
                "id": 228,
                "name": "INDONESIA",
                "code": "ID"
            }
        },
        {
            "id": 28,
            "name": "Sulawesi Selatan",
            "lat": -3.6687994,
            "lng": 119.9740534,
            "country": {
                "id": 228,
                "name": "INDONESIA",
                "code": "ID"
            }
        },
        {
            "id": 29,
            "name": "Sulawesi Tengah",
            "lat": -1.4300254,
            "lng": 121.4456179,
            "country": {
                "id": 228,
                "name": "INDONESIA",
                "code": "ID"
            }
        },
        {
            "id": 30,
            "name": "Sulawesi Tenggara",
            "lat": -1.4300254,
            "lng": 121.4456179,
            "country": {
                "id": 228,
                "name": "INDONESIA",
                "code": "ID"
            }
        }
    ],
    "pagination": {
        "current_page": 1,
        "current_elements": 30,
        "total_pages": 2,
        "total_elements": 34
    }
}

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 location

data.[].id

Province ID

data.[].name

Province Name

data.[].lat

Province Latitude

data.[].lng

Province Longitude

data.[].country

All the country information of the province

data.[].country.id

Country ID

data.[].country.name

Country name

data.[].country.code

Country code

GET Cities by Province ID

Returns a list of cities based on the Province ID

GET /v3/location/province/{province_id}/cities

URL Query Parameter

Parameter

Value

Description

province_id
(required)

integer

Shipper’s Province ID integer example: 6

city_ids

string

Array of Shipper’s City ID as a string w/o square brackets example: 41,42,43,44 (default: show all)

limit

integer

Limit data for each page, integer example: 30 (default: 30)

page

integer

Page Number integer example: 1 (default: 1)

Sample Request & Response

curl --location 
--request GET '{{baseUrl}}/v3/location/province/6/cities'
{
    "metadata": {
        "path": "/v3/location/province/6/cities?%3Aprovince_id=6&",
        "http_status_code": 200,
        "http_status": "OK",
        "timestamp": 1620374105
    },
    "data": [
        {
            "province": {
                "id": 6,
                "name": "DKI Jakarta",
                "lat": -6.1744651,
                "lng": 106.822745
            },
            "country": {
                "id": 228,
                "name": "INDONESIA",
                "code": "ID"
            },
            "id": 38,
            "name": "Kepulauan Seribu",
            "lat": -5.7985265,
            "lng": 106.5071981
        },
        {
            "province": {
                "id": 6,
                "name": "DKI Jakarta",
                "lat": -6.1744651,
                "lng": 106.822745
            },
            "country": {
                "id": 228,
                "name": "INDONESIA",
                "code": "ID"
            },
            "id": 39,
            "name": "Jakarta Utara",
            "lat": -6.1384145,
            "lng": 106.863956
        },
        {
            "province": {
                "id": 6,
                "name": "DKI Jakarta",
                "lat": -6.1744651,
                "lng": 106.822745
            },
            "country": {
                "id": 228,
                "name": "INDONESIA",
                "code": "ID"
            },
            "id": 40,
            "name": "Jakarta Timur",
            "lat": -6.2250138,
            "lng": 106.9004472
        },
        {
            "province": {
                "id": 6,
                "name": "DKI Jakarta",
                "lat": -6.1744651,
                "lng": 106.822745
            },
            "country": {
                "id": 228,
                "name": "INDONESIA",
                "code": "ID"
            },
            "id": 41,
            "name": "Jakarta Selatan",
            "lat": -6.2614927,
            "lng": 106.8105998
        },
        {
            "province": {
                "id": 6,
                "name": "DKI Jakarta",
                "lat": -6.1744651,
                "lng": 106.822745
            },
            "country": {
                "id": 228,
                "name": "INDONESIA",
                "code": "ID"
            },
            "id": 42,
            "name": "Jakarta Barat",
            "lat": -6.1683295,
            "lng": 106.7588494
        },
        {
            "province": {
                "id": 6,
                "name": "DKI Jakarta",
                "lat": -6.1744651,
                "lng": 106.822745
            },
            "country": {
                "id": 228,
                "name": "INDONESIA",
                "code": "ID"
            },
            "id": 43,
            "name": "Jakarta Pusat",
            "lat": -6.1864864,
            "lng": 106.8340911
        }
    ],
    "pagination": {
        "current_page": 1,
        "current_elements": 6,
        "total_pages": 1,
        "total_elements": 6
    }
}

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 location

data.[].id

City ID

data.[].name

City Name

data.[].lat

City Latitude

data.[].lng

City Longitude

data.[].country

All the country information of the city

data.[].country.id

Country ID

data.[].country.name

Country name

data.[].country.code

Country code

data.[].province

All the province information of the city

data.[].province.id

Province ID

data.[].province.name

Province name

data.[].province.lat

Province latitude

data.[].province.lng

Province longitude

GET Suburbs by City ID

Returns a list of suburbs based on the City ID

GET /v3/location/city/{city_id}/suburbs

URL Query Parameter

Parameter

Value

Description

city_id

integer

Shipper’s City ID integer example: 41

suburb_ids

string

Array of Shipper’s Suburb ID as a string w/o square brackets, example: 482,483,484 (default: show all)

limit

integer

Limit data for each page, integer example: 30 (default: 30)

page

integer

Page Number integer example: 1 (default: 1)

Sample Request & Response

curl --location
--request GET '{{baseUrl}}/v3/location/city/41/suburbs'
{
    "metadata": {
        "path": "/v3/location/city/41/suburbs?%3Acity_id=41&",
        "http_status_code": 200,
        "http_status": "OK",
        "timestamp": 1620376494
    },
    "data": [
        {
            "id": 482,
            "name": "Setia Budi",
            "lat": -6.2195686,
            "lng": 106.8325872,
            "city": {
                "id": 41,
                "name": "Jakarta Selatan",
                "lat": -6.2614927,
                "lng": 106.8105998
            },
            "province": {
                "id": 6,
                "name": "DKI Jakarta",
                "lat": -6.1744651,
                "lng": 106.822745
            },
            "country": {
                "id": 228,
                "name": "INDONESIA",
                "code": "ID"
            }
        },
        {
            "id": 483,
            "name": "Tebet",
            "lat": -6.2318597,
            "lng": 106.8473377,
            "city": {
                "id": 41,
                "name": "Jakarta Selatan",
                "lat": -6.2614927,
                "lng": 106.8105998
            },
            "province": {
                "id": 6,
                "name": "DKI Jakarta",
                "lat": -6.1744651,
                "lng": 106.822745
            },
            "country": {
                "id": 228,
                "name": "INDONESIA",
                "code": "ID"
            }
        },
        {
            "id": 484,
            "name": "Mampang Prapatan",
            "lat": -6.2506144,
            "lng": 106.8207875,
            "city": {
                "id": 41,
                "name": "Jakarta Selatan",
                "lat": -6.2614927,
                "lng": 106.8105998
            },
            "province": {
                "id": 6,
                "name": "DKI Jakarta",
                "lat": -6.1744651,
                "lng": 106.822745
            },
            "country": {
                "id": 228,
                "name": "INDONESIA",
                "code": "ID"
            }
        },
        {
            "id": 485,
            "name": "Pancoran",
            "lat": -6.2523005,
            "lng": 106.8473377,
            "city": {
                "id": 41,
                "name": "Jakarta Selatan",
                "lat": -6.2614927,
                "lng": 106.8105998
            },
            "province": {
                "id": 6,
                "name": "DKI Jakarta",
                "lat": -6.1744651,
                "lng": 106.822745
            },
            "country": {
                "id": 228,
                "name": "INDONESIA",
                "code": "ID"
            }
        },
        {
            "id": 486,
            "name": "Jagakarsa",
            "lat": -6.334917,
            "lng": 106.8237374,
            "city": {
                "id": 41,
                "name": "Jakarta Selatan",
                "lat": -6.2614927,
                "lng": 106.8105998
            },
            "province": {
                "id": 6,
                "name": "DKI Jakarta",
                "lat": -6.1744651,
                "lng": 106.822745
            },
            "country": {
                "id": 228,
                "name": "INDONESIA",
                "code": "ID"
            }
        },
        {
            "id": 487,
            "name": "Pasar Minggu",
            "lat": -6.2939813,
            "lng": 106.8237374,
            "city": {
                "id": 41,
                "name": "Jakarta Selatan",
                "lat": -6.2614927,
                "lng": 106.8105998
            },
            "province": {
                "id": 6,
                "name": "DKI Jakarta",
                "lat": -6.1744651,
                "lng": 106.822745
            },
            "country": {
                "id": 228,
                "name": "INDONESIA",
                "code": "ID"
            }
        },
        {
            "id": 488,
            "name": "Cilandak",
            "lat": -6.2845276,
            "lng": 106.8001396,
            "city": {
                "id": 41,
                "name": "Jakarta Selatan",
                "lat": -6.2614927,
                "lng": 106.8105998
            },
            "province": {
                "id": 6,
                "name": "DKI Jakarta",
                "lat": -6.1744651,
                "lng": 106.822745
            },
            "country": {
                "id": 228,
                "name": "INDONESIA",
                "code": "ID"
            }
        },
        {
            "id": 489,
            "name": "Pesanggrahan",
            "lat": -6.2474283,
            "lng": 106.7617984,
            "city": {
                "id": 41,
                "name": "Jakarta Selatan",
                "lat": -6.2614927,
                "lng": 106.8105998
            },
            "province": {
                "id": 6,
                "name": "DKI Jakarta",
                "lat": -6.1744651,
                "lng": 106.822745
            },
            "country": {
                "id": 228,
                "name": "INDONESIA",
                "code": "ID"
            }
        },
        {
            "id": 490,
            "name": "Kebayoran Lama",
            "lat": -6.2443916,
            "lng": 106.7765443,
            "city": {
                "id": 41,
                "name": "Jakarta Selatan",
                "lat": -6.2614927,
                "lng": 106.8105998
            },
            "province": {
                "id": 6,
                "name": "DKI Jakarta",
                "lat": -6.1744651,
                "lng": 106.822745
            },
            "country": {
                "id": 228,
                "name": "INDONESIA",
                "code": "ID"
            }
        },
        {
            "id": 491,
            "name": "Kebayoran Baru",
            "lat": -6.2436219,
            "lng": 106.8001396,
            "city": {
                "id": 41,
                "name": "Jakarta Selatan",
                "lat": -6.2614927,
                "lng": 106.8105998
            },
            "province": {
                "id": 6,
                "name": "DKI Jakarta",
                "lat": -6.1744651,
                "lng": 106.822745
            },
            "country": {
                "id": 228,
                "name": "INDONESIA",
                "code": "ID"
            }
        }
    ],
    "pagination": {
        "current_page": 1,
        "current_elements": 10,
        "total_pages": 1,
        "total_elements": 10
    }
}

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 location

data.[].id

Suburb ID

data.[].name

Suburb Name

data.[].lat

Suburb Latitude

data.[].lng

Suburb Longitude

data.[].country

All the country information of the suburb

data.[].country.id

Country ID

data.[].country.name

Country name

data.[].country.code

Country code

data.[].province

All the province information of the suburb

data.[].province.id

Province ID

data.[].province.name

Province name

data.[].province.lat

Province latitude

data.[].province.lng

Province longitude

data.[].city

All the city information of the suburb

data.[].city.id

City ID

data.[].city.name

City name

data.[].city.lat

City latitude

data.[].city.lng

City longitude

GET Areas by Suburb ID

Returns a list of areas based on the Suburb ID

GET /v3/location/suburb/{suburb_id}/areas

URL Query Parameter

Parameter

Value

Description

suburb_id
(required)

integer

Shipper’s Suburb ID integer example: 482

area_ids

string

Array of Shipper’s Area ID as a string w/o square brackets, example: 4707,4708 (default: show all)

limit

integer

Limit data for each page, integer example: 1

page

integer

Page Number integer example: 1 (default: 1)

Sample Request & Response

curl --location
 --request GET '{{baseUrl}}/v3/location/suburb/482/areas'
{
    "metadata": {
        "path": "/v3/location/suburb/482/areas?%3Asuburb_id=482&",
        "http_status_code": 200,
        "http_status": "OK",
        "timestamp": 1620377265
    },
    "data": [
        {
            "suburb": {
                "id": 482,
                "name": "Setia Budi",
                "lat": -6.2195686,
                "lng": 106.8325872
            },
            "city": {
                "id": 41,
                "name": "Jakarta Selatan",
                "lat": -6.2614927,
                "lng": 106.8105998
            },
            "province": {
                "id": 6,
                "name": "DKI Jakarta",
                "lat": -6.1744651,
                "lng": 106.822745
            },
            "country": {
                "id": 228,
                "name": "INDONESIA",
                "code": "ID"
            },
            "id": 4707,
            "name": "Pasar Manggis",
            "postcode": "12970",
            "lat": -6.2090339,
            "lng": 106.8415828
        },
        {
            "suburb": {
                "id": 482,
                "name": "Setia Budi",
                "lat": -6.2195686,
                "lng": 106.8325872
            },
            "city": {
                "id": 41,
                "name": "Jakarta Selatan",
                "lat": -6.2614927,
                "lng": 106.8105998
            },
            "province": {
                "id": 6,
                "name": "DKI Jakarta",
                "lat": -6.1744651,
                "lng": 106.822745
            },
            "country": {
                "id": 228,
                "name": "INDONESIA",
                "code": "ID"
            },
            "id": 4708,
            "name": "Guntur",
            "postcode": "12980",
            "lat": -6.2080273,
            "lng": 106.8340622
        },
        {
            "suburb": {
                "id": 482,
                "name": "Setia Budi",
                "lat": -6.2195686,
                "lng": 106.8325872
            },
            "city": {
                "id": 41,
                "name": "Jakarta Selatan",
                "lat": -6.2614927,
                "lng": 106.8105998
            },
            "province": {
                "id": 6,
                "name": "DKI Jakarta",
                "lat": -6.1744651,
                "lng": 106.822745
            },
            "country": {
                "id": 228,
                "name": "INDONESIA",
                "code": "ID"
            },
            "id": 4709,
            "name": "Kuningan Timur",
            "postcode": "12950",
            "lat": -6.2299792,
            "lng": 106.8266873
        },
        {
            "suburb": {
                "id": 482,
                "name": "Setia Budi",
                "lat": -6.2195686,
                "lng": 106.8325872
            },
            "city": {
                "id": 41,
                "name": "Jakarta Selatan",
                "lat": -6.2614927,
                "lng": 106.8105998
            },
            "province": {
                "id": 6,
                "name": "DKI Jakarta",
                "lat": -6.1744651,
                "lng": 106.822745
            },
            "country": {
                "id": 228,
                "name": "INDONESIA",
                "code": "ID"
            },
            "id": 4710,
            "name": "Menteng Atas",
            "postcode": "12960",
            "lat": -6.2180511,
            "lng": 106.8399623
        },
        {
            "suburb": {
                "id": 482,
                "name": "Setia Budi",
                "lat": -6.2195686,
                "lng": 106.8325872
            },
            "city": {
                "id": 41,
                "name": "Jakarta Selatan",
                "lat": -6.2614927,
                "lng": 106.8105998
            },
            "province": {
                "id": 6,
                "name": "DKI Jakarta",
                "lat": -6.1744651,
                "lng": 106.822745
            },
            "country": {
                "id": 228,
                "name": "INDONESIA",
                "code": "ID"
            },
            "id": 4711,
            "name": "Karet Kuningan",
            "postcode": "12940",
            "lat": -6.2197608,
            "lng": 106.8266873
        },
        {
            "suburb": {
                "id": 482,
                "name": "Setia Budi",
                "lat": -6.2195686,
                "lng": 106.8325872
            },
            "city": {
                "id": 41,
                "name": "Jakarta Selatan",
                "lat": -6.2614927,
                "lng": 106.8105998
            },
            "province": {
                "id": 6,
                "name": "DKI Jakarta",
                "lat": -6.1744651,
                "lng": 106.822745
            },
            "country": {
                "id": 228,
                "name": "INDONESIA",
                "code": "ID"
            },
            "id": 4712,
            "name": "Karet Semanggi",
            "postcode": "12930",
            "lat": -6.2213742,
            "lng": 106.8163628
        },
        {
            "suburb": {
                "id": 482,
                "name": "Setia Budi",
                "lat": -6.2195686,
                "lng": 106.8325872
            },
            "city": {
                "id": 41,
                "name": "Jakarta Selatan",
                "lat": -6.2614927,
                "lng": 106.8105998
            },
            "province": {
                "id": 6,
                "name": "DKI Jakarta",
                "lat": -6.1744651,
                "lng": 106.822745
            },
            "country": {
                "id": 228,
                "name": "INDONESIA",
                "code": "ID"
            },
            "id": 4713,
            "name": "Setiabudi",
            "postcode": "12910",
            "lat": -6.2098892,
            "lng": 106.8223457
        },
        {
            "suburb": {
                "id": 482,
                "name": "Setia Budi",
                "lat": -6.2195686,
                "lng": 106.8325872
            },
            "city": {
                "id": 41,
                "name": "Jakarta Selatan",
                "lat": -6.2614927,
                "lng": 106.8105998
            },
            "province": {
                "id": 6,
                "name": "DKI Jakarta",
                "lat": -6.1744651,
                "lng": 106.822745
            },
            "country": {
                "id": 228,
                "name": "INDONESIA",
                "code": "ID"
            },
            "id": 4714,
            "name": "Karet",
            "postcode": "12920",
            "lat": -6.214731,
            "lng": 106.818265
        }
    ],
    "pagination": {
        "current_page": 1,
        "current_elements": 8,
        "total_pages": 1,
        "total_elements": 8
    }
}

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 location

data.[].id

Area ID

data.[].name

Area Name

data.[].postcode

Area Postcode

data.[].lat

Area Latitude

data.[].lng

Area Longitude

data.[].country

All the country information of the area

data.[].country.id

Country ID

data.[].country.name

Country name

data.[].country.code

Country code

data.[].province

All the province information of the area

data.[].province.id

Province ID

data.[].province.name

Province name

data.[].province.lat

Province latitude

data.[].province.lng

Province longitude

data.[].city

All the city information of the area

data.[].city.id

City ID

data.[].city.name

City name

data.[].city.lat

City latitude

data.[].city.lng

City longitude

data.[].suburb

All the suburb information of the area

data.[].suburb.id

Suburb ID

data.[].suburb.name

Suburb name

data.[].suburb.lat

Suburb latitude

data.[].suburb.lng

Suburb longitude

For example, the destination will be Karet Kuningan, Setiabudi, Jakarta Selatan, DKI Jakarta, Indonesia

In the sample case above, the area_id will be 4711

Use the area_id obtained from GET Area for doing the next API Call (Pricing)


What’s Next