Alerts

id (string)

The unique ID attribute identifying the alert.

dataSource (string)

The source of the official alert information. Potential values include:
- noaa_nws
- envca
- meteoalarm
- ukmet

loc (object)

The location of the record.

loc.long (number)

The place or nearest place to the record.

loc.lat (number)

The latitude coordinate of the record.

active (boolean)

True if the alert is still active and has not expired.

details (object)

Object containing details for the issued alert.

details.type (string)

The valid-time event code for the alert for US and Canadian alerts, or Xweather-defined codes for global alerts. Review the list of supported Alert Types.

For non-US/Canadian alerts, the suffix indicates severity: EX (Extreme), SV (Severe), MD (Moderate), MN (Minor), and can be used to filter by severity (or awareness level).

details.name (string)

The type name for the alert.

details.loc (string)

The weather zone for the alert.

details.emergency (boolean)

Set to true if this is an emergency-specific alert, such as a tornado emergency.

details.priority (number)

The numeric priority of the alert, intended to aid in mapping prioritization. The lower the priority the higher the alert significance. US and Canadian alerts typically match the NOAA defined alert priorities. There may be some differences from the NOAA list, especially for non-US/Canadian locations.

details.color (string)

The 6 character hex color code for the alert. Corresponds to the Alert types/colors.

details.cat (string)

The default category of the alert type. May be null for non common alerts.

details.body (string)

The shortened and formatted version of the alert body text. Primarily for US alerts, removing the National Weather Service alert header information. Often the same as the bodyFull for Canadian and European alerts.

details.bodyFull (string)

The complete, unmodified version of the alert body text, including headers.

timestamps.issued (number)

UNIX timestamp when the alert was initially issued for the location. This value will not normally change during the lifetime of the alert.

timestamps.issuedISO (string)

ISO 8601 date of the time when the initially issued for the location. This value will not normally change during the lifetime of the alert.

timestamps.begins (number)

UNIX timestamp when the alert goes into effect. Often this will match the issue/updated time, though for some alerts, such as winter storm warnings, this may be set to a future date/time.

timestamps.beginsISO (string)

ISO 8601 date of the time when the alert goes into effect. Often this will match the issue/updated time, though for some alerts, such as winter storm warnings, this may be set to a future date/time.

timestamps.expires (number)

UNIX timestamp when the alert expires.

timestamps.expiresISO (string)

ISO 8601 date of the time when the alert expires.

timestamps.updated (number)

UNIX timestamp when the alert was updated. For a new alert, the issue and updated will normally match. If an alert is updated during its lifetime, this updated timestamp will change.

timestamps.updateISO (string)

ISO 8601 date of when the alert was updated. For a new alert, issue and updated will normally match. If an alert is updated during its lifetime, this updated timestamp will change.

timestamps.added (number)

UNIX timestamp when the issuance or last update for the alert was received and stored in the DB after initial issuance.

timestamps.addedISO (string)

ISO 8601 date when the issuance or last update for the alert was received and stored in the DB after initial issuance.

poly (string)

DEPRECATED. A comma-delimited string of latitude, longitude coordinates defining the small polygon boundary for this alert; typically used for certain alerts, such as tornado and severe thunderstorm warnings. NULL if the alert does not include a small polygon boundary.

This field has been deprecated in favor of the geoPoly attribute.

geoPoly ()

A GeoJSON polygon defining the small polygon boundary for this alert; typically used for certain alerts, such as tornado and severe thunderstorm warnings. NULL if the alert does not include a small polygon boundary.

When filter=geo is utilized, if no small polygon exists for the alert, the polygon for the weather zone, fire zone, county or CLC they alert is issued for will be returned.

includes.fips (array)

If a US alert will be a list of US counties in the XX### format, where XX is the state two digit fips number and ### is the 3 digit county fips number. If a Canadian alert will be null.

includes.counties (array)

If a US alert will be a list of US counties in the XXC### format, where XX is the state abbreviation and ### is the 3 digit county fips number. If a Canadian alert will be null.

includes.wxzones (array)

If a US alert will be a list of US public weather zones in the NOAA XXZ### format, where XX is the state abbreviation and ### is the 3 digit public zone id. If a Canadian alert will be a list of Canadian location codes (CLCs)

includes.zipcodes (array)

List of US zip codes that are affected by the alert. Only US zip codes, where the zip code centroid are within the alert, including any small polygon will be returned.

place.name (string)

The place or nearest place to the record.

place.state (string)

The state abbreviation in which the response is located. This may be null or an empty string depending on the country.

place.country (string)

The 2 letter ISO-3166 country abbreviation in which the response is located.

profile.tz (string)

Timezone name of the location, such as America/New_York.

timestamps (object)

timestamps.created (number)

timestamps.createdISO (string)

includes (object)

place (object)

Object containing information about the place or nearest place to the record.

profile (object)

Object containing information about the location or event.

profile.isSmallPoly (boolean)

Determines if alert has been issued as a small polygon.

localLanguages (array)

Array of all possible languages provided by upstream provider, typically the government agency.

localLanguages.#.language (string)

ISO 639 two-digit code for the language provided.

localLanguages.#.name (string)

Localized translation for the name of the alert in the language provided. This value comes directly from the issuing agency.

localLanguages.#.body (string)

Localized translation for the description of the alert in the language provided. This value comes directly from the issuing agency.