/shorts.v1alpha1.HousingService/GetSuburbProfileGetSuburbProfile
Full per-suburb profile: identity, demographics, headline price, comparison baselines.
Parameters
Define the version of the Connect protocol
Define the timeout, in ms
Request Body
required (proto string)
Responses
editorial banner header (archetype, blurb, landmarks) (proto shorts.v1alpha1.SuburbBanner)
classified/refined archetype id (proto string)
library asset key (defaults to archetype) (proto string)
bespoke background override (optional) (proto string)
editorial one-liner (also page copy) (proto string)
(proto shorts.v1alpha1.SuburbLandmark)
(proto shorts.v1alpha1.ComparisonBaselines)
(proto double)
(proto double)
(proto double)
(proto double)
council this suburb sits in ('' if unmatched) (proto shorts.v1alpha1.LgaInfo)
(proto double)
asset renewal + upgrade vs depreciation, % (proto double)
Per-council financials (VIC LGPRF, CC-BY; 0/'' for states not yet sourced). average rate per property assessment, AUD (proto double)
federal Financial Assistance Grant (latest yr), AUD; 0 if unmatched (proto double)
e.g. '2025-26' (proto string)
financials provenance ('vic_lgprf'), '' if none (proto string)
financials reporting year, e.g. '2024-25' (proto string)
(proto string)
(proto string)
adjusted underlying (operating) result, % (negative = deficit) (proto double)
summed from member-suburb Census populations (proto int32)
(proto string)
null when the suburb has no gated crime data (proto shorts.v1alpha1.SuburbCrime)
'bocsar' (proto string)
'NSW' (proto string)
'CC-BY-4.0' (proto string)
(proto shorts.v1alpha1.SuburbCrimeStat)
(proto shorts.v1alpha1.SuburbDemographics)
(proto int32)
(proto int32)
0..100 of persons aged 15+ (G43) (proto double)
(proto double)
(proto double)
(proto double)
(proto double)
(proto double)
0..100 (G46) (proto double)
Cultural demographics (ABS Census 2021: G01 birthplace/language, G13, G14). 0..100 (proto double)
0..100 families (G25) (proto double)
0..100 (speaks English only at home) (proto double)
0..100 occupied private dwellings (G32/G36) (proto double)
0..100, $2,000+ weekly (G17) (proto double)
0..100 households (G25) (proto double)
Curated ABS Census 2021 GCP rates. Zero means absent in this proto3 API; the database retains NULL for missing/suppressed/quality-gated values. 0..100, $1-$499 weekly (G17) (proto double)
0..100 ("No religion") (proto double)
(proto double)
(proto double)
(proto double)
0..100 occupied private dwellings (G32/G36) (proto double)
0..100 share speaking top_language (proto double)
0..100 share of the dominant religion (proto double)
(proto int32)
top language other than English at home (proto string)
dominant religious affiliation (proto string)
0..100 of labour force (G43) (proto double)
Profile-only measured terrain block; absent when the DEM sample is missing or below the collector's published cell-count quality floor. (proto shorts.v1alpha1.SuburbElevation)
(proto double)
(proto double)
(proto double)
percent of valid sampled land area, 0..100 (proto double)
percent of valid sampled land area, 0..100 (proto double)
percent of valid sampled land area, 0..100 (proto double)
Crawl-derived listing aggregates; null when the suburb is outside the crawl catalog or the HOUSING_DROP_LISTINGS_ENABLED kill switch is off. (proto shorts.v1alpha1.SuburbListingStats)
mean asking price of priced for-sale listings, AUD; 0 if none (proto double)
mean sold price, AUD; 0 if none (proto double)
active for-sale listings captured (proto int32)
median asking price, AUD; 0 if none (proto double)
median sold price, AUD; 0 if none (proto double)
recent sold listings captured (proto int32)
most-similar suburbs nationally (knowledge graph) (proto shorts.v1alpha1.SimilarSuburb)
A suburb with a similar demographic + amenity profile (feature-vector kNN).
(proto shorts.v1alpha1.SuburbSummary)
Amenity/lifestyle metrics (Local Insights); null/absent until ingested. (proto shorts.v1alpha1.SuburbAmenities)
0..100 (tech-tier proxy) (proto double)
Crime percentile ranks (0..100, higher = more reported crime; latest 2-yr-pooled FY, CVS-adjusted). 0 = no data — pct_rank is strictly > 0 whenever a reliable observation exists. Small-population and statistically-unreliable suburbs are gated server-side (mv_suburb_crime_latest) and read as no-data. NSW (BOCSAR) only in Phase 1; uncovered states/TAS/NT stay 0. CC-BY sources. The rank is population-weighted WITHIN THE SUBURB'S OWN STATE, never across states: each police force counts offences under its own rules, so a cross-jurisdiction pool would compare incomparable counts. Read "82nd percentile" as "82nd of that state", and label it that way in any client. (proto double)
Field 31 is reserved by convention for crime_property_damage_rank once a CVS anchor exists; do not use 31 for anything else. (proto double)
(proto double)
NBN connectivity (Local Insights); '' until ingested. Fixed Line | Fixed Wireless | Satellite (proto string)
Federal electoral representation (AEC 2025 election), spatially joined. Commonwealth Electoral Division (proto string)
sitting House of Reps member (proto string)
member's party (full name) (proto string)
party abbreviation (palette key) (proto string)
0..100 Labor two-party-preferred % (proto double)
0 if no price data (proto double)
(proto google.protobuf.Timestamp)
(proto double)
(proto double)
Cultural demographics for the map's "highlight" toggle (ABS Census 2021). 0..100 (proto double)
0..100 share speaking top_language (proto double)
Properties declared in the federal Registers of Members'/Senators' Interests that resolve to this suburb. A COUNT of declarations — the registers record what is held, never quantity or value. A scalar rather than a nested message on purpose: the map needs a value for every suburb in a state (~5,000 rows per request), and a message would drag the politicians descriptor into the hot /housing/[state] route bundle. (proto int32)
(proto int32)
(proto string)
priced-region code (for the price series), '' if unpriced (proto string)
(proto string)
(proto string)
Profile-only in the current backend query; list responses leave it absent. (proto shorts.v1alpha1.SuburbSeifa)
(proto string)
ABS State Electoral Division (proto string)
state lower-house member ('' for Hare-Clark TAS/ACT) (proto string)
state member's party (full name) (proto string)
state party abbreviation (palette key) (proto string)
top language other than English at home, '' if none (proto string)
dominant religious affiliation, '' if none (proto string)
(proto double)
Error type returned by Connect: https://connectrpc.com/docs/go/errors/#http-representation
The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].
A list of messages that carry the error details. There is no limit on the number of messages.
Contains an arbitrary serialized message along with a @type that describes the type of the serialized message, with an additional debug field for ConnectRPC error details.
A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client.
curl -X POST "https://api.shorted.com.au/shorts.v1alpha1.HousingService/GetSuburbProfile" \
-H "Content-Type: application/json" \
-d '{
"salCode": "string"
}'curl -X POST "https://api.shorted.com.au/shorts.v1alpha1.HousingService/GetSuburbProfile" \
-H "Content-Type: application/json" \
-d '{
"salCode": "string"
}'