Alerts Summary
https://data.api.xweather.com/alerts/summary/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.
Supported Alert Types
Please refer to the full list of available alerts, type and color codes:
https://www.aerisweather.com/support/docs/aeris-maps/reference/alert-types/ (opens in a new tab)
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.
Requests
Every request to the endpoint must include one of the supported actions in the url.
https://data.api.xweather.com/alerts/summary/{action}?client_id={client_id}&client_secret={client_secret}&{params}Supported Actions
The following actions are supported with the /alerts/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. |
| 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.count (number)
The total number of weather zones or FIPS that have active alerts.
summary.countries (array)
Array of the 2 letter ISO-3166 country abbreviations the alerts are active in.
summary.states (array)
Array of two letter US state abbreviations or Canadian province in the format of "ca.xx", that have active alerts. Empty array for other countries.
summary.typeCodes (array)
Array of active Alert Type 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.#.type (string)
The alert type name
summary.types.#.code (string)
The Alert Type code.
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.#.priority (number)
The alert priority. Higher numbers indicate a higher priority /severity. Useful for sorting alerts by severity.
summary.types.#.color (string)
The Alert Type color.
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.#.count (number)
The total number of alerts for the type in the country.
summary.types.#.states (array)
An array of the two letter US state abbreviations or Canadian province in the format of "ca.xx", that have active alerts for the type. An array with a null element for other countries.
summary.types.#.countries (array)
Array of the 2 letter ISO-3166 country abbreviations the alerts are active in.
summary.types.#.zones (array)
Array of the zone IDs, if applicable, the alerts are active in.
[
{
"summary": {
"count": 3,
"countries": [
"us"
],
"states": [
"co"
],
"typeCodes": [
"WS.W",
"WW.Y"
],
"types": [
{
"type": "WINTER STORM WARNING",
"code": "WS.W",
"priority": 25,
"color": "#FF69B4",
"count": 2,
"states": [
"co"
],
"countries": [
"us"
],
"zones": [
"COZ094",
"COZ099"
]
},
{
"type": "WINTER WEATHER ADVISORY",
"code": "WW.Y",
"priority": 64,
"color": "#7B68EE",
"count": 1,
"states": [
"co"
],
"countries": [
"us"
],
"zones": [
"COZ093"
]
}
]
}
}
]