Post Code

GET

/region/post-code

This API allows users to search for locations based on the input postal code. It can be used to display information about a specific area or region associated with the postal code, such as province, city, and sub-district.

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET '/region/post-code?post_code=14350' \
--header 'Authorization: Basic Og=='

Response Example

200 - 200 - Works fine.

{
    "success": true,
    "message": "",
    "data": [
        {
            "province_id": 32,
            "province_name": "JAWA BARAT",
            "city_id": 3201,
            "city_name": "BOGOR",
            "district_id": 3201020,
            "district": "LEUWILIANG",
            "subdistrict_id": 3201020001,
            "subdistrict": "PURASARI",
            "post_code": 16640
        },
        {
            "province_id": 32,
            "province_name": "JAWA BARAT",
            "city_id": 3201,
            "city_name": "BOGOR",
            "district_id": 3201020,
            "district": "LEUWILIANG",
            "subdistrict_id": 3201020002,
            "subdistrict": "PURASEDA",
            "post_code": 16640
        },
        {
            "province_id": 32,
            "province_name": "JAWA BARAT",
            "city_id": 3201,
            "city_name": "BOGOR",
            "district_id": 3201020,
            "district": "LEUWILIANG",
            "subdistrict_id": 3201020003,
            "subdistrict": "KARYASARI",
            "post_code": 16640
        },
        {
            "province_id": 32,
            "province_name": "JAWA BARAT",
            "city_id": 3201,
            "city_name": "BOGOR",
            "district_id": 3201020,
            "district": "LEUWILIANG",
            "subdistrict_id": 3201020004,
            "subdistrict": "PABANGBON",
            "post_code": 16640
        },
        {
            "province_id": 32,
            "province_name": "JAWA BARAT",
            "city_id": 3201,
            "city_name": "BOGOR",
            "district_id": 3201020,
            "district": "LEUWILIANG",
            "subdistrict_id": 3201020005,
            "subdistrict": "KARACAK",
            "post_code": 16640
        },
        {
            "province_id": 32,
            "province_name": "JAWA BARAT",
            "city_id": 3201,
            "city_name": "BOGOR",
            "district_id": 3201020,
            "district": "LEUWILIANG",
            "subdistrict_id": 3201020006,
            "subdistrict": "BARENGKOK",
            "post_code": 16640
        },
        {
            "province_id": 32,
            "province_name": "JAWA BARAT",
            "city_id": 3201,
            "city_name": "BOGOR",
            "district_id": 3201020,
            "district": "LEUWILIANG",
            "subdistrict_id": 3201020007,
            "subdistrict": "CIBEBER II",
            "post_code": 16640
        },
        {
            "province_id": 32,
            "province_name": "JAWA BARAT",
            "city_id": 3201,
            "city_name": "BOGOR",
            "district_id": 3201020,
            "district": "LEUWILIANG",
            "subdistrict_id": 3201020016,
            "subdistrict": "CIBEBER I",
            "post_code": 16640
        },
        {
            "province_id": 32,
            "province_name": "JAWA BARAT",
            "city_id": 3201,
            "city_name": "BOGOR",
            "district_id": 3201020,
            "district": "LEUWILIANG",
            "subdistrict_id": 3201020017,
            "subdistrict": "LEUWIMEKAR",
            "post_code": 16640
        },
        {
            "province_id": 32,
            "province_name": "JAWA BARAT",
            "city_id": 3201,
            "city_name": "BOGOR",
            "district_id": 3201020,
            "district": "LEUWILIANG",
            "subdistrict_id": 3201020018,
            "subdistrict": "LEUWILIANG",
            "post_code": 16640
        },
        {
            "province_id": 32,
            "province_name": "JAWA BARAT",
            "city_id": 3201,
            "city_name": "BOGOR",
            "district_id": 3201020,
            "district": "LEUWILIANG",
            "subdistrict_id": 3201020019,
            "subdistrict": "KAREHKEL",
            "post_code": 16640
        }
    ]
}

Request

Authorization

Send your HTTP requests with an

Authorization

header that contains the word Basic followed by a space and a base64-encoded string username:password

Example:

Authorization: Basic *****************

Query Params

Responses

🟢200200 - Works fine.

application/json

Body

🟠400400 - Bad request. Missing required parameters or parameters are not correct

🟠401401 - Request lacks authentication (Missing/Invalid Authentication Credentials)

🟠404404 - Not Found

🔴500500 - Internal Server Error

Modified at 2025-08-05 09:02:05

Sub-District

Search Region