Spec

Frammenti di codice

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

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

$ch = curl_init("https://api.oanor.com/poolheat-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/poolheat-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": "BTU = gallons × 8.34 × °F rise; ÷ heater BTU/hr for time; heat pump kWh = BTU ÷ 3412 ÷ COP. Pass temp_rise_f, or current_temp_f + target_temp_f. Ideal figures — add for surface/wind losses. For pool chemistry use a pool-chemistry API.",
        "service": "poolheat-api",
        "endpoints": {
            "GET /v1/meta": "This document.",
            "GET /v1/heat-pump": "A heat pump's electricity (kWh) and optional cost for the heat.",
            "GET /v1/heat-time": "Hours to raise a volume by a temperature rise at a heater's BTU/hr.",
            "GET /v1/heater-size": "Heater output (BTU/hr) needed to heat within a target time."
        },
        "description": "Pool & spa heating maths: time to heat by a temperature rise, the heater size to do it in time, and a heat pump's electricity and cost."
    },
    "meta": {
        "timestamp": "2026-06-06T15:30:44.040Z",
        "request_id": "478752c0-5032-4e8a-a7cb-13ff21baa59e"
    },
    "status": "ok",
    "message": "Meta",
    "success": true
}