Page tree
Skip to end of metadata
Go to start of metadata

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:

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

KeyNot nullTypeDescription

id

yes

String

Internal database ID

type

yes

String

Always equal to "Feature"

geometry.coordinates.0yesfloatlongitude in WGS84
geometry.coordinates.1yesfloatlatitude in WGS84




Observation (Triangulated lightning data)

This is a GeoJSON Feature and the table below describes the returned data:

Key

Not null

TypeDescription
properties.ampyesfloatStrength of the lightning stroke measured in kiloamperes.
properties.createdyesStringTimestamp of creation time in observation database in RFC3339 5.6 format
properties.observedyesStringObservation time in RFC3339 5.6 format
properties.sensorsyesString

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

properties.strokesyesintegerNumber of strokes registered
properties.typeyesintegerType of lightning detected. The types of lightning can be seen here

geometry

yes

Object

Triangulated position of the lightning strike in GeoJSON format




Sensordata (the data each lightning sensor has detected)

The table below describes how you should interpret the properties returned when requesting data from the sensordata schema.

KeyNot nullTypeDescription
properties.ampyesfloatStrength of the lightning stroke measured in kiloamperes.
properties.createdyesinteger ($int64)Timestamp of creation time in observation database in RFC3339 5.6 format
properties.directionyesfloatingThe direction in which the station has detected the lightning stroke given by its true-north based azimuth.
properties.observedyesinteger ($int64)Observation time in RFC3339 5.6 format
properties.sensorIdyesString

The lightning stations which has registered the lightning stroke.  A list of sensors/stations can be seen here

properties.strokesyesintegerNumber of strokes registered

geometry

yes

Object

Position of the observation in GeoJSON format. Derived from the stations location




Station properties

The table below describes how you should interpret the properties returned when requesting data from the station schema.

KeyNot nullTypeDescription
properties.countryyesStringCountry code
properties.lastHeartbeatyesStringA 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.nameyesStringThe name of the station
properties.owneryesStringOwner of the station
properties.sensorIdyesStringThe sensor number of the station.  A list of sensors/stations can be seen here
properties.stationIdyesStringStation id
properties.statusyesStringPossible values are "Active" or "Inactive"
properties.createdyesStringCreation time in database (in RFC3339 5.6 format, e.g. "2020-07-10T07:59:38Z")
properties.operationFromyesStringFirst date the station is operational (in RFC3339 5.6 format, e.g. "2020-07-10T07:59:38Z"
properties.operationToyesString)Last date the station is operational (in RFC3339 5.6 format, e.g. "2020-07-10T07:59:38Z"
properties.updatednoStringDate of the station update (in RFC3339 5.6 format, e.g. "2020-07-10T07:59:38Z"
properties.validFromyesStringFirst date the station sends valid data (in RFC3339 5.6 format, e.g. "2020-07-10T07:59:38Z"
properties.validTonoStringLast date the station sends valid data (in RFC3339 5.6 format, example "2020-07-10T07:59:38Z"
properties.typeyesStringStation type, See here for available types
geometryyesObjectPosition of the station in GeoJSON format


  • No labels