DOdomain
Statistics

Suburb Summary

Changed on

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

get/v1/suburbSummary/{state}/{suburb}/{postcode}

Request

Path parameters

state'NSW' | 'VIC' | 'QLD' | 'SA' | 'WA' | 'TAS' | 'NT' | 'ACT' required

The Australian state abbreviation

suburbstring required

Suburb name to retrieve data for

postcodestring required

Suburb Post Code for suburbs with official post codes.

Query parameters

propertyCategory'House' | 'Unit'

Category of sales results to show Available values : house, unit Default value : house

periodSize'months' | 'quarters' | 'years'

Unit of the measurement period to use Default value : quarters

hasBedroomSplitsboolean

Whether to include bedroom splits in summary data. When true or omitted, returns aggregated data plus splits by bedroom count. When false, returns only the total aggregated record. Default value : true

Response

Summary data returned

Changes

  • 7130302fb268Revision changes
    • info

      added the new optional query request parameter hasBedroomSplits

    • info

      added the optional property //// to the response with the status

    • info

      added the optional property //// to the response with the status

    • info

      added the optional property //// to the response with the status

  • 2b6eb6542715Revision changes
    • info

      endpoint added