docs/enrich parameter
Home ↗

Enrich Parameter

Add enrich=true to a supported endpoint to supplement its canonical response with normalized information discovered from curated public web sources.

Enrichment is additive. It never overwrites the endpoint response: the original payload is returned in apiResponse, and web-derived data is returned separately in enrichment.

Request

curl -G https://api.parcelkit.us/api/property \
  -H "x-api-key: sk_live_your_key" \
  --data-urlencode "address=550 Gunston Ct, Conroe, TX 77302" \
  --data-urlencode "enrich=true"

Omitting the parameter, or sending enrich=false, uses the standard endpoint path without live-web enrichment.

Response contract

response.json
{
  "apiResponse": {
    "...": "The normal endpoint response, unchanged"
  },
  "enrichment": {
    "status": "partial",
    "mode": "live_web",
    "profile": "property",
    "templateVersion": "property.v2",
    "address": "550 Gunston Ct, Conroe, TX 77302",
    "normalized": {
      "...": "Verified and normalized web data"
    },
    "quality": {
      "overall": "partial",
      "addressMatch": "high"
    }
  }
}

The public response contains normalized values and quality metadata. Search queries, raw pages, extraction rules, provider routing, and unresolved source conflicts stay internal.

Supported endpoints

/api/property

Listing, market, feature, history, school, and climate signals

/api/schools

Assignment consensus, ratings, grades, enrollment, and campus details

/api/crime

Community safety, historical trends, offense patterns, and registry signals

/api/deeds

Public sale and listing history plus deed-related mentions

/api/flood

Modeled risk, property statements, and area flood context

/api/neighbors

Neighborhood market, value, amenities, access, and resident signals

Status and confidence

complete

All core sections for the profile contain accepted evidence.

partial

Useful evidence was found, but one or more sections remain incomplete.

unavailable

No evidence passed the identity, scope, or quality checks.

Section confidence is reported as high, medium, low, or unavailable. A null value means that the field was not verified from accepted evidence at request time; it does not mean zero or none.

Runtime behavior

  • • Results come from live public-web discovery against curated source families.
  • • Property identity and geographic scope are validated before values are accepted.
  • • Results may be cached for up to 24 hours to reduce latency and repeated scraping.
  • • A source can be unavailable or rate-limited, so useful responses may be partial.
  • • Enriched requests usually take longer than standard endpoint requests.

Public web data is supporting evidence, not a legal, appraisal, insurance, school-boundary, or public-safety guarantee. Use the endpoint's canonical data and the enrichment quality fields together.

See Pricing for the enriched-request credit cost.