# iProperty Autocomplete API Documentation

<p><strong>iProperty Autocomplete API</strong> 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 <code>search_filter.location</code> slug that you pass to Search as <code>location</code>.</p>

- **Documentation:** [https://scrappa.co/docs/iproperty-api/iproperty_autocomplete](https://scrappa.co/docs/iproperty-api/iproperty_autocomplete)
- **API group:** iProperty API
- **Endpoint:** `GET https://scrappa.co/api/iproperty/v1/autocomplete`

## Authentication

Send your Scrappa API key in the `X-API-KEY` request header. Paid endpoints also support accountless x402 payments when called without an API key.

## Parameters

| Parameter | Type | Required | Description |
| --- | --- | --- | --- |
| `query` | string | Yes | Search text, 2 to 100 characters. Example: mont kiara. |
| `limit` | integer | No | Number of results, 1 to 20 (default 8). Example: 5. |

## Example response

```json
{
    "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

| Status | Error | Description |
| --- | --- | --- |
| 422 | Validation Error | A required parameter, a value or a range is invalid. This response is not billable. |
| 404 | Not Found | The requested resource was not found. This response is not billable. |
| 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. |

## More Scrappa resources

- [API documentation](https://scrappa.co/docs)
- [Full LLM-readable API reference](https://scrappa.co/llms-full.txt)
- [OpenAPI specification](https://scrappa.co/docs/api.json)
- [Pricing](https://scrappa.co/pricing)