Property

Get Property

GET

Retrieve all the details of a property given its id.

  • ID changes: it is rare, but can happen, to see the id of a property change. We consider it unlikely for bigger properties since they tend to have a more established “identity” among our data pipelines. For example, if multiples properties are merged into one, or major data changes make us change the id. In this case, you might receive a 404 error. The property search endpoint is free, so always feel free to query it in case that happens.
  • Payload usage: this payload can be used to get the property details, the unit pricing, the expense benchmarks, and the rent comps. And you are free to cache it if you need to.

We make a few properties free to access to help with testing. These three properties are listed below but if you would like to use a different property to test with, we are happy to allow that for you.

IDBuilding NameAddress
e8769b06-1334-5ab6-b9c6-6dfccbf9ea78Reserve at Glenview195 Waukegan Road, Glenview, IL 60025
20e4945a-ce78-5f2c-9053-6bdaca39044b7229-33 S Yates Blvd7229 South Yates Boulevard, Chicago, IL 60649
0e628031-57b8-5394-821d-13779318fef4OneEleven111 West Wacker Drive, Chicago, IL 60601

Path parameters

idstringRequired
The property id (UUIDv5 retrieved from the search endpoint).

Response

This endpoint returns an object
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.
street_address
string
The primary street address of the property.
street_address_alias
list of strings
Alternate or commonly used names or aliases for the street address.
city
string
The city where the property is located.
state
string
The state where the property is located.
zip_code
string
The postal code for the property's location.
lat
double
Latitude coordinate of the property's location.
lon
double
Longitude coordinate of the property's location.
building_name_alias
list of strings
Alternative names or aliases for the building.
specials_history
list of objects
Historical special offers or promotions available at the property, along with extracted values from the text.
pricing_strategy
object
Analysis of the property's pricing patterns and strategies.
created_on
string
Date when the property details were last updated or created.
building_quality
object
The quality scores for various aspects of the property, including both general areas and specific features.
building_availability
list of objects
The list of units and floorplans available at the property.
msa
stringOptional
Metropolitan Statistical Area the property belongs to, if applicable.
market_embedding
list of doublesOptional
An array representing the market embedding vector, used for advanced analyses. If you want to compare two markets, you can use the cosine similarity between their market embeddings. Note: this vector is subject to change a couple of times a year as we improve our models.
demographics
map from strings to optional doublesOptional

Beta Subject to change in near future. The demographics for the property’s location, if available.

census_tract_id
stringOptional
The FIPS code of the property's location.
building_name
stringOptional
The name of the building or property.
building_phone_number
stringOptional
Contact phone number for the building management or leasing office.
building_website
stringOptional
Website URL for the property or management company.
is_single_family
booleanOptional
Indicates if the property is a single-family home.
is_condo
booleanOptional
Indicates if the property consists of condominiums.
is_apartment
booleanOptional
Indicates if the property is an apartment complex.
number_units
doubleOptional
Total number of units in the property.
year_built
doubleOptional
Year the property was originally built.
year_built_prediction
stringOptional
Predicted or estimated construction period or era based on listing images.
number_stories
doubleOptional
Number of stories or levels in the property.
number_stories_prediction
stringOptional
Predicted or estimated range for the number of stories in the building based on facade images.
management_company
stringOptional
Name of the company managing the property.
cats_monthly_rent
doubleOptional
Monthly rent charge for having cats.
cats_one_time_fee
doubleOptional
One-time fee for having cats.
cats_deposit
doubleOptional
Deposit required for having cats.
dogs_monthly_rent
doubleOptional
Monthly rent charge for having dogs.
dogs_one_time_fee
doubleOptional
One-time fee for having dogs.
dogs_deposit
doubleOptional
Deposit required for having dogs.
admin_fee
doubleOptional
Administrative fee charged by the property.
amenity_fee
doubleOptional
Amenity fee charged by the property, if applicable.
application_fee
doubleOptional
Application fee charged to apply for residency.
storage_fee
doubleOptional
Fee for using storage facilities on the property.
parking_covered
doubleOptional
Monthly charge for covered parking, if available.
parking_garage
doubleOptional
Monthly charge for parking in a garage, if available.
parking_surface_lot
doubleOptional
Monthly charge for parking in a surface lot, if available.
lease_lengths
stringOptional
Available lease lengths in months.
min_deposit
doubleOptional
Minimum security deposit required.
max_deposit
doubleOptional
Maximum security deposit required (may vary by unit).
building_amenities
list of enumsOptional
List of amenities available in the building.
unit_amenities
list of enumsOptional
List of amenities available in the units.
estimated_occupancy
doubleOptional
Advertised occupancy rate of the property.
price_history
list of objectsOptional
Precomputed prices per unit type for the property over time. Deprecated, use the prices in the Availability object instead for more flexibility.
specials
stringOptional

Current special offers or promotions available at the property. Deprecated, use the specials_history field instead to get all specials over time.

