Search for a property given a query string (a property name, or an address, even partial)
The query string. Represents the property name, address, etc. We’ll also surface aliases and other names, as well as other known addresses.
A latitude. When specified along with lon, matched properties will be sorted by distance from the specified location.
A longitude. When specified along with lat, matched properties will be sorted by distance from the specified location.
The expected state. When specified, matched properties will be filtered by state. For example, ‘CA’ for California.
The zip code. When specified, matched properties will be filtered by zip code. Accept both 5 and ZIP+4 digits formats (e.g. 12345 or 12345-6789). If a leading zero is missing, it will be added automatically.
The maximum distance in miles between the specified location and the matched properties. When specified, matched properties will be filtered by distance. This parameter is only valid when lat and lon are specified.
A simplified list of properties.
The unique identifier of the property. It is a stringified UUIDv5. This value can occasionally change if multiple properties get merged into one.
Other known names for the property. When searching for a property by name, these aliases will also be matched.
The property’s street address part of the full address.
Other known street addresses for the property. When searching for a property by address, these aliases will also be matched.
The property’s city.
The property’s state. Formatted as a 2-char string.
The property’s zip code. Formatted as a 5-char string with leading 0.
The property’s latitude
The property’s longitude
The property’s name.
The property’s advertised number_units
The property’s year_built. This can be in the future if the property is under construction.
An arbitrary number representing the quality of the match between the query and the property. Can be used to sort the results of a search, for example. Do not use the absolute value to filter.