POST/shorts.v1alpha1.HousingService/GetCouncilProfile

GetCouncilProfile

One council's hub: identity, current facts, time series, member suburbs, hazard/price/crime rollups, representation, price drops and neighbours.

Parameters

Connect-Protocol-VersionheaderRequired

number [1]

Define the version of the Connect protocol

Connect-Timeout-Msheader

number

Define the timeout, in ms

Request Body

application/json

object

slugstring

lga.slug — minted once, never reassigned (proto string)

stateCodestring

NSW | VIC | QLD | SA | WA | TAS | NT | ACT (proto string)

Responses

200Success

application/json

object

profileobject

(proto shorts.v1alpha1.CouncilProfile)

councilobject

Identity + current facts. dominant_share is absent (it is a suburb fact). (proto shorts.v1alpha1.LgaInfo)

factsAsOfstring

when the council facts were loaded, 'YYYY-MM-DD' (proto string)

federalElectoratesarray

Federal electorates / state districts over the member suburbs, weighted by the residents each suburb contributes to this council. Largest first. (proto shorts.v1alpha1.CouncilRepresentative)

lgaVintagestring

(proto string)

neighboursarray

(proto shorts.v1alpha1.CouncilNeighbour)

priceDropsobject

Crawl-derived aggregate. Absent below 3 drops council-wide or with no crawl coverage. (proto shorts.v1alpha1.CouncilPriceDrops)

rollupobject

(proto shorts.v1alpha1.CouncilRollup)

seriesarray

(proto shorts.v1alpha1.CouncilSeries)

stateDistrictsarray

(proto shorts.v1alpha1.CouncilRepresentative)

suburbsarray

Every suburb whose dominant council this is, plus straddling suburbs where this council holds at least 5% of the residents. Population desc. (proto shorts.v1alpha1.CouncilSuburb)

summaryobject

The same row ListCouncils serves, so the hub and the index never disagree. (proto shorts.v1alpha1.CouncilSummary)

defaultError

application/json

object

Error type returned by Connect: https://connectrpc.com/docs/go/errors/#http-representation

codestring [canceled, unknown, invalid_argument, deadline_exceeded, not_found, already_exists, permission_denied, resource_exhausted, failed_precondition, aborted, out_of_range, unimplemented, internal, unavailable, data_loss, unauthenticated]

The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].

detailsarray

A list of messages that carry the error details. There is no limit on the number of messages.

Array Items:

object

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.

messagestring

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/GetCouncilProfile" \
  -H "Content-Type: application/json" \
  -d '{
  "slug": "string",
  "stateCode": "string"
}'

curl -X POST "https://api.shorted.com.au/shorts.v1alpha1.HousingService/GetCouncilProfile" \
  -H "Content-Type: application/json" \
  -d '{
  "slug": "string",
  "stateCode": "string"
}'