curl --request POST \
  --url https://data.apartmentiq.io/apartmentiq/api/v1/geo_boundary/{geo_boundary_id}/forecasts \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "account_id": 1111,
  "aggregations": [
    {
      "name": "avg_rent_growth",
      "field": "rent_growth_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
          }
        }
      ]
    }
  }
}

Forecasts

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.

Requires Explore Pro access.

Forecasts are only available for MSAs, Submarkets, and Zip Codes.

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

POST

geo_boundary

{geo_boundary_id}

forecasts

curl --request POST \
  --url https://data.apartmentiq.io/apartmentiq/api/v1/geo_boundary/{geo_boundary_id}/forecasts \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "account_id": 1111,
  "aggregations": [
    {
      "name": "avg_rent_growth",
      "field": "rent_growth_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

Authorization

string

header

required

Enter a Bearer token obtained via the OAuth client credentials flow or from the Access Tokens tab in your account settings.

Path Parameters

geo_boundary_id

integer

required

ID of the geographic boundary. Find IDs using the Search Geo Boundaries endpoint.

Body

application/json

account_id

integer

required

ID of the ApartmentIQ account.

Example:

1111

aggregations

object[]

required

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

interval

enum<string>

default:month

Time bucket size for the forecast data.

Available options:

month,

quarter,

year

Example:

"month"

offset

string

default:0d

Offset for time bucket alignment.

Example:

"0d"

use_rent_value

boolean

default:false

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.

Example:

true

filters

object

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

Response

Successfully retrieved forecast time-series data.

data

object

required

Show child attributes

Download Batch Job Results Property Forecasts

⌘I