---
title: "Suburb Summary"
method: GET
path: "/v1/suburbSummary/{state}/{suburb}/{postcode}"
tags: ["Statistics"]
---

# Suburb Summary

`GET /v1/suburbSummary/{state}/{suburb}/{postcode}`

Retrieve suburb summary data (up to 12 months) by state, suburb and postcode

## Path parameters

- `state` 'NSW' | 'VIC' | 'QLD' | 'SA' | 'WA' | 'TAS' | 'NT' | 'ACT', required
- `suburb` string, required
- `postcode` string, required

## Query parameters

- `propertyCategory` 'House' | 'Unit'
- `periodSize` 'months' | 'quarters' | 'years'
- `hasBedroomSplits` boolean

## Response `200`

Summary data returned

- SuburbSummaryAndHistorical
  - `header` object
    - `suburb` string
    - `state` string
    - `postcode` string
    - `propertyCategory` string
  - `series` object
    - `seriesInfo` object[]
      - `bedrooms` integer
      - `year` integer
      - `month` integer
      - `values` object
        - `numberSold` integer
        - `medianSoldPrice` integer
        - `highestSoldPrice` integer
        - `lowestSoldPrice` integer
        - `numberSaleListing` integer
        - `medianSaleListingPrice` integer
        - `highestSaleListingPrice` integer
        - `lowestSaleListingPrice` integer
        - `daysOnMarket` integer
        - `meanRentYield` number, float
        - `numberRentListing` integer
        - `medianRentListingPrice` integer
        - `highestRentListingPrice` integer
        - `lowestRentListingPrice` integer
        - `lowestDiscount` number, float
        - `medianDiscount` number, float
        - `highestDiscount` number, float

## Other responses

- `400` — Bad request
- `401` — Unauthorized
- `500` — Unexpected error

---

[API](https://skmtc.net/domain/apis/domain-public-api.md) · [All operations](https://skmtc.net/domain/apis/domain-public-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/domain/domain-public-api/versions/24ab78aba827/schema)