Property

Expense Benchmarks

POST
Get the expense benchmarks for a property given its details. Our models use all property details (characteristics, #stories, amenities, location, etc.) to compute the estimates.

Request

This endpoint expects an object.
building_availability
list of objectsRequired
The list of units and floorplans available at the property.
building_name_alias
list of stringsRequired
Alternative names or aliases for the building.
building_quality
objectRequired
The quality scores for various aspects of the property, including both general areas and specific features.
city
stringRequired
The city where the property is located.
created_on
stringRequired
Date when the property details were last updated or created.
id
stringRequired
The unique identifier of the property. It is a stringified UUIDv5. This value can occasionally change if multiple properties get merged into one.
lat
doubleRequired
Latitude coordinate of the property's location.
lon
doubleRequired
Longitude coordinate of the property's location.
pricing_strategy
objectRequired
Analysis of the property's pricing patterns and strategies.
specials_history
list of objectsRequired
Historical special offers or promotions available at the property, along with extracted values from the text.
state
stringRequired
The state where the property is located.
street_address
stringRequired
The primary street address of the property.
street_address_alias
list of stringsRequired
Alternate or commonly used names or aliases for the street address.
zip_code
stringRequired
The postal code for the property's location.
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.
building_amenities
list of enumsOptional
List of amenities available in the building.
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.
cats_deposit
doubleOptional
Deposit required for having cats.
cats_monthly_rent
doubleOptional
Monthly rent charge for having cats.
cats_one_time_fee
doubleOptional
One-time fee for having cats.
census_tract_id
stringOptional
The FIPS code of the property's location.
demographics
map from strings to optional doublesOptional

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

dogs_deposit
doubleOptional
Deposit required for having dogs.
dogs_monthly_rent
doubleOptional
Monthly rent charge for having dogs.
dogs_one_time_fee
doubleOptional
One-time fee for having dogs.
estimated_occupancy
doubleOptional
Advertised occupancy rate of the property.
gpr
doubleOptional
is_apartment
booleanOptional
Indicates if the property is an apartment complex.
is_condo
booleanOptional
Indicates if the property consists of condominiums.
is_single_family
booleanOptional
Indicates if the property is a single-family home.
lease_lengths
stringOptional
Available lease lengths in months.
management_company
stringOptional
Name of the company managing the property.
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.
max_deposit
doubleOptional
Maximum security deposit required (may vary by unit).
min_deposit
doubleOptional
Minimum security deposit required.
msa
stringOptional
Metropolitan Statistical Area the property belongs to, if applicable.
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.
number_units
doubleOptional
Total number of units in 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.
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.

storage_fee
doubleOptional
Fee for using storage facilities on the property.
unit_amenities
list of enumsOptional
List of amenities available in the units.
year_built
doubleOptional
Year the property was originally built.
year_built_prediction
stringOptional
Predicted or estimated construction period or era based on listing images.

Response

This endpoint returns an object
subject_estimate
objectOptional
POST
1curl -X POST https://api.hellodata.ai/property/expense_benchmarks \
2     -H "x-api-key: <apiKey>" \
3     -H "Content-Type: application/json" \
4     -d '{
5  "building_availability": [
6    {
7      "id": "52907745-7672-470e-a803-a2f8feb52944",
8      "is_floorplan": true,
9      "renovated": false,
10      "furnished": true,
11      "den": false,
12      "convertible": true,
13      "created_on": "2021-01-01",
14      "history": [
15        {
16          "from_date": "2021-01-01",
17          "to_date": "2021-01-01"
18        }
19      ],
20      "price_plans": [
21        {
22          "duration_in_months": 12,
23          "specials": "Special incentives available at OneEleven! Enjoy up to a half month free on select apartments."
24        }
25      ]
26    }
27  ],
28  "building_name_alias": [
29    "building_name_alias"
30  ],
31  "building_quality": {},
32  "city": "Chicago",
33  "created_on": "2021-01-01",
34  "id": "52907745-7672-470e-a803-a2f8feb52944",
35  "lat": 41.88651,
36  "lon": -87.63141,
37  "pricing_strategy": {},
38  "specials_history": [
39    {
40      "specials": "1 month free on 12 month lease if you move in by 12/31/2021",
41      "from_date": "2021-01-01",
42      "to_date": "2021-01-01"
43    }
44  ],
45  "state": "IL",
46  "street_address": "111 West Wacker Drive",
47  "street_address_alias": [
48    "street_address_alias"
49  ],
50  "zip_code": "60601"
51}'
Response - 200 Success
1{
2  "subject_estimate": {
3    "noi": {
4      "lower": 800,
5      "predicted": 1000,
6      "upper": 1200,
7      "explanation": {}
8    },
9    "vacancy_loss": {
10      "lower": 800,
11      "predicted": 1000,
12      "upper": 1200,
13      "explanation": {}
14    },
15    "ground_rent": {
16      "lower": 800,
17      "predicted": 1000,
18      "upper": 1200,
19      "explanation": {}
20    },
21    "property_insurance": {
22      "lower": 800,
23      "predicted": 1000,
24      "upper": 1200,
25      "explanation": {}
26    },
27    "utilities": {
28      "lower": 800,
29      "predicted": 1000,
30      "upper": 1200,
31      "explanation": {}
32    },
33    "total_operating_expenses": {
34      "lower": 800,
35      "predicted": 1000,
36      "upper": 1200,
37      "explanation": {}
38    },
39    "real_estate_taxes": {
40      "lower": 800,
41      "predicted": 1000,
42      "upper": 1200,
43      "explanation": {}
44    },
45    "payroll_and_benefits": {
46      "lower": 800,
47      "predicted": 1000,
48      "upper": 1200,
49      "explanation": {}
50    },
51    "capex_reserve": {
52      "lower": 800,
53      "predicted": 1000,
54      "upper": 1200,
55      "explanation": {}
56    },
57    "repair_and_maintenance": {
58      "lower": 800,
59      "predicted": 1000,
60      "upper": 1200,
61      "explanation": {}
62    },
63    "advertising_and_marketing": {
64      "lower": 800,
65      "predicted": 1000,
66      "upper": 1200,
67      "explanation": {}
68    },
69    "other_expenses": {
70      "lower": 800,
71      "predicted": 1000,
72      "upper": 1200,
73      "explanation": {}
74    },
75    "general_and_administrative": {
76      "lower": 800,
77      "predicted": 1000,
78      "upper": 1200,
79      "explanation": {}
80    },
81    "parking_income": {
82      "lower": 800,
83      "predicted": 1000,
84      "upper": 1200,
85      "explanation": {}
86    },
87    "other_income": {
88      "lower": 800,
89      "predicted": 1000,
90      "upper": 1200,
91      "explanation": {}
92    },
93    "laundry_vending_income": {
94      "lower": 800,
95      "predicted": 1000,
96      "upper": 1200,
97      "explanation": {}
98    },
99    "professional_fees": {
100      "lower": 800,
101      "predicted": 1000,
102      "upper": 1200,
103      "explanation": {}
104    },
105    "management_fees": {
106      "lower": 800,
107      "predicted": 1000,
108      "upper": 1200,
109      "explanation": {}
110    },
111    "gross_potential_rent": {
112      "lower": 800,
113      "predicted": 1000,
114      "upper": 1200,
115      "explanation": {}
116    },
117    "replacement_reserves": {
118      "lower": 800,
119      "predicted": 1000,
120      "upper": 1200,
121      "explanation": {}
122    },
123    "egi": {
124      "lower": 800,
125      "predicted": 1000,
126      "upper": 1200,
127      "explanation": {}
128    }
129  }
130}
Built with