REregrid
Query by field

Overview

Changed on

In addition to the primary identifiers in our dataset, our API is also queryable at a nationwide level using a subset of our 120+ schema fields that have been optimized for queries at scale. The following is the general form for this endpoint. See additional query endpoints for examples on each field type. Multiple fields can be used in a single query (up to 4), to refine results. <i>See full list of fields</i>. See full list of fields. Check out Sample Use Case Scenarios in this section. This endpoint allows access to test all of our premium matched datasets.

get/parcels/query

Request

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

Query parameters

fields[:field_name][:operator]string

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

offset_idinteger

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

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.

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 /country/state/county. This restricts the search to this area.

return_countboolean

Set to true to enable count of parcels in query.

return_geometryboolean

Default true. A features are returned without geometry values.

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_custom_idboolean

Default false. Set to true when input GeoJSON features include a 'custom_id' field in the 'properties' object. This flag enables the resulting parcels to include the user-set custom ID for matching parcel(s).

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

  • 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

    • info

      added the new optional query request parameter return_custom_id

    • info

      added the new optional query request parameter return_parcels