Documentation
DocumentationGET /v1/marine
DOCS / UWA V1 RELEASE CONTRACT SELF-HOSTED GATEWAY

GET /v1/marine

Modeled wave conditions (marine.v1 · experimental)

ONE GATEWAYCoordinates → eligible provider → canonical responseWhy UWA
On this page 4 sections

#Request

Required scope: marine:read. Registered in internal/routing/router.go (requires APP_RELEASE_PROFILE=full_experimental in dev/test).

#Parameters

ParameterTypeNotes
lat, lonnumberCoordinates are required; within 25 km of eligible marine grids
hoursinteger1–120 forecast points (default 24)
providerstringOptional override

#Request example

curl -H "X-API-Key: YOUR_GATEWAY_KEY" "http://127.0.0.1:8080/v1/marine?lat=0&lon=-140"

Verified against the UWA v1 router and request parsers. Replace YOUR_GATEWAY_KEY and configure an eligible upstream provider.

#Availability and provenance

Operator configuration required

Experimental route (APP_RELEASE_PROFILE=full_experimental in dev/test). Rejects sea-grid locations more than 25 km away.

Successful responses return canonical data plus meta (provider attribution, cache/fallback state, request correlation, and meta.partial on /v1/datasets). Refer to docs/openapi.yaml and docs/openapi.experimental.yaml for complete schema definitions.

Canonical contracts: docs/openapi.yaml (lean_v1) and docs/openapi.experimental.yaml · Verify against your build before production use.

Search local documentation. No external requests.

↑↓ to move · Enter to openESC to close