Statistics

Suburb Performance by State/Suburb

Changed on

Retrieve suburb performance data by state and suburb

get/v2/suburbPerformanceStatistics/{state}/{suburb}

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

Query parameters

propertyCategory'House' | 'Unit'

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

bedroomsinteger

Number of bedrooms to use in the sales search

periodSize'quarters' | 'halfYears' | 'years'

Unit of the measurement period to use Default value : quarters

startingPeriodRelativeToCurrentinteger

When to start stats from. 1 = current period, 2 = previous period, etc. Default value : 1

totalPeriodsinteger

Number of total periods to show statistics for. i.e. 4 Quarters would be 1 full year Default value : 4

Response

Statistics data returned

Changes

    • info

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

    • breaking

      the path request parameter state was restricted to a list of enum values

    • breaking

      for the query request parameter periodSize, default value quarters was removed

    • breaking

      for the query request parameter propertyCategory, default value house was removed

    • breaking

      for the query request parameter startingPeriodRelativeToCurrent, default value 1 was removed

    • breaking

      for the query request parameter totalPeriods, default value 4 was removed

    • breaking

      removed the enum value house from the query request parameter propertyCategory

    • breaking

      removed the enum value unit from the query request parameter propertyCategory

    • breaking

      the /// response's property format changed from int32 to no format for status

    • breaking

      the /// response's property format changed from int32 to no format for status

    • info

      added the new enum value ACT to the path request parameter state

    • info

      added the new enum value House to the query request parameter propertyCategory

    • info

      added the new enum value NSW to the path request parameter state

    • info

      added the new enum value NT to the path request parameter state

    • info

      added the new enum value QLD to the path request parameter state

    • info

      added the new enum value SA to the path request parameter state

    • info

      added the new enum value TAS to the path request parameter state

    • info

      added the new enum value Unit to the query request parameter propertyCategory

    • info

      added the new enum value VIC to the path request parameter state

    • info

      added the new enum value WA to the path request parameter state

    • info

      for the query request parameter bedrooms, the format was generalized from int32 to no format

    • info

      for the query request parameter startingPeriodRelativeToCurrent, the format was generalized from int32 to no format

    • info

      for the query request parameter totalPeriods, the format was generalized from int32 to no format

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success 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

    • 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

    • 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

    • 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

    • 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

    • 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

    • 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

    • info

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