POST/shorts.v1alpha1.HousingService/GetPriceDropsOverview

GetPriceDropsOverview

State-level price-drop + listing-price rollup, plus a national summary row.

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

Responses

200Success

application/json

object

nationalobject

the 'AU' row (proto shorts.v1alpha1.StatePriceDropSummary)

avgAskingnumber <double>

AUD (0 if none) (proto double)

avgDropPctnumber <double>

0..1 fraction (proto double)

avgSoldnumber <double>

AUD (0 if none) (proto double)

droppedCountinteger <int32>

physical addresses that cut asking price (30-day window, deduped) (proto int32)

droppedSharenumber <double>

dropped_count / total_active_listings (proto double)

droppedValuenumber <double>

summed AUD reductions across dropped addresses (proto double)

forSaleCountinteger <int32>

active for-sale listings (proto int32)

forSalePricedinteger <int32>

subset with a numeric asking price (auction/POA excluded) (proto int32)

maxDropPctnumber <double>

(proto double)

medianAskingnumber <double>

AUD (proto double)

medianDropPctnumber <double>

(proto double)

medianSoldnumber <double>

AUD (proto double)

soldCountinteger <int32>

incidental sold captures — indicative only (proto int32)

stateCodestring

'NSW'|'VIC'|... or 'AU' for the national row (proto string)

suburbsTrackedinteger <int32>

tracked suburbs contributing listings (proto int32)

totalActiveListingsinteger <int32>

(proto int32)

statesarray

ordered by dropped_count desc (proto shorts.v1alpha1.StatePriceDropSummary)

Array Items:

object

State-grain rollup of the tracked listing corpus: recent asking-price reductions plus asking/sold price aggregates. Derived aggregates only — the underlying listings are ToS-restricted and never republished.

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

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