POST/shorts.v1alpha1.HousingService/ListSuburbPriceDrops

ListSuburbPriceDrops

Suburbs ranked by recent for-sale asking-price drops.

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 50 (proto int32)

sortstring

optional: 'count' (default) | 'avg' | 'max' (proto string)

stateCodestring

optional filter, e.g. 'NSW'; '' = national (proto string)

windowDaysinteger <int32>

reserved; the aggregate uses a fixed rolling window (proto int32)

Responses

200Success

application/json

object

suburbsarray

(proto shorts.v1alpha1.SuburbPriceDrop)

Array Items:

object

A suburb's aggregate price-drop signal over the rolling window (derived; the underlying listings are ToS-restricted and never republished here).

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/ListSuburbPriceDrops" \
  -H "Content-Type: application/json" \
  -d '{
  "limit": 0,
  "sort": "string",
  "stateCode": "string",
  "windowDays": 0
}'

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