Propertys

Get Properties By State

Get a geojson FeatureCollection of visible properties for a single state.

Caching: this dataset only changes when an admin edits a property, so we cache the encoded payload in Redis for an hour and advertise the same TTL to shared caches (Cloudflare). Browsers get a shorter max-age so a stale tab heals quickly without a full reload.

get/properties/by-state/{state}

Request

  • Base URL: http://localhost:8000
  • URL: http://localhost:8000/properties/by-state/{state}
  • Auth: none declared

Path parameters

statestring required

Query parameters

expandedboolean nullable
include_capabilitiesboolean nullable
country'AU' | 'NZ'

ISO country code used to scope public property inventory.

Headers

API-Version'1'

Major API version. Omit or send 1 for the current v1 surface. Retired operations use RFC 9745 Deprecation and RFC 8594 Sunset headers.

Response

Successful Response

msgstring required

Changes

No recorded changes to this operation across all 1 revision of this API.