Endpoint: threats

The threats endpoint provides a localized threat summary for the location provided. Currently the threats are limited to storm based threats. Coverage area includes the 50 US states, Puerto Rico and Guam.

Supported Actions

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 enpoint's detailed documentation for specific information regarding how to use the :id action.

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.

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.

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.

(boolean) True if the storms are approaching, False is passing through.

periods[#].storms.span

(number) An arc span angle of the storm threats affecting a location. If a storm threat is approaching from the WSW at 256 degrees. If Span = 75, then an arc can be drawn that is 75 degrees and is centered on the 256 degree direction (WSW) to show the area the storms are approaching from.

periods[#].storms.speed

(object) Object of the speed information of the storm threats

periods[#].storms.speed.minKTS

(number) The minimum speed of the group of storms threats in knots

periods[#].storms.speed.minKPH

(number) The minimum speed of the group of storms threats in kilometers per hour

periods[#].storms.speed.minMPH

(number) The minimum speed of the group of storms threats in miles per hour

periods[#].storms.speed.maxKTS

(number) The maximum speed of the group of storms threats in knots

periods[#].storms.speed.maxKPH

(number) The maximum speed of the group of storms threats in kilometers per hour

periods[#].storms.speed.maxMPH

(number) The maximum speed of the group of storms threats in miles per hour

periods[#].storms.speed.avgKTS

(number) The average speed of the group of storms threats in knots

periods[#].storms.speed.avgKPH

(number) The average speed of the group of storms threats in kilometers per hour

periods[#].storms.speed.avgMPH

(number) The average speed of the group of storms threats in miles per hour

periods[#].storms.hail

(object) Object of hail information for the approaching storm threats. Null if no hail within the storm threats.

periods[#].storms.hail.prob

(number) The probability (0-100) that the storm threats include hail

periods[#].storms.hail.probSevere

(number) The probability (0-100) that the storm threats include severe / very large hail

periods[#].storms.hail.maxSize

(string) The maximum estimated hail size within the storm threats

periods[#].storms.hail.maxSizeMM

(number) The maximum estimated hail size within the storm threats in millimeters

periods[#].storms.hail.maxSizeIN

(number) The maximum estimated hail size within the storm threats in inches

periods[#].storms.tornadic

(boolean) True if the approaching storm threats may be tornadic, false otherwise.

periods[#].storms.rotation

(boolean) True if the approaching storm threats include a decent amount of mesoscale rotation, false otherwise.

If the location is under a severe thunderstorm warnings the value of ['SV.W']. If under both a Severe thunderstorm warning and Tornado warning the value may be ['TO.W', 'SV.W']. Refer to the advisories endpoint for more information on the advisory VTEC codes.

Null if no severe related storm advisories.

periods[#].storms.mda

(object) Object of mesoscale rotation information for the storm threats. Null if no appreciable MDA for the approaching storms.

periods[#].storms.mda.min

(number) The minimum value

periods[#].storms.mda.max

(number) The maximum value

periods[#].storms.dbz

(object) Object of radar intensity of the approaching storms. Often used for determining the intensity of the precipitation.

Null if no dbz data available for the storm threats.

periods[#].storms.dbz.min

(number) The minimum reported dbz within the storm threats

periods[#].storms.dbz.max

(number) The maximum reported dbz within the storm threats

periods[#].storms.dbz.avg

(number) The average reported dbz within the storm threats

loc.long

(number) The longitude coordinate of the record.

loc.lat

(number) The latitude coordinate of the record.

place.name

(string) The place or nearest place to the record.

place.state

(string) The state abbreviation in which the record is located. This may be null depending on the country.