Skip to content
Scrappa Get API key
iProperty API 1 credit/request

iProperty Autocomplete API Documentation

GET https://scrappa.co/api/iproperty/v1/autocomplete

iProperty Autocomplete API suggests Malaysian locations, areas and projects for a text query. Each result has an id, a type, a label, a description and the region. Area and district results also return a ready search_filter.location slug that you pass to Search as location.

iProperty Autocomplete API Documentation 1 credit/request

Endpoint

Request preview
GET
https://scrappa.co/api/iproperty/v1/autocomplete
Auth header
x-api-key
Cost
1 credit/request
query = coffee shops
Response preview
200 OK
{
    "data": {
        "query": "mont kiara",
        "results": [
            {
                "id": "q9qzw",
                "text": "Mont Kiara",
                "type": "DISTRICT",
                "region": "58jok",
                "district": "q9qzw",
                "latitude": null,
                "longitude": null,
                "type_label": "City/Area",
                "description": "Kuala Lumpur",
...

Parameters

Start with the required fields, then add optional filters only when your use case needs them.

Runnable path

1 required parameter needed before sending a request.

1 optional filter available.

query string Required

Search text, 2 to 100 characters. Example: mont kiara.

Example value coffee shops
limit integer Optional

Number of results, 1 to 20 (default 8). Example: 5.

Example value 10

Response Schema

Example response fields are illustrative; inspect the JSON before integrating.

Example response fields

Scan these fields before integrating.

data meta success
JSON Response
200 OK
{
    "data": {
        "query": "mont kiara",
        "results": [
            {
                "id": "q9qzw",
                "text": "Mont Kiara",
                "type": "DISTRICT",
                "region": "58jok",
                "district": "q9qzw",
                "latitude": null,
                "longitude": null,
                "type_label": "City/Area",
                "description": "Kuala Lumpur",
                "property_type": null,
                "search_filter": {
                    "location": "in-mont-kiara-q9qzw"
                }
            },
            {
                "id": "602",
                "text": "Mont Kiara Pines",
                "type": "PROPERTY",
                "region": "58jok",
                "district": null,
                "latitude": null,
                "longitude": null,
                "type_label": "Condominium",
                "description": "Jalan Kiara 50480, Kuala Lumpur",
                "property_type": "CONDO",
                "search_filter": null
            },
            {
                "id": "469",
                "text": "Mont Kiara Aman",
                "type": "PROPERTY",
                "region": "58jok",
                "district": null,
                "latitude": null,
                "longitude": null,
                "type_label": "Condominium",
                "description": "- Jalan Kiara 2 50480, Kuala Lumpur",
                "property_type": "CONDO",
                "search_filter": null
            },
            {
                "id": "471",
                "text": "Mont Kiara Banyan",
                "type": "PROPERTY",
                "region": "58jok",
                "district": null,
                "latitude": null,
                "longitude": null,
                "type_label": "Condominium",
                "description": "- Jalan Kiara 2 50480, Kuala Lumpur",
                "property_type": "CONDO",
                "search_filter": null
            },
            {
                "id": "472",
                "text": "Mont Kiara Bayu",
                "type": "PROPERTY",
                "region": "58jok",
                "district": null,
                "latitude": null,
                "longitude": null,
                "type_label": "Condominium",
                "description": "2 No. 2, Jalan Mont Kiara 2 50480, Kuala Lumpur",
                "property_type": "CONDO",
                "search_filter": null
            }
        ]
    },
    "meta": {
        "billable": true,
        "endpoint_family": "autocomplete"
    },
    "success": true
}

Errors

Handle these documented responses before retrying or showing customer-facing failures.

422

Validation Error

A required parameter, a value or a range is invalid. This response is not billable.

{
    "errors": {
        "query": [
            "The query field is required."
        ]
    },
    "message": "The request validation failed"
}
404

Not Found

The requested resource was not found. This response is not billable.

{
    "meta": {
        "billable": false,
        "retryable": false,
        "endpoint_family": "autocomplete"
    },
    "error": {
        "code": "NOT_FOUND",
        "message": "The requested resource was not found."
    },
    "success": false
}
503

Upstream Unavailable

iProperty could not be reached or returned data that does not match the request. This response is not billable and is retryable.

{
    "meta": {
        "billable": false,
        "retryable": true,
        "endpoint_family": "autocomplete"
    },
    "error": {
        "code": "UPSTREAM_UNAVAILABLE",
        "message": "iProperty could not be reached. Please retry shortly."
    },
    "success": false
}

Generate Code with AI

Copy a ready-made prompt with all the endpoint details, parameters, and example responses. Paste it into ChatGPT, Claude, or any AI assistant to instantly generate working code.

Try It Live

Test this endpoint in our interactive playground with real data.