- Created by DMI Bruger, last modified on Mar 18, 2022
Table of contents:
Overall structure
The lightningdata API is a OGC API - Features service and follows this standard as documented here: http://docs.opengeospatial.org/is/17-069r3/17-069r3.html
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 GeoJSON 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;
|
Generic fields for every Feature object
| Key | Not null | Type | Description |
|---|---|---|---|
id | yes | String | Internal database ID |
type | yes | String | Always equal to "Feature" |
| geometry.coordinates.0 | yes | float | longitude in WGS84 |
| geometry.coordinates.1 | yes | float | latitude in WGS84 |
Observation (Triangulated Lightning Data)
This is a GeoJSON Feature and the table below describes the returned data:
| Key | Not null | Type | Description |
|---|---|---|---|
| properties.amp | yes | float | Strength of the lightning stroke measured in kiloamperes. |
| properties.created | yes | String | Timestamp of creation time in observation database in RFC3339 5.6 format |
| properties.observed | yes | String | Observation time in RFC3339 5.6 format |
| properties.sensors | yes | String | A list of the lightning stations which have registered the lightning stroke. They are listed with their sensor number (e.g. "1,2,3,6") separated by a comma. A list of sensors/stations can be seen here Please note that the list of sensors only includes sensors owned by DMI and not the additional 3rd party sensors used for triangulation purposes. |
| properties.strokes | yes | integer | Number of strokes registered |
| properties.type | yes | integer | Type of lightning detected. The types of lightning can be seen here |
geometry | yes | Object | Triangulated position of the lightning strike in GeoJSON format |
Sensordata (Data each Lightning Sensor has Detected)
The table below describes how you should interpret the properties returned when requesting data from the sensordata schema.
| Key | Not null | Type | Description |
|---|---|---|---|
| properties.amp | yes | float | Strength of the lightning stroke measured in kiloamperes. |
| properties.created | yes | integer ($int64) | Timestamp of creation time in observation database in RFC3339 5.6 format |
| properties.direction | yes | String | The direction in which the station has detected the lightning stroke given by its true-north based azimuth. This is a number but formatted as a string. |
| properties.observed | yes | integer ($int64) | Observation time in RFC3339 5.6 format |
| properties.sensorId | yes | String | The lightning stations which has registered the lightning stroke. A list of sensors/stations can be seen here |
| properties.strokes | yes | integer | Number of strokes registered |
geometry | yes | Object | Position of the observation in GeoJSON format. Derived from the stations location |
Station
The table below describes how you should interpret the properties returned when requesting data from the station schema.
| Key | Not null | Type | Description | |
|---|---|---|---|---|
| properties.country | yes | String | Country code | |
| properties.lastHeartbeat | yes | String | A timestamp, which is renewed at least every 1 to 2 minutes to indicate that the station is in service (in RFC3339 5.6 format, e.g. "2020-09-24T05:58:51Z") | |
| properties.name | yes | String | The name of the station | |
| properties.owner | yes | String | Owner of the station | |
| properties.sensorId | yes | String | The sensor number of the station. A list of sensors/stations can be seen here | |
| properties.stationId | yes | String | Station id | |
| properties.status | yes | String | Possible values are "Active" or "Inactive" | |
| properties.created | yes | String | Creation time in database (in RFC3339 5.6 format, e.g. "2020-07-10T07:59:38Z") | |
| properties.operationFrom | yes | String | First date the station is operational (in RFC3339 5.6 format, e.g. "2020-07-10T07:59:38Z") | |
| properties.operationTo | yes | String) | Last date the station is operational (in RFC3339 5.6 format, e.g. "2020-07-10T07:59:38Z") | |
| properties.updated | no | String | Date of the station update (in RFC3339 5.6 format, e.g. "2020-07-10T07:59:38Z") | |
| properties.validFrom | yes | String | First date the station sends valid data (in RFC3339 5.6 format, e.g. "2020-07-10T07:59:38Z") | |
| properties.validTo | no | String | Last date the station sends valid data (in RFC3339 5.6 format, example "2020-07-10T07:59:38Z") | |
| properties.type | yes | String | Station type, See here for available types | |
| geometry | yes | Object | Position of the station in GeoJSON format |
- No labels