REregrid
Canada

Area Geometry Search

Changed on

Search for parcels in a specific geographical area. This endpoint allows access to test all our premium matched datasets with applicable API token. Accepted formats vary from GeoJSON Feature Collection of geometries (Polygon, MultiPolygon, Point, MultiPoint, LineString and/or MultiLineString), or a Feature with a GeoJSON geometry or a direct GeoJSON geometry. These parameters also accept an optional radius parameter in meters to create a buffer around the given geometries. Note adding a radius can increase the overall area of the request reaching the area size limit per request.

post/ca/parcels/area

Request

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

Query parameters

radiusinteger

(Default: 0, Maximum: 32000) Radius in meters for which all Parcel records will be returned if they are within the radius zone from latitude and longitude point.

offset_idinteger

ID from a previous query exceeding the limit, returns the next set of results up to limit.

limitinteger

Maximum number of Parcel Records to return.

return_geometryboolean

Default true. A features are returned without geometry values.

return_countboolean

Set to true to enable count of parcels in query.

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.

Request body

Example request

{
  "geojson": {
    "type": "Polygon",
    "coordinates": [
      [
        [
          -97.77785381153151,
          54.62696250754314
        ],
        [
          -97.77727445438435,
          54.62599980717738
        ],
        [
          -97.77403434589417,
          54.62683828942136
        ],
        [
          -97.77551492527041,
          54.62785686682221
        ],
        [
          -97.77785381153151,
          54.62696250754314
        ]
      ]
    ]
  }
}

Response

A list of parcel features

OR

Example response

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

Changes

  • b7a7c93d7494Revision 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_geometry, default value true was removed

    • breaking

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