Property

Comparables

POST

Find the best rent comps for a property given its details among close by properties. Score different facets of all candidates and return the best ones. In order to get the best results, we leverage market demographics, detected quality, amenities, similarity of unit mixes, and more.

  • Data completion: feel free to complete the record with extra data only you have access to or if you want to override the data we have. For example, what would be the rent of the property if it was in a better condition? You can increase the quality of the property and see how the comps change.
  • Extra Filters: you can set extra filters. For example, you can set a maximum distance between the subject and the rent comps, a minimum number of units, a maximum number of units, a minimum year built, and a maximum year built.
  • Exclusions: you can exclude properties from the results. For example, you can exclude properties that are not good comps or properties that have already been selected. We will make sure we don’t return them in the results.
  • Already Selected: you can also pass the ids of the properties that you want to force into the results.

Computing Similarities:

If you are interested in simply getting similarities between properties, you can use the comparables endpoint. Pass the ids of the comps you want similarities for into the selected_ids field. And set topN to the same number of properties you are passing. We will return the similarities between the subject and the selected properties.

Query parameters

topNdoubleOptional
The number of rent comps to return.
tierenumOptional
The tier of the property. Either 'valueAdd' or 'current'. When 'valueAdd', the results will assume a better condition of the property.
Allowed values: valueAddcurrent
renovationsdoubleOptional
The renovations to apply to the property. A value between 0 and 1 to add to the property quality. (e.g. 0.1 will transform a 0.4 quality property into a 0.5 quality property).
maxDistancedoubleOptional
The maximum distance in miles between the subject and the rent comps.
minDistancedoubleOptional
The minimum distance in miles between the subject and the rent comps.
minNumberUnitsdoubleOptional
The minimum number of units of the rent comps. Does not filter properties with no units.
maxNumberUnitsdoubleOptional
The maximum number of units of the rent comps. Does not filter properties with no units.
allowNullNumberUnitsbooleanOptional
Whether to allow properties with no units to be included in the results. False by default.
minYearBuiltdoubleOptional
The minimum year built of the rent comps. Does not filter properties with no year built.
maxYearBuiltdoubleOptional
The maximum year built of the rent comps. Does not filter properties with no year built.
allowNullYearBuiltbooleanOptional
Whether to allow properties with no year built to be included in the results. False by default.
minNumberStoriesdoubleOptional
The minimum number of stories of the rent comps. Does not filter properties with no stories.
maxNumberStoriesdoubleOptional
The maximum number of stories of the rent comps. Does not filter properties with no stories.
allowNullNumberStoriesbooleanOptional
Whether to allow properties with no stories to be included in the results. False by default.

Request

This endpoint expects an object.
selected_ids
list of stringsOptional
Force include some properties in the results
excluded_ids
list of stringsOptional
Exclude some properties from the results that are not suitable for comparison.
simple_subject
objectOptional
A simple property object that can come from your systems if you only have the basic information about the property. We will use the basic information to find the most similar properties.
subject
objectOptional

A detailed property object if you have queried the property details from /property/{id}. We will use all the available information to find the most similar properties, including market statistics, detailed quality scores, unit details and detected values for missing fields.

Response

This endpoint returns an object
comparables
list of objects
competition_profile
list of objectsOptional
BETA: the object is currently in beta and may change without notice. The CompetitionProfile object is used to explain the competition profile of a property. It describes how many properties are in the high, medium, and low similarity buckets within a given radius (non overlapping, non-cumulative).
POST
1curl -X POST https://api.hellodata.ai/property/comparables \
2 -H "x-api-key: <apiKey>" \
3 -H "Content-Type: application/json" \
4 -d '{}'
200Successful
1{
2 "comparables": [
3 {
4 "id": "52907745-7672-470e-a803-a2f8feb52944",
5 "building_name_alias": [
6 "The Main Building",
7 "Main Building",
8 "Main"
9 ],
10 "street_address": "123 Main St",
11 "street_address_alias": [
12 "123 Main St",
13 "125, Main Street"
14 ],
15 "city": "San Francisco",
16 "state": "CA",
17 "zip_code": "94103",
18 "similarity_score": {
19 "overall": 0.91,
20 "distance": 0.95,
21 "number_units": 0.85,
22 "number_stories": 0.85,
23 "quality": 0.85,
24 "building_amenities": 0.85,
25 "unit_amenities": 0.85,
26 "vintage": 0.85,
27 "market": 0.85
28 },
29 "lat": 37.7749,
30 "lon": -122.4194,
31 "building_name": "The Main Building",
32 "number_units": 314,
33 "year_built": 2020,
34 "score": 12323456789,
35 "number_stories": 18,
36 "avg_quality": 0.85,
37 "distance_miles": 1.41,
38 "distance_meters": 2227
39 }
40 ],
41 "competition_profile": [
42 {
43 "radius_miles": 0.5,
44 "high_similarity": 10,
45 "medium_similarity": 20,
46 "low_similarity": 30
47 }
48 ]
49}