Spec

Code snippets

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

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

$ch = curl_init("https://api.oanor.com/aquascape-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/aquascape-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": "CO2 = 3·KH·10^(7−pH); ppm = g × fraction × 1000 ÷ litres; substrate = footprint × depth. Salts: kno3, kh2po4, k2so4, mgso4, cano3. Educational — for a tank's water volume or fish stocking use an aquarium API; for pool chemistry use a pool API.",
        "service": "aquascape-api",
        "endpoints": {
            "GET /v1/co2": "Dissolved CO2 (ppm) from pH and carbonate hardness (KH).",
            "GET /v1/meta": "This document.",
            "GET /v1/substrate": "Substrate volume and bags from footprint and target depth.",
            "GET /v1/fertilizer": "Nutrient ppm added by dosing a dry salt (EI dry dosing)."
        },
        "description": "Planted-aquarium / aquascaping maths: dissolved CO2 from pH & KH, dry-fertiliser dosing in ppm, and substrate volume."
    },
    "meta": {
        "timestamp": "2026-06-06T15:30:47.778Z",
        "request_id": "94403b64-e3b9-4f1f-a386-2fee70939bf3"
    },
    "status": "ok",
    "message": "Meta",
    "success": true
}