Property

Pricing

POST
Get the unit pricing for a property given its details. We use all property and unit details (characteristics, amenities, location, etc.) to find similar units in the market that have been rented recently. We then use the rent prices of these units to estimate the unit pricing.

Request

This endpoint expects an object.
subject
objectRequired
The content of the property for which to compute the recommended pricing.
settings
objectOptional
The settings for computing the recommended pricing. For example to exclude the subject property from the comps analysis, to limit the search radius for comparable properties, or to filter the data to include only units occurring within a specific date range.

Response

This endpoint returns a list of objects
unit
object
The PricingUnit object represents rudimentary information about a unit and its pricing. It is returned when querying a property's recommended pricing instead of the full unit details.
supporting_units
list of objects
predicted_price
doubleOptional
The recommended rent for the unit, based on an analysis of comparable units.
predicted_price_sqft
doubleOptional
The recommended rent per square foot of the unit, based on an analysis of comparable units.
POST
1curl -X POST https://api.hellodata.ai/property/pricing \
2 -H "x-api-key: <apiKey>" \
3 -H "Content-Type: application/json" \
4 -d '{
5 "subject": {
6 "id": "52907745-7672-470e-a803-a2f8feb52944",
7 "street_address": "111 West Wacker Drive",
8 "street_address_alias": [
9 "111 West Wacker",
10 "111 West Wacker Drive"
11 ],
12 "city": "Chicago",
13 "state": "IL",
14 "zip_code": "60601",
15 "lat": 41.88651,
16 "lon": -87.63141,
17 "building_name_alias": [
18 "building_name_alias"
19 ],
20 "specials_history": [
21 {
22 "specials": "1 month free on 12 month lease if you move in by 12/31/2021",
23 "from_date": "2021-01-01",
24 "to_date": "2021-01-01"
25 }
26 ],
27 "pricing_strategy": {},
28 "created_on": "2021-01-01",
29 "building_quality": {},
30 "building_availability": [
31 {
32 "id": "52907745-7672-470e-a803-a2f8feb52944",
33 "is_floorplan": true,
34 "renovated": false,
35 "furnished": true,
36 "den": false,
37 "convertible": true,
38 "created_on": "2021-01-01",
39 "history": [
40 {
41 "from_date": "2021-01-01",
42 "to_date": "2021-01-01"
43 }
44 ],
45 "price_plans": [
46 {
47 "duration_in_months": 12,
48 "specials": "Special incentives available at OneEleven! Enjoy up to a half month free on select apartments."
49 }
50 ],
51 "amenities": [
52 "amenities"
53 ]
54 }
55 ]
56 }
57}'
200Successful
1[
2 {
3 "unit": {
4 "building_name": "OneEleven",
5 "unit_name": "203",
6 "floorplan_name": "2B2B",
7 "bed": 2,
8 "bath": 2,
9 "sqft": 850,
10 "price": 1500,
11 "enter_market": "2021-01-01",
12 "exit_market": "2021-01-01"
13 },
14 "supporting_units": [
15 {
16 "unit": {
17 "building_name": "OneEleven",
18 "unit_name": "203",
19 "floorplan_name": "2B2B",
20 "bed": 2,
21 "bath": 2,
22 "sqft": 850,
23 "price": 1500,
24 "enter_market": "2021-01-01",
25 "exit_market": "2021-01-01"
26 },
27 "similarity": 0.9
28 }
29 ],
30 "predicted_price": 2500,
31 "predicted_price_sqft": 2.08
32 }
33]