OrthoCoverage Service - v1.4


Introduction

OrthoCoverage will return a JSON file containing ortho imagery coverage information from the Vexcel library. The output JSON will contain the geometry of the geographic coverage for the query. This service is particularly useful to:

  • Identify the locations of ortho imagery

  • See the full extent of an AOI’s ortho coverage


Technical Details

This service operates by process of elimination to identify ortho imagery coverage; by using no refining parameters is it possible to receive complete coverage across the entire Vexcel library. The layer, aoi and wkt parameters can be used to narrow a search for specific types or locations of imagery. While this service primarily exists to provide ortho coverage geometry, a handful of metadata attributes are also available to help identify AOIs.

Output Specifications:

  • JSON file format

  • Metadata:

    • AOI name

    • Coverage Type

    • Min GSD

    • Max GSD

    • Min Capture Date

    • Max Capture Date

    • Layer

    • AOI Area (in km2)

    • geometry

    • Child AOI(s)


Base URL

This service will answer to requests on following URLs:

  • Mandatory parameters only:
    https://api.gic.org/metadata/OrthoCoverage?token={token}

  • All parameters - Defined as Key Value Pairs:
    https://api.gic.org/metadata/OrthoCoverage?layer={layer}&aoi={aoi}&wkt={wkt}epsg={epsg}&format={format}&token={token}


Parameters

Parameter

Parameter Type

Data Type

Description

Example Format

Notes

Parameter

Parameter Type

Data Type

Description

Example Format

Notes

Mandatory:

token

Key Value Pair (KVP)

 

String

The token used to authenticate the requests.

token={token}

Use the Authentication Token Service to receive a token.

A token will temporarily be stored in cache and may be omitted on subsequent calls.

Optional:

layer

Key Value Pair

String

The desired layer(s), separated by commas. If excluded, all layers are returned. 

bluesky-ultra-g
Urban data collected by Geomni

bluesky-ultra
Urban data collected with Osprey (7.5cm GSD)

bluesky-ultra-europe
Urban data collected with Osprey in Europe (7.5 GSD)

bluesky-ultra-oceania
Urban data collected with Osprey in Oceania (7.5 GSD)

bluesky-ultra-japan

Urban data collected with Osprey in Japan (7.5 GSD)

urban-r

Urban data collected with Condor (7.5 GSD)

bluesky-high
Wide area data collected with Condor (20cm GSD)

bluesky-high-europe
Wide area data collected with Condor in Europe (20cm GSD)

graysky-g
Gray Sky data collected by Geomni

graysky
Gray Sky data collected by UltraCam sensors.

layer=bluesky-ultra

 

aoi

Key Value Pair

String

The desired AOI names, separated by commas. If excluded, all AOIs will be returned.

bluesky-ultra-g: aoi=us-al-tuscaloosa_leica-2020

bluesky-ultra: aoi=us-az-avondale-2021

bluesky-ultra-europe: aoi=it-62-rome-2020

bluesky-ultra-oceania: aoi=au-qld-sunshinecoast-2019

bluesky-ultra-japan: aoi=jp-20-matsumoto-2022

urban-r: aoi=us-ok-oklahomacity_rf01-2023

bluesky-high: aoi=USUSCON2001

bluesky-high-europe: aoi=EUEUCON2201

graysky-g: aoi=USAZSTR1805

graysky: aoi=us-la-neworleans-tornado-2022

aoi=EUEUCON2201

or

aoi=us-fl-sebring_midas-2016,USFLSEB1709,USUSCON2101

The available AOI(s) for a point or polygon

childAOI

Key Value Pair

String

Filter by the identifier of the specific childAOI. It will return the coverage of the AOI(s) that contain it, and the specified childAOI.

bluesky-ultra-g: ChildAOI=us-al-tuscaloosa_leica-2020

bluesky-ultra: ChildAOI=us-az-avondale-2021

bluesky-ultra-europe: ChildAOI=it-62-rome-2020

bluesky-ultra-oceania: ChildAOI=au-qld-sunshinecoast-2019

bluesky-ultra-japan: ChildAOI=jp-20-matsumoto-2022

urban-r: ChildAOI=us-ok-oklahomacity_rf01-2023

bluesky-high: ChildAOI=n33w87-us-al-tuscaloosa-2019

bluesky-high-europe: ChildAOI=n53e14-de-bb-templin-2022

graysky-g: ChildAOI=190226/USMSCOLDMC

graysky: ChildAOI=graydata-363

ChildAOI=n53e14-de-bb-templin-2022

 

wkt

Key Value Pair

String

The wkt geometry filters results by geography. AOIs intersecting the specified wkt geometry are returned.

