Resolve a batch of parcels · API reference

A batch: one entry per locator, in the order sent, each with its status, how many parcels fit, and the best parcel with its match.

Every entry is answered in the one call. One credit per parcel returned, and free to fetch again for a day; a locator that matched nothing costs nothing.

Parameters

No parameters.

Request body

itemrequiredLocator[]

The locators, up to 500. Each names a parcel one way: an address, an apn with its jurisdiction or fips, a lat and lon, or a parcel id.

Show its fields

addressstring | null: A street address, with its city or postal code where one is known.
apnstring | null: A parcel number as its issuer writes it. Needs jurisdiction or fips.
jurisdictionstring | null: The government that issued apn, or the one to search within.
fipsstring | null: The Census GEOID of the county that issued apn, or of the state or county to search within.
latnumber | null: Latitude of a point, in WGS 84. Needs lon.
lonnumber | null: Longitude of the point, in WGS 84.
parcelstring | null: A parcel id, to fetch it directly.

Responses

200: Batch; Successful Response
401: ProblemDetail; credential_missing, credential_invalid or credential_expired: send a live API key as Authorization: Bearer <key>.
402: ProblemDetail; quota_exhausted: the balance can't cover the call. Nothing was charged and nothing was returned.
403: ProblemDetail; scope_missing, person_required or entitlement_missing: this credential or plan can't do this. detail says which.
404: ProblemDetail; no_such_resource: nothing has that id.
409: ProblemDetail; version_conflict: the record changed since you read it. Read it again and resend.
422: ProblemDetail; parameter_invalid, id_malformed or a cursor code: a parameter's value isn't one this operation takes.
429: ProblemDetail; rate_limited: wait for Retry-After, then send it again. Not charged.
501: empty; not_available: no parcels are published yet.

Example request

curl -X POST 'https://api.placestack.com/v1/parcel/batch' \
  -H "Authorization: Bearer $PLACESTACK_API_KEY" \
  -H 'Content-Type: application/json' \
  -d '{
  "item": [
    {
      "address": "string",
      "apn": "string",
      "jurisdiction": "jur_01h455vb4pex5vsknk084sn02q",
      "fips": "string",
      "lat": 1.25
    }
  ]
}'

Example response

{
  "object": "parcel_batch",
  "item": [
    {
      "input": "<Locator>",
      "status": "matched",
      "candidates": 1,
      "detail": "string",
      "match": "<Match>",
      "parcel": "<Parcel>"
    }
  ],
  "matched": 1,
  "ambiguous": 1,
  "unmatched": 1,
  "invalid": 1
}