Parcels

Neighborhood distress index for a parcel's tract and block group

The neighborhood distress index rows of the parcel's census tract and block group: area-level, describing the neighborhood, not this property. When the parcel has no block group on record, block_group is null with block_group_reason and the tract is returned alone. Requires an account (API key, MCP OAuth token or signed-in session) and is metered like the other analytics reads; an anonymous caller gets 401 and nothing is read. Before the index's first load the answer is 503 distress_index_unavailable.

get/api/v1/parcels/{id}/distress

Request

  • Base URL: https://propraven.com
  • URL: https://propraven.com/api/v1/parcels/{id}/distress
  • Auth: HTTP bearer

Path parameters

idstring required
Example:37:119:12104406

Parcel identifier: the canonical state_fips:county_fips:parcel_id form (e.g. 37:119:12104406), the legacy 5-digit county_fips5:parcel_id form, or a PropRaven parcel UUID. URL-encode it.

Response

The parcel's tract and block group rows.

schema_version'neighborhood-distress-v1' required
layer_versionstring required
built_atstring nullable required
notesstring[] required
tract_reasonstring nullable required
block_group_reasonstring nullable required

Example response

{
  "method": {
    "missing_components": "weighted mean over present components; weight_coverage published; never imputed; score NULL with null_reason when core ACS components are missing"
  },
  "tract": {
    "geoid": "37119001100",
    "components": [
      {
        "component": "poverty_rate",
        "label": "Poverty rate"
      }
    ]
  },
  "block_group": {
    "geoid": "37119001100",
    "components": [
      {
        "component": "poverty_rate",
        "label": "Poverty rate"
      }
    ]
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.