Value Forecast From Address

This endpoint provides a forecast time series of monthly block-median data for dollar value and dollar value per sq ft. The values are forecast one year into the future. You can specify a desired property type using the property_type request parameter. The default is SFD. You can also specify the order, limit, start, and end request parameters. The order parameter determines the chronological order to sort result items. The limit parameter sets the maximum integer number of result items to return. The start and end parameters set the beginning and ending date limits for result items, respectively, based on month in ISO 8601 format (e.g., 2015-01-01).

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>property_type</td><td>string</td><td>Desired property type to include in the time series. Defaults to SFD. One of [SFD, TH, CND, INC, MFH].</td><td></td> <td>[SFD, TH, CND, INC, MFH]</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></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><th>Enum Values</th></tr> <tr><td>property_type</td><td>string</td><td>Type of property specified in the request. Defaults to SFD. One of [SFD, TH, CND, INC, MFH].</td><td>TH</td> <td>[SFD, TH, CND, INC, MFH]</td></tr> <tr><td>time_series</td><td>array</td><td>List of months and values.</td><td></td> <td></td></tr> <tr><td>time_series[]</td><td>object</td><td></td><td></td> <td></td></tr> <tr><td>time_series[].month</td><td>string</td><td>Month of the value in ISO format.</td><td>2023-08-01</td> <td></td></tr> <tr><td>time_series[].value_median</td><td>integer</td><td>Amount in dollars of the forecasted median property sale value for the month.</td><td>320000</td> <td></td></tr> <tr><td>time_series[].value_sqft_median</td><td>number</td><td>Amount in dollars of the forecasted median property sale value per square foot for the month.</td><td>210.5</td> <td></td></tr> </table>

[
  {
    "property/block_value_ts_forecast": {
      "result": {
        "property_type": "TH",
        "time_series": [
          {
            "month": "2023-08-01",
            "value_median": 320000,
            "value_sqft_median": 210.5
          }
        ]
      }
    },
    "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"
        ]
      }
    }
  }
]