v1

latestOpenAPI 3.0.02026-07-26432882.9 KB
Canada

Overview

The Regrid API offers a flexible and dynamic set of features for querying Regrid Parcels by numerous fields, operators, geometries and allows for simple composition of API calls, from the output of one endpoint, to the input of another. Multiple fields can be used in a single query (up to 4), to refine results. <i>See full list of fields</i>. Check out Sample Use Case Scenarios in this section

get/ca/parcels/query

Query parameters

fields[:field_name][:operator]string

Use a supported field name and operator, and value to perform a query.

geojsonstring

A GeoJSON object with at least one geometry to filter results. The geometries can be no larger than 80 sq miles. If both geojson and lat-lon are present, geojson takes precedence. Accepted GeoJSON formats are: FeatureCollection, Feature or geometry. Supported geometries: Polygon, MultiPolygon, Point, MultiPoint, LineString and MultiLineString. Variations of geometry types are allowed in a FeatureCollection.

offset_idinteger

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

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.

limitinteger

Maximum number of Parcel Records to return.

pathstring

Represents the path for the /admin0/admin1/admin2. This restricts the search to this area.

return_countboolean

Set to true to enable count of parcels in query.

return_geometryboolean

Default true. Features are returned without geometry values. This reduces the payload size significantly if only field data is required.

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.

Response

A list of parcel features.

Example response

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