State Level

Rent Price Index Historical

Review historical time series data of monthly rental price index (RPI) values for a State, providing valuable insights into past rental market trends and performance.

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>state</td><td>string</td><td>2-letter state abbreviation</td><td>CA</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/state/rpi_ts_historical

Query parameters

statestring

2-letter state abbreviation

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

[
  {
    "state/rpi_ts_historical": {
      "result": {
        "time_series": [
          {
            "rpi_value": 1.25,
            "month": "2023-08-01"
          }
        ]
      }
    },
    "state_info": {
      "state": "CA"
    }
  }
]