Properties
Search for suggested addresses for the given terms
Changed onApplicable policies apply here include APM attribution.
get/v1/properties/_suggest
Request
- Base URLhttps://api.domain.com.au
- Auth
- API key in header x-api-key
- or OAuth 2Authorization codehttps://auth.domain.com.au/v1/connect/authorizeClient credentialsToken URLhttps://auth.domain.com.au/v1/connect/tokenScopesapi_properties_read
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Query parameters
termsstring required
The address to search
pageSizeinteger
the size of the page. Defaults to 15 if unspecified
channel'All' | 'Residential' | 'Commercial'
Restrict the suggestions to this type of property: All (default), Residential, Commercial
Response
Sample record details
Changes
- breaking
for the
queryrequest parameterchannel, default value was changed from0toAll - breaking
the
/response's property format changed fromint32to no format for status - info
for the
queryrequest parameterpageSize, the format was generalized fromint32to no format - info
added the non-success response with the status
- info
added the non-success response with the status
- info
added the non-success response with the status
- breaking