curl --request POST \
--url https://data.apartmentiq.io/apartmentiq/api/v1/properties/{property_id}/forecasts \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"account_id": 1111,
"aggregations": [
{
"name": "avg_rent_growth",
"field": "rent_growth_rate_yoy",
"aggregation_type": "avg"
}
]
}
'{
"data": {
"type": "forecasts",
"id": "550e8400-e29b-41d4-a716-446655440000",
"attributes": {
"time_series": [
{
"date": "2026-03-01",
"values": {
"avg_rent_growth": 0.0234
}
},
{
"date": "2026-04-01",
"values": {
"avg_rent_growth": 0.0241
}
},
{
"date": "2026-05-01",
"values": {
"avg_rent_growth": 0.0255
}
}
]
}
}
}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 |
curl --request POST \
--url https://data.apartmentiq.io/apartmentiq/api/v1/properties/{property_id}/forecasts \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"account_id": 1111,
"aggregations": [
{
"name": "avg_rent_growth",
"field": "rent_growth_rate_yoy",
"aggregation_type": "avg"
}
]
}
'{
"data": {
"type": "forecasts",
"id": "550e8400-e29b-41d4-a716-446655440000",
"attributes": {
"time_series": [
{
"date": "2026-03-01",
"values": {
"avg_rent_growth": 0.0234
}
},
{
"date": "2026-04-01",
"values": {
"avg_rent_growth": 0.0241
}
},
{
"date": "2026-05-01",
"values": {
"avg_rent_growth": 0.0255
}
}
]
}
}
}Authorizations
Enter a Bearer token obtained via the OAuth client credentials flow or from the Access Tokens tab in your account settings.
- Token URL
- https://data.apartmentiq.io/oauth/token
Path Parameters
ID of the property.
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.
Show child attributes
Show child attributes
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
When true, uses the property's submarket rent-growth forecast only if all requested property rent-growth values are unavailable. Available property forecast data and non-rent-growth aggregations are unchanged.
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.
Show child attributes
Show child attributes
Response
Successfully retrieved forecast time-series data.
Show child attributes
Show child attributes