Geo Boundary Forecasts
Retrieve modeled future time-series forecast data for a geographic boundary. 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_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.
Valid Aggregation Fields
All fields have _downside and _upside variants for confidence bounds (e.g., rent_growth_yoy_downside, rent_growth_yoy_upside).
Rent Growth
| Field | Description |
|---|---|
rent_growth_yoy | Year-over-year rent growth rate |
rent_growth_yoy_bed_0 | Rent growth for studios |
rent_growth_yoy_bed_1 | Rent growth for 1-bedrooms |
rent_growth_yoy_bed_2 | Rent growth for 2-bedrooms |
rent_growth_yoy_bed_3 | Rent growth for 3-bedrooms |
rent_growth_yoy_class_a | Rent growth for Class A properties |
rent_growth_yoy_class_b | Rent growth for Class B properties |
rent_growth_yoy_class_c | Rent growth for Class C properties |
Occupancy, Absorption & Deliveries
| Field | Description |
|---|---|
occupancy | Forecast occupancy rate |
absorption | Forecast net absorption (units) |
deliveries | Forecast new unit deliveries |
Authorizations
Enter a Bearer token obtained via the OAuth client credentials flow or from the Access Tokens tab in your account settings.
Path Parameters
ID of the geographic boundary. Find IDs using the Search Geo Boundaries endpoint.
Body
ID of the ApartmentIQ account.
1111
One or more aggregations to compute over the forecast time-series. Each aggregation defines a metric that appears in the response values object, keyed by the name you provide.
Time bucket size for the forecast data.
month, quarter, year "month"
Offset for time bucket alignment.
"0d"
When true, transforms rent-growth aggregation values into seasonally adjusted forecasted rent values in dollars. Aggregation keys in the response remain the names you provide in aggregations.
true
Optional date range filters for forecast data. If omitted, defaults to the full forecast window (current month through 5 years out). Dates outside the forecast window are automatically clamped.
Response
Successfully retrieved forecast time-series data.