Alerts
get/alerts
Returns all alerts
Path parameters
- Name
active- Type
- boolean
- Description
List only active alerts (use /alerts/active endpoints instead)
- Name
start- Type
- string
- Description
Start time
- Name
end- Type
- string
- Description
End time
- Name
status- Type
- array
- Description
Status (actual, exercise, system, test, draft)
- Name
message_type- Type
- array
- Description
Message type (alert, update, cancel)
- Name
event- Type
- array
- Description
Event name
- Name
code- Type
- array
- Description
Event code
- Name
area- Type
- array
- Description
State/territory code or marine area code This parameter is incompatible with the following parameters: point, region, region_type, zone
- Name
point- Type
- string
- Description
Point (latitude,longitude) This parameter is incompatible with the following parameters: area, region, region_type, zone
- Name
region- Type
- array
- Description
Marine region code This parameter is incompatible with the following parameters: area, point, region_type, zone
- Name
region_type- Type
- string
- Description
Region type (land or marine) This parameter is incompatible with the following parameters: area, point, region, zone
- Name
zone- Type
- array
- Description
Zone ID (forecast or county) This parameter is incompatible with the following parameters: area, point, region, region_type
- Name
urgency- Type
- array
- Description
Urgency (immediate, expected, future, past, unknown)
- Name
severity- Type
- array
- Description
Severity (extreme, severe, moderate, minor, unknown)
- Name
certainty- Type
- array
- Description
Certainty (observed, likely, possible, unlikely, unknown)
- Name
limit- Type
- integer
- Description
Limit
- Name
cursor- Type
- string
- Description
Pagination cursor
get/alerts/active
Returns all currently active alerts
Path parameters
- Name
status- Type
- array
- Description
Status (actual, exercise, system, test, draft)
- Name
message_type- Type
- array
- Description
Message type (alert, update, cancel)
- Name
event- Type
- array
- Description
Event name
- Name
code- Type
- array
- Description
Event code
- Name
area- Type
- array
- Description
State/territory code or marine area code This parameter is incompatible with the following parameters: point, region, region_type, zone
- Name
point- Type
- string
- Description
Point (latitude,longitude) This parameter is incompatible with the following parameters: area, region, region_type, zone
- Name
region- Type
- array
- Description
Marine region code This parameter is incompatible with the following parameters: area, point, region_type, zone
- Name
region_type- Type
- string
- Description
Region type (land or marine) This parameter is incompatible with the following parameters: area, point, region, zone
- Name
zone- Type
- array
- Description
Zone ID (forecast or county) This parameter is incompatible with the following parameters: area, point, region, region_type
- Name
urgency- Type
- array
- Description
Urgency (immediate, expected, future, past, unknown)
- Name
severity- Type
- array
- Description
Severity (extreme, severe, moderate, minor, unknown)
- Name
certainty- Type
- array
- Description
Certainty (observed, likely, possible, unlikely, unknown)
- Name
limit- Type
- integer
- Description
Limit
get/alerts/active/count
Returns info on the number of active alerts
get/alerts/active/zone/{zoneId}
Returns active alerts for the given NWS public zone or county
get/alerts/active/area/{area}
Returns active alerts for the given area (state or marine area)
get/alerts/active/region/{region}
Returns active alerts for the given marine region
get/alerts/types
Returns a list of alert types
get/alerts/{id}
Returns a specific alert