Storm Reports Summary
https://data.api.xweather.com/stormreports/summary/The storm reports/summary endpoint provides an overall summary of received storm reports based on search/filter criteria. Example uses include obtaining the number of storm reports received within a specified timeframe and/or geographical area, obtaining the maximum rainfall or snowfall reported, or obtaining the total number of tornado storm reports within a 50-mile radius. This endpoint is available for all 50 states in the USA, as well as Puerto Rico and Canada.
Requests
Every request to the endpoint must include one of the supported actions in the url.
https://data.api.xweather.com/stormreports/summary/{action}?client_id={client_id}&client_secret={client_secret}&{params}Supported Actions
The following actions are supported with the /stormreports/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. |
| within | Type: stringUses a circle or polygon, define an area to search for results. Learn more. |
| search | Type: stringA generalized action that is determined with the endpoints query parameters. 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 storm reports.
summary.range (object)
Object with count and date range of the summary.
summary.range.count (number)
The total number of storm reports within the summary.
summary.range.fromTimestamp (number)
The Unix timestamp of the start of the summary period. Often matches the `from` parameter.
summary.range.fromDateTimeISO (string)
The ISO 8601 date and time of the start of the summary period. Often matches the `from` parameter.
summary.range.toTimestamp (number)
The Unix timestamp of the end of the summary period. Often matches the `to` parameter.
summary.range.toDateTimeISO (string)
The ISO 8601 date and time of the end of the summary period. Often matches the `to` parameter.
summary.range.maxTimestamp (number)
The Unix timestamp of the last storm report within the summary.
summary.range.maxDateTimeISO (string)
The ISO 8601 date and time of the last storm report within the summary.
summary.range.minTimestamp (number)
The Unix timestamp of the first storm report within the summary.
summary.range.minDateTimeISO (string)
The ISO 8601 date and time of the first storm report within the summary.
summary.states (array)
Array of states within the summary that contain storm reports
summary.typeCats (array)
Array of categories of the storm reports used within the summary.
summary.types (array)
Array of objects providing a summary of each storm report type.
summary.types.#.type (string)
The type of storm report.
summary.types.#.code (string)
The code of the storm report type.
summary.types.#.range (object)
The count and date range of the storm report type.
summary.types.#.range.count (number)
The total number of storm reports of the type.
summary.types.#.range.maxTimestamp (number)
The Unix timestamp of the last storm report of the type within the summary.
summary.types.#.range.maxDateTimeISO (string)
The ISO 8601 date and time of the last storm report of the type within the summary.
summary.types.#.range.minTimestamp (number)
The Unix timestamp of the first storm report of the type within the summary.
summary.types.#.range.minDateTimeISO (string)
The ISO 8601 date and time of the first storm report of the type within the summary.
summary.types.#.detail (object)
The count and date range of the storm report type.
summary.types.#.detail.count (number)
The total number of storm reports of the type.
summary.types.#.detail.maxMPH (number)
Summary of the maximum wind speed in miles per hour. Included only for wind related storm report types.
summary.types.#.detail.maxKPH (number)
Summary of the maximum wind speed in kilometers per hour. Included only for wind related storm report types.
summary.types.#.detail.maxKTS (number)
Summary of the maximum wind speed in knots. Included only for wind related storm report types.
summary.types.#.detail.maxMPS (number)
Summary of the maximum wind speed in meters per second. Included only for wind related storm report types.
summary.types.#.detail.minMPH (number)
Summary of the minimum wind speed in miles per hour. Included only for wind related storm report types.
summary.types.#.detail.minKPH (number)
Summary of the minimum wind speed in kilometers per hour. Included only for wind related storm report types.
summary.types.#.detail.minKTS (number)
Summary of the minimum wind speed in knots. Included only for wind related storm report types.
summary.types.#.detail.minMPS (number)
Summary of the minimum wind speed in meters per second. Included only for wind related storm report types.
summary.types.#.detail.avgMPH (number)
Summary of the average wind speed in miles per hour. Included only for wind related storm report types.
summary.types.#.detail.avgKPH (number)
Summary of the average wind speed in kilometers per hour. Included only for wind related storm report types.
summary.types.#.detail.avgKTS (number)
Summary of the average wind speed in knots. Included only for wind related storm report types.
summary.types.#.detail.avgMPS (number)
Summary of the average wind speed in meters per second. Included only for wind related storm report types.
summary.types.#.states (array)
The states within the summary that contain storm reports of the type.
summary.types.#.cat (string)
The category of the storm report type.
[
{
"summary": {
"range": {
"count": 49,
"fromTimestamp": 1702598400,
"fromDateTimeISO": "2023-12-15T00:00:00+00:00",
"toTimestamp": 1702656012,
"toDateTimeISO": "2023-12-15T16:00:12+00:00",
"maxTimestamp": 1702652940,
"maxDateTimeISO": "2023-12-15T15:09:00+00:00",
"minTimestamp": 1702598760,
"minDateTimeISO": "2023-12-15T00:06:00+00:00"
},
"states": [
"as",
"co",
"fl",
"ks",
"mi",
"nm",
"ok",
"tx"
],
"typeCats": [
"flood",
"fog",
"snow",
"tropical",
"wind"
],
"types": [
{
"type": "fog",
"code": "J",
"range": {
"count": 4,
"maxTimestamp": 1702652940,
"maxDateTimeISO": "2023-12-15T15:09:00+00:00",
"minTimestamp": 1702598760,
"minDateTimeISO": "2023-12-15T00:06:00+00:00"
},
"detail": {
"count": 4
},
"states": [
"co",
"ks"
],
"cat": "fog"
},
{
"type": "landslide",
"code": "0",
"range": {
"count": 1,
"maxTimestamp": 1702633500,
"maxDateTimeISO": "2023-12-15T09:45:00+00:00",
"minTimestamp": 1702633500,
"minDateTimeISO": "2023-12-15T09:45:00+00:00"
},
"detail": null,
"states": [
"as"
],
"cat": "tropical"
},
{
"type": "snow",
"code": "S",
"range": {
"count": 28,
"maxTimestamp": 1702650960,
"maxDateTimeISO": "2023-12-15T14:36:00+00:00",
"minTimestamp": 1702616640,
"minDateTimeISO": "2023-12-15T05:04:00+00:00"
},
"detail": {
"count": 28,
"maxIN": 21,
"maxCM": 53,
"minIN": 0.8,
"minCM": 2,
"avgIN": 7.8,
"avgCM": 20
},
"states": [
"nm",
"ok",
"tx"
],
"cat": "snow"
},
{
"type": "flood",
"code": "E",
"range": {
"count": 1,
"maxTimestamp": 1702605600,
"maxDateTimeISO": "2023-12-15T02:00:00+00:00",
"minTimestamp": 1702605600,
"minDateTimeISO": "2023-12-15T02:00:00+00:00"
},
"detail": null,
"states": [
"as"
],
"cat": "flood"
},
{
"type": "non-tstm wnd gst",
"code": "N",
"range": {
"count": 15,
"maxTimestamp": 1702626660,
"maxDateTimeISO": "2023-12-15T07:51:00+00:00",
"minTimestamp": 1702600080,
"minDateTimeISO": "2023-12-15T00:28:00+00:00"
},
"detail": {
"count": 15,
"maxMPH": 57,
"maxKPH": 92,
"maxKTS": 50,
"maxMPS": 25,
"minMPH": 39,
"minKPH": 63,
"minKTS": 34,
"minMPS": 17,
"avgMPH": 45.9,
"avgKPH": 74,
"avgKTS": 40,
"avgMPS": 21
},
"states": [
"fl",
"mi"
],
"cat": "wind"
}
]
}
}
]