Alerts by LocationKey

GET

Alerts by LocationKey

Returns alert data for a specific location. Alert searches require a location key. Please use the Locations API to obtain the location key for your desired location. By default, a truncated version of the alert data is returned. The full object can be obtained by passing "details=true" into the url string.

Resource URL

http://dataservice.accuweather.com /alerts/v1/{locationKey}

Query Parameters


Name Values Description
apikey
(required)

Provided API Key

language

String indicating the language in which to return the resource

details

Boolean value specifies whether or not to include full details in the response.


Request Body

locationKey Unique ID used to search for a specific location true

HTTP Basic

OAuth 2.0

API Key

Reset

Make a request and see the response.

Make a request and see the response.

Make a request and see the response.

Response Error Details

  • HTTP Code
    Error Code
    Description
  • 400

    Request had bad syntax or the parameters supplied were invalid

  • 401

    Unauthorized. API authorization failed

  • 403

    Unauthorized. You do not have permission to access this endpoint

  • 404

    Server has not found a route matching the given URI

  • 500

    Server encountered an unexpected condition which prevented it from fulfilling the request

Working...

LastAction Values and Definitions 

 

Response Parameters

Parameter Type Description
CountryCode string A unique ID number assigned to a specific country.
AlertID int64 A unique ID number that identifies a specific alert for a particular country.
Description.Localized string A short phrase that summarizes the alert in the specified language. Default is US English (en-us).
Description.English string A short phrase that summarizes the alert in US English.
Category string A classification word or phrase that describes the alert type.
Priority int32 A ranking number that indicates the alert's importance based on the issuing authority's list of alert types. Higher impact alerts have a lower number. The highest priority is 1.
Type string An abbreviated alert description.
TypeId string An alphanumeric ID that indicates the alert description.
Class string The alert classification. Not available for all countries. Can be null.
Level string Indicates the alert severity. Not available for all countries. Can be null.
Color.Name string Descriptive name of the color.
Color.Red int32 The red RGB component of the color.
Color.Green int32 The green RGB component of the color.
Color.Blue int32 The blue RGB component of the color.
Color.Hex string The hexadecimal code that specifies the color.
Source string The alert data provider.
SourceId int32 An ID integer that identifies the alert data provider.
Disclaimer string A disclaimer that must be displayed with the alert data. Can be null.
Area.Name string The name for the area that encompasses the requested location and falls under the current alert.
Area.StartTime string The time at which the alert began, returned in ISO 8601 format: yyyy-mm-ddThh:mm:ss±hh:mm.
Area.EpochStartTime int64 The time at which the alert began, returned in the number of seconds that have elapsed since January 1, 1970 (midnight UTC/GMT).
Area.EndTime string The time at which the alert ended or will end, returned in ISO 8601 format: yyyy-mm-ddThh:mm:ss±hh:mm.
Area.EpochEndTime int64 The time at which the alert ended or will end, returned in the total number of seconds that have elapsed since January 1, 1970 (midnight UTC/GMT).
Area.LastAction.Localized string The alert's current status in the specified language.
Area.LastAction.English string The alert's current status in US English.
Area.Text string A full description of the alert.
Area.LanguageCode string A full description of the alert.
Area.Summary string A brief description of the alert.
MobileLink string A full description of the alert.
Link string Link to severe weather alerts on AccuWeather's free site for the requested location.
AlarmLevel string A color-based system that indicates the alert severity. Possible values are: Red: Critical alert. Immediately notify user. Orange: Medium alert. Notify user upon any interaction. Yellow: Normal alert. Notify user on a schedule or when asked. null: Default value. Returned if there is no alert severity.