v1

latestOpenAPI 3.0.32026-08-0638140175.8 KB

Parcels

Advanced parcel search - beta

Retrieve a list of parcel IDs based on a set of filters. The maximum number of IDs returned is 100,000.

Schema is subject to change.

post/parcels/advanced-search

Request body

Example request

{
  "search_filter": {
    "ALL": [
      {
        "id": "additional-opportunities-id",
        "values": [
          {
            "key": "declassified_green_belt",
            "checked": true
          }
        ],
        "must": "MATCH_ANY"
      }
    ]
  }
}

Response

A list of parcel IDs matching the search criteria.

parcel_idsParcelId[] required

A list of parcel UUIDs.

Example response

{
  "parcel_ids": [
    "2a5ad2c7-29ef-d609-8ade-36eef8e3a072"
  ]
}