Docs
View as Markdown

nws.glossary

stable Advanced

NWS weather glossary (term and definition).

GET /v1/nws/glossary

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#

This endpoint takes no parameters.

Request#

curl "https://api.onekey.dev/v1/nws/glossary" \
  -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": {
        "name": "1-2-3 Rule",
        "description": "A means of avoiding winds associated with a tropical cyclone by taking into account the forecast track error of the National Weather Service over a 10 year period which is approximately 100 nm in 24 hours, 200 nm for 48 hours and 300 nm in 72 hours. The forecast track error is added to the 34 knot wind radii to compute the danger area. The wind radii may be found within Tropical Cyclone Forecast A"
      }
    },
    {
      "entity": {
        "name": "100-year Flood",
        "description": "A statistic that indicates the magnitude of flood which can be expected to occur on average with a frequency of once every 100 years at a given\r\npoint or reach on a river. The 100-year flood is usually developed from a statistical distribution that is based on historical floods.\r\nThis is also called a base flood."
      }
    }
  ],
  "metadata": {
    "platform": "nws",
    "endpoint": "glossary",
    "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 pathOnekey fieldTransform
termentity.name-
definitionentity.description-

Caching and freshness#

  • Fresh for about 1 hour. Repeat calls in that window are served from cache and are free.
  • Between 1 hour and 1 day 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#

StatusCodeWhat to do
401unauthorizedCheck the x-api-key header.
402insufficient_creditsAdd credits; your balance must cover the price.
404not_foundUnknown endpoint path.
422invalid_paramsFix the parameters using the table above. Free.
429rate_limitedWait Retry-After seconds, then retry.
502upstream_errorThe source failed. Refunded; retry with backoff.

See Errors for the full list and retry guidance.

Status: stable (verified against the live source).