---
title: "Compare suburbs side by side"
method: GET
path: "/v1/rental/compare"
tags: ["Rental Prices"]
---

# Compare 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`

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

## Query parameters

- `state` string, required
- `suburbs` string, required: Comma-separated suburb names
- `bedrooms` integer, nullable
- `property_type` string: flat, house, or all
- `periods` integer: Number of recent quarters to include

## Headers

- `X-API-Key` string, required

## Response `200`

Successful Response

- unknown

## Other responses

- `422`: Validation Error

---

[API](https://skmtc.dev/aristocles/apis/aristocles-data-api.md) · [All operations](https://skmtc.dev/aristocles/apis/aristocles-data-api/llms.txt) · [OpenAPI document](https://skmtc.dev/aristocles/apis/aristocles-data-api/revisions/4ca3fbb73c59?raw)