Customer API — Flood Sentinel

Endpoints

What the API gives you

All data endpoints live under /bom/v1 and require a Bearer token (role api_customer or admin).

Stations

GET /bom/v1/stations — filter by state, type or bbox. GET /bom/v1/stations/{id} for detail and /parameters for what each gauge measures.

Readings & latest

GET /bom/v1/stations/{id}/readings for time series, /latest for the most recent value per parameter.

History range

Query readings?from=&to= for historical water level and rainfall — how far back you can go scales with your plan (7 days on Free → the full record on Atlas).

Catchments & routing

GET /bom/v1/routing/network returns the routing graph and /stations/{id}/upstream the tributary topology.

Forecast

GET /bom/v1/forecast/{id} — ML-based flood forecast where the station is modelled, out to 72 hours at gated stations. GET /bom/v1/stations/{id}/validation returns the measured skill metrics for that station.

Thresholds & alerts

GET /bom/v1/stations/{id}/thresholds for the minor/moderate/major flood classifications, GET /bom/v1/alerts for active alerts.

Coverage

GET /bom/v1/coverage — station totals and live counts by state and kind, with the freshness window we count as "live".

Quickstart

Authenticate, then pull data

JWT auth: register, log in for an access token, then send it as Authorization: Bearer <token>.

1. Log in & pull readings

# Login → access_token
TOKEN=$(curl -s -X POST \
  https://api.floodsentinel.com.au/api/auth/login \
  -H 'Content-Type: application/json' \
  -d '{"email":"you@example.com",
       "password":"••••••••"}' \
  | jq -r .access_token)

# Time series for a station
curl -H "Authorization: Bearer $TOKEN" \
  "https://api.floodsentinel.com.au/bom/v1/stations/212903/readings?from=2026-05-01&to=2026-05-15"

# Latest value per parameter
curl -H "Authorization: Bearer $TOKEN" \
  "https://api.floodsentinel.com.au/bom/v1/stations/212903/latest"

2. Sample JSON (latest)

{
  "api_version": "1.0",
  "station_id": "212903",
  "latest": [
    {
      "parameter": "GAUGE_HEIGHT",
      "value": 2.41,
      "timestamp": "2026-05-15T03:00:00+00:00"
    }
  ],
  "attribution": "Data sourced from the
    Bureau of Meteorology
    © Commonwealth of Australia
    (CC-BY 4.0)."
}

Every authenticated response carries X-RateLimit-Plan, X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset; unauthenticated responses carry none of them, because no key has been identified to budget against. Every response, authenticated or not, carries an attribution field and api_version. Errors return {"error", "status"} with the matching HTTP code.

Included in every paid plan. Free tier: 100 calls/day, 7 days of history, 1,000 rows/request.

Flood Sentinel Customer API — Australia-wide rain & river data, one REST call