GetPropertyInformation - v1.4
Introduction
The GetPropertyInformation service will take a lat/lon coordinate and return a metadata response (JSON or xml) for a single parcel with associated property attributes including building structures and their respective attributes and footprint geometry.
Assess insurable property features and condition
Display building footprints
Property feature change detection
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
The Property Information service provides access to computer-generated property information on a parcel basis. Some attributes are parcel-specific while most are building-specific. All numeric units are metric as either meters or square meters (Imperial is now available as an option with unit-system). Property information can be generated against bluesky-ultra or bluesky-high, it is being precomputed in select locations (see table below) and is available on-demand worldwide. On-Demand requests for structure attributes are available worldwide wherever imagery exists. On-Demand requests for property attributes are limited by parcel availability. We will be continually indexing property information and parcel data to expand our coverage.
Property Information precomputed shortly after imagery is published. For bluesky-ultra and bluesky-ultra-r all AOIs are precomputed. bluesky-high is precomputed only in locations in which there is no bluesky-ultra or bluesky-ultra-r coverage within the previous 12 months.
When a request is made to GetPropertyInformation, the response will vary depending on if the property has been precomputed or not:
Precomputed - The property attributes are cached in a database; the property information will return in the REST body with little delay.
On-Demand - The property information is not cached in a database but can be calculated on-demand (with the
permit-on-demandparameter). The REST body will return arequest_idand indicate that the property is not immediately available, and a user will have two options to receive the property information: Callback URL or Download Service. Additionally, the GetStatus service can be used to query the status of an On-Demand request.Callback URL - If a callback url was provided, Vexcel will send the property information to the callback url as soon as it is computed. This will require a user to have a callback server with which to listen for callback responses. See the External Resources section for more information.
Download Service - This is a multi-service process in which a user will use the provided
request_idto download the property information via the Download service.
Location | Precomputed using: | On-Demand* containing: | ||
|---|---|---|---|---|
bluesky-ultra | bluesky-high | Structure Attributes | Property Attributes | |
United States | ||||
Canada | ||||
Puerto Rico | ||||
Australia | ||||
Germany | North Rhine Westphalia Other Regions TBD | |||
Italy | Some Regions Available | |||
Rest of World | (more countries will be added) | |||
Last updated: May 2023
*where imagery coverage exists
Data Dictionary
The following list contains the available objects available from this service.
There may be slight variations in object names.
New objects are occasionally added. Previously precomputed properties may not contain new objects.
Properties that are not pre-computed will return back
nullin the property features response
Object | Description | Unit or Possible Values | ||||||
|---|---|---|---|---|---|---|---|---|
structures | {
Each building in a separate object | footprint | area | Area of the building footprint | Meters | |||
wkt | Geometry of the building footprint (WKT Polygon) |
| ||||||
ground_elevation | value | Ground elevation, derived from DTM, measured at the center of a bounding box surrounding the structure geometry. | Meters | |||||
metadata | camera_technology | Type of camera used for imagery collection |
| |||||
gsd | Ground sample distance (average pixel size) | Meters | ||||||
image_id | The name of the source image |
| ||||||
version | Version of the Auto GPE pipeline used to produce this property information. |
| ||||||
layer_name | Layer name of the source imagery |
| ||||||
primaryStructure | Identifies if the building is the primary structure on the property | true, false | ||||||
roof_condition | value | Condition of the roof. 5 - Roof is in great condition - No visible signs of defects. It looks new 4 - Roof is in good condition - Minimal signs of defects. Defects are cosmetic and do not affect the function and safety of the roof. 3 - Roof is in fair condition - Discoloration and damage are present but not as pronounced as scores 1 and 2. Defects may affect the function and safety of the roof if not addressed. 2 - Roof is in poor condition - Pronounced signs of defects that affect the function and safety of the roof. the damage is primarily at the barrier or surface materials. 1 - Roof is in bad condition - Pronounced signs of defects that significantly affect the function and safety of the roof. The damage is beyond the barrier or surface materials. | 1 to 5 | |||||
roof_condition_report | discolorated | detected | Whether the network detected any discoloration | true, false | ||||
percentage | Percentage of detected discoloration that covers the roof | Percentage (0 - 100) | ||||||
score | A confidence score for the detection | 0 to 1 | ||||||
types | algae_staining | detected | Whether algae staining was detected | true, false | ||||
percentage | Percentage of the full roof that has detected algae staining | Percentage (0 - 100) | ||||||
score | A confidence score for the detection | 0 to 1 | ||||||
vent_staining | detected | Whether vent staining was detected | true, false | |||||
percentage | Percentage of the full roof that has detected vent staining | Percentage (0 - 100) | ||||||
score | A confidence score for the detection | 0 to 1 | ||||||
water_pooling | detected | Whether water pooling was detected | true, false | |||||
percentage | Percentage of the full roof that has detected water pooling | Percentage (0 - 100) | ||||||
score | A confidence score for the detection | 0 to 1 | ||||||
Debris | detected | Whether debris was detected | true, false | |||||
percentage | Percentage of the full roof that was covered by debris | Percentage (0 - 100) | ||||||
score | A confidence score for the detection | 0 to 1 | ||||||
Missing Material | detected | Whether missing material was detected | true, false | |||||
percentage | Percentage of the full roof that has detected missing material | Percentage (0 - 100) | ||||||
score | A confidence score for the detection | 0 to 1 | ||||||
Tarp | detected | Whether a tarp was detected | true, false | |||||
percentage | Percentage of the full roof that is covered by tarp | Percentage (0 - 100) | ||||||
score | A confidence score for the detection | 0 to 1 | ||||||
roof_material | class | Predominant material used for the roof | shingle, tile, metal, shake, gravel, membrane | |||||
score | A confidence score for the detection | 0 to 1 | ||||||
roof_shape | value | Predominant architectural style used for the roof. hip = all sides slope down, gable = two opposing sides slope down, flat = less than 2/12 slope | hip, gable, flat | |||||
score | A confidence score for the detection | 0 to 1 | ||||||
roof_solar | value | Indicates whether the roof contains one or more solar panels | Solar panel, No solar panel | |||||
score | A confidence score for the detection | 0 to 1 | ||||||
roof_elements | ac_unit | count | A count of air conditioning units found on the roof |
| ||||
chimney | count | A count of chimneys found on the roof |
| |||||
roof_vent | count | A count of roof vents found on the roof |
| |||||
satellite_dish | count | a count of satellite dishes found on the roof |
| |||||
skylight | count | A count of skylights found on the roof |
| |||||
tree_cover | percent | Percentage of structure covered by trees | Percentage (0 - 100) | |||||
roof_top_location | wkt | Centroid of the building footprint (WKT Point) |
| |||||
defensible_space | image | image_id | Name of the image |
| ||||
region_contained | Indicates whether the image contains the full 100 ft buffer surrounding the building. If false, values are reported for areas with imagery coverage. | true, false | ||||||
report *DSx formulas below | DSB5 | A percentage representing how much of the region within 5 ft around a structure contains other structures. | Percentage (0 - 100+) | |||||
DST5 | A percentage representing how much of the region within 5 ft around and over a structure contain trees. | Percentage (0 - 100+) | ||||||
DSB30 | A percentage representing how much of the region within 30 ft around a structure contains other structures. | Percentage (0 - 100+) | ||||||
DST30 | A percentage representing how much of the region within 30 ft around and over a structure contain trees. | Percentage (0 - 100+) | ||||||
DSB100 | A percentage representing how much of the region within 100 ft around a structure contains other structures. | Percentage (0 - 100+) | ||||||
DST100 | A percentage representing how much of the region within 100 ft around and over a structure contain trees. | Percentage (0 - 100+) | ||||||
DSB200 | A percentage representing how much of the region within 200 ft around a structure contains other structures. | Percentage (0 - 100+) | ||||||
DST200 | A percentage representing how much of the region within 200 ft around and over a structure contain trees. | Percentage (0 - 100+) | ||||||
status | Whether the report generation was successful or not | SUCCESS, FAIL | ||||||
status_msg | Description of the failure if status:fail |
| ||||||
roof_elevation | value | Elevation of the roof_top_location above sea level derived from DSM | Meters | |||||
roof_height | value | Height of the roof_top_location above ground. Measured by subtracting DTM from DSM at roof_top_location | Meters | |||||
capture_date | Capture date of the source image. | YYYY-MM-DD | ||||||
ortho_date_estimate | The estimated date of the pixels comprising the source ortho image. | MMM DD, YYY | ||||||
property_features | ||||||||
Need help? Create a support ticket | support@vexcelgroup.com