Endpoint: stormcells/summary

The stormcells/summary endpoint provides an overall summary on current storm cells based on search / filter criteria.  Example uses include obtaining the number of storms cells, maximum hail currently reported within storm cells,  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. Coverage area includes the 50 US states, Puerto Rico and Guam

https://api.aerisapi.com/stormcells/summary

Supported Actions

The following actions are supported with the stormcells/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 enpoint's detailed documentation for specific information regarding how to use the :id action.
affects The affects action requests all places affected by a particular type of event, such as earthquake or storm cell. The query for places affected is unique for each endpoint it belongs to and can be a polygon (e.g., storm cell forecasts or warnings) or a circle with the center being the location of the event (e.g., earthquakes or fires). Instead of returning an array of objects specific to the endpoint, the affects action will always return an array of place objects in the same format as the within action on the places endpoint.

Note: Not all endpoints support this action, so refer to each endpoint's complete documentation to determine if supported and its usage.
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), square (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.

Supported Parameters

The following parameters are optional unless otherwise noted:

callback callback=:functionName Used with JSONP implementation.

Defines the callback function to use for the response. The response will be enclosed as C(response), where C is the callback function provided.
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.
p p=:place Defines the location to query data for. Refer to the list of supported place value formats.
query query=:string Used to filter results based on certain fields in the data set. See Advanced Queries for more details.
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.
limit limit=:total The total number of results to return as an integer. Each endpoint may have a set maximum for this value depending on usage.

The default limit is 1 if not specified.
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.

Supported Filters

The following filters can be passed to the filter parameter to reduce the results that are returned:

hail Returns summary for storm cells that most likely contain hail.
rotating Returns summary for storm cells that show rotation characteristics.
tornado Returns summary for storm cells that contain a tornadic vortex signature (TVS) as determined by NEXRAD radar.
threat Returns summary for storm cells that are potentially threatening, ignoring storm cells that are not currently threatening in nature.
rainmoderate Returns summary for storm cells that show moderate, heavy or intense rainfall / precipitation
rainheavy Returns summary for storm cells that show heavy or intense rainfall / precipitation
rainintense Returns summary for storm cells that show intense rainfall / precipitation
conus Returns summary for storm cells within the Continental US only.
geo Indicator for the API to include the polygons of the storm cell groups used with-in the summary
noforecast Indicator for the API to ignore the storm cell forecasts when creating the storm cell groups used with-in the summary

Supported Query Properties

Use the following supported property keys when creating custom queries for your requests:

hail, hailprob Used to query the storm cells hail probability. i.e. query=hail:70 will return only if the hail probability is greater than or equal to 70%.
hailsevere Used to query the storm cells probability of severe hail.
hailsize Used to query the storm cells maximum hail size, in inches.
tvs Used to query if a storm cell is tornadic.
mda, rotation Used to query the degree of a storm cells rotation.
dbz Used to query the storm cells based on estimated precipitation intensity
name Used to query based on the closest city to the storm cell.
state Query the state the storm cell is in.

Example:
/stormcells/search?query=state:al&limit=100 (Returns up to 100 storm cells in the state of Alabama)
country Used to limit results based on country. Currently only 'us' supported.
pop* Available for use with the affects action only. Utilized to limit results based on population.

Sortable Fields

You can use the following fields to sort the data returned in your response:

pop* Available for use with the affects action only. Utilized to sort the results based on population. By default the affects action will sort by population descending.

Examples

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 a summary for all storm cells
/stormcells/summary?

Return a summary for only storm cells within the Continental US
/stormcells/summary/search?filter=conus&

Return a summary for only storm cells within the state of Georgia.
/stormcells/summary/search?query=state:ga&

Return a summary for storm cells that are within the states of Georgia or Alabama.
Note the semicolon is used to represent a logical 'OR'.
/stormcells/summary/search?query=state:ga;state:al&

Return a summary for storm cells within a 50 mile radius of Minneapolis, MN
/stormcells/summary/minneapolis,mn?

Return a summary for storm cells within a 100 mile radius of zip code 55403 (Minneapolis, MN)
/stormcells/summary/55403?radius=100miles&

Return a summary for storm cells within the Continental US and have a high probability of having hail.
/stormcells/summary/search?filter=conus,hail&

Return a summary for storm cells that have a high probability of having hail and contain a tornadic vortex signature (TVS) as determined by NEXRAD radar.
Note the comma is used to represent a logical 'AND', meaning only use storm cells that meet both criteria.
/stormcells/summary/search?filter=hail,tornado&

Return a summary for storm cells that have a high probability of having hail or contain a tornadic vortex signature (TVS) as determined by NEXRAD radar.
Note the semicolon is used to represent a logical 'OR', meaning only use storm cells that meet both criteria.
/stormcells/summary/search?filter=hail;tornado&

Return a summary for storm cells that have a high probability of having hail. Additionally include the polygons of the storm cell groups.
/stormcells/summary/search?filter=hail,geo&

Return a summary for storm cells that are threatening in nature.
/stormcells/summary/search?filter=threat&

Return up to 10 locations with a population of 50,000 or higher within the state of Georgia, that are currently being affected or within the path of threatening storm cells.
/stormcells/summary/affects?filter=threat&query=state:ga,pop:50000&limit=10&

Return up to 10 locations with a population of 50,000 or higher within the state of Georgia, that are within the immediate vicinity (ignoring storm cell forecasts) of threatening storm cells.
/stormcells/summary/affects?filter=threat,noforecast&query=state:ga,pop:50000&limit=10&

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.


{
    "success": true,
    "error": null,
    "response": [{
        "summary": {
            "id": "all",
            "range": {
                "count": 305,
                "fromTimestamp": 1528243200,
                "fromDateTimeISO": "2018-06-06T00:00:00+00:00",
                "toTimestamp": 1528310418,
                "toDateTimeISO": "2018-06-06T18:40:18+00:00",
                "maxTimestamp": 1528310401,
                "maxDateTimeISO": "2018-06-06T18:40:01+00:00",
                "minTimestamp": 1528309714,
                "minDateTimeISO": "2018-06-06T18:28:34+00:00"
            },
            "tvs": {
                "count": 0,
                "min": 0,
                "max": 0
            },
            "mda": {
                "count": 19,
                "threatCount": 0,
                "min": 0,
                "max": 4
            },
            "hail": {
                "prob": {
                    "count": 32,
                    "threatCount": 8,
                    "min": 0,
                    "max": 90,
                    "avg": 4
                },
                "probSevere": {
                    "count": 1,
                    "threatCount": 0,
                    "min": 0,
                    "max": 10,
                    "avg": 0
                },
                "maxSize": {
                    "count": 32,
                    "maxIN": 0.5,
                    "maxCM": 1,
                    "minIN": 0,
                    "minCM": 0,
                    "avgIN": 0.1,
                    "avgCM": 0
                }
            },
            "dbzm": {
                "count": 294,
                "min": 34,
                "max": 64,
                "avg": 47
            },
            "vil": {
                "count": 291,
                "min": 0,
                "max": 56,
                "avg": 11
            },
            "top": {
                "count": 294,
                "maxFT": 49800,
                "maxM": 15179,
                "minFT": 3600,
                "minM": 1097.3,
                "avgFT": 18617,
                "avgM": 5674.4
            },
            "speed": {
                "count": 237,
                "maxKTS": 58,
                "maxKPH": 107,
                "maxMPH": 67,
                "minKTS": 0,
                "minKPH": 0,
                "minMPH": 0,
                "avgKTS": 16,
                "avgKPH": 30,
                "avgMPH": 19
            },
            "states": ["ga", "fl", "al", "in", "ak", "me", "tx", "ca", "az", "nm", "mi", "il", "sd", "nc", "wi", "nh", "la"],
            "traits": {
                "general": 296,
                "hail": 8,
                "rotating": 2,
                "tornado": 0,
                "threat": 228
            },
            "geoPoly": null
        }
    }]
}
								

Response Properties

The following properties will be provided in every response object:

summary (object) The storm cell summary object.
summary.range (object) Object containing the time range of storm cell observations and total used for the summary
summary.range.count (number) The total number of storm cells used to generate the summary
summary.range.fromTimestamp (number) The unix timestamp of the from parameter.
summary.range.fromDateTimeISO (string) The ISO8601 date of the from parameter.
summary.range.toTimestamp (number) The unix timestamp of the to parameter.
summary.range.toDateTimeISO (string) The ISO8601 date of the to parameter.
summary.range.maxTimestamp (number) The unix timestamp for the latest storm cell observation used to generate the summary
summary.range.maxDateTimeISO (string) The ISO8601 date of the latest storm cell observation used to generate the summary
summary.range.minTimestamp (number) The unix timestamp for the earliest storm cell observation used to generate the summary
summary.range.minDateTimeISO (string) The ISO8601 date of the earliest storm cell observation used to generate the summary
summary.tvs (object) Object containing information on the storm cells with a TVS
summary.tvs.count (number) The total number of storm cells that had a TVS indicator
summary.tvs.min (number) The minimum TVS value. Should be zero (0)
summary.tvs.max (number) The maximum TVS value. Should be zero (0) or one (1)
summary.mda (object) Object containing information on the storm cells with MDA
summary.mda.count (number) The total number of storm cells that had an MDA of greater than zero (0)
summary.mda.threatCount (number) The total number of storm cells that had a high MDA value, which could be potentially threatening
summary.mda.min (number) The mininmum MDA value for a storm cell within the summary
summary.mda.max (number) The maximum MDA value for a storm cell within the summary
summary.hail (object) Object containing a summary of hail information
summary.hail.prob (object) Object containing a summary of hail probability information.
summary.hail.prob.count (number) Total number of storm cells with a probability of hail > 0
summary.hail.prob.threatCount (number) Total number of storm cells with a high probability ( > 70%) of hail
summary.hail.prob.min (number) The minimum hail probability for the storm cells used in the summary
summary.hail.prob.max (number) The maximum hail probability for the storm cells used in the summary
summary.hail.prob.avg (number) The average hail probability for the storm cells used in the summary
summary.hail.probSevere (number) Object containing a summary of severe hail probability information.
summary.hail.probSevere.count (number) Total number of storm cells with a probability of severe hail > 0
summary.hail.probSevere.threatCount (number) Total number of storm cells with a high probability ( > 70%) of severe hail
summary.hail.probSevere.min (number) The minimum hail probability for the storm cells used in the summary
summary.hail.probSevere.max (number) The maximum hail probability for the storm cells used in the summary
summary.hail.probSevere.avg (number) The average hail probability for the storm cells used in the summary
summary.hail.maxSize (object) Object containing a summary of the estimated maximum hail size within the storm cells
summary.hail.maxSize.count (number) Total number of storm cells with an estimated hail size greater than 0
summary.hail.maxSize.minIN (number) The minimum estimated max hail size in inches
summary.hail.maxSize.minCM (number) The minimum estimated max hail size in centimeters
summary.hail.maxSize.maxIN (number) The maximum estimated max hail size in inches
summary.hail.maxSize.maxCM (number) The maximum estimated max hail size in centimeters
summary.hail.maxSize.avgIN (number) The average estimated max hail size in inches
summary.hail.maxSize.avgCM (number) The average estimated max hail size in centimeters
summary.dbzm (object) Object containing a summary of the dbzm
summary.dbzm.count (number) Total number of storm cells with an estimated dbzm > 0
summary.dbzm.min (number) The minimum estimated dbzm.
summary.dbzm.max (number) The maximum estimated dbzm.
summary.dbzm.avg (number) The average estimated dbzm.
summary.vil (object) Object containing a summary of the estimated VIL (Vertically integrated liquid)
summary.vil.count (number) Total number of storm cells with a VIL greater than zero (0)
summary.vil.min (number) The minimum estimated VIL.
summary.vil.max (number) The maximum estimated VIL.
summary.vil.avg (number) The average estimated VIL.
summary.top (number) Object containing a summary of cloud top heights
summary.top.count (number) Total number of storm cells with a cloud height greater than zero (0)
summary.top.minM (number) The minimum cloud top height in meters
summary.top.minFT (number) The minimum cloud top height in feet
summary.top.maxM (number) The maximum cloud top height in meters
summary.top.maxFT (number) The maximum cloud top height in feet
summary.top.avgM (number) The average cloud top height in meters
summary.top.avgFT (number) The averag cloud top height in feet
summary.speed (object) Object containing summary of storm cells speeds.
summary.speed.count (number) The total number of storm cells with a speed greater than zero (0)
summary.speed.minKTS (number) The minimum storm cell speed in knots
summary.speed.minKPH (number) The minimum storm cell speed in kilometers per hour
summary.speed.minMPH (number) The minimum storm cell speed in miles per hour
summary.speed.maxKTS (number) The maximum storm cell speed in knots
summary.speed.maxKPH (number) The maximum storm cell speed in kilometers per hour
summary.speed.maxMPH (number) The maximumstorm cell speed in miles per hour
summary.speed.avgKTS (number) The average storm cell speed in knots
summary.speed.avgKPH (number) The average storm cell speed in kilometers per hour
summary.speed.avgMPH (number) The average storm cell speed in miles per hour
summary.states (array) Array of two letter state abbreviations that storm cells included in the summary are located in.
geoPoly (object) GeoJSON object, normally a Polygon or MultiPolygon of the groups of storm cells used within the summary.

Will be 'null' unless the geo filter is provided.