get/health
- 200The service is up
API reference
Every route the API serves. Generated, not written.
This reference renders from the OpenAPI document the server emits about itself, checked in and gated in CI, so it cannot describe a route the deployed API does not serve. Base URL: https://api.orr.sh. Version 0.1.0. No key needed during the early preview.
meta
Service liveness
atmosphere
International Standard Atmosphere state
get/v1/atmosphere
ISA state for a geometric altitude, computed with the standard-atmosphere crate.
| Parameter | Type | Required | Description |
|---|---|---|---|
| altitude_m | number (double) | yes | Geometric altitude, metres, -500 to 86000 |
- 200ISA temperature, pressure, and density at the altitude
- 400Missing or out-of-range altitude_m
weather
Weather intelligence (the V1 beachhead)
get/v1/weather/forecast
Point forecast, one time series per requested variable.
| Parameter | Type | Required | Description |
|---|---|---|---|
| lat | number (double) | yes | Latitude, WGS84 degrees, -90 to 90 |
| lon | number (double) | yes | Longitude, WGS84 degrees, -180 to 180 |
| vars | string | yes | Comma-separated canonical variable ids, e.g. temperature_2m,wind_speed_10m |
| model | string | no | Model override: auto (default), nbm, hrrr, gfs, or ecmwf |
| horizon_hours | integer (int32) | no | Hours ahead of issue time to cover |
- 200One series per variable (stub: series are empty until the store lands)
- 400Missing or invalid parameters
get/v1/weather/observations
Recent observed/analyzed values near a point.
| Parameter | Type | Required | Description |
|---|---|---|---|
| lat | number (double) | yes | Latitude, WGS84 degrees, -90 to 90 |
| lon | number (double) | yes | Longitude, WGS84 degrees, -180 to 180 |
| var | string | yes | Canonical variable id, e.g. temperature_2m |
| since | string | yes | Return values at or after this RFC 3339 instant |
- 200Observations near the point (stub: empty until the store lands)
- 400Missing or invalid parameters
get/v1/weather/wind
Wind at a height above ground, for wind-energy work.
| Parameter | Type | Required | Description |
|---|---|---|---|
| lat | number (double) | yes | Latitude, WGS84 degrees, -90 to 90 |
| lon | number (double) | yes | Longitude, WGS84 degrees, -180 to 180 |
| height_m | number (double) | yes | Height above ground to report wind at, metres, 10 to 300 (modern turbine hubs sit at 80-160 m) |
- 200Wind at the requested height from the freshest published GFS cycle, with the shear derivation and model lineage
- 400Missing or invalid parameters
- 503No recent GFS cycle is reachable
energy
Power-system data, keyed by ISO zone
get/v1/energy/load
System load (demand) for a zone.
| Parameter | Type | Required | Description |
|---|---|---|---|
| zone | string | yes | Balancing authority / ISO zone, e.g. CAISO, ERCOT, MISO, PJM |
| since | string | no | Return values at or after this RFC 3339 instant (default: now) |
- 200Load series for the zone (stub: null until the store lands)
- 400Missing or invalid parameters
get/v1/energy/prices
Locational marginal prices for a zone (optionally one node/hub).
| Parameter | Type | Required | Description |
|---|---|---|---|
| zone | string | yes | Balancing authority / ISO zone, e.g. CAISO, ERCOT, MISO, PJM |
| node | string | no | Node or hub within the zone |
| since | string | no | Return values at or after this RFC 3339 instant (default: now) |
- 200LMP series for the zone (stub: null until the store lands)
- 400Missing or invalid parameters
signup
Early-access list (double opt-in)
get/v1/confirm
Finish a double opt-in: match the token, flip to confirmed, render the page.
| Parameter | Type | Required | Description |
|---|---|---|---|
| e | string | yes | Subscriber email address |
| t | string | yes | One-time confirmation token from the email |
- 200Confirmed onto the list; a branded HTML page
- 400Missing, malformed, or stale link; a branded HTML page
- 500Backend failure; a branded HTML page
post/v1/subscribe
Capture a signup: validate, store the row, best-effort send the confirm email.
- 200Already confirmed; nothing re-sent
- 202Captured; the double-opt-in email was sent or deferred
- 400Not a valid email address
- 500The subscription store is unavailable