Parcel Mode is a parameter available in the AI Feature API, which allows you to specify how roof and building features are managed when the feature extends across adjacent parcels. This parameter is typically used with other Nearmap API products such as the RSI, RCCS, Perils Scores, and so on.
By default, the AI Features API treats input AOIs supplied as a polygon or an address as a search area of interest, returning all features found intersecting the AOI. However, often there will be some detections that intersect the AOI that are not relevant to the query, such as a neighboring parcel's building or detections with low confidence. To make results more relevant to the query, the Parcel Model filtering logic, specified using the parcelMode boolean query parameter, can be applied to the intersecting detections. This applies only when the confidence and fidelity of the detection is high enough to make a confident determination.
The parcelMode parameter is applicable only for Gen6 resources.
Parcel Mode enables you to:
- Fetch the features relevant to a single parcel, filtering out features that may intersect the parcel but belong to another parcel
- Analyze large, connected structures such as row-homes that may belong to multiple parcels
- Analyze inclusion of structures that sit alongside, or straddle a property boundary
When Parcel Mode is run:
- Features that are considered to belong to the parcel will be marked with the
belongsToParcel flag - Features that should be clipped will have the
clippedGeometry field added
The resulting discrete features will then be input to downstream models and algorithms to produce data such as RSI, RCCS, Defensible Space, and Peril Scores. For detailed technical information about the algorithms, see the developer documentation.
Quick info
Available for properties in: | USA, AU |
|---|
Available in APIs | AI Features API |
Available in Applications | N/A |
Algorithm Version | A.2 |
Request
Parcel Mode can be enabled by setting the parcelMode parameter to true. The parcelMode parameter can be used along with other parameters such as include for supplementary data sources. By default, if the parcelModeparameter is not set, parcel mode will not be enabled.
Parcel Mode is only available for Gen 6 resources, so when making date-based features requests, systemVersionPrefix=gen6 will also be needed.
Example Request using parcelMode
curl "https://api.nearmap.com/ai/features/v4/features.json?polygon=-112.008154,40.313049,-112.008186,40.312747,-112.008471,40.312771,-112.008424,40.313072,-112.008154,40.313049&systemVersionPrefix=gen6&packs=roof_cond&include=roofConditionConfidenceStats&parcelMode=true&apiKey=xxx"
Response
When parcelMode=true is included in the request, the following fields may be added to features. Existing fields describing feature areas (such as areaSqm) may also be updated depending on the results of the algorithms.
Added to all features:
belongsToParcel: A boolean field indicating whether the feature belongs to the parceltrue: The feature belongs to the parcel and is relevant to analysisfalse: The feature does not belong to the parcel (e.g., neighbor's building)
Added when clipping occurs:
clippedGeometry: The feature geometry clipped to the parcel boundary- Only provided when a feature is determined to need clipping
- Used for multi-parcel buildings (e.g., row houses)
Existing area fields updated:
areaSqm/areaSqm: Feature area (clipped area if clipping occurred, unclipped area otherwise)clippedAreaSqm/clippedAreaSqft: Area of the feature within the parcel boundaryunclippedAreaSqm/unclippedAreaSqft: Total area of the feature (original geometry)
Feature detections that lack the confidence and fidelity levels to make a confident and useful determination of parcel inclusion are excluded and will not be updated.
Sample Response (excerpt):
{ "features": [ { "id": "a625b32f-6fd8-53b8-b577-7ac5a5da040f", "classId": "91987430-6739-5e16-b92f-b830dd7d52a6", "internalClassId": 1099, "description": "Building lifecycle", "confidence": 0.998, "parentId": "", "geometry": { "type": "Polygon", "coordinates": [...] }, "clippedGeometry": { "type": "Polygon", "coordinates": [...] }, "areaSqm": 236, "areaSqft": 2540, "clippedAreaSqm": 222.7, "clippedAreaSqft": 2397, "unclippedAreaSqm": 236, "unclippedAreaSqft": 2540, "attributes": [], "surveyDate": "2025-01-11", "meshDate": "", "isFootprint": false, "belongsToParcel": true } ]}
Additional Resources