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_availabilitylist of objectsRequired
The list of units and floorplans available at the property.
building_name_aliaslist of stringsRequired
Alternative names or aliases for the building.
building_qualityobjectRequired
The quality scores for various aspects of the property, including both general areas and specific features.
citystringRequired
The city where the property is located.
created_onstringRequired
Date when the property details were last updated or created.
idstringRequired
The unique identifier of the property. It is a stringified UUIDv5. This value can occasionally change if multiple properties get merged into one.
latdoubleRequired
Latitude coordinate of the property's location.
londoubleRequired
Longitude coordinate of the property's location.
pricing_strategyobjectRequired
Analysis of the property's pricing patterns and strategies.
statestringRequired
The state where the property is located.
street_addressstringRequired
The primary street address of the property.
street_address_aliaslist of stringsRequired
Alternate or commonly used names or aliases for the street address.
zip_codestringRequired
The postal code for the property's location.
specials_historylist of objectsRequiredDeprecated
Historical special offers or promotions available at the property, along with extracted values from the text.
admin_feedoubleOptional
Administrative fee charged by the property.
amenity_feedoubleOptional
Amenity fee charged by the property, if applicable.
application_feedoubleOptional
Application fee charged to apply for residency.
building_amenitieslist of enumsOptional
List of amenities available in the building.
building_namestringOptional
The name of the building or property.
building_phone_numberstringOptional
Contact phone number for the building management or leasing office.
building_websitestringOptional
Website URL for the property or management company.
cats_depositdoubleOptional
Deposit required for having cats.
cats_monthly_rentdoubleOptional
Monthly rent charge for having cats.
cats_one_time_feedoubleOptional
One-time fee for having cats.
census_tract_idstringOptional
The FIPS code of the property's location.
concessions_historylist of objectsOptional
Historical concession offers or promotions available at the property, along with extracted values from the text.
demographicsmap from strings to optional doublesOptional

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

dogs_depositdoubleOptional
Deposit required for having dogs.
dogs_monthly_rentdoubleOptional
Monthly rent charge for having dogs.
dogs_one_time_feedoubleOptional
One-time fee for having dogs.
gprdoubleOptional
is_apartmentbooleanOptional
Indicates if the property is an apartment complex.
is_condobooleanOptional
Indicates if the property consists of condominiums.
is_seniorbooleanOptional
Indicates if the property is a senior living community.
is_single_familybooleanOptional
Indicates if the property is a single-family home.
is_studentbooleanOptional
Indicates whether we have identified the property as a student housing complex. Detected based on the presence of certain amenities, unit naming conventions, price points, and other factors.
management_companystringOptional
Name of the company managing the property.
market_embeddinglist of doublesOptional
An array representing the market embedding vector, used for advanced analysis. 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_depositdoubleOptional
Maximum security deposit required (may vary by unit).
min_depositdoubleOptional
Minimum security deposit required.
msastringOptional
Metropolitan Statistical Area the property belongs to, if applicable.
number_storiesdoubleOptional
Number of stories or levels in the property.
number_stories_predictionstringOptional
Predicted or estimated range for the number of stories in the building based on facade images.
number_unitsdoubleOptional
Total number of units in the property.
number_units_predictiondoubleOptional
A prediction of the number of units based on images, number of floors, amenities, location, year built, and the number of units we have seen so far. NOTE: This is an approximation to understand the property's size when the exact number of units is not available, do not use it as a variable in your financial models.
parking_covereddoubleOptional
Monthly charge for covered parking, if available.
parking_garagedoubleOptional
Monthly charge for parking in a garage, if available.
parking_surface_lotdoubleOptional
Monthly charge for parking in a surface lot, if available.
property_embeddinglist of doublesOptional
An array representing the property embedding vector, used for advanced analysis. If you want to compare two properties, you can use the cosine similarity between their property embeddings. Note: this vector is subject to change a couple of times a year as we improve our models.
review_analysisobjectOptional
Analysis of the property's public reviews over the past 24 months.
storage_feedoubleOptional
Fee for using storage facilities on the property.
street_view_urlstringOptional
A url to the street view image of the property.
unit_amenitieslist of enumsOptional
List of amenities available in the units.
user_idstringOptional

When it’s a custom property, this field will be populated with the user_id of the user who created the property.

year_builtdoubleOptional
Year the property was originally built.
year_built_predictionstringOptional
Predicted or estimated construction period or era based on listing images.
estimated_occupancydoubleOptionalDeprecated
The number of units currently marketed as available for move in now (implying they are vacant), divided by the total number of units in the building.
lease_lengthsstringOptionalDeprecated
Available lease lengths in months.
price_historylist of objectsOptionalDeprecated
Precomputed prices per unit type for the property over time. Deprecated, use the prices in the Availability object instead for more flexibility.
specialsstringOptionalDeprecated

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

Response

This endpoint returns an object.
subject_estimateobjectOptional
Built with