Search
Search for a property by name, address, or other identifying text.
This endpoint matches properties based on a query string. A well-formatted input—such as a full address—is more likely to return accurate results. We also include known aliases and alternate addresses when available.
Recommendation: Use filters whenever possible to improve performance and result quality.
Filtering options:
- Use
lat
andlon
together to sort results by proximity. - Use
max_distance
(in miles) withlat
andlon
to limit results to a given radius. - Use
state
(e.g. ‘CA’) orzip_code
(5-digit or ZIP+4 formats) to restrict results by region.
Headers
Query parameters
Latitude for proximity-based sorting. Must be used with lon
.
Longitude for proximity-based sorting. Must be used with lat
.
Optional. State abbreviation to filter results (e.g. ‘NY’).
Optional. Zip code to filter results. Accepts 5-digit or ZIP+4 formats; missing leading zeros are automatically handled.
Optional. Maximum distance in miles for nearby results. Requires both lat
and lon
.
Response
The property’s state. Formatted as a 2-char string.
The property’s zip code. Formatted as a 5-char string with leading 0.
A list of alternate unique identifiers (alias IDs) for the property. These IDs are typically derived from historical addresses and remain valid even if the primary address changes over time. While old IDs are automatically redirected to the current primary ID, exposing alias IDs helps with deduplication and data consistency.
The property’s advertised number_units
The property’s year_built. This can be in the future if the property is under construction.