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 Offices API

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

NOAA — National Oceanic and Atmospheric Administration Offices 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 Offices. 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 14 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 14 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 Offices 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.

Offices 8
GET
/offices/{officeId}
Returns metadata about a NWS forecast office
office 1 param → 200default
GET
/offices/{officeId}/briefing
Returns active briefing for an NWS office
office_briefing 1 param → 200default
GET
/offices/{officeId}/briefing/download/latest
Returns the latest briefing for an office
office_briefing_download_latest 1 param → 302default
GET
/offices/{officeId}/briefing/download/{briefingId}
Returns a briefing for an office
office_briefing_download 2 params → 200default
GET
/offices/{officeId}/headlines/{headlineId}
Returns a specific news headline for a given NWS office
office_headline 2 params → 200default
GET
/offices/{officeId}/headlines
Returns a list of news headlines for a given NWS office
office_headlines 1 param → 200default
GET
/offices/{officeId}/weatherstories
Returns active weather stories for an NWS office
office_weatherstory 1 param → 200default
GET
/offices/{officeId}/weatherstories/download/{imageId}
Returns the image for a weather story
office_weatherstory_image 2 params → 200default

Schemas 14

The contract defines 14 schemas that model the data the API accepts and returns. The most detailed are Office (16 properties), OfficeHeadline (11 properties), NWSConnectDocumentMetadata (8 properties), ProblemDetail (6 properties). Each schema is shown below with its type and property counts.

OfficeWeatherStory
9 required
NWSRegionalHQId
string
Three-letter identifier for a NWS Regional HQ.
OfficeHeadline
object
11 properties
BinaryFile
string
NWSForecastOfficeId
string
Three-letter identifier for a NWS office.
NWSConnectDocumentMetadata
object
Metadata for an NWS Connect document.
8 properties
Office
object
16 properties
NWSNationalHQId
string
Three-letter identifier for NWS National HQ.
OfficeWeatherStoryCollection
array
NWSOfficeId
OfficeHeadlineCollection
object
2 properties 2 required
OfficeBriefing
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-offices-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 Alerts API