Spec

Code snippets

curl "https://api.oanor.com/setanddrift-api/v1/meta" \
  -H "x-oanor-key: oanor_test_..."

await fetch("https://api.oanor.com/setanddrift-api/v1/meta", {
  headers: { "x-oanor-key": "oanor_test_..." }
});

$ch = curl_init("https://api.oanor.com/setanddrift-api/v1/meta");
curl_setopt($ch, CURLOPT_HTTPHEADER, ["x-oanor-key: oanor_test_..."]);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$out = curl_exec($ch);

import requests
requests.get(
    "https://api.oanor.com/setanddrift-api/v1/meta",
    headers={"x-oanor-key": "oanor_test_..."}
)

Example response

A real response from this endpoint, captured by the latest health check.

{
    "data": {
        "notes": "Degrees true, knots, nm, hours. COG/SOG by vector addition; course to steer from sin(H−T) = −drift·sin(set−track)/STW; current set = DR→fix bearing, drift = distance/time. Set is the direction the current flows toward. For great-circle distance use a geo-distance API; for tide times a tides API.",
        "service": "setanddrift-api",
        "endpoints": {
            "GET /v1/meta": "This document.",
            "GET /v1/current": "Set & drift from a DR-to-fix offset.",
            "GET /v1/course-to-steer": "Heading to steer to hold a desired ground track.",
            "GET /v1/course-made-good": "Course and speed over ground from heading and current."
        },
        "description": "Current-sailing (set & drift) navigation: course/speed over ground, course to steer, and set & drift from a fix."
    },
    "meta": {
        "timestamp": "2026-06-07T08:17:59.170Z",
        "request_id": "9501d5d6-1a42-473b-9550-9923e4e4d20d"
    },
    "status": "ok",
    "message": "Meta",
    "success": true
}