# PropertyGuru Autocomplete API Documentation

<p><strong>PropertyGuru Autocomplete API</strong> turns search text into districts, areas, neighbourhoods, MRT and LRT stations and projects. Each result has an id, type, display text, description, district and coordinates when known. Districts in Singapore and areas and regions in Malaysia also carry a ready <code>search_filter</code> you can pass to the Search API. An empty list is a successful, billable response.</p>

- **Documentation:** [https://scrappa.co/docs/propertyguru-api/propertyguru_autocomplete](https://scrappa.co/docs/propertyguru-api/propertyguru_autocomplete)
- **API group:** PropertyGuru API
- **Endpoint:** `GET https://scrappa.co/api/propertyguru/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 |
| --- | --- | --- | --- |
| `market` | string | Yes | Market to search: sg (Singapore) or my (Malaysia). Example: sg. |
| `query` | string | Yes | Search text, 2 to 100 characters. Example: orchard. |
| `limit` | integer | No | Number of results, 1 to 20 (default 8). Example: 5. |

## Example response

```json
{
    "data": {
        "query": "orchard",
        "market": "sg",
        "results": [
            {
                "id": "D09",
                "text": "D09 Orchard / River Valley",
                "type": "DISTRICT",
                "district": "D09",
                "latitude": null,
                "longitude": null,
                "type_label": "District",
                "description": "D9",
                "search_filter": {
                    "district_code": "D09"
                }
            },
            {
                "id": "8197",
                "text": "TE14 Orchard MRT Station",
                "type": "MRT_STATION",
                "district": "D09",
                "latitude": 1.30407,
                "longitude": 103.83226,
                "type_label": "MRT Station",
                "description": "301 Orchard Boulevard, 237974",
                "search_filter": null
            }
        ]
    },
    "meta": {
        "billable": true,
        "endpoint_family": "autocomplete"
    },
    "success": true
}
```

## Errors

| Status | Error | Description |
| --- | --- | --- |
| 422 | Validation Error | A required parameter or a range is invalid. This response is not billable. |
| 503 | Upstream Unavailable | PropertyGuru 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)