---
title: "Enrich a parcel"
method: POST
path: "/v1/enrich"
---

# Enrich a parcel

`POST /v1/enrich`

## Request

- Base URL: `https://api.mireye.com`
- URL: `https://api.mireye.com/v1/enrich`
- Auth: none declared
- TypeScript: <https://skmtc.dev/mireye/apis/mireye-earth/docs/v1/enrich/post.ts> (a function with typed inputs; its response is checked against the schema)

Resolve an address or coordinate to one US parcel, then return the selected parcel attributes, point data and whole-parcel calculations. Requires current customer terms and an Enrich-enabled key or hosted connection. Enrich costs $0.02 per successful parcel on Free; active paid-plan discounts apply. A parcel is charged only when at least one requested field is returned: an empty fields map, no_match, ambiguous and unavailable results are free. An address selects a parcel only from a rooftop-precision geocode; otherwise parcel_match is no_match with a reason. Fields and preset combine; omitting both requests every Enrich field, so prefer a small selection. GET /v1/enrich/fields lists every field ID and preset. Supply a stable Idempotency-Key for safe retries and an optional max_cost_usd decimal-string ceiling. The flat fields map follows preset order; each returned field has value, source, confidence, interpretation_hints, and unit when defined. Failed fields and unavailable values are omitted. An empty fields map is valid. At capacity Enrich returns 429 enrich_busy with Retry-After.

## Headers

- `Idempotency-Key` string, nullable

## Request body

- EnrichRequest: Give an address or lat and lng; select individual fields, presets or both. Omitting both selectors requests every Enrich field. Unknown field IDs and preset names are rejected before any work or charge.
  - `address` string, nullable
  - `fields` string[], nullable: Individual Enrich field IDs, for example slope_degrees or owner. Combined with presets by union; duplicates are returned once. Omit or use null for both selectors to request all Enrich fields.
  - `lat` number, nullable
  - `lng` number, nullable
  - `max_cost_usd` string, nullable
  - `preset` string[], nullable: A list of one or more named Enrich bundles, combined with fields by union; each field is returned once.

## Response `200`

Successful Response

- EnrichPublicResponse: One parcel's match result and its requested field values.
  - `analysis_point` PublicAnalysisPoint: The point used for point-sampled fields on the matched parcel.
    - `lat` number, required
    - `lng` number, required
    - `method` 'stored_parcel_centroid' | 'input_fallback', required: stored_parcel_centroid when the parcel's recorded centroid is used; input_fallback when the parcel has no recorded centroid and the resolved location is used instead.
    - `source` 'parcel_centroid' | 'geocoded_address' | 'input_coordinate', required: Where the point comes from: parcel_centroid (the parcel's recorded centroid), geocoded_address (the geocoded address) or input_coordinate (the supplied lat/lng).
  - `billing` PaidBilling: The charge receipt for one paid Search or Enrich operation.
    - `charged_usd` string, required: Amount charged, as a decimal USD string.
    - `currency` 'USD', required
    - `operation_id` string, required: Stable identity of this paid operation.
    - `pricing_version` string, required: Rate card the charge used.
    - `replayed` boolean, required: True when this response replays an earlier result without a new charge.
  - `fields` object, required: Sparse flat map in Enrich preset order. Failed fields and unavailable values are omitted. The map may be empty even when fields were requested.
  - `geocode` GeocodeDetails: How the address was geocoded and how precise the resulting coordinate is.
    - `accuracy` number, nullable, required
    - `accuracy_type` string, nullable, required
    - `match_type` string, nullable, required
    - `normalized_address` string, nullable, required
    - `parcel_grade` boolean, required
    - `precision_note` string, nullable, required
    - `provider` string, nullable, required
    - `source` string, nullable, required
  - `lat` number, required
  - `lng` number, required
  - `parcel_match` PublicParcelMatch, required
    - `candidates` PublicParcelCandidate[]
      - `address` string, nullable
      - `match_distance_m` number, nullable
      - `match_type` string, nullable
      - `parcelnumb` string, nullable
      - `source` string, required
    - `parcel` PublicParcelCandidate: Match evidence: the county parcel number, situs address and source.
      - `address` string, nullable
      - `match_distance_m` number, nullable
      - `match_type` string, nullable
      - `parcelnumb` string, nullable
      - `source` string, required
    - `reason` string, nullable
    - `status` 'matched' | 'ambiguous' | 'no_match' | 'unavailable', required
  - `resolved_location` ResolvedLocation, required: The coordinate the request resolved to: the supplied lat/lng, or the geocoded address.
    - `lat` number, required
    - `lng` number, required
    - `source` 'address' | 'coordinate', required: address when the point came from geocoding; coordinate when supplied.

## Other responses

- `400`: Unknown field ID, empty field list or a coordinate outside the US.
- `401`: Missing or invalid credential.
- `402`: The charge would exceed the balance or spending limit.
- `403`: Current terms or a licensed credential grant is required.
- `404`: The address could not be placed precisely enough.
- `409`: The Idempotency-Key is in use.
- `410`: The operation for this Idempotency-Key cannot be delivered again.
- `422`: Invalid request shape: give address or lat and lng (not both); preset must be a nonempty list of known preset names; fields must be nonempty when present; a mail-only address (PO box) returns address_form_unsupported.
- `429`: Rate limit or capacity reached; honor the Retry-After header.
- `503`: A required service is temporarily unavailable.
- `504`: Address geocoding timed out.

---

[API](https://skmtc.dev/mireye/apis/mireye-earth.md) - [All operations](https://skmtc.dev/mireye/apis/mireye-earth/llms.txt) - [OpenAPI document](https://skmtc.dev/mireye/apis/mireye-earth/revisions/d8410ba83654?raw)