# Domain.com.au Suburb Insights

Pass a suburb slug for one profile, or a bounding box to resolve every suburb inside it in the same single upstream call. Returns the annual median-sold-price series with sale counts and days on market. A year can carry a null median alongside a populated sale count for sparse property types; that is reported as-is. property_type accepts only Unit or House.

- **Documentation:** [https://scrappa.co/docs/domain-com-au-api/domain_com_au_suburb_insights](https://scrappa.co/docs/domain-com-au-api/domain_com_au_suburb_insights)
- **API group:** Domain.com.au API
- **Endpoint:** `GET https://scrappa.co/api/domain-com-au/suburb-insights`

## 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 |
| --- | --- | --- | --- |
| `slug` | string | No | Suburb slug, for example pyrmont-nsw-2009. |
| `top_left[latitude]` | number | No | Bounding-box north-west latitude. |
| `top_left[longitude]` | number | No | Bounding-box north-west longitude. |
| `bottom_right[latitude]` | number | No | Bounding-box south-east latitude. |
| `bottom_right[longitude]` | number | No | Bounding-box south-east longitude. All four coordinates are required together; supplying only the latitudes returns a 400. |
| `bedrooms` | integer | Yes | Bedroom count the profile is computed for. |
| `property_type` | string | Yes | Unit or House. No other value is accepted. |

## Example request

```bash
#!/bin/bash

curl -X GET \
    -H "x-api-key: YOUR_API_KEY_HERE" \
    "https://scrappa.co/api/domain-com-au/suburb-insights?slug=pyrmont-nsw-2009&bedrooms=2&property_type=Unit"
```

## Example response

```json
{
    "success": true,
    "data": {
        "suburb": {
            "name": "Pyrmont",
            "postcode": "2009",
            "insights": {
                "median_sold_price": 1220000,
                "annual_growth": -0.043
            }
        }
    }
}
```

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