The alerts/summary endpoint provides an overall summary of the currently-active alerts within the USA and Canada based on search/filter criteria. Example use cases include obtaining the total number of active weather zones or counties with active alerts, the types of active alerts, what states currently have active alerts, and more. This endpoint is available for all 50 states in the USA, as well as Puerto Rico, Canada, and Europe.
Use our wizard to try out this endpoint
Please refer to the full list of available alerts, type and color codes:
https://www.aerisweather.com/support/docs/aeris-maps/reference/alert-types/
The alert type codes may be passed in the type element of the query parameter and correspond to the details.type in the response output.
The following actions are supported with the alerts/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. |
| 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. The maximum limit for this endpoint is 250. |
| 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. |
The following filters can be passed to the filter parameter to reduce the results that are returned:
| warning | Returns all warnings. A warning is issued when a hazardous weather or hydrologic event is occurring, imminent, or likely. A warning means weather conditions pose a threat to life or property. People in the path of the storm need to take protective action. |
| watch | Returns all watches. A watch is used when the risk of a hazardous weather or hydrologic event has increased significantly, but its occurrence, location, or timing is still uncertain. It is intended to provide enough lead time so those who need to set their plans in motion can do so. A watch means that hazardous weather is possible. People should have a plan of action in case a storm threatens and they should listen for later information and possible warnings especially when planning travel or outdoor activities. |
| advisory | Returns all alerts. An alert is issued when a hazardous weather or hydrologic event is occurring, imminent, or likely. Alerts are for "less serious" conditions than warnings that may cause significant inconvenience, and if caution is not exercised could lead to situations that may threaten life or property. |
| outlook | Returns all outlooks. An outlook is issued daily to indicate that a hazardous weather or hydrologic event may occur in the next several days. The outlook will include information about potential severe thunderstorms, heavy rain or flooding, winter weather, extremes of heat or cold, etc., that may develop over the next 7 days with an emphasis on the first 24 hours of the forecast. It is intended to provide information to those who need considerable lead time to prepare for the event. |
| statement | Returns all special weather statements. |
| severe | Returns all severe-related alerts: - severe thunderstorm - tornado |
| flood | Returns all flood/hydro-related alerts: - debris flow - flood, flash flood - hydrologic |
| tropical | Returns all tropical-related alerts: - tropical storm, hurricane, typhoon - tropical storm wind - hurricane wind - extreme wind |
| winter | Returns all winter-related alerts: - blizzard, winter storm, winter weather - snow, heavy snow - lake effect snow - snow and blowing snow - ice pellets, freezing rain, ice storm - wind chill |
| marine | Returns all marine/coastal-related alerts: - marine - freezing spray, heavy freezing spray - small craft - small craft for winds - small craft for hazardous seas - small craft for rough bar - gale - hazardous seas - hurricane force winds - lakeshore flood - coastal flood, high surf - tsunami - low water - dense fog, dense smoke, ashfall (marine) |
| nonprecip | Returns all non-precipitation-related alerts: - blowing dust/dust storm - wind, high wind, lake wind - dense smoke - dense fog, freezing fog - freeze, frost - heat, excessive heat, extreme cold |
| forecast | Returns forecasts, normally short-term forecasts. |
| all | Return all warnings, watches, advisories, statements, outlooks and forecasts. |
| wind | Returns wind-related alerts. |
| fire | Returns fire-related alerts. |
| tsunami | Returns tsunami-related alerts. |
| now | Returns alerts that are currently in effect. |
| synopsis | Returns a synopsis of the alerts. |
| tornado | Returns tornado related alerts (Tornado watches/warnings) |
| emergency | Returns emergency-specific alerts. |
| canada | Returns only Canadian alerts. Equivalent to query=country:ca |
| usa | Returns only USA alerts. Equivalent to query=country:us |
| allcountries | Returns alerts for all countries (the default). |
| hassmallpoly | Returns alerts that have a small polygon (US severe thunderstorm, tornado, flash flood etc) |
| distinct | Returns a summary based on counting alerts issued for multiple locations once. |
| nonmarine | Returns all warnings, watches, and alerts that are not marine related. |
Use the following supported property keys when creating custom queries for your requests:
| type | Used to query the alert type. The value should be set to the VTEC Code or the WMO if no VTEC code exists. Review the list of allowed Alert Types. Examples: /alerts/minneapolis,mn?query=type:TO.W will return only the tornado warnings/alerts/minneapolis,mn?query=type:TO.W;type:NOW will return tornado warnings and short-term forecasts |
| wxzone | Used to query by the zone id the alert is issued for. Normally will be a NOAA public weather zone that looks similar to: VAZ014 or if issued for a specific county : VAC023 |
| sig | Used to query by the one character coded significance of an alert type. W = Warning A = Watch Y = Advisory S = Statement O = Outlook F = Forecast Examples: /alerts/minneapolis,mn?query=sig:W,sig:A (returns only warnings and alerts for Minneapolis, MN) |
| sigp | Used to query by the numeric representation of an alert type. A lower number has higher significance. 1 = Warning 3 = Watch 5 = Advisory 7 = Statement 9 = Forecast (Short term) 11 = Outlook Examples: /alerts/minneapolis,mn?query=sigp:1:3 (returns only warnings and alerts for Minneapolis, MN) |
| name | County name or weather zone name (lowercase) of the location the alert has been issued for. |
| issued | Used to query by the date the alert is issued for. |
| expires | Used to query by the date the alert is scheduled to expire. |
| active | Used to query active or inactive alerts. 0 = not active 1 = active By default the API will not return inactive alerts Examples: /alerts/minneapolis,min?query=active:0:0 (returns only alerts that are no longer active for Minneapolis, MN) |
| emergency | Used to query emergency specific alerts, such as tornado emergencies. true = emergency specific alerts false = non emergency specific alerts |
| issued | Used to query alerts based on the issued time. Values can be relative formats or dates. Times are not currently supported. Examples: /alerts/minneapolis,mn?query=issued:-10minutes&limit=100 (returns alerts issued within the past 10 minutes for Minneapolis, MN) |
| begins | Used to query alerts based on the begins time of the alert. Some alerts such as winter storm warnings may be issued now, but do not go into effect until several hours later. Values can be relative formats or dates. Times are not currently supported. Examples: /alerts/minneapolis,mn?query=begins:-6hours:6hours&limit=100 (returns active alerts that either went into effect in the past six hours or are set to go live in the next 6 hours for Minneapolis, MN) |
| expires | Used to query alerts based on the expiration time. Values can be relative formats or dates. Times are not currently supported. Examples: /alerts/minneapolis,mn?query=expires:now:10minutes&limit=100 (returns alerts set to expire within the next 10 minutes for Minneapolis, MN) |
| added | Used to query alerts based on the time they were added to the API database. Values can be relative formats or dates. Times are not currently supported. Examples: /alerts/minneapolis,mn?query=added:-10minutes&limit=100 (returns alerts received and added within the last 10 minutes for Minneapolis, MN) |
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 active alerts./alerts/summary?
Return a summary for all active alerts within a 50 mile radius of Minneapolis, MN/alerts/summary/minneapolis,mn?
Return a summary for all active alerts within a 100 mile radius of Minneapolis, MN/alerts/summary/minneapolis,mn?radius=100miles&
Return a summary for all severe thunderstorm and tornado watches/warnings./alerts/summary/?filter=severe&
Return a summary for all alerts for severe or flood related events.
Note the semicolon is used to represent a logical 'OR'./alerts/summary/?filter=severe;flood&
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": {
"count": 5,
"countries": [
"us"
],
"states": [
"fl"
],
"typeCodes": [
"FR.Y",
"RP.S"
],
"types": [
{
"type": "FROST ADVISORY",
"code": "FR.Y",
"priority": 88,
"color": "#6495ED",
"count": 3,
"states": [
"fl"
],
"countries": [
"us"
],
"zones": [
"FLZ020",
"FLZ021",
"FLZ122"
]
},
{
"type": "RIP CURRENT STATEMENT",
"code": "RP.S",
"priority": 96,
"color": "#40E0D0",
"count": 2,
"states": [
"fl"
],
"countries": [
"us"
],
"zones": [
"FLZ114",
"FLZ168"
]
}
]
}
}
}
The following properties will be provided in every response object:
| summary | (object) Object containing the summary |
| summary.count | (number) The total number of weather zones or FIPS that have active alerts. |
| summary.states | (array) Array of two letter US state abbreviations or Canadian province in the format of "ca.xx", that have active alerts |
| summary.typeCodes | (array) Array of active VTEC or WMO (if no VTEC) codes for the active alerts. Please refer to the full list of available alerts, type and color codes: https://www.aerisweather.com/support/docs/aeris-maps/reference/alert-types/ |
| summary.types | (array) Array of each active alert type, with summary information for each |
| summary.types[#].type | (string) The alert type name |
| summary.types[#].code | (string) The VTEC or WMO (if no VTEC) codes for the alert Please refer to the full list of available alerts, type and color codes. |
| summary.types[#].color | (string) The 6 character hex color code for the alert. Corresponds to the AMP Alert types/colors. |
| summary.types[#].count | (number) The total number of weather zones or FIPS that the alert is active within. |
| summary.types[#].states | (array) Array of two letter US state abbreviations or Canadian province in the format of "ca.xx",that the alert is active within |
| summary.types[#].zones | (array) Array of NOAA public weather zones and/or FIPS codes that the alert is active within. |
Last modified: December 08, 2022