# Mudah.my Property Autocomplete API Documentation

<p><strong>Mudah.my Property Autocomplete API</strong> turns a keyword into states, subareas and buildings (type <code>location</code>, default) or into ready-made keyword suggestions (type <code>keyword</code>). Every result carries <code>search_filters</code> that you pass unchanged to the search endpoint.</p>

- **Documentation:** [https://scrappa.co/docs/mudah-property-api/mudah_property_autocomplete](https://scrappa.co/docs/mudah-property-api/mudah_property_autocomplete)
- **API group:** Mudah.my Property API
- **Endpoint:** `GET https://scrappa.co/api/mudah-property/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 |
| --- | --- | --- | --- |
| `keyword` | string | Yes | Search text, 2 to 100 characters. Example: bangsar. |
| `type` | string | No | location (default) or keyword. |
| `listing_type` | string | No | sale (default) or rent. Used by type keyword. |

## Example response

```json
{
    "data": {
        "results": [
            {
                "id": 353,
                "name": "Bangsar",
                "type": "subarea",
                "region": {
                    "id": 9,
                    "name": "Kuala Lumpur"
                },
                "subarea": {
                    "id": 353,
                    "name": "Bangsar"
                },
                "property_type": null,
                "search_filters": {
                    "region": 9,
                    "subarea": 353
                }
            },
            {
                "id": 354,
                "name": "Bangsar South",
                "type": "subarea",
                "region": {
                    "id": 9,
                    "name": "Kuala Lumpur"
                },
                "subarea": {
                    "id": 354,
                    "name": "Bangsar South"
                },
                "property_type": null,
                "search_filters": {
                    "region": 9,
                    "subarea": 354
                }
            }
        ],
        "search_parameters": {
            "type": "location",
            "keyword": "bangsar"
        }
    },
    "meta": {
        "billable": true,
        "endpoint_family": "autocomplete"
    },
    "success": true
}
```

## Errors

| Status | Error | Description |
| --- | --- | --- |
| 422 | Validation Error | A required parameter or a value is invalid. This response is not billable. |
| 503 | Upstream Unavailable | Mudah.my could not be reached. This response is not billable and is retryable. |
| 503 | Unexpected Upstream Data | Mudah.my returned data in an unexpected shape. 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)