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

NOAA — National Oceanic and Atmospheric Administration Alerts API

The Alerts API from NOAA — National Oceanic and Atmospheric Administration — 8 operation(s) for alerts.

NOAA — National Oceanic and Atmospheric Administration Alerts API is one of 24 APIs that NOAA — National Oceanic and Atmospheric Administration publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

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

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

Requests are made against a single 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.1.2
API Version
3.9.2
Base URL
https://api.weather.gov
Authentication
API Key, API Key
Resource Areas
1

Authentication & Security 2

NOAA — National Oceanic and Atmospheric Administration Alerts API declares 2 security schemes for authenticating requests. An API key is passed in the header as User-Agent (userAgent). An API key is passed in the header as API-Key (apiKeyAuth). By default, every request must be authenticated.

  • userAgent — We require that all consumers of the API include a User-Agent header in requests. This is due to a high number of scripts exhibiting abusive behavior (intentio…
  • apiKeyAuth — We are testing including a more traditional API Key system on certain endpoints. This is due to a large change in the weather.gov site. The API remains open an…

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.

AlertAtomEntry
object
An alert entry in an Atom feed
19 properties
AreaCode
State/territory codes and marine area codes
AlertCap
object
AlertCertainty
string
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
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…
PointString
string
GeoJsonBoundingBox
array
A GeoJSON bounding box. Please refer to IETF RFC 7946 for information on the GeoJSON format.
GeoJsonGeometry
A GeoJSON geometry object. Please refer to IETF RFC 7946 for information on the GeoJSON format.
GeoJsonLineString
array
A GeoJSON line string. Please refer to IETF RFC 7946 for information on the GeoJSON format.
AlertGeoJson
AlertStatus
string
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
AlertCollectionGeoJson
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…
PaginationInfo
object
Links for retrieving more data from paged data sets
1 property 1 required
AlertAtomFeed
object
An alert feed in Atom format
6 properties
AlertId
string
The identifier of the alert message.
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)…
AlertXMLParameter
object
2 properties
AlertUrgency
string
AlertSeverity
string
StateTerritoryCode
string
GeoJsonCoordinate
array
A GeoJSON coordinate. Please refer to IETF RFC 7946 for information on the GeoJSON format.
AlertCollection
object
3 properties
AlertJsonLd
object
1 property
AlertMessageType
string
AlertCollectionJsonLd
GeoJsonPolygon
array
A GeoJSON polygon. Please refer to IETF RFC 7946 for information on the GeoJSON format.
ProblemDetail
object
Detail about an error. This document conforms to RFC 7807 (Problem Details for HTTP APIs).
6 properties 6 required
JsonLdContext

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

noaa-gov-alerts-api-openapi.yml Raw ↑

Other APIs NOAA — National Oceanic and Atmospheric Administration publishes across the network.

Space Weather Prediction Center (SWPC) Data Service
CO-OPS Data Retrieval API (Tides & Currents)
CO-OPS Metadata API (MDAPI v1)
CO-OPS Derived Product API (DPAPI v0.1)
NCEI Access Data Service (v1)
NCEI Climate Data Online (CDO) v2 API
National Data Buoy Center (NDBC) Web Data Service
NOAA CoastWatch ERDDAP Server
NOAA Open Data Dissemination (NODD)
NOAA Fisheries One Stop Shop (FOSS) ODS / ORDS
NOAA InPort Metadata Catalog
NOAA — National Oceanic and Atmospheric Administration Aviation API