Suburb Performance by State/Suburb
Changed onRetrieve suburb performance data by state and suburb
Request
- Base URLhttps://api.domain.com.au
- Auth
- API key in header x-api-key
- or OAuth 2Authorization codehttps://auth.domain.com.au/v1/connect/authorizeClient credentialsToken URLhttps://auth.domain.com.au/v1/connect/tokenScopesapi_suburbperformance_read
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Path parameters
The Australian state abbreviation
Suburb name to retrieve data for
Query parameters
Category of sales results to show Available values : house, unit Default value : house
Number of bedrooms to use in the sales search
Unit of the measurement period to use Default value : quarters
When to start stats from. 1 = current period, 2 = previous period, etc. Default value : 1
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
- info
- breaking
the
pathrequest parameterstatewas restricted to a list of enum values - breaking
for the
queryrequest parameterperiodSize, default valuequarterswas removed - breaking
for the
queryrequest parameterpropertyCategory, default valuehousewas removed - breaking
for the
queryrequest parameterstartingPeriodRelativeToCurrent, default value1was removed - breaking
for the
queryrequest parametertotalPeriods, default value4was removed - breaking
removed the enum value
housefrom thequeryrequest parameterpropertyCategory - breaking
removed the enum value
unitfrom thequeryrequest parameterpropertyCategory - breaking
the
///response's property format changed fromint32to no format for status - breaking
the
///response's property format changed fromint32to no format for status - info
added the new enum value
ACTto thepathrequest parameterstate - info
added the new enum value
Houseto thequeryrequest parameterpropertyCategory - info
added the new enum value
NSWto thepathrequest parameterstate - info
added the new enum value
NTto thepathrequest parameterstate - info
added the new enum value
QLDto thepathrequest parameterstate - info
added the new enum value
SAto thepathrequest parameterstate - info
added the new enum value
TASto thepathrequest parameterstate - info
added the new enum value
Unitto thequeryrequest parameterpropertyCategory - info
added the new enum value
VICto thepathrequest parameterstate - info
added the new enum value
WAto thepathrequest parameterstate - info
for the
queryrequest parameterbedrooms, the format was generalized fromint32to no format - info
for the
queryrequest parameterstartingPeriodRelativeToCurrent, the format was generalized fromint32to no format - info
for the
queryrequest parametertotalPeriods, the format was generalized fromint32to 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
- breaking