StormGeo Tile API

This document describes the StormView Tile API. Tiles are accessed through the following process:

  1. Get API key through /keygen. Key is valid for 24 hours, and can be reused.
  2. Get list of available layers, timesteps and anatimes using /layers
  3. Use /tile url to get tiles
or for faster tiles
  1. Get API key through /keygen. Key is valid for 24 hours, and can be reused.
  2. Get list of available layers, timesteps and anatimes using /cachedlayers
  3. Use /cache/tile url to get tiles

Note that only the timesteps and anatimes that is listed in the /layers or /cachedlayers url is guaranteed to be available.

Urls

/keygen/{appKey} returns AuthenticationResource
Use your application key to generate an API key. The key is valid 24 hours. Append "auth=[API key]" to all urls in the API
/keygen/js/{appKey} returns AuthenticationResource
Use your application key to generate an API key. The key is valid 24 hours. Append "auth=[API key]" to all urls in the API
/legend/{layerId}/{height}
Get legend for layer
/legenddata/{layerId}/{unitOfMeasure} returns LegendData
Get legend for layer represented as data. Optionally convert the legend interval to a preferred unit of measure.
/legenddata/js/{layerId}/{unitOfMeasure} returns LegendData
Get legend for layer represented as data. Optionally convert the legend interval to a preferred unit of measure.
/legenddata/{layerId} returns LegendData
Get legend for layer represented as data. Optionally convert the legend interval to a preferred unit of measure.
/legenddata/js/{layerId} returns LegendData
Get legend for layer represented as data. Optionally convert the legend interval to a preferred unit of measure.
/legend/{layerId}/{height}/{unitOfMeasure}
Get legend for layer
/tile/{level}/{x}/{y}/{timeStep}/{anaTime}?layers={layers}&culture={culture}
Generate tile on the fly.
{layers}
 Comma separated list of values
/tile/{level}/{x}/{y}/{timeStep}?layers={layers}&culture={culture}
Generate tile on the fly.
{layers}
 Comma separated list of values
/tile/{level}/{x}/{y}?layers={layers}
Generate tile on the fly.
{layers}
 Comma separated list of values
/cache/tile/{level}/{x}/{y}/{timeStep}/{anaTime}?layers={layers}&culture={culture}
Gets tiles from cache if they are present there. If not an attempt is made to generate the tile on the fly
{timeStep}
 Date with format yyyyMMddHHmm
/cache/tile/{level}/{x}/{y}/{timeStep}?layers={layers}&culture={culture}
Gets tiles from cache if they are present there. If not an attempt is made to generate the tile on the fly
{timeStep}
 Date with format yyyyMMddHHmm
/layers?layers={layers}&allowPartiallyLoaded={allowPartiallyLoaded} returns LayersResource
Lists layers that are availible through the /tile urls.
{layers}
 Comma separated list of values
{allowPartiallyLoaded}
 true/false
{dimensions}
 true/false
/js/layers?layers={layers}&allowPartiallyLoaded={allowPartiallyLoaded} returns LayersResource
Lists layers that are availible through the /tile urls.
{layers}
 Comma separated list of values
{allowPartiallyLoaded}
 true/false
{dimensions}
 true/false
/layers returns LayersResource
Lists layers that are availible through the /tile urls.
{allowPartiallyLoaded}
 true/false
/js/layers returns LayersResource
Lists layers that are availible through the /tile urls.
{allowPartiallyLoaded}
 true/false
/cachedlayers returns LayersResource
List all pre-generated (fast) layers that are available. These layers are only guaranteed to be available for a given zoom level and area. This depends on the current server configuration.
/js/cachedlayers returns LayersResource
List all pre-generated (fast) layers that are available. These layers are only guaranteed to be available for a given zoom level and area. This depends on the current server configuration.

Json entities

LayersResource structure

{
Layers Array of LayerInfo
}

LayerInfo structure

{
AnaTime String Analysis time with format yyyyMMddHHmm
LayerId String
Description String
TimeSteps String[] Date strings with format yyyyMMddHHmm
HasLegend Boolean Determines if legend is available for layer
LegendLayerId String
Tags String[]
}

LoadStatusResource structure

{
ProductInfo Object
SatelliteTimes Array of Date
}

LegendDataResource structure

{
LegendData LegendData
}

LegendData structure

{
Intervals Single[] n+1 numbers describing n intervals
Colors String[] n colors describing the color of each interval
UnitOfMeasure String Unit of the interval
}

AuthenticationResource structure

{
Key String API key. The key is valid for 24 hours
}