/
GetPropertyDamage - v1.4

GetPropertyDamage - v1.4


Introduction

The GetPropertyDamage service will take a lat/lon coordinate and return a metadata response (JSON or xml) for structures with associated catastrophic damage attributes as well as some pre-damage attributes. This service is run against graysky imagery and is available for all graysky collections from March 2022 and beyond.

  • Damage Assessment

  • Catastrophic Response

  • Insurance Assessments

This is a transactional service; each requests will be billed against the agreed upon rate and aggregated into a billing cycle. Please contact Customer Advocacy at support@vexcelgroup.com.


Technical Details

This Property Damage service provides access to computer-generated post-catastrophe damage assessment information on an individual structure basis. Damage Assessments are precomputed for graysky collections and are available for all graysky events beginning in 2022. catastrophe_score is calculated based on the detected structural_damage_percent, missing_material_percent, tarp_percent and debris_percent. fema_classification is an estimation of damage using FEMA’s classification categories, it is not derived from FEMA nor guaranteed to match FEMA’s official classification but is intended to offer a prediction of FEMA’s survey. The HistoScore attribute will provide an estimate of the source imagery’s clarity or obscurity (cloud, smoke, shadow, etc.). The structure of this service’s response contains an array of structures, within each structure is a post-catastrophe object (damage assessment attributes) and a pre-catastrophe object (attributes similar to what is available from GetPropertyInformation for the target structure’s parcel and all parcel-based attributes, including the pre-catastrophe structure attributes).


Data Dictionary

The following list contains definitions for the objects that are unique to this service. For definitions of all other objects, please reference the Data Dictionary in the GetPropertyInformation service.

Object

 

Description

Unit

Possible Values

Object

 

Description

Unit

Possible Values

damage_
assessments

catastrophe_score

A score representing the catastrophic condition of the roof.

 

0 to 100

fema_classification

An estimation of damage using FEMA’s classification categories.

null - no damage (0)
FEMA 0 / Minor (1-15)
FEMA 1 / Moderate (15-30)
FEMA 2 / Moderate (30-45)
FEMA 3 / Moderate (45-60)
FEMA 4 / Major (60-75)
FEMA 5 / Major (75-90)
FEMA 6 / Destroyed (90-100)

 

ⓘ Beginning September 2022

Wildfire events will only use two classifications:
0 = no damage due to fire (pre-existing damage may be present)
6 = destroyed by fire

 

FEMA 0 to FEMA 6

roof_condition

structural_damage_percent

Percentage of the roof detected as containing structural damage

Percentage

0 to 100

missing_material_percent

Percentage of the roof detected as containing missing material.

Percentage

0 to 100

tarp_percent

Percentage of the roof detected as containing a tarp.

Percentage

0 to 100

debris_percent

Percentage of the roof detected as containing debris.

Percentage

0 to 100

discoloration

detected

Whether the network detected any discoloration on the roof.

 

true, false

percentage

Percentage of the roof containing discoloration.

Percentage

0 to 100

score

A confidence score for the detection.

 

 

source_image_metadata

HistoScore

February 2023

An estimation of the clarity of the source image. 0 = bad clarity, 1 = excellent clarity.

 

0 to 1


Base URL

This service will answer to requests on following URL (mandatory parameters only):

https://api.gic.org/damage/GetPropertyDamage?wkt={wkt}&token={token}


Parameters

Parameter

Parameter Type

Data Type

Description

Example Format

Notes

Parameter

Parameter Type

Data Type

Description

Example Format

Notes

Mandatory:

wkt

Key Value Pair (KVP)

String

The “well-known-text” (WKT) representation of the requested point.

wkt=POINT (-105.34184578917959 35.92483934252866)

The point must fall within a building footprint to return property information.

token

Key Value Pair (KVP)

String

The token used to authenticate the request.

token={token}

Use the Authenticate Service to receive a token.

Optional:

format

Key Value Pair (KVP)

String

The format of the response

json - default - JavaScript Object Notation

xml - Extensible Markup Language

