Eric Rakestraw 3136131519
All checks were successful
ci/woodpecker/push/build-image Pipeline was successful
Clean up completed roadmap documents
2026-07-02 07:48:56 -05:00
2026-07-02 07:48:56 -05:00
2026-03-17 03:32:40 +00:00
2026-03-19 19:52:13 -05:00
2026-03-19 21:38:29 -05:00
2026-03-17 03:32:40 +00:00
2026-03-19 19:52:13 -05:00

weatherapi

weatherapi is a read-only HTTP API for weather data already stored by weatherfeeder in PostgreSQL. It exposes the latest observations, current conditions, alerts, forecasts, discussions, weather stories, and convective outlooks as JSON, XML, or text.

Quickstart

The service needs a reachable Postgres database with weatherfeeder-owned tables and the configured text template directory.

go run ./cmd/weatherapi -config config.yml

The checked-in config.yml is a local sample. For new deployments, start from examples/config.minimal.yml or examples/config.production.yml and provide database credentials through your normal secret-management process.

Endpoint Families

  • Observations and current conditions
  • Active alerts
  • Hourly and narrative forecasts
  • Forecast discussions
  • Weather stories
  • Convective outlooks

Common query parameters include format, units, and route-specific options such as forecast precision, timezone tz / TZ, and outlook filters day and outlookType.

See docs/api.md for the HTTP contract.

Documentation

Description
A small HTTP API that serves a variety of weather-related endpoints.
Readme AGPL-3.0 7.8 MiB
Languages
Go 99.1%
Dockerfile 0.9%