Skip to main content
POST
/
properties
/
{property_id}
/
forecasts
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

​
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

​
property_id
integer
required

ID of the property.

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.

​
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.

Response

Successfully retrieved forecast time-series data.

​
data
object
required