Search

GET

Search for a property given a query string (a property name, or an address, even partial)

  • Well formatted queries will return the best results. For example, a full address will be more likely to return the correct property as first result as opposed to just a street name.
  • We’ll also surface aliases and other names, as well as other known addresses.
  • Using extra filters like latitude, longitude, city, state, and zip code is perfectly optional, but it’ll give you better results at no extra cost.

Query parameters

qstringRequired
The query string. Represents the property name, address, etc. We'll also surface aliases and other names, as well as other known addresses.
latdoubleOptional

A latitude. When specified along with lon, matched properties will be sorted by distance from the specified location.

londoubleOptional

A longitude. When specified along with lat, matched properties will be sorted by distance from the specified location.

statestringOptional
The expected state. When specified, matched properties will be filtered by state. For example, 'CA' for California.
zip_codestringOptional
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.
max_distancedoubleOptional

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.

Response

This endpoint returns a list of objects.
idstring
The unique identifier of the property. It is a stringified UUIDv5. This value can occasionally change if multiple properties get merged into one.
building_name_aliaslist of strings
Other known names for the property. When searching for a property by name, these aliases will also be matched.
street_addressstring
The property's street address part of the full address.
street_address_aliaslist of strings
Other known street addresses for the property. When searching for a property by address, these aliases will also be matched.
citystring
The property's city.
statestring
The property's state. Formatted as a 2-char string.
zip_codestring
The property's zip code. Formatted as a 5-char string with leading 0.
latdoubleOptional
The property's latitude
londoubleOptional
The property's longitude
building_namestringOptional
The property's name.
number_unitsdoubleOptional

The property’s advertised number_units

year_builtdoubleOptional

The property’s year_built. This can be in the future if the property is under construction.

scoredoubleOptional
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.
Built with