Properties

Resolve a batch of addresses to property ids

POST
/v1/properties/resolve

Resolve up to 2,000 postal addresses to property ids in one call — e.g. a mailing list before a bulk delivery. Free. Returns one result per input, in order, keyed by your ref. matched carries the parcel id and mmPropertyId — pass them to bulk delivery propertyIds or the list flatFilters.id, then join the rows back on ref. Each address is first matched on the normalized number + street + unit + zip key (suffix, directional, punctuation and case insensitive); misses fall back to a ranked search that only accepts a hit with the same house number, the same zip or city, and a near-identical street name. ambiguous lists candidates: unit_required (a building whose units are separate parcels — resend with the unit), duplicate_parcels (one address on several parcel records; usually safe to take them all), multiple_parcels. not_found gives a reason: no_parcel_at_number (no parcel at that house number in that zip/city), low_confidence, or an input problem (no_house_number, no_street, no_location).

Authorization

x-api-key<token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/v1/properties/resolve" \  -H "Content-Type: application/json" \  -d '{    "addresses": [      {}    ]  }'
{
  "results": [
    {
      "address": "string",
      "candidates": [
        {
          "address": "string",
          "id": "string",
          "mmPropertyId": "string",
          "score": 0
        }
      ],
      "id": "string",
      "matchedBy": "exact_key",
      "mmPropertyId": "string",
      "reason": "unit_required",
      "ref": "string",
      "score": 0,
      "status": "matched"
    }
  ],
  "summary": {
    "ambiguous": 0,
    "matched": 0,
    "notFound": 0
  }
}
{
  "error": "string"
}
{
  "error": "string"
}
{
  "error": "string"
}
{
  "error": "string"
}
{
  "error": "string",
  "limit": 0,
  "size": 0
}

Property count and average AVM POST

Previous Page

Free-text property search POST

Find properties by a single free-text query — a full or partial address, an owner name, or a place. Results are ranked by relevance and tolerate typos, missing components, and reordered street directionals (e.g. "112 5th ave nw" and "112 nw 5th ave" both match). Returns the same property summary rows as the list endpoint. Use this for a search box; use the list endpoint for structured filtering.