Enrichment
Enrich by APN
POST
Look up properties by Assessor’s Parcel Number (APN). Each item in the
data array provides an apn, and the API normalizes formatting automatically (dashes, spaces, dots are all handled). Optionally include a location to narrow results to a specific area.
Each request accepts up to 250 items in the
data array. The response returns every submitted
item with a matched flag indicating whether a property was found.Body Parameters
array
required
Array of APN objects to look up (max 250).
object
Location to narrow results to a specific area. When omitted, results are not filtered by location.
string[]
Field IDs to include in results. Can include both property and people fields.
Omit or pass an empty array for the default set.
string
Which contacts to include on matched properties.Options:
owners, owners_and_family, renters, residents, noneUse none or omit this parameter to return property data without contacts or people data credit charges. Any other value includes a contacts array.Response Fields
The response contains adata array and a totals object. There is no pagination — all submitted items are returned in a single response.
Matched Result
Whenmatched is true, the result contains all always-included property fields plus any requested fields.
Unmatched Result
Match Failure Codes
These codes are shared across all enrichment endpoints.Totals
Credits
This endpoint consumes 1 property data credit per matched property. A non-none contact_audience adds people data credits for included contacts. Use none for zero people data credits. Only matched results consume credits. Credits are deduplicated within your billing period, so accessing the same entity again is free.
Every response includes a credits object with a full breakdown of what was charged. See Credits for details.
Notes
- Each item only requires the
apnfield. The API normalizes formatting (dashes, dots, spaces) to the raw unformatted form automatically. - The
locationparameter is optional. When provided, results are scoped to that area. When omitted, the search is nationwide. - Items are matched independently — one failed match does not affect others.
- The
inputobject is always echoed back so you can correlate results with your input data. - When
contact_audienceis set to an audience other thannone, each matched result includes acontactsarray with the same structure and match behavior as Search Properties.