National Weather Service Alerts API
The Alerts API from National Weather Service — 8 operation(s) for alerts.
National Weather Service Alerts API is one of 13 APIs that National Weather Service 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 and API documentation.
This API exposes 8 operations across 8 paths, and defines 32 schemas. It is described by OpenAPI 3.1.2, at version 3.8.1.
Requests are made against a single base URL, https://api.weather.gov.
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 2
National Weather Service 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.
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), AlertAtomFeed (6 properties), ProblemDetail (6 properties). Each schema is shown below with its type and property counts.
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from National Weather Service 12
Other APIs National Weather Service publishes across the network.