PropertyReport - v1.4

Owned by Scott Jonker
Jan 09, 2023
3 min read

Introduction

The property/report service will return an Elements: Property Report PDF file tailored to the user’s specifications. This report will contain a combination of Blue Sky imagery and attributes for a property, formatted into a clean and easily consumable format without requiring a user to make multiple calls to GetPropertyInformation, ExtractImage, ExtractNIRImage, etc.

 

 

Note: For a similar report containing Gray Sky imagery and damage attributes, use the DamageReport service.

 

 

Technical Details

By default the report will return:

  • Blue Sky AI-generated property and parcel attributes (Attribute list)

  • 5-way image orientations from the most recent Blue Sky collection:

    • Nadir (Vertical) and Oblique (North, South, East, West)

With additional options:

  • Imperial vs Metric units

  • Additional historical Blue Sky imagery

  • Additional historical Gray Sky imagery

  • Most-recent Color Infrared imagery

 

Base URL

https://api.gic.org/property/report/

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 or polygon. If a polygon is passed, the polygon centroid will be used.

wkt=POINT(-118.451501 34.085102)

wkt=POLYGON((-118.451728 34.085492,-118.451075 34.085375,-118.450813 34.085396,-118.450822 34.085370,-118.450827 34.085343,-118.450828 34.085315,-118.450790 34.084985,-118.450969 34.084736,-118.451801 34.084960,-118.452021 34.085351,-118.451971 34.085355,-118.451922 34.085365,-118.451875 34.085380,-118.451832 34.085401,-118.451792 34.085427,-118.451757 34.085458,-118.451728 34.085492))

The point or polygon centroid must fall within a parcel 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:

aoi

Key Value Pair (KVP)

String

The identifier of the Area of Interest (AOI) which contains the imagery from which to derive the property information and building footprints.

aoi=us-ca-losangeles-2021

 

bluesky-childAOIs

Key Value Pair (KVP)

String

This parameter will append extra pages with additional Blue Sky ultra imagery from the defined Child AOI(s). Multiple Child AOI(s) to be separated with a comma.

bluesky-childAOIs=us-tn-knoxville-2021,us-tn-knoxville-2020

 

bluesky-high-childAOIs

Key Value Pair (KVP)

String

This parameter will append extra pages with additional Blue Sky High imagery from the defined Child AOI(s). Multiple Child AOI(s) to be separated with a comma.

bluesky-high-childAOIs=n36w83-us-tn-morristown-2020,n36w84-us-tn-oneida-2021

 

graysky-childAOIs

Key Value Pair (KVP)

String

This parameter will append extra pages with additional Gray Sky imagery from the defined Child AOI(s). Multiple Child AOI(s) to be separated with a comma.

graysky-childAOIs=graydata-395,graydata-399,us-sc-irma-hurricane_block3-2017

 

infrared-childAOIs

Key Value Pair (KVP)

String

This parameter will append extra pages with additional Blue Sky infrared imagery from the defined Child AOI(s). Multiple Child AOI(s) to be separated with a comma.

infrared-childAOIs=us-fl-fortlauderdaler1-2021,graydata-447

 

unit-system

Key Value Pair (KVP)

String

The system of measurement with which to return values in the report.

metric - default - metric system (m, m2, etc)

imperial - imperial system (ft, ft2, etc)

unit-system=imperial

 

skip-categories

Key Value Pair (KVP)

String

A list of content types to omit from the report. Multiple values to be separated with a comma.

property_attributes

primary_structure_attributes

secondary_structure_attributes

property_imagery

historical_imagary

historical_infrared

skip-categories=primary_attributes,property_imagery

 

alt-image

Key Value Pair (KVP)

String

Determines how to handle pages containing images which are unavailable.

drop-slide - default - Any slide containing missing images will be removed from the PDF

template - the image from the template will be left unchanged

placeholder - A 'Not Found' placeholder image will be used.

alt-image=drop-slide

 

Examples

Eames House, Los Angeles, California - mandatory parameters only
https://api.gic.org/property/report?wkt=POINT(-118.518844 34.030117)

 

Table of Parameters

Parameter

Value

Parameter

Value

wkt

POINT(-118.518844 34.030117)

token

{token}

Full Response File:

See Also

 

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