Spec

Frammenti di codice

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

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

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

Risposta di esempio

Una risposta reale di questo endpoint, acquisita dall'ultimo health check.

{
    "data": {
        "notes": "US units (inches, RPM, knots). Theoretical speed = pitch × prop RPM ÷ 1215; slip = (theo − actual)/theo; prop RPM = engine RPM ÷ gear ratio. Estimates — hull, load and bottom condition all shift real slip.",
        "service": "propeller-api",
        "endpoints": {
            "GET /v1/meta": "This document.",
            "GET /v1/slip": "Propeller slip from pitch, prop RPM and actual speed.",
            "GET /v1/pitch": "Pitch needed to reach a target speed at a prop RPM and slip.",
            "GET /v1/prop-rpm": "Prop RPM from engine RPM and gear ratio (and theoretical speed)."
        },
        "description": "Boat-propeller maths: propeller slip, prop RPM from engine RPM and gear ratio, and the pitch needed for a target speed."
    },
    "meta": {
        "timestamp": "2026-06-06T23:54:01.712Z",
        "request_id": "fe01951a-fd28-4fc6-af00-7b0d38a0e7ed"
    },
    "status": "ok",
    "message": "Meta",
    "success": true
}