wkt=POINT(12.4920256 41.8897457)

epsg

Key Value Pair

String

The desired EPSG code in which to receive the coordinates of the coverage areas. If excluded the geographic coordinates (Lat/Lon) are returned in EPSG 4326.

epsg=4326

 

format

Key Value Pair

String

The format in which to receive the geometry of the coverage areas. If excluded the format is returned as an array of coordinates.

wkt - formats the geometry as a well known text (wkt)

excluded - formats the geometry as an array of coordinates.

format=wkt

 

include

Key Value Pair

String

Fields to be included on the JSON result, separated by comas.

aoi.avg_gsd - Average GSD of the AOI

aoi.child_aoi.avg_gsd - Average GSD of the Child AOI

include=aoi.avg_gsd

skip

Key Value Pair

String

Fields to be skipped on the JSON result, separated by comas.

skip=aoi.geometry,aoi.child_aoi.coverage


Examples

Colosseum, Rome Italy - Demonstrating format=wkt, wkt=point()
https://api.gic.org/metadata/OrthoCoverage?wkt=POINT(12.4920256 41.8897457)&format=wkt&token={token}

Sample JSON Response (truncated):

{"type":"FeatureCollection","features":[{"type":"Feature","properties":{"AOI":"it-62-rome-2022","Coverage Type":"final-ortho","Min GSD":0.032385413,"Max GSD":0.07353346,"Min Capture date":"2022-03-21 09:08:41","Max Capture date":"2022-06-06 11:12:37","layer":"bluesky-ultra-europe","AOI Area":1849.5967,"AOI Max Zoom":21,"AOI Pretty Name":""},"geometry":{"type":"MultiPolygon","coordinates":[[[[12.16228398875279,41.88934397135958],[12.16854432066376,41.88949861960452],[12.16833755784473,41.89417644529216],[12.18398974089191,41.89456163766927],[12.18409255879133,41.89222269398429],
.
.
.

Coverage Geometry Visualized in QGIS:


Avon Park, Florida - Demonstrating aoi, epsg, and skip
https://api.gic.org/metadata/OrthoCoverage?wkt=POINT(-81.521746 27.653192)&format=wkt&aoi=us-fl-sebring_midas-2016,us-fl-sebringavonpark-2022,us-fl-sebring_hurricaneirma_midas-2017&epsg=2237&skip=aoi.child_aoi&token={token}

Sample JSON Response (truncated):

{"type":"FeatureCollection","features":[{"type":"Feature","properties":{"AOI":"us-fl-sebringavonpark-2022","Coverage Type":"final-ortho","Min GSD":0.07284139,"Max GSD":0.0758724,"Min Capture date":"2022-01-31 20:12:12","Max Capture date":"2022-02-14 20:46:36","layer":"bluesky-ultra","AOI Area":750.1736,"AOI Max Zoom":21,"AOI Pretty Name":""},"geometry":{"type":"MultiPolygon","coordinates":[[[[788923.5922244759,1207551.8284180714],[790892.6583955574,1207567.78038023],[790884.68204655,1208552.3141810552],[791869.2162029505,1208560.2908938925],
.
.
.

Coverage Geometry Visualized in QGIS:

 


Duck Island, NC - Demonstrating layer, and include
https://api.gic.org/metadata/OrthoCoverage?wkt=POLYGON((-75.76103210449217 36.17432692655348, -75.75897216796875 36.16185469422557, -75.73854446411133 36.16199328548835, -75.74043273925781 36.17474263344862, -75.76103210449217 36.17432692655348))&layer=graysky-g,bluesky-ultra-g&include=aoi.avg_gsd&token={token}

Sample JSON Response (truncated):

{"type":"FeatureCollection","features":[{"type":"Feature","properties":{"AOI":"us-nc-killdevilhills_hurricanedorian_leica-2019","Coverage Type":"quick-ortho","Min GSD":0.0730971,"Avg GSD":0.07550501,"Max GSD":0.07697764,"Min Capture date":"2019-09-07 03:18:16","Max Capture date":"2019-09-07 09:28:56","layer":"graysky-g","AOI Area":344.252,"AOI Max Zoom":21,"AOI Pretty Name":""},"geometry":{"type":"MultiPolygon","coordinates":[[[[-75.80980544054586,36.25471849178291],[-75.81076692337972,36.25658243683695],[-75.80292138075582,36.25931500253965],[-75.77270867405406,36.20216271881874],[-75.77743754693152,36.20051328310442],[-75.76393674094328,36.17474539725871],
.
.
.

Coverage Geometry Visualized in QGIS:


External Resources

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