Storm Cells Summary
https://data.api.xweather.com/stormcells/summary/The storm cells/summary endpoint provides an overall summary of current storm cells based on search/filter criteria. Example uses include obtaining the number of storm cells, maximum amount of hail currently reported within storm cells, or number of storm cells with a high probability of hail within a 50-mile radius. This endpoint can also provide polygons of the storm cell groups included in the summary. Storm cells/summary coverage area includes all 50 US states, as well as Puerto Rico and Guam.
Requests
Every request to the endpoint must include one of the supported actions in the url.
https://data.api.xweather.com/stormcells/summary/{action}?client_id={client_id}&client_secret={client_secret}&{params}Supported Actions
The following actions are supported with the /stormcells/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. |
| affects | Type: stringReturns a list of locations that are currently affected by a weather event. Criteria for the location(s) can be determined in your query parameters. Learn more. |
| search | Type: stringA generalized action that is determined with the endpoints query parameters. Learn more. |
| within | Type: stringUses a circle or polygon, define an area to search for results. 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)
The storm cell summary object.
summary.id (string)
The unique identifier for the the requested summary.
summary.range (object)
The range of time for the summary.
summary.range.count (number)
The number of storm cells in the summary.
summary.range.fromTimestamp (number)
The Unix timestamp of the start of the summary, matching the `from` parameter.
summary.range.fromDateTimeISO (string)
The ISO 8601 date and time of the start of the summary, matching the `from` parameter.
summary.range.toTimestamp (number)
The Unix timestamp of the end of the summary, matching the `to` parameter.
summary.range.toDateTimeISO (string)
The ISO 8601 date and time of the end of the summary, matching the `to` parameter.
summary.range.maxTimestamp (number)
The Unix timestamp of the last storm cell in the summary.
summary.range.maxDateTimeISO (string)
The ISO 8601 date and time of the last storm cell in the summary.
summary.range.minTimestamp (number)
The Unix timestamp of the first storm cell in the summary.
summary.range.minDateTimeISO (string)
The ISO 8601 date and time of the first storm cell in the summary.
summary.tvs (object)
Object containing information about tornado vortex signatures (TVS) in the summary.
summary.tvs.count (number)
The number of storm cells with a TVS in the summary.
summary.tvs.min (number)
The minimum TVS value in the summary. Will normally be 0.
summary.tvs.max (number)
The maximum TVS value in the summary. Will normally be 0 if count = 0, 1 if count > 0.
summary.mda (object)
Object containing information about Mesocyclone Detection Algorithm (MDA) in the summary.
summary.mda.count (number)
The number of storm cells with a MDA > 0 in the summary.
summary.mda.threatCount (number)
The number of storm cells with a MDA > 12 and potentially threatening in the summary.
summary.mda.min (number)
The minimum MDA value in the summary. Will normally be 0.
summary.mda.max (number)
The maximum MDA value in the summary.
summary.hail (object)
Object containing information about hail in the summary.
summary.hail.prob (object)
Object containing information about hail probability in the summary.
summary.hail.prob.count (number)
The number of storm cells with a hail probability > 0 in the summary.
summary.hail.prob.threatCount (number)
The number of storm cells with a hail probability >= 70 and potentially threatening in the summary.
summary.hail.prob.min (number)
The minimum hail probability value in the summary. Will normally be 0.
summary.hail.prob.max (number)
The maximum hail probability value in the summary.
summary.hail.prob.avg (number)
The average hail probability value in the summary.
summary.hail.probSevere (object)
Object containing information about severe hail probability in the summary. Severe hail is defined as hail >= 1.0" in diameter.
summary.hail.probSevere.count (number)
The number of storm cells with a severe hail probability > 0 in the summary.
summary.hail.probSevere.threatCount (number)
The number of storm cells with a severe hail probability >= 30 and potentially threatening in the summary.
summary.hail.probSevere.min (number)
The minimum severe hail probability value in the summary. Will normally be 0.
summary.hail.probSevere.max (number)
The maximum severe hail probability value in the summary.
summary.hail.probSevere.avg (number)
The average severe hail probability value in the summary.
summary.hail.maxSize (object)
Object containing information about hail size in the summary.
summary.hail.maxSize.count (number)
The number of storm cells with a hail size > 0 in the summary.
summary.hail.maxSize.maxIN (number)
The maximum hail size in inches in the summary.
summary.hail.maxSize.maxCM (number)
The maximum hail size in centimeters in the summary.
summary.hail.maxSize.minIN (number)
The minimum hail size in inches in the summary.
summary.hail.maxSize.minCM (number)
The minimum hail size in centimeters in the summary.
summary.hail.maxSize.avgIN (number)
The average hail size in inches in the summary.
summary.hail.maxSize.avgCM (number)
The average hail size in centimeters in the summary.
summary.dbzm (object)
Object containing information about maximum reflectivity in the summary.
summary.dbzm.count (number)
The number of storm cells with a maximum reflectivity > 0 in the summary.
summary.dbzm.min (number)
The minimum maximum reflectivity value in the summary. Will normally be 0.
summary.dbzm.max (number)
The maximum maximum reflectivity value in the summary.
summary.dbzm.avg (number)
The average maximum reflectivity value in the summary.
summary.vil (object)
Object containing information about vertically integrated liquid (VIL) in the summary.
summary.vil.count (number)
The number of storm cells with a VIL > 0 in the summary.
summary.vil.min (number)
The minimum VIL value in the summary. Will normally be 0.
summary.vil.max (number)
The maximum VIL value in the summary.
summary.vil.avg (number)
The average VIL value in the summary.
summary.top (object)
Object containing information about maximum storm top in the summary.
summary.top.count (number)
The number of storm cells with a maximum storm top > 0 in the summary.
summary.top.maxFT (number)
The maximum storm top in feet in the summary.
summary.top.maxM (number)
The maximum storm top in meters in the summary.
summary.top.minFT (number)
The minimum storm top in feet in the summary.
summary.top.minM (number)
The minimum storm top in meters in the summary.
summary.top.avgFT (number)
The average storm top in feet in the summary.
summary.top.avgM (number)
The average storm top in meters in the summary.
summary.speed (object)
Object containing information about storm speed in the summary.
summary.speed.count (number)
The number of storm cells with a storm speed > 0 in the summary.
summary.speed.maxKTS (number)
The maximum storm speed in knots in the summary.
summary.speed.maxKPH (number)
The maximum storm speed in kilometers per hour in the summary.
summary.speed.maxMPH (number)
The maximum storm speed in miles per hour in the summary.
summary.speed.maxMPS (number)
The maximum storm speed in meters per second in the summary.
summary.speed.minKTS (number)
The minimum storm speed in knots in the summary.
summary.speed.minKPH (number)
The minimum storm speed in kilometers per hour in the summary.
summary.speed.minMPH (number)
The minimum storm speed in miles per hour in the summary.
summary.speed.minMPS (number)
The minimum storm speed in meters per second in the summary.
summary.speed.avgKTS (number)
The average storm speed in knots in the summary.
summary.speed.avgKPH (number)
The average storm speed in kilometers per hour in the summary.
summary.speed.avgMPH (number)
The average storm speed in miles per hour in the summary.
summary.speed.avgMPS (number)
The average storm speed in meters per second in the summary.
summary.states (array)
An array of state abbreviations in which the storm cells are located.
summary.traits (object)
Object containing information about storm traits in the summary.
summary.traits.general (number)
The number of storm cells with a general threat in the summary.
summary.traits.hail (number)
The number of storm cells with a hail threat in the summary.
summary.traits.rotating (number)
The number of storm cells with a rotating threat in the summary.
summary.traits.tornado (number)
The number of storm cells with a tornado threat in the summary.
summary.traits.threat (number)
The number of storm cells with a threat in the summary.
summary.geoPoly (object)
GeoJson Object containing the polygon or multipolygons surrounding the storm cells in the summary. Null if no storm cells are found or if the `filter=geo` parameter is not passed.
summary.geoPoly.type (string)
The type of GeoJson object. Will always be `Polygon` or `MultiPolygon`.
summary.geoPoly.coordinates (array)
An array of coordinates defining the polygon or multipolygon.
[
{
"summary": {
"id": "all",
"range": {
"count": 272,
"fromTimestamp": 1702512000,
"fromDateTimeISO": "2023-12-14T00:00:00+00:00",
"toTimestamp": 1702597192,
"toDateTimeISO": "2023-12-14T23:39:52+00:00",
"maxTimestamp": 1702597043,
"maxDateTimeISO": "2023-12-14T23:37:23+00:00",
"minTimestamp": 1702596511,
"minDateTimeISO": "2023-12-14T23:28:31+00:00"
},
"tvs": {
"count": 0,
"min": 0,
"max": 0
},
"mda": {
"count": 36,
"threatCount": 0,
"min": 1,
"max": 6
},
"hail": {
"prob": {
"count": 1,
"threatCount": 0,
"min": 0,
"max": 50,
"avg": 0
},
"probSevere": {
"count": 0,
"threatCount": 0,
"min": 0,
"max": 0,
"avg": 0
},
"maxSize": {
"count": 1,
"maxIN": 0.5,
"maxCM": 1.3,
"minIN": 0,
"minCM": 0,
"avgIN": 0,
"avgCM": 0
}
},
"dbzm": {
"count": 272,
"min": 32,
"max": 58,
"avg": 42
},
"vil": {
"count": 263,
"min": 0,
"max": 12,
"avg": 2
},
"top": {
"count": 271,
"maxFT": 19200,
"maxM": 5852.16,
"minFT": 0,
"minM": 0,
"avgFT": 9449.3,
"avgM": 2880
},
"speed": {
"count": 177,
"maxKTS": 86.99972377152,
"maxKPH": 161,
"maxMPH": 100,
"maxMPS": 45,
"minKTS": 1.99999364992,
"minKPH": 4,
"minMPH": 2,
"minMPS": 1,
"avgKTS": 41,
"avgKPH": 76,
"avgMPH": 47,
"avgMPS": 21
},
"states": [
"nd",
"ak",
"nm",
"fl",
"ks",
"tx",
"ok",
"ne"
],
"traits": {
"general": 269,
"hail": 0,
"rotating": 3,
"tornado": 0,
"threat": 136
},
"geoPoly": null
}
}
]