REregrid
International

Parcel Path

This endpoint delivers a single parcel record based on the unique path. This is best used in combination with the Typeahead API endpoint. This endpoint allows access to test all of our premium matched datasets with applicable API token. Note: the example shown uses Canada (ca).

get/{country}/parcels/path

Request

  • Base URL
    https://app.regrid.com/api/v2
  • URL
    https://app.regrid.com/api/v2/{country}/parcels/path
  • Auth
    • API key in header x-regrid-token
    • or API key in query parameter token

Path parameters

country'ca' | 'ch' | 'cy' | 'cz' | 'de' | 'dk' | 'ee' | 'es' | 'fi' | 'fr' | 'gb' | 'ie' | 'is' | 'it' | 'lu' | 'lv' | 'nl' | 'no' | 'pl' | 'si' | 'sk' required

ISO 3166-1 alpha-2 country code for international data.

Query parameters

pathstring required

The canonical path of the parcel in the Regrid system.

return_customboolean

Default false: A true value allows county-specific fields to be passed through beyond standard schema fields only. Note: only supported for Canada (ca).

return_field_labelsboolean

Default false: A true value shows the naming convention for each standardized schema field.

return_stackedboolean

Default true: A false value returns the first parcel if geometries are identical.

Response

A list of parcel features. When supported by the account with buildings array and addresses property

Example response

{
  "parcels": {
    "type": "FeatureCollection",
    "features": [
      {
        "type": "Feature"
      }
    ]
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.