Click here for Swagger - Interactive API explorer
To execute calls the service input your api-key by clicking the "Authorize" button in Swagger
Example: https://dmigw.govcloud.dk/v1/radardata/collections/composite/items?api-key=<api-key>
Description: Will return up to 1000 (the default limit) composite radar scans
Example: https://dmigw.govcloud.dk/v1/radardata/collections/volume/items?api-key=<api-key>
Description: Will return up to 1000 (the default limit) volume radar scans
The collection endpoints support a number of query parameters to filter or sort data. Make sure to read the query primer to make use of the below query parameters.
{
"type": "FeatureCollection",
"features": [
{
"stac_version": "1.0.0",
"bbox": [
4.379082700525593,
52.29427206432812,
20.735140174892805,
59.827708427801085
],
"geometry": {
"coordinates": [
[
[
4.379082700525593,
52.29427206432812
],
[
20.735140174892805,
52.29427206432812
],
[
20.735140174892805,
59.827708427801085
],
[
4.379082700525593,
59.827708427801085
],
[
4.379082700525593,
52.29427206432812
]
]
],
"type": "Polygon"
},
"collection": "composite",
"id": "dk.com.202310260915.500_max.h5",
"asset": {
"data": {
"href": "https://dmigw.govcloud.dk/v1/radardata/download/dk.com.202310260915.500_max.h5",
"title": "Radar file download resource",
"type": "application/x-hdf5",
"roles": [
"data"
]
}
},
"type": "Feature",
"properties": {
"created": "2023-10-26T09:27:09.383Z",
"datetime": "2023-10-26T09:15:00Z",
"scanType": "doppler"
}
}
],
"timeStamp": "2023-10-26T09:28:49Z",
"numberReturned": 1,
"links": [
{
"href": "https://dmigw.govcloud.dk/v1/radardata/collections/composite/items?sortorder=datetime,DESC&limit=1",
"rel": "self",
"type": "application/geo+json",
"title": "This document"
},
{
"href": "https://dmigw.govcloud.dk/v1/radardata/collections/composite/items?sortorder=datetime,DESC&limit=1&offset=1",
"rel": "next",
"type": "application/geo+json",
"title": "Next set of results"
}
]
}Example: https://dmigw.govcloud.dk/v1/radardata/collections
Description: Will return all available collections in the API. Available collections:
for composite, pseudo CAPPI and volume files respectively
| limit |
Specify a maximum number of objects (e.g radar files) you want to be returned. If a limit is not specified, the default limit is 1000. If more than 300000 objects are needed then use either the offset to request the next set of observations or download the data. Please be advised that this is a "maximum" and the result size could be less than what is requested Max possible limit: 300000 is the maximum limit you can request Example: Returns a maximum of 100 objects |
| offset |
Specify the number of objects that should be skipped before returning matching objects. Default: 0. Max possible offset: 1.000.000 Using the limit and the offset parameters, a client can page through the objects returned - page size is set by the limit parameter. This will only work up to the maximum possible offset. If datasets larger than maximum limit plus maximum offset are required then data should be retrieved using the download service or by splitting requests by the datetime parameter. Example: Returns a maximum of 100 objects skipping the first 1000 |
| stationId |
Narrow the search to a specific station ID. You can find the station list here: Radar stations list Can only be used for the volume and pseudoCappi collections Example: Returns radarfiles from radar station with stationId 06194 |
| scanType |
Narrow the search for a specific scan type. Can only be used for the volume and composite collections The scanType can be 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. Examples: Returns composite radarfiles with scanType fullRange
Returns volume radarfiles with scanType fullRange |
| datetime |
Narrow the search to a date range where both ends of the range are inclusive or a specific date. The range can be open on one side. If that is the case simply use ".." (double-dot) in stead of the an actual date for the open side. If only one date is supplied, then only exactly matching dates will be included. If both sides of the range are open, simply omit the datetime parameter. The plus sign "+" must be URL encoded: Danish summer time is UTC+2 (GMT+2) You can read more about how to deal with the status and the datetime parameter in the context of station here. Examples: Returns radarfiles within the dates UTC 2018-02-12 at midnight and UTC 2018-03-18 at midnight. Both dates are inclusive.
Returns radarfiles within the dates 2019-01-01 at midnight and 2020-01-01 at midnight in Danish summer timezone. Both dates are inclusive.
Returns radarfiles from the date 2019-01-01 at midnight (Danish summer timezone) and after
Returns radarfiles before or matching the date 2019-01-01 at midnight (Danish summer timezone).
Returns radarfiles matching the date 2019-01-01 at midnight (Danish summer timezone) |
| bbox |
Narrow the search to only include objects within the specified bounding box. A bounding box (usually shortened to bbox) is an area defined by two longitudes and two latitudes, where:
They follow the standard format of: bbox = Southwesterly point (lon,lat) followed by northeasterly point (lon, lat) This bbox tool may be useful. Please use a decimal point as the decimal separator, e.g. 1.99 (and not 1,99) Examples: Returns radarfiles within the bounding box having the Southwesterly point of 7.0, 54.0 and northeasterly point of 16.0, 58.0 (which basically covers the area of Denmark)
Returns radarfiles within the bounding box having the Southwesterly point of 8.351697,55.421038 and northeasterly point of 8.542584,55.511345 (which basically covers the area of the city of Esbjerg in Denmark) |
| bbox-crs |
Specifies the coordinate reference system of the bbox parameter. This service only support the CRS84 coordinate reference system. Example: Returns radarfiles within the bounding box having the Southwesterly point of 7.0, 54.0 and northeasterly point of 16.0, 58.0 (which basically covers the area of Denmark) using the CRS84 coordinate reference system |
| sortorder |
Sorts returned objects. Asking for results to be sorted should only be done when it is needed - responses are generally faster when asking for results with no sorting. Can only be used for the observation collection Example: Returns the response sorted by the observed time in descending order |
|
Example: Returns radarfiles from station 06194 after 6. of august 2021 in a bbox covering Denmark in the CRS84 coordinate system in descending datetime order, with 0 offset and with only up to 10 occurences |
Link to the file can be found by querying using the /collections/<collection name>/items documented above. Link will be in the asset section of the features.
Example:
Downloads the file. File is in HDF5 file format.
The 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.
Features are wrapped in a STAC Item FeatureCollection object, which includes:
| Key | Not null | Data Type | Description |
| type | yes | String | Always equal to "FeatureCollection" |
| features | yes | list<Feature> | See below for the description of the specific Feature object |
| timeStamp | yes | String | Timestamp when the response was generated. In RFC3339 5.6 format. |
| numberReturned | yes | Number | Number of Feature objects returned |
| links | yes | List of Link objects |
Links to pages;
|
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 )
| Key | Not null | Data Type | Description |
| stac_version | yes | String | STAC version |
| bbox.0 | yes | float | Southwesterly point longitude in WGS84 |
| bbox.1 | yes | float | Southwesterly point latitude in WGS84 |
| bbox.2 | yes | float | Northeasterly point longitude in WGS84 |
| bbox.3 | yes | float | Northeasterly point latitude in WGS84 |
| geometry.coordinates.0 | yes | float | longitude in WGS84 |
| geometry.coordinates.1 | yes | float | latitude in WGS84 |
| collection | yes | String | Name of the collection (composite, pseudo CAPPI and volume) |
| id | yes | String | feature id (radarfile name) |
| asset.data.href | yes | string <uri> | The location of the radar file |
| asset.data.title | yes | String | The title of the ressource, always "Radar file download resource" |
| asset.data.type | yes | String | The media type of the resource, always "application/x-hdf5" What is HDF5 ? |
| asset.data.roles.0 | yes | String | role is always "data" |
| type | yes | String | type is always "feature" |
| properties.datetime | yes | String | Observation time in RFC3339 5.6 format. |
| properties.created | yes | String | Creation time in database (in RFC3339 5.6 format, e.g. "2020-07-10T07:59:38Z") |
| properties.stationId | yes | String |
Station ID identifying the station (see radar stations ) (not for composite radar files, as they are composed by all stations) |
| properties.scanType | yes | String | Is 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. |