Table of contents:






Overall structure 

The radardata API is a STAC API - Features service and follows this standard as documented here: https://api.stacspec.org/v1.0.0-beta.4/core/

Data is returned in a FeatureCollection object that describes the returned data set. Data points are found in the features field which contains a number of Feature objects as described below.

FeatureCollection

Features are wrapped in a STAC Item FeatureCollection object, which includes:

KeyNot nullData TypeDescription
typeyesStringAlways equal to "FeatureCollection"
featuresyeslist<Feature>See below for the description of the specific Feature object
timeStampyesStringTimestamp when the response was generated. In RFC3339 5.6 format.
numberReturnedyesNumberNumber of Feature objects returned
linksyesList of Link objects

Links to pages;

  • the link with rel="self" is a link to the page itself. 
  • the link with rel="next" is a link to the next page of results


Generic fields for every Feature object

These are STAC Items, as described by STAC Item Specification and the table below describes the returned data:
(Note that a STAC Item can be seen as an augmented GeoJson feature )

KeyNot nullData TypeDescription
stac_versionyesStringSTAC version
bbox.0yesfloatSouthwesterly point longitude in WGS84
bbox.1yesfloatSouthwesterly point latitude in WGS84
bbox.2yesfloatNortheasterly point longitude in WGS84
bbox.3yesfloatNortheasterly point latitude in WGS84
geometry.coordinates.0yesfloatlongitude in WGS84
geometry.coordinates.1yesfloatlatitude in WGS84
collectionyesStringName of the collection (composite, pseudo CAPPI and volume)

id

yes

String

feature id (radarfile name)

asset.data.hrefyesstring <uri> The location of the radar file
asset.data.titleyesStringThe title of the ressource, always "Radar file download resource"
asset.data.typeyesStringThe media type of the resource, always "application/x-hdf5" What is HDF5 ?
asset.data.roles.0yesString

role is always "data"

type

yes

String

type is always  "feature"

properties.datetimeyesStringObservation time in RFC3339 5.6 format.
properties.createdyesStringCreation time in database (in RFC3339 5.6 format, e.g. "2020-07-10T07:59:38Z")
properties.stationIdyesString

Station ID identifying the station (see radar stations )

(not for composite radar files, as they are composed by all stations)

properties.scanTypeyesStringIs either "fullRange" or "doppler". For "fullRange" the range radius of the radars is 240 km, for doppler it is 120 km. For additional details, see link.



  • No labels