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.
The following actions are supported with the stormreports/summary endpoint:
| :id | Requesting data by using the :id action is used for returning data for a particular item that has an ID associated with it. This is the primary method for requesting general weather information for a single location (observations, forecasts, advisories, etc.) as the location's name or a zip code serves as the id. Other endpoints may expect a certain value for the ID, such as storm cells whose ID value is a combination of the radar site identifier and unique identifier assigned to every storm cell. Refer to an endpoint's detailed documentation for specific information regarding how to use the :id action. |
| search | The search action is used as a more general query method and expects the query to be defined with the custom query for the request. Unlike the closest action, results will not be returned in any particular order. |
| within | The within action allows for returning data within a variety of different geometrical regions. Currently supported geometries include a circle (requires a center point and radius), rectangle (requires two coordinate points defining the top-left and bottom-right corners) and polygon (requires at least three coordinate points). Unlike the closest action, the results will not be returned in any particular order based on distance. |
The following parameters are optional unless otherwise noted:
| fields | fields=:string |
Provides a comma separated list of values for the API to return. This parameter is often used to limit the amount of data returned. See Reducing Output. |
| filter | filter=:string |
Predefined filters for limiting the results. The filter value can be a single, comma-delimited or a semicolon delimited string of filter names. |
| from | from=:string |
Returns the results starting from the value specified. For best practices we recommend using the to parameter as well to define a specific time frame.Supports a UNIX timestamp or a specific date string. Alternatively, common date formats supported by the PHP strtotime() function will be accepted; however, commas are not accepted. Examples: from=tomorrow from=friday from=1302883980 from=MM/DD/YYYY from=YYYY/MM/DD from=+2hours from=2017-02-27 5:00 PM |
| p | p=:place |
Defines the location to query data for. Refer to the list of supported place value formats. |
| to | to=:string |
Returns the results between now and the value specified. For best practices we recommend using the from parameter as well to define a specific time frame. When used in conjunction with the from parameter, the value of to will be relative to the value of from, not relative to the current time. Supports a UNIX timestamp or a specific date string. Alternatively, common date formats supported by the PHP strtotime() function will be accepted; however, commas are not accepted. Examples: to=+6hours to=+5days to=1302883980 to=MM/DD/YYYY to=YYYY/MM/DD to=2017-02-27 5:00 PM |
| radius | radius=:distance:unit |
When requesting the closest results within a circle, the radius determines how far from the specified location to search. A valid unit value must be included in your radius value, e.g., "5mi", "10km", "25miles". If no unit is provided, your value is assumed to be in meters by default. Most endpoints utilize a default radius of 50 miles, though some endpoints, such as lightning, may have tighter restrictions specified. |
| query | query=:string |
Used to filter results based on certain fields in the data set. See Advanced Queries for more details. |
The following filters can be passed to the filter parameter to reduce the results that are returned:
| avalanche | Returns summary for avalanche-related storm reports. |
| blizzard | Returns summary for blizzard-related storm reports. |
| dust | Return summary for dust related storm reports. |
| flood | Returns summary for flood-related storm reports. |
| fog | Returns summary for fog-related storm reports. |
| ice | Returns summary for ice-related storm reports. |
| hail | Returns summary for hail-related storm reports. |
| lightning | Returns summary for lightning-related storm reports. |
| marine | Returns summary for marine related storm reports. |
| rain | Returns summary for rain-related storm reports. |
| snow | Returns summary for snow-related storm reports. |
| tides | Returns summary for tide-related storm reports. |
| tornado | Returns summary for tornado and waterspout-related storm reports. |
| tropical | Returns summary for tropical storm / hurricane related storm reports |
| wind | Returns summary for wind-related storm reports. |
Use the following supported property keys when creating custom queries for your requests:
| code | Query storm reports based on the coded type. Example: /stormreports/summary/search?query=code:S (returns summary on storm reports that are of the code "S", which is snow) |
| type | Query storm reports based on the named type. Example: /stormreports/summary/search?query=type:snow (returns summary on storm reports that are of the type snow) |
| state | Query storm reports within a state. The state should be lower case and a two letter abbreviation. Example: /stormreports/summary/search?query=state:mn (returns summary on storm reports that the state matches Minnesota, "mn") |
| name | Query storm reports based on the closest location. |
| detail | Query storm reports based on the reported magnitude. i.e. rain/snow amount, wind speed |
The /[:endpoint]/[:action]? portion within the query template below can be exchanged with any of the examples. Also, please note you will need to input your client credentials in the [ID] and [SECRET] fields which can be found under the Apps section of the members area.
https://api.aerisapi.com/[:endpoint]/[:action]?client_id=[ID]&client_secret=[SECRET]
Return summary for all storm reports received today/stormreports/summary?
Return a summary for only storm reports today within the state of Georgia./stormreports/summary/search?query=state:ga&
Return a summary for storm reports that are within the states of Georgia or Alabama.
Note the semicolon is used to represent a logical 'OR'./stormreports/summary/search?query=state:ga;state:al&
Return a summary for storm reports within a 50 mile radius of Minneapolis, MN today./stormreports/summary/minneapolis,mn?
Return a summary for all storm reports received over the past week./stormreports/summary?from=-1week&to=now&
Return a summary for all tornado, funnel cloud and waterspout related storm reports/stormreports/summary?filter=tornado&
Return a summary for all tornado, funnel cloud and waterspout related storm reports over the past week/stormreports/summary?filter=tornado&from=-1week&to=now&
Return a summary for all tornado, funnel cloud and waterspout related storm reports on Aug 17, 2016 (UTC)/stormreports/summary?filter=tornado&from=2016-08-17&to=+1day&
Return a summary of rain and snow related storm reports today.
Note the semicolon is used to represent a logical 'OR'./stormreports/summary?filter=rain;snow&
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.
{
"success": true,
"error": null,
"response": [{
"summary": {
"range": {
"count": 2,
"fromTimestamp": 709171200,
"fromDateTimeISO": "1992-06-22T00:00:00+00:00",
"toTimestamp": 709171200,
"toDateTimeISO": "1992-06-22T00:00:00+00:00",
"maxTimestamp": 709171200,
"maxDateTimeISO": "1992-06-22T00:00:00+00:00",
"minTimestamp": 709171200,
"minDateTimeISO": "1992-06-22T00:00:00+00:00"
},
"states": ["co", "tx"],
"typeCats": ["tornado"],
"types": [{
"type": "tornado",
"code": "T",
"range": {
"count": 2,
"maxTimestamp": 709171200,
"maxDateTimeISO": "1992-06-22T00:00:00+00:00",
"minTimestamp": 709171200,
"minDateTimeISO": "1992-06-22T00:00:00+00:00"
},
"detail": {
"count": 2
},
"states": ["co", "tx"],
"cat": "tornado"
}]
}
}]
}
The following properties will be provided in every response object:
Last modified: September 14, 2023