Property measurement

Create a parcel site

Measure exactly the parcel you choose from FindParcels, instead of the one Duranta picks from the address. Pass the externalId of a site that ended with PARCEL_AMBIGUOUS to measure it on this parcel. Otherwise works like CreateSite; read the result with GetSite or ListSites. See [Choosing the parcel](/parcels/).

POST
/duranta.api.public.v1.SiteService/CreateParcelSite

Authorization

Authorizationheaderrequired

Bearer token with the sites:scan scope. You get it in exchange for an API key: see Authentication, or press Try in Playground, which takes your key and gets the token for you.

Request body

application/json
  1. body
externalId*string

Your identifier for the property, as in CreateSite. Reuse the externalId of a site that ended with PARCEL_AMBIGUOUS: it is measured on this parcel and keeps its identifier. Any other externalId that already exists with a different parcel, aiModel or propertyBoundary, or that was created by CreateSite, fails with already_exists. At most 1024 bytes.

parcelId*string

The parcelId from FindParcels. An unknown one fails with not_found. At most 256 bytes.

address*

US street address of the property, stored with the site and shown in the Duranta app. It is not looked up again. line1, city, region and postalCode are required.

tier*ResultTier

As in CreateSite.

One of"RESULT_TIER_IMAGE""RESULT_TIER_IMAGE_AND_SEGMENTS""RESULT_TIER_IMAGE_SEGMENTS_AND_SHARE_LINK"
aiModel?AiModel

As in CreateSite.

One of"AI_MODEL_AUTO""AI_MODEL_RESIDENTIAL""AI_MODEL_COMMERCIAL_FAST""AI_MODEL_COMMERCIAL_MAKROS"
propertyBoundary?PropertyBoundary

As in CreateSite. PROPERTY_BOUNDARY_ESTIMATED estimates the service area around this parcel.

One of"PROPERTY_BOUNDARY_OFFICIAL""PROPERTY_BOUNDARY_ESTIMATED"

Response

Success

application/json
  1. response

A property submitted for measurement. Measurement fields are set only when status is SITE_STATUS_COMPLETED, and only those that tier includes.

externalId?string

Your identifier for the property, as you submitted it.

address?

The address as you submitted it.

status?SiteStatus

Where the site is in measurement.

One of"SITE_STATUS_ACCEPTED""SITE_STATUS_ISSUE""SITE_STATUS_COMPLETED""SITE_STATUS_FAILED"
error?

Set when status is SITE_STATUS_ISSUE or SITE_STATUS_FAILED. code is one of ADDRESS_NOT_FOUND (the address does not resolve to a location), PARCEL_AMBIGUOUS (the address lookup services place the address on different parcels with no majority; use FindParcels and CreateParcelSite), PARCEL_NOT_FOUND (no parcel at the location), INSUFFICIENT_CREDITS (the credit balance is below zero; send the site again once credits are added), or SCAN_FAILED (the scan could not produce measurements).

appUrl?string

Link to the property in the Duranta app, for a person to review or correct it. Requires a Duranta login to open.

location?

Geocoded point for the address.

parcelAreaSqFt?number

Area of the parcel boundary, in square feet.

Formatdouble
surfaces?array<>

Every surface type the scan reports. Tree and shrub canopy overlap the surfaces beneath them, so the areas can sum to more than the parcel. Set from RESULT_TIER_IMAGE_AND_SEGMENTS up.

boundary?

The parcel outline the scan was clipped to, as a GeoJSON MultiPolygon. Set by GetSite from RESULT_TIER_IMAGE_AND_SEGMENTS up.

image?

The measurement map. Set by GetSite for every tier, unless the site has no parcel to draw.

submittedAt?string

When you submitted the site.

Formatdate-time
tier?ResultTier

The tier chosen in CreateSite.

One of"RESULT_TIER_IMAGE""RESULT_TIER_IMAGE_AND_SEGMENTS""RESULT_TIER_IMAGE_SEGMENTS_AND_SHARE_LINK"
shareUrl?string

Read-only public link to the measurement map, no login needed. Anyone with the link can open it. Set for RESULT_TIER_IMAGE_SEGMENTS_AND_SHARE_LINK once the site is completed. Moving the site to a lower tier revokes the link.

aiModel?AiModel

AI_MODEL_AUTO until the scan picks a model, then the model that ran. Never unspecified.

One of"AI_MODEL_AUTO""AI_MODEL_RESIDENTIAL""AI_MODEL_COMMERCIAL_FAST""AI_MODEL_COMMERCIAL_MAKROS"
propertyBoundary?PropertyBoundary

The property boundary the site was created with. Never unspecified.

One of"PROPERTY_BOUNDARY_OFFICIAL""PROPERTY_BOUNDARY_ESTIMATED"
updatedAt?string

When the site last changed in a way you can see: a scan result, a status change, a tier change, or a correction made in the Duranta app.

Formatdate-time
revision?string

Starts at 1 and increases on every change that moves updatedAt. Compare it to tell whether a site changed since you last read it.

Formatint64
Create a parcel site
curl -X POST \  'https://app.getduranta.com/duranta.api.public.v1.SiteService/CreateParcelSite' \  -H 'Content-Type: application/json' \  -d '{  "externalId": "string",  "parcelId": "string",  "address": {},  "tier": "RESULT_TIER_IMAGE"}'
Response
{  "externalId": "string",  "address": {    "line1": "string",    "line2": "string",    "city": "string",    "region": "string",    "postalCode": "string",    "country": "string"  },  "status": "SITE_STATUS_ACCEPTED",  "error": {    "code": "string",    "message": "string"  },  "appUrl": "string",  "location": {    "latitude": 0.1,    "longitude": 0.1  },  "parcelAreaSqFt": 0.1,  "surfaces": [    {      "type": "SURFACE_TYPE_LAWN",      "areaSqFt": 0.1,      "geometry": {        "type": "MultiPolygon",        "coordinates": [          [            [              [                0,                0              ]            ]          ]        ]      },      "perimeterFt": 0.1,      "segmentCount": 0,      "areaExclTreesSqFt": 0    }  ],  "boundary": {    "type": "MultiPolygon",    "coordinates": [      [        [          [            0,            0          ]        ]      ]    ]  },  "image": {    "contentType": "string",    "data": "string"  },  "submittedAt": "2023-01-15T01:30:15.01Z",  "tier": "RESULT_TIER_IMAGE",  "shareUrl": "string",  "aiModel": "AI_MODEL_AUTO",  "propertyBoundary": "PROPERTY_BOUNDARY_OFFICIAL",  "updatedAt": "2023-01-15T01:30:15.01Z",  "revision": "string"}