Sign in

v1

latestOpenAPI 3.0.32026-08-0638140175.8 KB
Parcels

Search for parcels

Given a region GSS code and optional parcel size, retrieve a list of parcel IDs. The maximum number of IDs returned is 100,000.

post/parcels/search

Request body

regionstring required

A region code (e.g. GSS code for UK Local Authority Districts).

tenurestring[]

Example request

{
  "region": "E06000023",
  "parcel_size": {
    "min": 2023.43,
    "max": 4046.86
  },
  "tenure": [
    "freehold"
  ]
}

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"
  ]
}