Shorted
POST/shorts.v1alpha1.HousingService/ListHousingRegions

ListHousingRegions

List house-price regions (suburbs/LGAs/etc) for the suburb explorer.

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
limitinteger <int32>

optional; default 2000 (proto int32)

querystring

optional case-insensitive name substring (proto string)

regionTypestring

optional filter, e.g. 'suburb' | 'gccsa' | 'state' (proto string)

stateCodestring

optional filter, e.g. 'SA' | 'VIC' (proto string)

Responses

200Success
application/json
object
regionsarray

(proto shorts.v1alpha1.HousingRegion)

Array Items:
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:
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/ListHousingRegions" \
  -H "Content-Type: application/json" \
  -d '{
  "limit": 0,
  "query": "string",
  "regionType": "string",
  "stateCode": "string"
}'