nws.forecast_hourly

stable Advanced

Hourly forecast (156 h) for an NWS grid point.

GET /v1/nws/forecast_hourly

What you get#

A list of Nws results in Onekey's unified shape, in data (an array). An empty array is a normal, successful answer and is charged like any other; a source that reports "nothing found" as an error returns a free 404 not_found instead.

What it costs#

Advanced · 5 credits for a fresh fetch, charged only when it succeeds.
Free when served from cache (0.2 credit for a cached response over 100 KB).
Free if the request is invalid (never charged) or the source fails or reports not found (refunded).

Parameters#

Name	Type	Required	Default	What it is	Constraints
`office`	string	yes	(required)	Forecast office / WFO id, UPPERCASE (e.g. TOP)	max 3 chars; must match `[A-Z]{3}`; trimmed
`x`	string	yes	(required)	Grid X	max 3 chars; must match `\d{1,3}`; trimmed
`y`	string	yes	(required)	Grid Y	max 3 chars; must match `\d{1,3}`; trimmed

Request#

curl "https://api.onekey.dev/v1/nws/forecast_hourly?office=TOP&x=31&y=80" \
  -H "x-api-key: YOUR_API_KEY"

Try it

Add your key to run this call right here. No key? Get one free. The key stays in this tab.

Recorded response#

A real Nws response, recorded and returned in Onekey's shape. Fields the platform does not provide are null.

json

{
  "success": true,
  "data": [
    {
      "entity": {
        "id": "1",
        "name": "",
        "date": "2026-09-28T19:00:00Z",
        "category": "Partly Sunny",
        "description": ""
      },
      "content": {
        "createdAt": "2026-09-28T20:00:00Z"
      },
      "ext": {
        "isDaytime": true,
        "temperature": 71,
        "temperatureUnit": "F",
        "windSpeed": "10 mph",
        "windDirection": "SE",
        "precipProbabilityPct": 0
      },
      "media": {
        "thumbnailUrl": "https://api.weather.gov/icons/land/day/bkn?size=small"
      }
    },
    {
      "entity": {
        "id": "2",
        "name": "",
        "date": "2026-09-28T20:00:00Z",
        "category": "Partly Sunny",
        "description": ""
      },
      "content": {
        "createdAt": "2026-09-28T21:00:00Z"
      },
      "ext": {
        "isDaytime": true,
        "temperature": 74,
        "temperatureUnit": "F",
        "windSpeed": "10 mph",
        "windDirection": "SE",
        "precipProbabilityPct": 0
      },
      "media": {
        "thumbnailUrl": "https://api.weather.gov/icons/land/day/bkn?size=small"
      }
    }
  ],
  "metadata": {
    "platform": "nws",
    "endpoint": "forecast_hourly",
    "cached": false,
    "stale": false,
    "age_s": 0,
    "fetched_at": "2026-01-01T12:00:00+00:00",
    "credits_charged": 5,
    "request_id": "7f3a9c2e5b1d4c8fa2e6d0b9c4f18e37"
  },
  "error": null
}

Field mapping#

How this endpoint's source fields become Onekey's unified schema. Fields the source lacks come back as null.

Source path	Onekey field	Transform
`number`	`entity.id`	`toString`
`name`	`entity.name`	-
`startTime`	`entity.date`	`toIsoDate`
`endTime`	`content.createdAt`	`toIsoDate`
`isDaytime`	`ext.isDaytime`	`toBoolean`
`temperature`	`ext.temperature`	`toNumber`
`temperatureUnit`	`ext.temperatureUnit`	-
`windSpeed`	`ext.windSpeed`	-
`windDirection`	`ext.windDirection`	-
`shortForecast`	`entity.category`	-
`detailedForecast`	`entity.description`	-
`probabilityOfPrecipitation.value`	`ext.precipProbabilityPct`	`toNumber`
`icon`	`media.thumbnailUrl`	`safeUrl`

Caching and freshness#

Fresh for about 30 minutes. Repeat calls in that window are served from cache and are free.
Between 30 minutes and 6 hours the cached copy is still served instantly and marked stale: true while Onekey refreshes it in the background.
If the source is down when a refresh is needed, the last copy can be served for up to 1 day more (marked stale).
A "not found" is remembered for 5 minutes and is free.
The cache is shared across all customers, which is what keeps repeat calls cheap.

What can go wrong#

Status	Code	What to do
401	`unauthorized`	Check the `x-api-key` header.
402	`insufficient_credits`	Add credits; your balance must cover the price.
404	`not_found`	Unknown endpoint path.
422	`invalid_params`	Fix the parameters using the table above. Free.
429	`rate_limited`	Wait `Retry-After` seconds, then retry.
502	`upstream_error`	The source failed. Refunded; retry with backoff.

See Errors for the full list and retry guidance.

Status: stable (verified against the live source).