Lightning Summary
https://data.api.xweather.com/lightning/summary/The lighting/summary endpoint expands on the lightning API endpoint (opens in a new tab) and provides an overall summary of recent lightning strikes or pulses across the globe. Example use cases include - but are not limited to - obtaining the total number of recent lightning strikes or pulses within a radius of a requested location.
This endpoint has the following limitations:
- Lighting strike/pulse information is available for the last 5 minutes.
Requests
Every request to the endpoint must include one of the supported actions in the url.
https://data.api.xweather.com/lightning/summary/{action}?client_id={client_id}&client_secret={client_secret}&{params}Supported Actions
The following actions are supported with the /lightning/summary endpoint:
| Action | Description |
|---|---|
| :id | Type: stringTypically used for passing a geographical location name or identifier such as city name, lat/long, or even US and Canadian postal codes. Learn more. |
| closest | Type: stringBased on a location search, the results will be returned in order from closest to farthest. Learn more. |
Response
The following is an example of what each object in the response will consist of. Depending on your requested action, the response may contain multiple instances of this object within an array.
Properties
summary (object)
Object containing summary information about the lightning pulses.
summary.range (object)
Object containing the range of the pulses.
summary.range.count (number)
The total lightning pulses within the summary time range.
summary.range.fromTimestamp (number)
The Unix timestamp of the summary time range start. Usually the same as the `from` parameter.
summary.range.fromDateTimeISO (string)
The ISO 8601 date and time of the summary time range start. Usually the same as the `from` parameter.
summary.range.toTimestamp (number)
The Unix timestamp of the summary time range end. Usually the same as the `to` parameter.
summary.range.toDateTimeISO (string)
The ISO 8601 date and time of the summary time range end. Usually the same as the `to` parameter.
summary.range.maxTimestamp (number)
The Unix timestamp of the last pulse time within the summary time range.
summary.range.maxDateTimeISO (string)
The ISO 8601 date and time of the last pulse time within the summary time range.
summary.range.minTimestamp (number)
The Unix timestamp of the first pulse time within the summary time range.
summary.range.minDateTimeISO (string)
The ISO 8601 date and time of the first pulse time within the summary time range.
summary.pulse (object)
Object containing summary information about the lightning pulses.
summary.pulse.count (number)
The total lightning pulses within the summary time range.
summary.pulse.cg (number)
The total cloud-to-ground lightning pulses within the summary time range.
summary.pulse.ic (number)
The total intra-cloud (cloud to cloud) lightning pulses within the summary time range.
summary.pulse.negative (number)
The total number of lightning pulses with a negative polarity within the summary time range.
summary.pulse.positive (number)
The total number of lightning pulses with a positive polarity within the summary time range.
summary.peakAmp (object)
Object containing summary information about the peak amplitude of the lightning pulses.
summary.peakAmp.count (number)
The total number of lightning pulses that included peak amp information
summary.peakAmp.all (object)
Object containing summary information about the peak amplitude of all lightning pulses.
summary.peakAmp.all.min (number)
The minimum peak amplitude of all lightning pulses within the summary time range.
summary.peakAmp.all.max (number)
The maximum peak amplitude of all lightning pulses within the summary time range.
summary.peakAmp.all.avg (number)
The average peak amplitude of all lightning pulses within the summary time range.
summary.peakAmp.positive (object)
The total number of lightning pulses with a positive polarity within the summary time range.
summary.peakAmp.positive.min (number)
The minimum peak amplitude of all lightning pulses with a positive polarity within the summary time range.
summary.peakAmp.positive.max (number)
The maximum peak amplitude of all lightning pulses with a positive polarity within the summary time range.
summary.peakAmp.positive.avg (number)
The average peak amplitude of all lightning pulses with a positive polarity within the summary time range.
summary.peakAmp.negative (object)
The total number of lightning pulses with a negative polarity within the summary time range.
summary.peakAmp.negative.min (number)
The minimum peak amplitude of all lightning pulses with a negative polarity within the summary time range.
summary.peakAmp.negative.max (number)
The maximum peak amplitude of all lightning pulses with a negative polarity within the summary time range.
summary.peakAmp.negative.avg (number)
The average peak amplitude of all lightning pulses with a negative polarity within the summary time range.
summary.icHeight (object)
DEPRECATED
summary.icHeight.count (number)
DEPRECATED
summary.icHeight.min (number)
DEPRECATED
summary.icHeight.max (number)
DEPRECATED
summary.icHeight.avg (number)
DEPRECATED
summary.numSensors (object)
Object containing summary information about the number of sensors that detected the lightning pulses.
summary.numSensors.count (number)
The total number of lightning pulses that included sensor information
summary.numSensors.min (number)
The minimum number of sensors that detected a lightning pulse within the summary time range.
summary.numSensors.max (number)
The maximum number of sensors that detected a lightning pulse within the summary time range.
summary.numSensors.avg (number)
The average number of sensors that detected a lightning pulse within the summary time range.
{
"summary": {
"range": {
"count": 13896,
"fromTimestamp": 1702584155,
"fromDateTimeISO": "2023-12-14T20:02:35+00:00",
"toTimestamp": 1702584455,
"toDateTimeISO": "2023-12-14T20:07:35+00:00",
"maxTimestamp": 1702584394,
"maxDateTimeISO": "2023-12-14T20:06:34+00:00",
"minTimestamp": 1702584155,
"minDateTimeISO": "2023-12-14T20:02:35+00:00"
},
"pulse": {
"count": 13896,
"cg": 5957,
"ic": 7939,
"negative": 5888,
"positive": 8008
},
"peakAmp": {
"count": 13896,
"all": {
"min": 1000,
"max": 379000,
"avg": 16883
},
"positive": {
"min": 1000,
"max": 192000,
"avg": 13029
},
"negative": {
"min": 2000,
"max": 379000,
"avg": 22125
}
},
"icHeight": {
"count": 13896,
"min": 0,
"max": 0,
"avg": 0
},
"numSensors": {
"count": 13896,
"min": 3,
"max": 24,
"avg": 6
}
}
}