Skip to content
Documentation menu
docs / api / get-v1-weather-frames
live

GET/v1/weather/frames

API key required, sent as Authorization: Bearer snk_… or ?api_key=snk_….

What it does

The NOAA GFS forecast frames MapMap processes for the map: kept runs (newest first), each frame's valid time and file paths, how each field's PNG bytes decode (encodings), a base URL the paths resolve against and a tiles template for the pressure-line and rain/temperature tile ids. A forecast, not an observation; derived from NOAA GFS and modified by MapMap; no endorsement by or affiliation with NOAA is implied. Freshness is a field (ok, stale, unknown), never an error. When the key is sent as ?api_key=, the same key is stamped onto base and tiles. One Standard unit per request; a browser (maps) key may call it.

Call it

bash
curl -fsS -X GET "https://api.mapmap.ai/v1/weather/frames" \
  -H "Authorization: Bearer $MAPMAP_KEY"

Parameters

NameInRequiredDescription
runquerynoOne kept run, YYYYMMDDHH. 404 run-not-found if it is not kept; 400 invalid-run if malformed
latestqueryno1: only the newest run. Default: every kept run

Responses

200The frame manifest
FieldTypeRequiredDescription
age_sintegernoSeconds since generated_at. null with no manifest.
attributionobjectyesThe credit, verbatim from the manifest.
basestringyesFrame paths below resolve against this URL.
encodingsobjectyesHow each field's PNG bytes decode, verbatim from the manifest.
generated_atstringnoThe manifest's own generation time (RFC 3339). null with no manifest.
labelstringyesForecast, not an observation.
modelWeatherModelyesThe model.
notestringyesThe modification and no-endorsement note.
processed_bystringyesAlways MapMap.
runsWeatherRun[]yesKept runs, newest first.
statusstringyesok, stale or unknown.
threshold_sintegeryesThe age after which the manifest reads stale, seconds.
tilesstringyesTile URL template for the gateway ids on each frame (rain, temp: png; isobars: mvt).
400invalid-run or invalid-latest. Not billed
404run-not-found. Not billed
501Weather frames not enabled (SN_WEATHER_DIR unset). Not billed

Error bodies follow the shared problem model documented on API conventions.

Also under live

Generated from https://api.mapmap.ai/openapi.json on 2026-10-17 · operationId get_weather_frames