Properties

Search for suggested addresses for the given terms

Changed on

Applicable policies apply here include APM attribution.

get/v1/properties/_suggest

Request

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

addressstring
idstring
relativeScoreinteger

Changes

    • breaking

      for the query request parameter channel, default value was changed from 0 to All

    • breaking

      the / response's property format changed from int32 to no format for status

    • info

      for the query request parameter pageSize, the format was generalized from int32 to 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