---
title: "Rank Suburbs"
method: GET
path: "/api/v1/cd-planner/rank-suburbs"
tags: ["cd-planner"]
---

# Rank Suburbs

`GET /api/v1/cd-planner/rank-suburbs`

## Request

- Base URL: `https://api.casaintelligence.com.au` (the document declares no server; this is the origin it was published from)
- URL: `https://api.casaintelligence.com.au/api/v1/cd-planner/rank-suburbs`
- Auth: API key in header `X-API-Key`

Rank suburbs in an LGA by Promise Score. Iterates the suburb-
intelligence aggregation per suburb. For an SEQ LGA with ~50-100
distinct suburbs this completes in 2-5 seconds.

## Query parameters

- `lga` string, nullable
- `region` string, nullable: Free-form region label (e.g. 'Sunshine Coast')
- `top` integer

## Response `200`

Successful Response

- unknown

## Other responses

- `422`: Validation Error

---

[API](https://skmtc.dev/casaintelligence/apis/casa-intelligence-engine.md) · [All operations](https://skmtc.dev/casaintelligence/apis/casa-intelligence-engine/llms.txt) · [OpenAPI document](https://skmtc.dev/casaintelligence/apis/casa-intelligence-engine/revisions/71d711039de0?raw)