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

A simplified list of properties.

list of objects or null
Built with