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

idstringRequiredformat: "[0-9a-fA-F]{8}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F]{12}"

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

Response

The property details.

idstringformat: "[0-9a-fA-F]{8}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F]{12}"

The unique identifier of the property. It is a stringified UUIDv5. This value can occasionally change if multiple properties get merged into one.

street_addressstring

The primary street address of the property.

citystring

The city where the property is located.

statestring

The state where the property is located.

zip_codestring

The postal code for the property’s location.

latdouble

Latitude coordinate of the property’s location.

londouble

Longitude coordinate of the property’s location.

created_onstringformat: "^\d{4}-\d{2}-\d{2}$"

Date when the property details were last updated or created.

building_availabilitylist of objects

The list of units and floorplans available at the property.

street_address_aliaslist of strings

Alternate or commonly used names or aliases for the street address.

building_name_aliaslist of strings

Alternative names or aliases for the building.

pricing_strategyobject

Analysis of the property’s pricing patterns and strategies.

building_qualityobject

The quality scores for various aspects of the property, including both general areas and specific features.

building_namestringOptional

The name of the building or property.

year_builtdoubleOptional

Year the property was originally built.

number_unitsdoubleOptional

Total number of units in the property.

number_storiesdoubleOptional

Number of stories or levels in the property.

msastringOptional

Metropolitan Statistical Area the property belongs to, if applicable.

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.

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.

demographicsmap from strings to optional doublesOptional

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

census_tract_idstringOptional

The FIPS code of the property’s location.

building_phone_numberstringOptional

Contact phone number for the building management or leasing office.

building_websitestringOptional

Website URL for the property or management company.

is_single_familybooleanOptional

Indicates if the property is a single-family home.

is_condobooleanOptional

Indicates if the property consists of condominiums.

is_apartmentbooleanOptional

Indicates if the property is an apartment complex.

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.

is_seniorbooleanOptional

Indicates if the property is a senior living community.

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.

year_built_predictionstringOptional

Predicted or estimated construction period or era based on listing images.

number_stories_predictionstringOptional

Predicted or estimated range for the number of stories in the building based on facade images.

management_companystringOptional

Name of the company managing the property.

concessions_historylist of objectsOptional

Historical concession offers or promotions available at the property, along with extracted values from the text.

cats_monthly_rentdoubleOptional

Monthly rent charge for having cats.

cats_one_time_feedoubleOptional

One-time fee for having cats.

cats_depositdoubleOptional

Deposit required for having cats.

dogs_monthly_rentdoubleOptional

Monthly rent charge for having dogs.

dogs_one_time_feedoubleOptional

One-time fee for having dogs.

dogs_depositdoubleOptional

Deposit required for having dogs.

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.

storage_feedoubleOptional

Fee for using storage facilities on the property.

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.

min_depositdoubleOptional

Minimum security deposit required.

max_depositdoubleOptional

Maximum security deposit required (may vary by unit).

building_amenitieslist of enumsOptional

List of amenities available in the building.

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.

review_analysisobjectOptional

Analysis of the property’s public reviews over the past 24 months.

street_view_urlstringOptional

A url to the street view image of the property.