Spec

Code-Snippets

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

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

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

Beispiel-Response

Echte Antwort dieses Endpoints, erfasst beim letzten Health-Check.

{
    "data": {
        "notes": "SI (m, m/s, g=9.80665 m/s²). Fr = v/√(g·L). This is the Froude number and regime; for Manning open-channel discharge use a Manning API.",
        "service": "froude-api",
        "endpoints": {
            "GET /v1/meta": "This document.",
            "GET /v1/number": "Froude number and regime from a velocity and characteristic length.",
            "GET /v1/channel": "Open-channel Froude number, regime and critical depth.",
            "GET /v1/velocity": "Velocity from a Froude number and length.",
            "GET /v1/hull-speed": "Displacement hull speed from waterline length."
        },
        "description": "Froude number: flow regime, open-channel critical depth, and displacement hull speed."
    },
    "meta": {
        "timestamp": "2026-06-05T19:50:28.821Z",
        "request_id": "1eadddb0-371d-4c08-957c-785942a595c2"
    },
    "status": "ok",
    "message": "Meta",
    "success": true
}