Spec

Extraits de code

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

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

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

Exemple de réponse

Une réponse réelle de ce endpoint, capturée lors du dernier contrôle de santé.

{
    "data": {
        "notes": "kWh, kg, m³. ENplus ~4.8 kWh/kg, bulk ~650 kg/m³. pellets = demand/(cv·eff); heat = kg·cv·eff; volume = kg/density. For cordwood use a firewood API; for propane/LPG a propane API.",
        "service": "pellet-api",
        "endpoints": {
            "GET /v1/meta": "This document.",
            "GET /v1/consumption": "Pellet mass (and bags) to cover a heat demand.",
            "GET /v1/heat-output": "Gross and usable heat from a mass of pellets.",
            "GET /v1/storage-volume": "Storage volume from pellet mass and bulk density."
        },
        "description": "Wood-pellet heating maths: pellet mass for a heat demand, usable heat from a mass, and storage volume."
    },
    "meta": {
        "timestamp": "2026-06-07T08:17:48.844Z",
        "request_id": "b9c4671b-5520-4f55-a8ee-ad54be7edcaf"
    },
    "status": "ok",
    "message": "Meta",
    "success": true
}