# Realestate.com.au Locations

Search realestate.com.au location suggestions for suburbs, regions, schools, and projects. Use this before property search when you need a validated location string.

- **Documentation:** [https://scrappa.co/docs/realestate-com-au-api/realestate_com_au_locations](https://scrappa.co/docs/realestate-com-au-api/realestate_com_au_locations)
- **API group:** Realestate.com.au API
- **Endpoint:** `GET https://scrappa.co/api/realestate-com-au/locations`

## 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 | Suburb, postcode, school, region, or project search term. |
| `limit` | integer | No | Maximum suggestions to return. |

## Example request

```bash
#!/bin/bash

curl -X GET \
    -H "x-api-key: YOUR_API_KEY_HERE" \
    "https://scrappa.co/api/realestate-com-au/locations?query=Sydney&limit=5"
```

## Example response

```json
{
    "success": true,
    "data": {
        "query": "Sydney",
        "locations": {
            "suggestions": [
                {
                    "display": "Sydney, NSW 2000"
                }
            ]
        }
    }
}
```

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