format=json

 

aoi

Key Value Pair (KVP)

String

The identifier of the damage event which contains the imagery from which to derive the structure damage assessment.

aoi=us-la-neworleans-tornado-2022

A single damage event will contain one or more child_aois.

child_aoi

 

 

The identifier of the specific collection flight from which to derive the damage information and building footprints.

child_aoi=graydata-363

 

search_radius

Key Value Pair (KVP)

Integer

The radius in meters with which to search for the nearest intersecting structures.

search_radius=15

 

only_damages

Key Value Pair (KVP)

String

Modifies the response to omit the pre-catastrophe objects.

false - default - returns the full response (both pre-catastrophe and post-catastrophe)

true - the response will not contain any of the information found within the pre-catastrophe object.

only_damages=true

 

unit-system

Key Value Pair (KVP)

String

Determines the unitary system in which values are returned.

metric - default - metric units (meters and sqmeters)

imperial - imperial units (feet and square feet)

unit-system=imperial

 


Examples

Tampa, Florida Hurricane- Demonstrating aoi

https://api.gic.org/damage/GetPropertyDamage?wkt=POINT (-82.497153 27.573122)&aoi=us-fl-milton-hurricane-2024&token={token}

Parameter

Value

Parameter

Value

wkt

POINT (-82.497153 27.573122)

aoi

us-fl-milton-hurricane-2024

token

{token}

Sample Response (Damage Assessment Information only):

