The threats endpoint provides a localized threat summary for the location provided. Currently, threats are limited to storm-based threats. The threats coverage area includes the 50 US states, in addition to Puerto Rico and Guam.
Use our wizard to try out this endpoint
The following actions are supported with the threats 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. |
The following parameters are optional unless otherwise noted:
| p | p=:place |
Defines the location to query data for. Refer to the list of supported place value formats. |
| 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. |
| 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. |
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]
Find the threats affecting Minneapolis, MN/threats/minneapolis,mn?
Find the threats within a 200 mile radius that may affect zip code 55403 (Minneapolis, MN)/threats/55403?radius=200miles&
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": [{
"loc": {
"lat": 26.82339,
"long": -80.13865
},
"place": {
"name": "palm beach gardens",
"state": "fl",
"country": "us"
},
"profile": {
"tz": "America\/New_York"
},
"periods": [{
"timestamp": 1528311387,
"dateTimeISO": "2018-06-06T14:56:27-04:00",
"storms": {
"phrase": {
"long": "An area of strong storms is approaching from the WSW with frequent lightning and up to 0.50 inch hail possible.",
"short": "An area of strong storms is approaching from the WSW with frequent lightning and up to 0.50\" hail possible."
},
"distance": {
"minKM": 10.3,
"minMI": 6.4,
"maxKM": 48.3,
"maxMI": 30,
"avgKM": 22.6,
"avgMI": 14
},
"direction": {
"toDEG": 61,
"to": "ENE",
"fromDEG": 241,
"from": "WSW"
},
"approaching": true,
"speed": {
"minKTS": 14,
"minKPH": 25.9,
"minMPH": 16.1,
"maxKTS": 39,
"maxKPH": 72.2,
"maxMPH": 44.9,
"avgKTS": 21.4,
"avgKPH": 39.6,
"avgMPH": 24.6
},
"span": 133,
"hail": {
"probSevere": 0,
"prob": 40,
"maxSizeIN": 0.5,
"maxSize": "<0.50",
"maxSizeCM": 1.27
},
"rotation": false,
"tornadic": false,
"advisories": null,
"mda": {
"min": 3,
"max": 4,
"avg": 4
},
"dbz": {
"min": 46,
"max": 54,
"avg": 49.666666666667
},
"lightning": null
}
}]
}]
}
{
"type": "FeatureCollection",
"features": [{
"type": "Feature",
"geometry": {
"type": "Point",
"coordinates": [-80.13865, 26.82339]
},
"properties": {
"loc": {
"lat": 26.82339,
"long": -80.13865
},
"place": {
"name": "palm beach gardens",
"state": "fl",
"country": "us"
},
"profile": {
"tz": "America\/New_York"
},
"periods": [{
"timestamp": 1528311415,
"dateTimeISO": "2018-06-06T14:56:55-04:00",
"storms": {
"phrase": {
"long": "An area of strong storms is approaching from the WSW with frequent lightning and up to 0.50 inch hail possible.",
"short": "An area of strong storms is approaching from the WSW with frequent lightning and up to 0.50\" hail possible."
},
"distance": {
"minKM": 10.3,
"minMI": 6.4,
"maxKM": 48.3,
"maxMI": 30,
"avgKM": 22.6,
"avgMI": 14
},
"direction": {
"toDEG": 61,
"to": "ENE",
"fromDEG": 241,
"from": "WSW"
},
"approaching": true,
"speed": {
"minKTS": 14,
"minKPH": 25.9,
"minMPH": 16.1,
"maxKTS": 39,
"maxKPH": 72.2,
"maxMPH": 44.9,
"avgKTS": 21.4,
"avgKPH": 39.6,
"avgMPH": 24.6
},
"span": 133,
"hail": {
"probSevere": 0,
"prob": 40,
"maxSizeIN": 0.5,
"maxSize": "<0.50",
"maxSizeCM": 1.27
},
"rotation": false,
"tornadic": false,
"advisories": null,
"mda": {
"min": 3,
"max": 4,
"avg": 4
},
"dbz": {
"min": 46,
"max": 54,
"avg": 49.666666666667
},
"lightning": null
}
}]
}
}]
}
The following properties will be provided in every response object:
Last modified: August 18, 2022