Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Kin Lane

Chat with Kin

AI assistant · trained on my blog

NOAA

NOAA Alerts API

The Alerts API from NOAA — 8 operation(s) for alerts.

Documentation Provider Profile APIs.io OpenAPI GitHub

NOAA Alerts API is one of 17 APIs that NOAA publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 9 JSON Schema definitions.

Tagged areas include Alerts. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a GitHub repository, and 9 JSON Schemas.

This API exposes 8 operations across 8 paths, and defines 32 schemas. It is described by OpenAPI 3.0.3, at version v4.0.

Requests are made against the base URL https://api.weather.gov.

8 operations 8 paths 32 schemas 8 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
v4.0
Base URL
https://api.weather.gov
Terms of Service
View terms
Resource Areas
1

Paths & Operations 8

Across 8 paths, the API surfaces 8 operations — 8 GET. Each is listed below with its method, path, parameters, and response codes.

Alerts 8
GET
/alerts
Returns all alerts
alerts_query 17 params → 200301default
GET
/alerts/active
Returns all currently active alerts
alerts_active 12 params → 200301default
GET
/alerts/active/count
Returns info on the number of active alerts
alerts_active_count → 200default
GET
/alerts/active/zone/{zoneId}
Returns active alerts for the given NWS public zone or county
alerts_active_zone 1 param → 200default
GET
/alerts/active/area/{area}
Returns active alerts for the given area (state or marine area)
alerts_active_area 1 param → 200default
GET
/alerts/active/region/{region}
Returns active alerts for the given marine region
alerts_active_region 1 param → 200default
GET
/alerts/types
Returns a list of alert types
alerts_types → 200default
GET
/alerts/{id}
Returns a specific alert
alerts_single 1 param → 200default

Schemas 32

The contract defines 32 schemas that model the data the API accepts and returns. The most detailed are Alert (30 properties), AlertAtomEntry (19 properties), ProblemDetail (6 properties), AlertAtomFeed (6 properties). Each schema is shown below with its type and property counts.

JsonLdContext
AlertCollectionGeoJson
AlertJsonLd
object
1 property
AlertGeoJson
AlertAtomFeed
object
An alert feed in Atom format
6 properties
GeoJsonGeometry
A GeoJSON geometry object. Please refer to IETF RFC 7946 for information on the GeoJSON format.
PaginationInfo
object
Links for retrieving more data from paged data sets
1 property 1 required
StateTerritoryCode
string
GeoJsonPolygon
array
A GeoJSON polygon. Please refer to IETF RFC 7946 for information on the GeoJSON format.
AlertCertainty
string
AlertUrgency
string
AlertSeverity
string
NWSZoneID
string
UGC identifier for a NWS forecast zone or county. The first two letters will correspond to either a state code or marine area code (see /components/schemas/Sta…
GeoJsonLineString
array
A GeoJSON line string. Please refer to IETF RFC 7946 for information on the GeoJSON format.
Alert
object
An object representing a public alert message. Unless otherwise noted, the fields in this object correspond to the National Weather Service CAP v1.2 specificat…
30 properties
AlertMessageType
string
AreaCode
State/territory codes and marine area codes
AlertCollection
object
3 properties
AlertCap
object
ProblemDetail
object
Detail about an error. This document conforms to RFC 7807 (Problem Details for HTTP APIs).
6 properties 6 required
GeoJsonBoundingBox
array
A GeoJSON bounding box. Please refer to IETF RFC 7946 for information on the GeoJSON format.
AlertId
string
The identifier of the alert message.
AlertXMLParameter
object
2 properties
MarineRegionCode
string
Marine region code. These are groups of marine areas combined. AL: Alaska waters (PK) AT: Atlantic Ocean (AM, AN) GL: Great Lakes (LC, LE, LH, LM, LO, LS, SL)…
GeoJsonFeatureCollection
object
A GeoJSON feature collection. Please refer to IETF RFC 7946 for information on the GeoJSON format.
3 properties 2 required
GeoJsonFeature
object
A GeoJSON feature. Please refer to IETF RFC 7946 for information on the GeoJSON format.
5 properties 3 required
GeoJsonCoordinate
array
A GeoJSON coordinate. Please refer to IETF RFC 7946 for information on the GeoJSON format.
AlertAtomEntry
object
An alert entry in an Atom feed
19 properties
PointString
string
MarineAreaCode
string
Marine area code as defined in NWS Directive 10-302: AM: Western North Atlantic Ocean and along U.S. East Coast south of Currituck Beach Light NC following the…
AlertStatus
string
AlertCollectionJsonLd

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

noaa-alerts-api-openapi.yml Raw ↑

Other APIs NOAA publishes across the network.

Climate Data Online (CDO) API
AE Profile APIs.io
CO-OPS Tides and Currents API
AE Profile APIs.io
NOAA Aviation API
AE Profile APIs.io
NOAA Glossary API
AE Profile APIs.io
NOAA Gridpoints API
AE Profile APIs.io
NOAA Icons API
AE Profile APIs.io
NOAA Navigational Data API
AE Profile APIs.io
NOAA Offices API
AE Profile APIs.io
NOAA Points API
AE Profile APIs.io
NOAA Products API
AE Profile APIs.io
NOAA Radar API
AE Profile APIs.io
NOAA Radio API
AE Profile APIs.io
#Alerts
← Back to N APIs
API Details
ID
noaa:noaa-alerts-api
Base URL
https://api.weather.gov
Docs
https://www.weather.gov/documentation/services-web-api
Provider
NOAA
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network