Skip to main content
POST
/
properties
/
bulk_forecasts
Bulk Property Forecasts
curl --request POST \
  --url https://data.apartmentiq.io/apartmentiq/api/v2/properties/bulk_forecasts \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "account_id": "{account_id}",
  "time_period": "next_12_months",
  "interval": "month"
}
'
{
  "rows": [
    {
      "property_name": "The Livingston",
      "market_name": "Madison, WI Metro Area",
      "submarket_name": "Downtown Madison",
      "property_id": 781245,
      "address": "1025 E Washington Ave",
      "city": "Madison",
      "state": "WI",
      "zip_code": "53703",
      "latitude": 43.0836,
      "longitude": -89.3723,
      "unified_status": "stabilized",
      "unit_count": 186,
      "number_of_stories": 6,
      "year_built": 2018,
      "year_renovated": null,
      "property_class": "A",
      "property_type": "Multifamily",
      "management_company_names": [
        "Northstar Residential"
      ],
      "ownership_company_names": [
        "Lakeview Multifamily Fund"
      ],
      "period": "2026-07",
      "rent_growth_rate_yoy": 0.0312,
      "rent_growth_rate_yoy_downside": 0.0175,
      "rent_growth_rate_yoy_upside": 0.0468,
      "occupancy_percent": 0.9412,
      "occupancy_percent_downside": 0.9224,
      "occupancy_percent_upside": 0.9588
    },
    {
      "property_name": "Summit Row",
      "market_name": "Madison, WI Metro Area",
      "submarket_name": "West Madison",
      "property_id": 781266,
      "address": "711 Junction Rd",
      "city": "Madison",
      "state": "WI",
      "zip_code": "53717",
      "latitude": 43.0719,
      "longitude": -89.5264,
      "unified_status": "lease_up",
      "unit_count": 244,
      "number_of_stories": 5,
      "year_built": 2024,
      "year_renovated": null,
      "property_class": "A",
      "property_type": "Multifamily",
      "management_company_names": [
        "Crescent Urban Living"
      ],
      "ownership_company_names": [],
      "period": "2026-08",
      "rent_growth_rate_yoy": null,
      "rent_growth_rate_yoy_downside": null,
      "rent_growth_rate_yoy_upside": null,
      "occupancy_percent": 0.8721,
      "occupancy_percent_downside": 0.8365,
      "occupancy_percent_upside": 0.9018
    }
  ],
  "pagination": {
    "current_page": 1,
    "total_pages": 4,
    "total_count": 100,
    "per_page": 25
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
​
account_id
required

ApartmentIQ account ID used to set the request account context.

​
time_period
enum<string>
required

Forecast horizon.

Available options:
next_12_months,
next_3_years,
next_5_years
​
interval
enum<string>
required

Forecast period bucket.

Available options:
month,
quarter,
year
​
fields
enum<string>[]

Forecast metric field names to include in each property row.

Available options:
rent_growth_rate_yoy,
rent_growth_rate_yoy_downside,
rent_growth_rate_yoy_upside,
occupancy_percent,
occupancy_percent_downside,
occupancy_percent_upside
​
property_filters
object

Filters used to select properties and constrain the metric aggregation date range.

​
page
integer
default:1

Page number. Values less than 1 are treated as 1.

Required range: x >= 1
​
per_page
integer
default:25

Matched properties per page. Values above 100 are capped at 100. Interval-based rows expand each matched property into one row per period, so the number of rows returned can be greater than per_page.

Required range: 1 <= x <= 100

Response

Bulk property forecast rows and pagination metadata.

Paginated property forecast export results.

​
rows
object[]
required

Property forecast rows for the matched properties on the current page. Each matched property is expanded into one row per interval period, so the number of rows returned can be greater than the per_page value. Each row includes property identity fields, an output period, and any requested forecast fields.

​
pagination
object
required

Pagination details for matched properties, not the expanded interval-period rows.