Property Forecasts
Retrieve modeled future time-series forecast data for a specific property. Returns aggregated forecast metrics at configurable time intervals.
The forecast window spans from the beginning of the current month up to 5 years in the future. Any date filters outside this window are automatically clamped.
Set use_submarket_fallback to true to use the property’s submarket rent-growth forecast when all requested property rent-growth values are unavailable. The fallback is disabled by default. It does not replace available property data or change non-rent-growth aggregations.
Set use_rent_value to true to transform rent-growth aggregation values into seasonally adjusted forecasted rent values in dollars. The response keeps the aggregation names you provide. Non-rent-growth aggregations are unchanged. If the current base rent is unavailable, rent-growth-derived values are returned as null. When both options are true, submarket growth is applied to the property’s rent baseline.
Valid Aggregation Fields
All fields have _downside and _upside variants for confidence bounds (e.g., rent_growth_rate_yoy_downside, rent_growth_rate_yoy_upside).
| Field | Description |
|---|---|
rent_growth_rate_yoy | Year-over-year rent growth rate |
occupancy_percent | Forecast occupancy percentage |