. . . "post_catastrophe": { "structure": [ { "catastrophe_score": 0.0, "fema_classification": null, "roof_condition": { "structural_damage_percent": 0.0, "missing_material_percent": 0.0, "tarp_percent": 0.0, "debris_percent": null, "discoloration": { "detected": true, "percentage": 16.31, "score": 0.65 } }, "source_image_metadata": { "camera_technology": "UltraCam_Condor_4.1_f120", "gsd": 3.98, . . .

 

Companion Graysky Image:

 

https://api.gic.org/images/ExtractImages/graysky?mode=one&EPSG=4326&zoom=0&xcoordinate=-82.497153&ycoordinate=27.573122&orientation=Nadir&nadirRotatedNorth=yes&aoi=us-fl-milton-hurricane-2024&width=600&height=400

[ { "post_catastrophe": { "structure": [ { "catastrophe_score": 0.0, "fema_classification": null, "roof_condition": { "structural_damage_percent": 0.0, "missing_material_percent": 0.0, "tarp_percent": 0.0, "debris_percent": null, "discoloration": { "detected": true, "percentage": 16.31, "score": 0.65 } }, "source_image_metadata": { "camera_technology": "UltraCam_Condor_4.1_f120", "gsd": 3.98, "image_id": "2024~us-fl-milton-hurricane-2024~graydata-670~images~NS_20241012_144437_101_389B933C9DCEFC7_rgb", "capture_date": "2024-10-12 00:00:00.0", "version": "3.86.1", "layer_name": "graysky", "aoi": "us-fl-milton-hurricane-2024", "orientation_source": null, "child_aoi": "graydata-670", "HistoScore": null }, "primaryStructure": true } ] }, "pre_catastrophe": { "structure": [ { "source_image_metadata": { "camera_technology": "UltraCam_Osprey_4.1_f120", "gsd": 3.11, "image_id": "Ortho_us-fl-stpetersburg-2024_567994_881364_3_3_21_bluesky-ultra", "capture_date": "2024-02-21 00:00:00.0", "version": "3.86.1", "layer_name": "bluesky-ultra", "aoi": "us-fl-stpetersburg-2024", "orientation_source": "ORTHO", "child_aoi": null, "HistoScore": null }, "roof_condition_report": { "discolorated": { "detected": null, "percentage": null, "score": null }, "Missing Material": null, "Tarp": null }, "roof_condition": { "value": 4.0 }, "footPrint": { "area": 307.9765666200496, "wkt": "POLYGON((-82.49723809075162 27.573218910272285,-82.49715877681008 27.573218910273557,-82.49715834480564 27.573177502600036,-82.49713564161337 27.573177690686016,-82.49713581522994 27.57319433219609,-82.49708743292962 27.573194733010087,-82.49708725244045 27.573177432021854,-82.4970450069429 27.57317778198263,-82.49704363801305 27.5730465562766,-82.4971916898963 27.57304532976863,-82.49719200419821 27.57307545498874,-82.49723659013631 27.573075085593512,-82.49723809075162 27.573218910272285))" }, "ground_elevation": { "value": 8.8392 }, "primaryStructure": true, "roof_material": { "score": 1.0, "class": "shingle" }, "roof_shape": { "value": "hip", "score": null }, "roof_solar": { "value": "false", "score": 0.0 }, "tree_cover": { "percent": 0.0 }, "roof_top_location": { "wkt": "POINT(-82.49714079868643 27.573126443505295)" }, "defensible_space": { "image": { "image_id": null, "regionContained": false }, "report": { "DSB5": 0.0, "DSB30": 11.0, "DSB100": 11.0, "DSB200": 13.0, "DST5": 5.0, "DST30": 12.0, "DST100": 12.0, "DST200": 18.0 }, "status": "SUCCESS" } } ], "property_features": { "pool": { "detected": false, "score": 0.0, "area": null }, "parcel_wkt": "POLYGON((-82.49725052216716 27.572967360899558,-82.4972535498311 27.57326972668121,-82.49702220408653 27.573271545170282,-82.49701920442742 27.57296918469331,-82.49725052216716 27.572967360899558))", "parcel_source": "unknown", "sport_court": { "detected": false, "score": 0.0 }, "playground": { "detected": false, "score": 0.0 }, "deck": { "area": null, "detected": false, "score": 0.0 }, "trampoline": { "detected": false, "score": 0.0 }, "enclosure": { "detected": false, "score": 0.0 }, "water_slide": { "detected": false, "score": 0.0 }, "diving_board": { "detected": false, "score": 0.0 }, "parcel_tree_cover": null, "hardscapes": null } }, "input_metadata": { "requested_wkt": "POINT (-82.497153 27.573122)", "inside_parcel": true, "request_id": null } }, { "post_catastrophe": { "structure": [ { "catastrophe_score": 0.0, "fema_classification": null, "roof_condition": { "structural_damage_percent": 0.0, "missing_material_percent": 0.0, "tarp_percent": 0.0, "debris_percent": null, "discoloration": { "detected": true, "percentage": 18.14, "score": 0.61 } }, "source_image_metadata": { "camera_technology": "UltraCam_Condor_4.1_f120", "gsd": 3.96, "image_id": "2024~us-fl-milton-hurricane-2024~graydata-648~images~NN_20241010_175746_101_389B93277B9DFD0_rgb", "capture_date": "2024-10-10 00:00:00.0", "version": "3.86.1", "layer_name": "graysky", "aoi": "us-fl-milton-hurricane-2024", "orientation_source": null, "child_aoi": "graydata-648", "HistoScore": null }, "primaryStructure": true } ] }, "pre_catastrophe": { "structure": [ { "source_image_metadata": { "camera_technology": "UltraCam_Osprey_4.1_f120", "gsd": 3.11, "image_id": "Ortho_us-fl-stpetersburg-2024_567994_881364_3_3_21_bluesky-ultra", "capture_date": "2024-02-21 00:00:00.0", "version": "3.86.1", "layer_name": "bluesky-ultra", "aoi": "us-fl-stpetersburg-2024", "orientation_source": "ORTHO", "child_aoi": null, "HistoScore": null }, "roof_condition_report": { "discolorated": { "detected": null, "percentage": null, "score": null }, "Missing Material": null, "Tarp": null }, "roof_condition": { "value": 4.0 }, "footPrint": { "area": 307.9765666200496, "wkt": "POLYGON((-82.49723809075162 27.573218910272285,-82.49715877681008 27.573218910273557,-82.49715834480564 27.573177502600036,-82.49713564161337 27.573177690686016,-82.49713581522994 27.57319433219609,-82.49708743292962 27.573194733010087,-82.49708725244045 27.573177432021854,-82.4970450069429 27.57317778198263,-82.49704363801305 27.5730465562766,-82.4971916898963 27.57304532976863,-82.49719200419821 27.57307545498874,-82.49723659013631 27.573075085593512,-82.49723809075162 27.573218910272285))" }, "ground_elevation": { "value": 8.8392 }, "primaryStructure": true, "roof_material": { "score": 1.0, "class": "shingle" }, "roof_shape": { "value": "hip", "score": null }, "roof_solar": { "value": "false", "score": 0.0 }, "tree_cover": { "percent": 0.0 }, "roof_top_location": { "wkt": "POINT(-82.49714079868643 27.573126443505295)" }, "defensible_space": { "image": { "image_id": null, "regionContained": false }, "report": { "DSB5": 0.0, "DSB30": 11.0, "DSB100": 11.0, "DSB200": 13.0, "DST5": 5.0, "DST30": 12.0, "DST100": 12.0, "DST200": 18.0 }, "status": "SUCCESS" } } ], "property_features": { "pool": { "detected": false, "score": 0.0, "area": null }, "parcel_wkt": "POLYGON((-82.49725052216716 27.572967360899558,-82.4972535498311 27.57326972668121,-82.49702220408653 27.573271545170282,-82.49701920442742 27.57296918469331,-82.49725052216716 27.572967360899558))", "parcel_source": "unknown", "sport_court": { "detected": false, "score": 0.0 }, "playground": { "detected": false, "score": 0.0 }, "deck": { "area": null, "detected": false, "score": 0.0 }, "trampoline": { "detected": false, "score": 0.0 }, "enclosure": { "detected": false, "score": 0.0 }, "water_slide": { "detected": false, "score": 0.0 }, "diving_board": { "detected": false, "score": 0.0 }, "parcel_tree_cover": null, "hardscapes": null } }, "input_metadata": { "requested_wkt": "POINT (-82.497153 27.573122)", "inside_parcel": true, "request_id": null } } ]

________________________________________________________________________________________

Camarillo Mountain, California Fire - Demonstrating format and search_radius

https://api.gic.org/damage/GetPropertyDamage?wkt=POINT(-119.061084 34.248623)&format=xml&search_radius=10&token={token}

Parameter

Value

Parameter

Value

wkt

POINT(-119.061084 34.248623)

format

xml

search_radius

10

token

{token}

Sample Response (Damage Assessment Information only):

<properties> <property> <post_catastrophe> <structure> <catastrophe_score>100.0</catastrophe_score> <fema_classification>FEMA 6 / Destroyed</fema_classification> <roof_condition> <tarp_percent>null</tarp_percent> <discoloration> <score>null</score> <percentage>null</percentage> <detected>null</detected> </discoloration> <debris_percent>null</debris_percent> <missing_material_percent>null</missing_material_percent> <structural_damage_percent>null</structural_damage_percent> </roof_condition> <source_image_metadata> <child_aoi>graydata-707</child_aoi> . . .

 

Companion Graysky Image:

 

https://api.gic.org/images/ExtractImages/graysky?mode=one&EPSG=4326&zoom=0&xcoordinate=-119.061084&ycoordinate=34.248623&orientation=Nadir&nadirRotatedNorth=yes&aoi=us-ca-camarillomountain-fire-2024&width=2400&height=1600

<properties> <property> <post_catastrophe> <structure> <catastrophe_score>100.0</catastrophe_score> <fema_classification>FEMA 6 / Destroyed</fema_classification> <roof_condition> <tarp_percent>null</tarp_percent> <discoloration> <score>null</score> <percentage>null</percentage> <detected>null</detected> </discoloration> <debris_percent>null</debris_percent> <missing_material_percent>null</missing_material_percent> <structural_damage_percent>null</structural_damage_percent> </roof_condition> <source_image_metadata> <child_aoi>graydata-707</child_aoi> <capture_date>null</capture_date> <camera_technology>null</camera_technology> <HistoScore>null</HistoScore> <gsd>null</gsd> <aoi>us-ca-camarillomountain-fire-2024</aoi> <image_id>null</image_id> <version>null</version> <layer_name>graysky</layer_name> <orientation_source>null</orientation_source> </source_image_metadata> <primaryStructure>false</primaryStructure> </structure> <structure> <catastrophe_score>100.0</catastrophe_score> <fema_classification>FEMA 6 / Destroyed</fema_classification> <roof_condition> <tarp_percent>null</tarp_percent> <discoloration> <score>null</score> <percentage>null</percentage> <detected>null</detected> </discoloration> <debris_percent>null</debris_percent> <missing_material_percent>null</missing_material_percent> <structural_damage_percent>null</structural_damage_percent> </roof_condition> <source_image_metadata> <child_aoi>graydata-707</child_aoi> <capture_date>null</capture_date> <camera_technology>null</camera_technology> <HistoScore>null</HistoScore> <gsd>null</gsd> <aoi>us-ca-camarillomountain-fire-2024</aoi> <image_id>null</image_id> <version>null</version> <layer_name>graysky</layer_name> <orientation_source>null</orientation_source> </source_image_metadata> <primaryStructure>true</primaryStructure> </structure> </post_catastrophe> <input_metadata> <inside_parcel>true</inside_parcel> <requested_wkt>POINT(-119.061084 34.248623)</requested_wkt> <request_id>null</request_id> </input_metadata> <pre_catastrophe> <property_features> <enclosure> <score>0.0</score> <detected>false</detected> </enclosure> <sport_court> <score>0.0</score> <detected>false</detected> </sport_court> <deck> <area>null</area> <score>0.0</score> <detected>false</detected> </deck> <pool> <area>null</area> <score>1.0</score> <detected>true</detected> </pool> <playground> <score>0.0</score> <detected>false</detected> </playground> <trampoline> <score>0.0</score> <detected>false</detected> </trampoline> <parcel_wkt>POLYGON((-119.06131395938546 34.248447820866346,-119.0613147719304 34.248768393347746,-119.06075127065287 34.24876947056299,-119.0607504624433 34.24844889805875,-119.06131395938546 34.248447820866346))</parcel_wkt> <water_slide> <score>0.0</score> <detected>false</detected> </water_slide> <parcel_source>unknown</parcel_source> <diving_board> <score>0.0</score> <detected>false</detected> </diving_board> <parcel_tree_cover>null</parcel_tree_cover> <hardscapes>null</hardscapes> </property_features> <structure> <roof_condition_report> <Missing_material>null</Missing_material> <Tarp>null</Tarp> <discolorated> <score>null</score> <percentage>null</percentage> <detected>null</detected> </discolorated> </roof_condition_report> <roof_condition> <value>4.0</value> </roof_condition> <source_image_metadata> <child_aoi>null</child_aoi> <capture_date>2024-08-02 00:00:00.0</capture_date> <camera_technology>UltraCam_Condor_4.1_f120</camera_technology> <HistoScore>null</HistoScore> <gsd>2.65</gsd> <aoi>us-ca-oxnard_rf08-2024</aoi> <image_id>Ortho_us-ca-oxnard_rf08-2024_354995_835995_2_2_21_urban-r</image_id> <version>null</version> <layer_name>urban-r</layer_name> <orientation_source>ORTHO</orientation_source> </source_image_metadata> <primaryStructure>false</primaryStructure> <roof_solar> <score>0.0</score> <value>false</value> </roof_solar> <footPrint> <area>26.732976580735247</area> <wkt>POLYGON((-119.0608274533735 34.24867715947011,-119.06082533016618 34.24863553479631,-119.0608880657286 34.24863332809827,-119.06089018896665 34.2486749527699,-119.0608274533735 34.24867715947011))</wkt> </footPrint> <roof_material> <score>1.0</score> <class>shingle</class> </roof_material> <roof_shape> <score>null</score> <value>hip</value> </roof_shape> <tree_cover> <percent>9.0</percent> </tree_cover> <defensible_space> <image> <regionContained>false</regionContained> <image_id>null</image_id> </image> <report> <DST5>38.0</DST5> <DSB5>0.0</DSB5> <DSB30>0.0</DSB30> <DSB200>19.0</DSB200> <DSB100>18.0</DSB100> <DST30>23.0</DST30> <DST100>26.0</DST100> <DST200>20.0</DST200> </report> <status>SUCCESS</status> </defensible_space> <roof_top_location> <wkt>POINT(-119.06085775955911 34.248655243783105)</wkt> </roof_top_location> <ground_elevation> <value>179.22240000000002</value> </ground_elevation> </structure> <structure> <roof_condition_report> <Missing_material>null</Missing_material> <Tarp>null</Tarp> <discolorated> <score>null</score> <percentage>null</percentage> <detected>null</detected> </discolorated> </roof_condition_report> <roof_condition> <value>3.0</value> </roof_condition> <source_image_metadata> <child_aoi>null</child_aoi> <capture_date>2024-08-02 00:00:00.0</capture_date> <camera_technology>UltraCam_Condor_4.1_f120</camera_technology> <HistoScore>null</HistoScore> <gsd>2.65</gsd> <aoi>us-ca-oxnard_rf08-2024</aoi> <image_id>Ortho_us-ca-oxnard_rf08-2024_354993_835994_3_5_21_urban-r</image_id> <version>null</version> <layer_name>urban-r</layer_name> <orientation_source>ORTHO</orientation_source> </source_image_metadata> <primaryStructure>true</primaryStructure> <roof_solar> <score>0.0</score> <value>false</value> </roof_solar> <footPrint> <area>493.39239064171943</area> <wkt>POLYGON((-119.06099817420433 34.24878190996804,-119.06099760157899 34.24865216711442,-119.06098652012608 34.24865220083984,-119.06098616353685 34.24857140265684,-119.06096765846733 34.24857145897248,-119.06096126625563 34.248565420313675,-119.06098100170672 34.24856536025464,-119.06098089545736 34.24854128505937,-119.06098836288014 34.24854126233371,-119.06098902831187 34.24857316514484,-119.06099773699457 34.24857313864092,-119.06099707656966 34.24849452761074,-119.06105419885422 34.24849435375207,-119.06105411239716 34.248474766959994,-119.06109593251841 34.24847476695993,-119.06109601498322 34.24849344721637,-119.06114724424867 34.24849329125371,-119.06114795311744 34.248653842592994,-119.0611795408185 34.24865374641435,-119.0611799763293 34.248752374575375,-119.06116604804994 34.248769644289595,-119.06115410547929 34.248772934872925,-119.06112391726387 34.248773026785706,-119.06110838055612 34.24876798145044,-119.06108421621254 34.24878164806797,-119.06099817420433 34.24878190996804))</wkt> </footPrint> <roof_material> <score>0.9</score> <class>tile</class> </roof_material> <roof_shape> <score>null</score> <value>hip</value> </roof_shape> <tree_cover> <percent>8.0</percent> </tree_cover> <defensible_space> <image> <regionContained>false</regionContained> <image_id>null</image_id> </image> <report> <DST5>52.0</DST5> <DSB5>0.0</DSB5> <DSB30>6.0</DSB30> <DSB200>17.0</DSB200> <DSB100>13.0</DSB100> <DST30>38.0</DST30> <DST100>22.0</DST100> <DST200>18.0</DST200> </report> <status>SUCCESS</status> </defensible_space> <roof_top_location> <wkt>POINT(-119.06106705848038 34.24861266612963)</wkt> </roof_top_location> <ground_elevation> <value>178.61280000000002</value> </ground_elevation> </structure> </pre_catastrophe> </property> </properties>

See Also

External Resources

Note, the following resources are external to Vexcel and may change without prior notice.

Related content

Need help? Create a support ticket | support@vexcelgroup.com