# Realestate.com.au Autocomplete

Fetch realestate.com.au consumer-suggest autocomplete results. This is the endpoint used by public search boxes for suburbs, regions, states, postcodes, precincts, addresses, schools, and projects depending on the types parameter.

- **Documentation:** [https://scrappa.co/docs/realestate-com-au-api/realestate_com_au_autocomplete](https://scrappa.co/docs/realestate-com-au-api/realestate_com_au_autocomplete)
- **API group:** Realestate.com.au API
- **Endpoint:** `GET https://scrappa.co/api/realestate-com-au/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 | Autocomplete search term. |
| `limit` | integer | No | Maximum suggestions to return. |
| `types` | string | No | Comma-separated suggestion types, e.g. suburb,region,precinct,state,postcode,address. |
| `source` | string | No | Client source sent to consumer-suggest, e.g. homepage-web, property-seeker, or reax-multi-intent-search-modal. |

## Example request

```bash
#!/bin/bash

curl -X GET \
    -H "x-api-key: YOUR_API_KEY_HERE" \
    "https://scrappa.co/api/realestate-com-au/autocomplete?query=Sydney+CBD%2C+NSW&limit=7&types=suburb%2Cregion%2Cprecinct%2Cstate%2Cpostcode"
```

## Example response

```json
{
    "success": true,
    "data": {
        "query": "Sydney CBD, NSW",
        "types": "suburb,region,precinct,state,postcode",
        "suggestions": []
    }
}
```

## Errors

| Status | Error | Description |
| --- | --- | --- |
| 422 | Request validation failed. |  |
| 503 | Realestate.com.au returned a challenge without parseable page data. |  |
| 503 | The upstream service is temporarily unavailable. Please retry shortly. |  |
| 503 | The upstream service is temporarily unavailable. Please retry shortly. |  |
| 503 | The upstream service is temporarily unavailable. Please retry shortly. |  |

## 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)