POST/shorts.v1alpha1.HousingService/ListCouncils

ListCouncils

Every council with a page in one state (kind council | unincorporated), with the rollup metrics the council index and choropleth colour by.

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

stateCodestring

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

Responses

200Success

application/json

object

councilsarray

population desc, then name (proto shorts.v1alpha1.CouncilSummary)

Array Items:

object

One council's headline row: the council index table and the council choropleth read exactly these fields.

lgaVintagestring

boundary vintage, e.g. 'ABS ASGS LGA 2024' (proto string)

priceDropsAsOfstring <date-time>

Freshness of every council's price_drop_share (program decision 9): when the shares were computed, and the newest crawl observation behind any of them. Both absent when no council publishes a share. (proto google.protobuf.Timestamp)

priceDropsDataThroughstring <date-time>

(proto google.protobuf.Timestamp)

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

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