Introduction

ImageLayerCoverage will return a JSON file containing coverage of discrete imagery 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 available layers available over a given location
Compare coverage between sensor types (layers)
See the full extent of an AOI’s coverage

Technical Details

This service operates by process of elimination to identify discrete imagery coverage; by using no refining parameters it is 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 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
- geometry
- Child AOI(s)

Base URL

This service responds to requests from the following URLs:

Mandatory parameters only:
https://api.gic.org/metadata/ImageLayerCoverage?token={token}
All parameters - Defined as Key Value Pairs:
https://api.gic.org/metadata/ImageLayerCoverage?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 (15cm GSD) `bluesky-high-europe` Wide area data collected with Condor in Europe (15cm GSD) `graysky-g` Gray Sky data collected by Geomni `graysky` Gray Sky data collected by UltraCam sensors.	`layer=bluesky-ultra`
`orientation`	Key Value Pair	String	The camera-axis and/or cardinal orientation of the images to be delivered. `ALL:` all orientations `NADIR:` default - all the Nadir orientations (NN, NS, NE, NW) `OBLIQUE:` all the oblique orientations: (N, S, E, W) Single values for specific orientations: `N, S, E, W, NN, NS, NE, NW, I`	`orientation=N,S`	May 2023
`aoi`	Key Value Pair	String	The desired `AOI` names, separated by commas. If excluded, all AOIs will be returned.	`aoi=` 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`
`childAOI`	Key Value Pair	String	The desired `childAOI` names. It will return the coverage of the AOI(s) that contain it and the specified `childAOI`.	`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`
`wkt`	Key Value Pair	String	The “well-known text” field is used to define a polygon around the desired area. AOIs intersecting the specified `wkt` geometry are returned.	`wkt=POLYGON((-94.365776 39.0543699,-94.2902456 39.0543699,-94.2902456 38.9828831,-94.365776 38.9828831,-94.365776 39.0543699))`
`epsg`	Key Value Pair	Integer	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=3857`
`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) `json` - default - formats the geometry as an array of coordinates (JavaScript Object Notation).	`format=wkt`
`skip`	Key Value Pair	String	Metadata objects to be omitted from the json response. Multiple values must be separated with a comma.	`skip=aoi.geometry,aoi.child_aoi.coverage`
`include`	Key Value Pair	String	Metadata objects to be included in the json response. Multiple values must be separated with a comma.	`include=aoi.avg_gsd`

Examples

St. Louis, MO - Demonstrating AOI, epsg, skip and include:
https://api.gic.org/metadata/ImageLayerCoverage?aoi=us-mo-stlouis-2022&epsg=32615&skip=aoi.min_gsd,aoi.child_aoi.coverage&include=aoi.avg_gsd&token={token}

Sample Pretty JSON Response (truncated):

{
    "type": "FeatureCollection",
    "features": [
        {
            "type": "Feature",
            "properties": {
                "AOI": "us-mo-stlouis-2022"",
                "Coverage Type": "V",
                "Avg GSD": "0.07239862",
                "Max GSD": "0.07518936",
                "Min Capture date": "2022-05-29 13:23:09",
                "Max Capture date": "2022-05-30 14:54:12",
                "layer": "bluesky-ultra",
                "AOI Area": 1631.2109,
                ...

Coverage Geometry Visualized in QGIS:

________________________________________________________________________________________

Graysky collection - Demonstrating layer:
https://api.gic.org/metadata/ImageLayerCoverage?layer=graysky&token={token}

Sample JSON Response (truncated):

{"type":"FeatureCollection","features":[{"type":"Feature","properties":{"AOI":"USKYDEC2112","Coverage Type":"V","Min GSD":0.069405496,"Max GSD":0.10020183,"Min Capture date":"2021-12-12 03:30:28","Max Capture date":"2021-12-12 10:01:43","layer":"graysky","AOI Area":3840.8433,"AOI Max Zoom":0,"AOI Pretty Name":""},"geometry":{"type":"MultiPolygon","coordinates":[[[[-86.541,36.9685],[-86.5441,36.9758],[-86.4334,37.0069],[-86.3722,37.0235],[-86.3455,37.0305],[-86.3308,36.9956],[-86.3495,36.9901],[-86.4794,36.9549],[-86.5061,36.9472],[-86.5296,36.941],[-86.541,36.9685]]],[[[-88.1117,37.0521],[-88.071,37.0696],[-88.0459,37.0808],[-87.9729,37.112],[-87.9526,37.1212],[-87.8866,37.1497],[-87.874,37.1555],[-87.849,37.1661],[-87.8146,37.1814],[-87.8054,37.185],[-87.7112,37.2264],[-87.703,37.2297],[-87.677,37.2412],[-87.6478,37.2535],[-87.6016,37.2737],[-87.5766,37.2845],[-87.5715,37.2864],[-87.5641,37.2899],[-87.5197,37.309],[-87.4991,37.3175],[-87.338,37.3871],[-87.3123,37.349],[-87.3041,37.3363],[-87.2781,37.2982],[-87.284,37.2953],[-87.2976,37.2897],[-87.3033,37.2871],[-87.325,37.2779],[-87.333,37.2748],[-87.3469,37.2685],
.
.
.

Coverage Geometry Visualized in QGIS:

________________________________________________________________________________________

Green Bay, Wisconsin - Demonstrating wkt and format:
https://api.gic.org/metadata/ImageLayerCoverage?wkt=POLYGON((-88.13334998269332 44.56837029609595,-87.90538367409957 44.56837029609595,-87.90538367409957 44.429278530221296,-88.13334998269332 44.429278530221296,-88.13334998269332 44.56837029609595))&format=wkt&token={token}

Sample JSON response (truncated):

{"type":"FeatureCollection","features":[{"type":"Feature","properties":{"AOI":"us-wi-greenbay-2021","Coverage Type":"V","Min GSD":0.06865406,"Max GSD":0.076372474,"Min Capture date":"2021-08-12 01:46:53","Max Capture date":"2021-08-15 04:02:52","layer":"bluesky-ultra","AOI Area":841.94275,"AOI Max Zoom":0,"AOI Pretty Name":null},"geometry":"MULTIPOLYGON (((-88.2013369298169 44.6386136374143, -88.2011027797184 44.6495511799668, -88.1932318689699 44.6495294137906, -88.1929886800615 44.652944949965, -88.1853468438311 44.6529875185453, -88.1853751197756 44.6546367799512, -88.1763569798182 44.6547212804711, -88.1763261100162 44.6551185600526, -88.1663792449805 44.6547430136295, -88.1517608783724 44.6549388799665, -88.1256488387617 44.6548967099897, -88.1256409261028 44.6546782609877, -88.1014615312744 44.6550089299352, -88.0571182803832 44.6546682207286, -88.0546378613887 44.6547019462327, -88.0546203700094 44.6550595499857, -88.0440263586604 44.6547643492248, -87.8327522527515 44.4141626608112, -87.8324559400975 44.3989308734777, -87.8328099301002 44.3880041600161, -87.8404108247204 44.3881416630984, -87.8405725497549 44.3845209600361, -87.8484171709632 44.3846519129626, -87.8484033900102 44.3831362800044, -87.8902210196012 44.3825995800196, -88.1927241946716 44.3863724100776, -88.2008067100604 44.3864323700114, -88.2009055709841 44.4275662447165, -88.2012612300293 44.4446126053292, -88.2007468597758 44.4831554923823, -88.2012623602906 44.5005107038385, -88.2007903805471 44.540800581038, -88.2010200797757 44.5669607803317, -88.2006443909383 44.5852541315513, -88.2013369298169 44.6386136374143)))","Child AOI":[{"Name":"us-wi-greenbay-2021","Coverage Type":"V","Coverage":"MULTIPOLYGON (((-88.2013369298169 44.6386136374143, -88.2011027797184 44.6495511799668,
.
.
.

Coverage Geometry Visualized in QGIS:

External Resources

wkt generator and visualizer:
Wicket - Lightweight Javascript for WKT [Sandbox]

Vexcel API Documentation

ImageLayerCoverage Service - v1.4

Introduction

Technical Details

Base URL

Parameters

Examples

See Also

External Resources