Retrieve all the details of a property given its id.
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.
The property id (UUIDv5 retrieved from the search endpoint).
The property details.
The unique identifier of the property. It is a stringified UUIDv5. This value can occasionally change if multiple properties get merged into one.
The primary street address of the property.
The city where the property is located.
The state where the property is located.
The postal code for the property’s location.
Latitude coordinate of the property’s location.
Longitude coordinate of the property’s location.
Date when the property details were last updated or created.
The list of units and floorplans available at the property.
Alternate or commonly used names or aliases for the street address.
Alternative names or aliases for the building.
Analysis of the property’s pricing patterns and strategies.
The quality scores for various aspects of the property, including both general areas and specific features.
The name of the building or property.
Year the property was originally built.
Total number of units in the property.
Number of stories or levels in the property.
Metropolitan Statistical Area the property belongs to, if applicable.
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.
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.
Beta Subject to change in near future. The demographics for the property’s location, if available.
The FIPS code of the property’s location.
Contact phone number for the building management or leasing office.
Website URL for the property or management company.
Indicates if the property is a single-family home.
Indicates if the property consists of condominiums.
Indicates if the property is an apartment complex.
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.
Indicates if the property is a senior living community.
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.
Predicted or estimated construction period or era based on listing images.
Predicted or estimated range for the number of stories in the building based on facade images.
Name of the company managing the property.
Historical concession offers or promotions available at the property, along with extracted values from the text.
Monthly rent charge for having cats.
One-time fee for having cats.
Deposit required for having cats.
Monthly rent charge for having dogs.
One-time fee for having dogs.
Deposit required for having dogs.
Administrative fee charged by the property.
Amenity fee charged by the property, if applicable.
Application fee charged to apply for residency.
Fee for using storage facilities on the property.
Monthly charge for covered parking, if available.
Monthly charge for parking in a garage, if available.
Monthly charge for parking in a surface lot, if available.
Minimum security deposit required.
Maximum security deposit required (may vary by unit).
List of amenities available in the building.
List of amenities available in the units.
When it’s a custom property, this field will be populated with the user_id of the user who created the property.
Analysis of the property’s public reviews over the past 24 months.
A url to the street view image of the property.
Available lease lengths in months.
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.
Precomputed prices per unit type for the property over time. Deprecated, use the prices in the Availability object instead for more flexibility.
Current special offers or promotions available at the property. Deprecated, use the concessions_history field instead to get all concessions over time.