# Property.com.au Location Autocomplete API Documentation

Scrappa's `GET /api/property-com-au/autocomplete` suggests Australian suburbs, postcodes, states, regions and street addresses for the start of a name.

## Use the result

- For a place (`suburb`, `postcode`, `state`, `region`), pass `search_location` as `location` to `/api/property-com-au/search`. It is the exact text the search accepts, for example `Bondi Beach, NSW 2026`.
- For an `address`, `pid` is the property id and `listing_path` is a path you pass as `path` to `/api/property-com-au/listing`. An address is one property, not a place, so `search_location` is `null`.

## Fields

Each suggestion has `id`, `type`, `text`, `subtext`, `suburb`, `state`, `postcode`, `street`, `search_location`, `pid` and `listing_path`. `type` limits the kinds returned: a comma-separated list of `suburb`, `postcode`, `state`, `region`, `address`. The default is all five.

- **Documentation:** [https://scrappa.co/docs/property-com-au-api/property_com_au_autocomplete](https://scrappa.co/docs/property-com-au-api/property_com_au_autocomplete)
- **API group:** Property.com.au API
- **Endpoint:** `GET https://scrappa.co/api/property-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 | Start of a place or address, at least 2 characters. |
| `type` | string | No | Comma-separated: suburb, postcode, state, region, address. Default: all five. |
| `limit` | integer | No | Suggestions to return, 1-10 (default 6). |

## Example request

```bash
#!/bin/bash

curl -X GET \
    -H "x-api-key: YOUR_API_KEY_HERE" \
    "https://scrappa.co/api/property-com-au/autocomplete?query=Bondi&limit=3"
```

## Example response

```json
{
    "success": true,
    "data": [
        {
            "id": "9795ffbe-fdfb-40b3-86be-47b22cba6cfe-2026",
            "type": "suburb",
            "text": "Bondi Beach, NSW 2026",
            "subtext": "Suburb",
            "suburb": "Bondi Beach",
            "state": "NSW",
            "postcode": "2026",
            "street": null,
            "search_location": "Bondi Beach, NSW 2026",
            "pid": null,
            "listing_path": null
        },
        {
            "id": "11740812",
            "type": "address",
            "text": "10 Lamrock Ave, Bondi Beach, NSW 2026",
            "subtext": "Property history",
            "suburb": "Bondi Beach",
            "state": "NSW",
            "postcode": "2026",
            "street": "10 Lamrock Ave",
            "search_location": null,
            "pid": 11740812,
            "listing_path": "/nsw/bondi-beach-2026/lamrock-ave/10-pid-11740812/"
        }
    ],
    "meta": {
        "endpoint_family": "autocomplete",
        "billable": true,
        "attempts": 1
    }
}
```

## Errors

| Status | Error | Description |
| --- | --- | --- |
| 422 | Validation Error | A query parameter is missing, unknown or unusable. Unknown parameters are rejected, never ignored. Non-billable. |
| 503 | Upstream Unavailable | Property.com.au could not be reached after retries or answered with something unusable (`upstream_unavailable`, `upstream_blocked`, `parser_drift`). Retryable and never billed. Clients are never rate limited. |

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