Property Search

The first step before retrieving property detailes, identifying comps, recommending rents or any other analysis is to find the property you are interested in. This endpoint allows you to search for properties by address, city, state, zip code, or property name. It works with typos and fuzzy matching, so you can be sure to find the property you are looking for.

Basic search

You can search by address, city, state, zip code, property name, or a combination of these.

1
import requests
2
3
url = "https://api.hellodata.ai/property/search"
4
5
querystring = {"q": "111 W Wacker Chicago"}
6
7
headers = {
8
    'x-api-key': "your-api-key"
9
}
10
11
response = requests.request("GET", url, headers=headers, params=querystring)
12
13
print(response.json()) # list of potential matches    

This returns a simple list of properties that match your search. You can then use the id to get more details on a specific property.

1
[
2
    {
3
        "id": "0e628031-57b8-5394-821d-13779318fef4",
4
        "lat": 41.88651,
5
        "lon": -87.63141,
6
        "building_name": "OneEleven",
7
        "building_name_alias": [
8
            "OneEleven"
9
        ],
10
        "street_address": "111 West Wacker Drive",
11
        "street_address_alias": [
12
            "111 West Wacker Drive",
13
            "111 West Wacker"
14
        ],
15
        "city": "Chicago",
16
        "state": "IL",
17
        "zip_code": "60601",
18
        "year_built": 2014,
19
        "number_units": 505,
20
    }
21
]

Adding constraints

For automated searches, constrain results by zip code, state, or distance from a specific location.

1
import requests
2
3
url = "https://api.hellodata.ai/property/search"
4
5
querystring = {"q":"111 W Wacker Chicago", "zip_code": "60601"}
6
7
headers = {
8
    'x-api-key': "your-api-key"
9
}
10
11
response = requests.request("GET", url, headers=headers, params=querystring)
12
13
print(response.json()) # list of potential matches within the zip code

Fuzzy matching

The search endpoint supports fuzzy matching, so you can search for properties even with a typo or two, or partial information.

Speed and performance

The search endpoint is optimized for speed and performance, so you can expect fast responses even when performing multiple searches in a short period of time.

Caching

It is perfectly fine to cache the results of the search endpoint, as the data does not change frequently. This can help improve the performance of your application and reduce the load on the API.

Full Documentation

Find more details about this endpoint our API Reference.