Spec

Code snippets

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

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

$ch = curl_init("https://api.oanor.com/irrigation-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/irrigation-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": "US units (GPM, feet, inches). PR = 96.25 × GPM ÷ area; run-time = depth ÷ PR ÷ efficiency; max heads = available GPM ÷ per-head GPM. Estimates — verify pressure and uniformity on site.",
        "service": "irrigation-api",
        "endpoints": {
            "GET /v1/meta": "This document.",
            "GET /v1/zone": "Maximum sprinkler heads a zone's available flow can drive.",
            "GET /v1/runtime": "Run-time (minutes) to apply a water depth at a precipitation rate.",
            "GET /v1/precip-rate": "Precipitation rate (in/hr) from GPM per head and head/row spacing."
        },
        "description": "Irrigation-design maths: sprinkler precipitation rate, run-time to apply a depth, and the maximum heads a zone's flow can drive."
    },
    "meta": {
        "timestamp": "2026-06-06T15:30:44.402Z",
        "request_id": "fe4d28c2-7fd5-4c71-bfef-412363a333da"
    },
    "status": "ok",
    "message": "Meta",
    "success": true
}