Propertys

Get properties similar to the given seed property

Get parks similar to the seed property, ranked by embedding cosine distance.

Phase 3 of the semantic-search roadmap: the first user-visible consumer of properties.embedding. Candidates are pulled via the HNSW index and then re-ranked in Python to prefer same-state matches and to cap same-management-group siblings at one in the result set.

Returns 200 with an empty list when the seed exists but has no embedding yet — the PDP carousel renders nothing and degrades quietly. Returns 404 when the seed is not found or hidden from public view.

get/properties/{property_id}/similar

Request

  • Base URL: http://localhost:8000
  • URL: http://localhost:8000/properties/{property_id}/similar
  • Auth: none declared

Path parameters

property_idinteger required

Query parameters

limitinteger

Maximum number of similar properties to return (1-12).

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.