Neptun·

← API reference

Current field

Vector field across an area — for chart overlays.

GET /v1/currents-field

Scope: currents

Returns a grid of set and drift across a bounding box. Meant for drawing the stream across a chart rather than querying a single point.

Parameters

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

Example response

{ "ok": true, "cells": [ { "lat": 54.3, "lon": 10.1, "set_deg": 47, "drift_kn": 1.3 } ],
  "attribution": "… FES2014a …", "quota": { … } }