boscod OpenAPI

Search Area

Developing

GET

/v1/address/search

Search for locations across provinces, cities, or districts.

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Query Params

keyword

string

required

Search provinces, cities, or districts

Example:

BANGUNTAPAN

start

integer

optional

Starting index for pagination (default: 0)

Example:

limit

integer

optional

Number of records per page (default: 10)

Example:

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200Success

application/json

Body

items

array [object {7}]

required

string

optional

propinsi

string

optional

kota

string

optional

kecamatan

string

optional

kode_kota

string

optional

kodepos

string

optional

lokasi

string

optional

Example

{
    "total": 1,
    "items": [
        {
            "id": "15587",
            "propinsi": "DI YOGYAKARTA",
            "kota": "BANTUL",
            "kecamatan": "BANGUNTAPAN",
            "kode_kota": "BTL",
            "kodepos": "55198",
            "lokasi": "BANTUL / BANGUNTAPAN"
        }
    ]
}

Districts

List Courier