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

Weather.gov Products API

The Products API from Weather.gov — 9 operation(s) for products.

Weather.gov Products API is one of 13 APIs that Weather.gov publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Products. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 9 operations across 9 paths, and defines 6 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.

9 operations 9 paths 6 schemas 9 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.2
API Version
3.8.1
Base URL
https://api.weather.gov
Authentication
API Key, API Key
Resource Areas
1

Authentication & Security 2

Weather.gov Products 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 9

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

Products 9
GET
/products
Weather.gov Returns a List of Text Products
products_query 7 params → 200default
GET
/products/locations
Weather.gov Returns a List of Valid Text Product Issuance Locations
product_locations → 200default
GET
/products/types
Weather.gov Returns a List of Valid Text Product Types and Codes
product_types → 200default
GET
/products/{productId}
Weather.gov Returns a Specific Text Product
product 1 param → 200default
GET
/products/types/{typeId}
Weather.gov Returns a List of Text Products of a Given Type
products_type 1 param → 200default
GET
/products/types/{typeId}/locations
Weather.gov Returns a List of Valid Text Product Issuance Locations for a Given Product Type
products_type_locations 1 param → 200default
GET
/products/locations/{locationId}/types
Weather.gov Returns a List of Valid Text Product Types for a Given Issuance Location
location_products 1 param → 200default
GET
/products/types/{typeId}/locations/{locationId}
Weather.gov Returns a List of Text Products of a Given Type for a Given Issuance Location
products_type_location 2 params → 200default
GET
/products/types/{typeId}/locations/{locationId}/latest
Weather.gov Returns Latest Text Products of a Given Type for a Given Issuance Location with Product Text
latest_product_type_location 2 params → 200default

Schemas 6

The contract defines 6 schemas that model the data the API accepts and returns. The most detailed are TextProduct (9 properties), ProblemDetail (6 properties), TextProductTypeCollection (2 properties), TextProductCollection (2 properties). Each schema is shown below with its type and property counts.

TextProductLocationCollection
object
2 properties
TextProduct
object
9 properties
ProblemDetail
object
Detail about an error. This document conforms to RFC 7807 (Problem Details for HTTP APIs).
6 properties 6 required
TextProductCollection
object
2 properties
TextProductTypeCollection
object
2 properties
JsonLdContext

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

weather-gov-products-api-openapi.yml Raw ↑

Other APIs Weather.gov publishes across the network.

Weather.gov Alerts API
Weather.gov Aviation API
Weather.gov Glossary API
Weather.gov Gridpoints API
Weather.gov Icons API
Weather.gov Offices API
Weather.gov Points API
Weather.gov Radar API
Weather.gov Radio API
Weather.gov Stations API
Weather.gov Thumbnails API
Weather.gov Zones API