Rental Prices

Compare suburbs side by side

Compare rental price history across up to 10 suburbs side by side.

get/v1/rental/compare

Request

  • Base URL: https://api.aristocles.com.au (the document declares no server; this is the origin it was published from)
  • URL: https://api.aristocles.com.au/v1/rental/compare
  • Auth: none declared. Required headers: X-API-Key

Query parameters

statestring required
suburbsstring required

Comma-separated suburb names

bedroomsinteger nullable
property_typestring

flat, house, or all

periodsinteger

Number of recent quarters to include

Headers

X-API-Keystring required

Response

Successful Response

unknown required

Changes

No recorded changes to this operation across all 2 revisions of this API.