Skip to navigation
Property

Get Property

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.
  • Date filtering: You can optionally filter units, history, availability periods, and concessions by providing from and/or to date parameters. Only data that overlaps with the specified date range will be included. You can provide either date, both, or neither. This is particularly useful when you only need current or recent data, as it can significantly speed up API calls and reduce response payload size compared to retrieving the full historical dataset.

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

Authentication

x-api-keystring
API Key authentication via header
OR
AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

idstringRequiredformat: "uuid"

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

Query parameters

fromstringOptional

Optional. Filter results to include only data that overlaps with dates on or after this date (ISO 8601 format, e.g., “2024-01-01”).

tostringOptional

Optional. Filter results to include only data that overlaps with dates on or before this date (ISO 8601 format, e.g., “2024-12-31”).

use_tmlpbooleanOptional

Optional. Adjusts the ‘min_price’, ‘price’, ‘max_price’, ‘min_effective_price’, ‘effective_price’, ‘max_effective_price’, ‘price_plans’ to be Total Monthly Leasing Price (TMLP) by adding in fees.

occupancy_over_timebooleanOptional

Response

The property details.
idstringformat: "uuid"
The unique identifier of the property. It is a stringified UUIDv5. This value can occasionally change if multiple properties get merged into one.
building_namestring or null
The name of the building or property.
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.
year_builtdouble or null
Year the property was originally built.
number_unitsdouble or null
Total number of units in the property.
number_storiesdouble or null
Number of stories or levels in the property.
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 that have been listed for rent at the property since the start of the data collection.
building_qualityobject
The quality scores for various aspects of the property, including both general areas and specific features.
street_address_aliaslist of strings
Alternate or commonly used names or aliases for the street address.
msastring or null
Metropolitan Statistical Area the property belongs to, if applicable.
market_embeddinglist of doubles or null

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.

building_name_aliaslist of strings
Alternative names or aliases for the building.
building_phone_numberstring or null
Contact phone number for the building management or leasing office.
building_websitestring or null
Website URL for the property or management company.
is_single_familyboolean or null

Indicates if the property is a single-family home.

is_condoboolean or null
Indicates if the property consists of condominiums.
is_apartmentboolean or null
Indicates if the property is an apartment complex.
year_built_predictionstring or null
Predicted or estimated construction period or era based on listing images.
number_stories_predictionstring or null
Predicted or estimated range for the number of stories in the building based on facade images.
management_companystring or null
Name of the company managing the property.
pricing_strategyobject
Analysis of the property's pricing patterns and strategies.
cats_monthly_rentdouble or null
Monthly rent charge for having cats.
cats_one_time_feedouble or null

One-time fee for having cats.

cats_depositdouble or null
Deposit required for having cats.
dogs_monthly_rentdouble or null
Monthly rent charge for having dogs.
dogs_one_time_feedouble or null

One-time fee for having dogs.

dogs_depositdouble or null
Deposit required for having dogs.
admin_feedouble or null
Administrative fee charged by the property.
amenity_feedouble or null
Amenity fee charged by the property, if applicable.
application_feedouble or null
Application fee charged to apply for residency.
storage_feedouble or null
Fee for using storage facilities on the property.
parking_covereddouble or null
Monthly charge for covered parking, if available.
parking_garagedouble or null
Monthly charge for parking in a garage, if available.
parking_surface_lotdouble or null
Monthly charge for parking in a surface lot, if available.
min_depositdouble or null
Minimum security deposit required.
max_depositdouble or null

Maximum security deposit required (may vary by unit).

building_amenitieslist of enums or null
List of amenities available in the building.
unit_amenitieslist of enums or null
List of amenities available in the units.
review_analysisobject or nullOptional
Analysis of the property's public reviews over the past 24 months.
property_embeddinglist of doubles or nullOptional

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.

demographicsobjectOptional

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

census_tract_idstring or nullOptional
The FIPS code of the property's location.
ami_limitsobjectOptional

AMI (Area Median Income) affordability limits by household size. The AMI Limits can be either 30%, 50%, 60%, 80%, or 120% Each of these percents has a price amount for 1 to 8 people denoted by the p suffix The 25 refers to the year 2025 Used to determine if a unit qualifies as affordable based on rent-to-income ratio.

is_studentboolean or nullOptional
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_seniorboolean or nullOptional
Indicates if the property is a senior living community.
is_build_to_rentboolean or nullOptional

Indicates if the property is a build-to-rent community.

is_affordableboolean or nullOptional

Indicates if the property contains affordable units. Uses the public database of LIHTC properties and the floorplan names from the property website + data from other public data sources.

number_units_predictiondouble or nullOptional

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.

concessions_historylist of objectsOptional
Historical concession offers or promotions available at the property, along with extracted values from the text.
user_idstring or nullOptional

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

street_view_urlstring or nullOptional
A URL to a custom street view image provided for the property. This field is only populated if the user has supplied their own street view image, overriding the default value.
is_lease_upboolean or nullOptional

Lease-up mode indicates that the building was recently built, and it is assumed that the developers are only showing a small number of their available units because they are still trying to fill their spaces.

The function checks several conditions to determine if the building is in lease-up mode:

  1. It verifies if the building was built recently (within the last two years).
  2. It checks if the building has more than 10 units.
  3. It counts the number of available units and tracks the earliest availability date.
  4. It ensures that there have been at least 5 leases.
  5. It checks if the earliest move-in date is within the last 18-months.
  6. It calculates the percentage of units still being marketed and ensures it is at least 15%.

If all these conditions are met, the building is considered to be in lease-up mode.

abnormal_lease_spikeslist of objectsOptional

Abnormal lease spikes from portal/management transitions. Informational for the UI: the frontend shows warnings when a spike falls in the viewed period. Does not change lease counts.

occupancy_over_timelist of objects or nullOptional

DEPRECATED: This field will be removed in future versions.

feeslist of objects or nullOptional
All of the unstructured fees

Errors

404
Not Found Error