Spec

Codefragmenten

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

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

$ch = curl_init("https://api.oanor.com/shipstability-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/shipstability-api/v1/meta",
    headers={"x-oanor-key": "oanor_test_..."}
)

Voorbeeldrespons

Een echte respons van dit endpoint, vastgelegd bij de laatste health check.

{
    "data": {
        "notes": "Metric (m, t, °, s). GM = KM − KG; GZ ≈ GM·sin(heel) (small angles ≤ ~10°); T = 2π·k/√(g·GM), k ≈ 0.35·beam. Initial-stability estimates — use full KN cross-curves for large angles. For hull speed and design ratios use a sailing API.",
        "service": "shipstability-api",
        "endpoints": {
            "GET /v1/meta": "This document.",
            "GET /v1/roll-period": "Natural transverse rolling period from GM and beam.",
            "GET /v1/righting-moment": "Small-angle righting arm GZ and righting moment.",
            "GET /v1/metacentric-height": "GM = KM − KG with a stability classification."
        },
        "description": "Ship initial-stability maths: metacentric height GM, the righting arm and moment at a heel angle, and the natural rolling period."
    },
    "meta": {
        "timestamp": "2026-06-06T23:53:54.201Z",
        "request_id": "f583980d-93ae-46fa-9d20-fdea7c230244"
    },
    "status": "ok",
    "message": "Meta",
    "success": true
}