GET
1curl https://api.hellodata.ai/property/52907745-7672-470e-a803-a2f8feb52944 \
2     -H "x-api-key: <apiKey>"
200
Retrieved
1{
2  "id": "52907745-7672-470e-a803-a2f8feb52944",
3  "street_address": "111 West Wacker Drive",
4  "street_address_alias": [
5    "street_address_alias"
6  ],
7  "city": "Chicago",
8  "state": "IL",
9  "zip_code": "60601",
10  "lat": 41.88651,
11  "lon": -87.63141,
12  "building_name_alias": [
13    "building_name_alias"
14  ],
15  "specials_history": [
16    {
17      "specials": "1 month free on 12 month lease if you move in by 12/31/2021",
18      "from_date": "2021-01-01",
19      "to_date": "2021-01-01",
20      "condition_lease_term_months": 12,
21      "condition_deadline": "2021-01-01",
22      "free_months": 1,
23      "one_time_dollars_off": 100,
24      "recurring_dollars_off": 100,
25      "waived_application_fee": true,
26      "waived_security_deposit": true,
27      "waived_administrative_fee": true,
28      "waived_move_in_fee": true,
29      "cheaper_security_deposit": true,
30      "cheaper_administrative_fee": true,
31      "cheaper_application_fee": true,
32      "cheaper_move_in_fee": true,
33      "cheaper_rent": true
34    }
35  ],
36  "pricing_strategy": {
37    "is_using_rev_management": true,
38    "avg_duration": 30,
39    "avg_price_change": 100,
40    "avg_time_on_market": 30,
41    "day_of_week_distribution": [
42      1.1
43    ],
44    "count_prices": 100
45  },
46  "created_on": "2021-01-01",
47  "building_quality": {
48    "property_overall_quality": 0.85,
49    "avg_quality_score_bedroom": 0.82,
50    "avg_quality_score_kitchen": 0.87,
51    "avg_quality_score_bathroom": 0.81,
52    "avg_quality_score_dining_room": 0.8,
53    "avg_quality_score_common_areas": 0.83,
54    "avg_quality_score_fitness_center": 0.78,
55    "avg_quality_score_laundry_room": 0.75,
56    "avg_quality_score_living_room": 0.84,
57    "avg_quality_score_main_entrance": 0.86,
58    "avg_quality_score_stairs_hallway": 0.79,
59    "avg_quality_score_swimming_pool": 0.88,
60    "avg_quality_score_walk_in_closet": 0.8
61  },
62  "building_availability": [
63    {
64      "id": "52907745-7672-470e-a803-a2f8feb52944",
65      "is_floorplan": true,
66      "renovated": false,
67      "furnished": true,
68      "den": false,
69      "convertible": true,
70      "created_on": "2021-01-01",
71      "history": [
72        {
73          "from_date": "2021-01-01",
74          "to_date": "2021-01-01",
75          "min_price": 1200,
76          "price": 1500,
77          "max_price": 1800,
78          "min_effective_price": 1150,
79          "effective_price": 1450,
80          "max_effective_price": 1750,
81          "period_id": 0
82        }
83      ],
84      "price_plans": [
85        {
86          "duration_in_months": 12,
87          "specials": "Special incentives available at OneEleven! Enjoy up to a half month free on select apartments.",
88          "monthly_rent": 1500
89        }
90      ],
91      "floorplan_name": "2B2B",
92      "unit_name": "203",
93      "floor": 5,
94      "availability": "2021-01-01",
95      "min_price": 1200,
96      "price": 1500,
97      "max_price": 1800,
98      "min_effective_price": 1150,
99      "effective_price": 1450,
100      "max_effective_price": 1750,
101      "bed": 2,
102      "bath": 2,
103      "partial_bath": 1,
104      "enter_market": "2021-01-01",
105      "exit_market": "2021-01-01",
106      "days_on_market": 45,
107      "min_sqft": 800,
108      "sqft": 850,
109      "max_sqft": 900,
110      "availability_periods": [
111        {
112          "period_id": 0,
113          "enter_market": "2021-01-01",
114          "exit_market": "2021-01-01",
115          "days_on_market": 45,
116          "availability": "2021-01-01"
117        }
118      ],
119      "amenities": [
120        "amenities"
121      ]
122    }
123  ],
124  "msa": "Chicago-Naperville-Elgin, IL-IN-WI",
125  "market_embedding": [
126    1.1
127  ],
128  "demographics": {
129    "demographics": 1.1
130  },
131  "census_tract_id": "11001007301",
132  "building_name": "OneEleven",
133  "building_phone_number": "7087250291",
134  "building_website": "https://www.oneelevenchicago.com/",
135  "is_single_family": false,
136  "is_condo": false,
137  "is_apartment": true,
138  "number_units": 505,
139  "year_built": 2014,
140  "year_built_prediction": "2020+",
141  "number_stories": 60,
142  "number_stories_prediction": "11+",
143  "management_company": "The Bozzuto Group",
144  "cats_monthly_rent": 50,
145  "cats_one_time_fee": 50,
146  "cats_deposit": 50,
147  "dogs_monthly_rent": 50,
148  "dogs_one_time_fee": 50,
149  "dogs_deposit": 50,
150  "admin_fee": 600,
151  "amenity_fee": 1.1,
152  "application_fee": 65,
153  "storage_fee": 50,
154  "parking_covered": 300,
155  "parking_garage": 319,
156  "parking_surface_lot": 100,
157  "lease_lengths": "12,6",
158  "min_deposit": 2248,
159  "max_deposit": 2248,
160  "building_amenities": [
161    "24_hour_maintenance"
162  ],
163  "unit_amenities": [
164    "air_conditioning"
165  ],
166  "estimated_occupancy": 0.97,
167  "price_history": [
168    {
169      "history": [
170        {
171          "created_on": "2021-01-01",
172          "min_price": 1200,
173          "avg_price": 1500,
174          "max_price": 1800,
175          "min_price_psf": 1150,
176          "avg_price_psf": 1450,
177          "max_price_psf": 1750,
178          "min_effective_price": 1150,
179          "avg_effective_price": 1450,
180          "max_effective_price": 1750,
181          "min_effective_price_psf": 1150,
182          "avg_effective_price_psf": 1450,
183          "max_effective_price_psf": 1750
184        }
185      ],
186      "bed": 1.1,
187      "bath": 1.1
188    }
189  ],
190  "specials": "Special incentives available at OneEleven! Enjoy up to a half month free on select apartments."
191}
Built with