Eric Rakestraw
ecea856e8e
All checks were successful
ci/woodpecker/push/build-image Pipeline was successful
37 lines
842 B
Markdown
37 lines
842 B
Markdown
# weatherapi
|
|
|
|
A small HTTP API that serves a variety of weather-related endpoints.
|
|
|
|
## Endpoints
|
|
|
|
- `GET /observations`
|
|
- `GET /conditions/current`
|
|
- `GET /alerts/active`
|
|
- `GET /discussion`
|
|
- `GET /discussion/key-messages`
|
|
- `GET /discussion/short-term`
|
|
- `GET /discussion/long-term`
|
|
- `GET /weatherstories`
|
|
- `GET /weatherstories/latest`
|
|
- `GET /forecast/hourly`
|
|
- `GET /forecast/hourly/today`
|
|
- `GET /forecast/hourly/tomorrow`
|
|
- `GET /forecast/narrative`
|
|
- `GET /forecast/narrative/today`
|
|
- `GET /forecast/narrative/tomorrow`
|
|
|
|
## Query Parameters
|
|
|
|
Shared weather query parameters:
|
|
|
|
- `format` (`json`, `xml`, `text`)
|
|
- `units` (`metric`, `us`)
|
|
|
|
Forecast endpoint query parameters:
|
|
|
|
- `precision` (`0`-`2`)
|
|
|
|
Forecast, discussion, and weather stories endpoint query parameters:
|
|
|
|
- `tz` / `TZ` (IANA timezone, US abbreviation, or UTC offset)
|