Property

Search

GET

Search for properties given a query string (property name, address, etc.)

  • 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.

citystringOptional
The expected city. When specified, matched properties will be filtered by city. Careful: the name of the city must be spelled correctly, for this reason, we recommend using the state or zip code instead.
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.

Response

This endpoint returns a list of objects
id
string
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_alias
list of strings
Other known names for the property. When searching for a property by name, these aliases will also be matched.
street_address
string
The property's street address part of the full address.
street_address_alias
list of strings
Other known street addresses for the property. When searching for a property by address, these aliases will also be matched.
city
string
The property's city.
state
string
The property's state. Formatted as a 2-char string.
zip_code
string
The property's zip code. Formatted as a 5-char string with leading 0.
lat
doubleOptional
The property's latitude.
lon
doubleOptional
The property's longitude.
building_name
stringOptional
The property's name.
number_units
doubleOptional

The property’s advertised number_units

year_built
doubleOptional

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

score
doubleOptional
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.
GET
1curl -G https://api.hellodata.ai/property/search \
2 -H "x-api-key: <apiKey>" \
3 -d q=q
200Retrieved
1[
2 {
3 "id": "52907745-7672-470e-a803-a2f8feb52944",
4 "building_name_alias": [
5 "The Main Building",
6 "Main Building",
7 "Main"
8 ],
9 "street_address": "123 Main St",
10 "street_address_alias": [
11 "123 Main St",
12 "125, Main Street"
13 ],
14 "city": "San Francisco",
15 "state": "CA",
16 "zip_code": "94103",
17 "lat": 37.7749,
18 "lon": -122.4194,
19 "building_name": "The Main Building",
20 "number_units": 314,
21 "year_built": 2020,
22 "score": 12323456789
23 }
24]