# Domain.com.au Locations

Returns matched properties with their suburb, state and postcode, plus the suburbs neighbouring a supplied slug. Supplying suburb_slug alongside q returns structured neighbouring suburbs; without it the suggestion list for that operation is empty.

- **Documentation:** [https://scrappa.co/docs/domain-com-au-api/domain_com_au_locations](https://scrappa.co/docs/domain-com-au-api/domain_com_au_locations)
- **API group:** Domain.com.au API
- **Endpoint:** `GET https://scrappa.co/api/domain-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 |
| --- | --- | --- | --- |
| `q` | string | Yes | Free-text address or suburb fragment. |
| `suburb_slug` | string | No | Slug whose neighbouring suburbs are returned, for example pyrmont-nsw-2009. |
| `mode` | string | No | sale or rent. Selects which neighbourhood set is returned. |
| `channel` | string | No | ALL (default), RESIDENTIAL, or COMMERCIAL. |
| `page_size` | integer | No | Rows per page, up to 50. |

## Example request

```bash
#!/bin/bash

curl -X GET \
    -H "x-api-key: YOUR_API_KEY_HERE" \
    "https://scrappa.co/api/domain-com-au/locations?q=pyrmont&suburb_slug=pyrmont-nsw-2009"
```

## Example response

```json
{
    "success": true,
    "data": {
        "suggested_properties": [
            {
                "address": "166 Pyrmont Street, Pyrmont NSW 2009",
                "postcode": "2009"
            }
        ],
        "suggested_suburbs": [
            {
                "name": "Glebe",
                "state": "NSW",
                "postcode": "2037"
            }
        ]
    }
}
```

## Errors

| Status | Error | Description |
| --- | --- | --- |
| 400 | Validation Error | A parameter is invalid, including an unrecognised mode, property type or enum. Accepted values are listed in the error. This response is not billable. |
| 404 | Not Found | The requested listing, agent profile or city was not found. This response is not billable. |
| 422 | Upstream Input Rejected | Domain.com.au refused the requested filters, or an identifier could not be resolved. This response is not billable. |
| 503 | Service Unavailable | The service could not reach its data source, or the lookup did not complete. No credits are charged for a failed request. |

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