docs / enrich-property

Property Snapshot API

Property Snapshot API

base /enrich-property/v14 endpoints
post/enrich-property/v1/snapshot5 credits

address OR listing_url → one normalized property snapshot: status, price, sold-history, core facts, valuation (where available), per-field provenance + a match block (how the address was resolved + match_confidence).

ParameterAllowed / rangeDescription
addressoptionalFree-text property address (street + city + state/postcode). Provide this OR listing_url. For the most reliable match include the unit/apt and the postcode. Supported countries: US, UK, Japan.
listing_urloptionalA copied listing URL — routed to the right source automatically (zillow.com, redfin.com, realtor.com, rightmove.co.uk, suumo.jp). Provide this OR address.
countryoptionalUS · GB · JPOptional ISO country hint to skip auto-detection (US/GB/JP). Recommended when an address is ambiguous (e.g. a bare ZIP/outcode).
mode = standardoptionalstandard · rich · cross_validatedDepth of the snapshot. rich adds area market_context; cross_validated (US) reconciles facts across all 3 US sources.
Try in playground →
post/enrich-property/v1/resolve2 credits

address → ranked candidate listings[] (id + source + match_confidence) so the customer picks the exact property (apartment-unit / stale-listing disambiguation). The false-match-reducing flow — call this when a snapshot returns low confidence.

ParameterAllowed / rangeDescription
addressoptionalFree-text property address (street + city + state/postcode). Provide this OR listing_url. For the most reliable match include the unit/apt and the postcode. Supported countries: US, UK, Japan.
countryoptionalUS · GB · JPOptional ISO country hint to skip auto-detection (US/GB/JP). Recommended when an address is ambiguous (e.g. a bare ZIP/outcode).
limit = 10optional1–25Max candidate listings to return (resolve action).
Try in playground →
post/enrich-property/v1/batch5 credits

snapshot up to 10 addresses/listing-URLs in one call (standard mode, cache-first, per-item ok/error).

ParameterAllowed / rangeDescription
itemsrequiredUp to 10 addresses and/or listing URLs (array). Each is snapshotted independently; per-item ok/error.
countryoptionalUS · GB · JPOptional ISO country hint to skip auto-detection (US/GB/JP). Recommended when an address is ambiguous (e.g. a bare ZIP/outcode).
Try in playground →
post/enrich-property/v1/coveragefree

Static capability map: which countries/sources are supported, per-country source set, and the documented gaps (UK has no AVM; JP only 4 prefectures). No sub-calls.

Try in playground →