Skip to content
Documentation menu
docs / api / get-v1-weather-frames-gfs-run-field-file
live

GET/v1/weather/frames/gfs/{run}/{field}/{file}

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

What it does

One forecast frame file, served verbatim: a global equirectangular PNG for rain, temp, cloud, gust or mslp, or a wind PNG with its JSON sidecar. file is fHHH.png, fHHH.json or the .half variants. The run must be one GET /v1/weather/frames lists. Run-keyed and never rewritten, so it is cached as immutable (private, because the resource is key-gated), with an ETag; If-None-Match answers 304. PMTiles frames are not served here; use the tiles template. A forecast, not an observation; derived from NOAA GFS and modified by MapMap. One Standard unit per file requested.

Call it

bash
curl -fsS -X GET "https://api.mapmap.ai/v1/weather/frames/gfs/{run}/{field}/{file}" \
  -H "Authorization: Bearer $MAPMAP_KEY"

Parameters

NameInRequiredDescription
runpathyesRun directory, YYYYMMDDHH
fieldpathyeswind, rain, temp, cloud, gust or mslp
filepathyesfHHH.png, fHHH.json, fHHH.half.png or fHHH.half.json

Responses

200The file's bytes
304Not modified (If-None-Match matched the ETag)
404not-found: unknown shape, unlisted run or no such file. 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_frame_file