State Level

Rent Price Index Forecast From Address

Access one-year forecast time series data of monthly rental price index (RPI) values for a State, supporting informed decisions about rental market trends and investment opportunities.

Source: HouseCanary

Pricing Tier: Premium

Updated: Monthly

Request Query Params

<table><tr><th>Property</th><th>Type</th><th>Description</th><th>Example</th><th>Enum Values</th></tr> <tr><td>slug</td><td>string</td><td>Unique readable string identifier for the property</td><td>123-Main-St-Apt-1B-San-Francisco-CA-94132</td> <td></td></tr> <tr><td>address</td><td>string</td><td>Either a single URL-safe string ("slug") identifying the address, or just a building number, street name, and optionally unit number (if not a slug the payload must also include other identifiers)</td><td>123 Main St</td> <td></td></tr> <tr><td>unit</td><td>string</td><td>Unit number for the property, if needed and not already specified in the address string</td><td>Apt 1B</td> <td></td></tr> <tr><td>city</td><td>string</td><td>City in which the property is located</td><td>San Francisco</td> <td></td></tr> <tr><td>state</td><td>string</td><td>2-letter acronym of the US state in which the property is located</td><td>CA</td> <td></td></tr> <tr><td>zipcode</td><td>string</td><td>5-digit US zipcode in which the property is located</td><td>94105</td> <td></td></tr> <tr><td>order</td><td>string</td><td>Chronological order to sort result items. One of [asc or desc]. Defaults to asc.</td><td>asc</td> <td>[asc, desc]</td></tr> <tr><td>limit</td><td>integer</td><td>Maximum integer number of result items to return. Defaults to null.</td><td>10</td> <td></td></tr> <tr><td>start</td><td>string</td><td>Beginning date limit for result items, based on month, in ISO 8601 format, i.e. 2015-01-01. Defaults to null.</td><td>2015-01-01</td> <td></td></tr> <tr><td>end</td><td>string</td><td>Ending date limit for result items, based on month, in ISO 8601 format, i.e. 2015-01-01. Defaults to null.</td><td>2015-01-01</td> <td></td></tr> </table>

Response

<table><tr><th>Field</th><th>Type</th><th>Description</th><th>Example</th></tr> <tr><td>time_series</td><td>array</td><td>Set of forecasted values with the associated month</td><td></td> </tr> <tr><td>time_series[]</td><td>object</td><td></td><td></td> </tr> <tr><td>time_series[].rpi_value</td><td>number</td><td>Forecast median rental value per square foot based on RPI.</td><td>1.25</td> </tr> <tr><td>time_series[].month</td><td>string</td><td>Month of the RPI value in ISO format</td><td>2023-08-01</td> </tr> </table>
get/v2/property/state_rpi_ts_forecast

Query parameters

slugstring

Unique readable string identifier for the property

addressstring required

Either a single URL-safe string ("slug") identifying the address, or just a building number, street name, and optionally unit number (if not a slug the payload must also include other identifiers)

unitstring

Unit number for the property, if needed and not already specified in the address string

citystring

City in which the property is located

statestring

2-letter acronym of the US state in which the property is located

zipcodestring

5-digit US zipcode in which the property is located

order'asc' | 'desc' nullable

Chronological order to sort result items. One of [asc or desc]. Defaults to asc.

limitinteger nullable

Maximum integer number of result items to return. Defaults to null.

startstring nullable

Beginning date limit for result items, based on month, in ISO 8601 format, i.e. 2015-01-01. Defaults to null.

endstring nullable

Ending date limit for result items, based on month, in ISO 8601 format, i.e. 2015-01-01. Defaults to null.

Response

Success

Example response

[
  {
    "property/state_rpi_ts_forecast": {
      "result": {
        "time_series": [
          {
            "rpi_value": 1.25,
            "month": "2023-08-01"
          }
        ]
      }
    },
    "address_info": {
      "address_full": "123 Main St San Francisco CA 94132",
      "slug": "123-Main-St-Apt-1B-San-Francisco-CA-94132",
      "address": "123 Main St",
      "unit": "Apt 1B",
      "city": "San Francisco",
      "state": "CA",
      "zipcode": "94132",
      "zipcode_plus4": "1234",
      "block_id": "060750313013007",
      "blockgroup_id": "060750201004",
      "county_fips": "06075",
      "metrodiv": "41860",
      "msa": "41860",
      "geo_precision": "rooftop",
      "lat": 37.789,
      "lng": -122.401,
      "status": {
        "match": true,
        "details": [
          "Address fully verified"
        ],
        "requested_item": {
          "zipcode": "94132",
          "address": "123+Main+St"
        },
        "changes": [
          "State added or changed"
        ]
      }
    }
  }
]