Documentation

Search District by Name

Search for districts by name keyword. Requests are rate-limited — excessive calls will temporarily suspend your API access

POST
Disclaimer: There are separate APIs for Pos Indonesia, RPX, and Paxel services. Please contact our technical team for more information.

Request

FieldDataTypeNullableDesc
searchstring(min: 3)falseName of district keyword
{
  "search": "Ngemplak"
}

Response

FieldDataTypeDesc
statusbooleanRequest status
textstringResponse message
methodstringAPI method name
dataarrayList of matched districts
data[].idintegerDistrict ID
data[].textstringFull district name with city and province
{
  "status": true,
  "text": "Success",
  "method": "get_address_by_name",
  "data": [
    {
      "id": 1251,
      "text": "Ngemplak, Kabupaten Boyolali, Jawa Tengah"
    },
    {
      "id": 5789,
      "text": "Ngemplak, Kabupaten Sleman, DI Yogyakarta"
    }
  ]
}