Neptun·

Current field

Vector field across an area — for chart overlays.

GET /v1/currents-field

Scope: currents

Returns a grid of u/v (m/s) across a bounding box. Meant for drawing the stream across a chart rather than querying a single point. Where a SHOM atlas has water it replaces the model (cells with `src: shom`).

Parameters

NameTypeDescription
nnumber, requirednorthern box limit
snumber, requiredsouthern box limit
enumber, requiredeastern box limit
wnumber, requiredwestern box limit

Example response

{ "ok": true, "t": 1794556800, "unit_uv": "m/s",
  "cells": [ { "lat": 49.7, "lon": -2.2, "u": 1.078, "v": 0.586, "src": "shom" }, { "lat": 54.3, "lon": 10.1, "u": 0.21, "v": -0.05 } ],
  "attribution": "… FES2014a … Shom …", "quota": { … } }