v1

latestOpenAPI 3.0.42026-08-04108409993.8 KB
Statistics

Suburb Performance by State/Suburb/Postcode

Retrieve suburb performance data by state, suburb and postcode

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

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

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