REregrid
Canada

Address Search

Changed on

This endpoint delivers parcels using an address within Canada. There can be multiple locations within Canada with similar addresses and therefore we suggest specifying the location within an admin1 and/or admin2 by using the path parameter.

get/ca/parcels/address

Request

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

Query parameters

querystring required

A street address or partial address, starting at the beginning

pathstring

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

limitinteger

Maximum number of Parcel Records to return.

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

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_stacked, default value true was removed