Additional Endpoints

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.

get/parcels/path

Request

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

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.

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.

return_zoningboolean

Set to false to disable zoning data in the response. Default is true when supported by the account.

return_matched_buildingsboolean

Set to false to disable building footprint data in the response. Default is true when supported by the account.

return_matched_addressesboolean

Set to false to matched addresses data in the response. Default is true when supported by the account.

return_enhanced_ownershipboolean

Set to false to disable enhanced ownership data in the response. Default is true when supported by the account.

return_parcelsboolean

Default true. A false value will not return parcel records. Used to return additional add-on datasets when parcel information is not needed.

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",
        "properties": {
          "score": 86.75966
        }
      }
    ]
  },
  "buildings": {
    "type": "FeatureCollection",
    "features": [
      {
        "type": "Feature"
      }
    ]
  },
  "zoning": {
    "type": "FeatureCollection",
    "features": [
      {
        "type": "Feature"
      }
    ]
  }
}

Changes

    • breaking

      for the query request parameter return_custom, default value false was removed

    • breaking

      for the query request parameter return_field_labels, default value false was removed

    • breaking

      for the query request parameter return_stacked, default value true was removed

    • info

      added the new optional query request parameter return_parcels