Get pricing recommendations for active units among a subject property given its details. We use all property and unit details (characteristics, amenities, location, etc.)
to find similar units in the market that have been rented recently. We then use the rent prices of these units to estimate the unit pricing.
Request
This endpoint expects an object.
subjectobjectRequired
The content of the property for which to compute the recommended pricing.
settingsobjectOptional
The settings for computing the recommended pricing. For example to exclude
the subject property from the comps analysis, to limit the search radius for
comparable properties, or to filter the data to include only units occurring
within a specific date range.
Response
This endpoint returns a list of objects.
unitobject
The PricingUnit object represents rudimentary information about a unit and its pricing. It is returned when querying a property's recommended pricing instead of the full unit details.
supporting_unitslist of objects
predicted_pricedoubleOptional
The recommended rent for the unit, based on an analysis of comparable units.
predicted_price_sqftdoubleOptional
The recommended rent per square foot of the unit, based on an analysis of comparable units.