Skip to content

Energy Meters

Get Available Keys

Returns the telemetry keys available for a specific energy meter.

GET https://api.hedgehogapplications.nl/v1/energy-meters/:meterId/keys
Parameter Description
meterId UUID of the energy meter *

Example

curl -H "X-API-Key: hh_live_a1b2c3d4e5f6..." \
  https://api.hedgehogapplications.nl/v1/energy-meters/5aa268e0-0666-11f1-a8a4-2bf9576f784e/keys

meter_id = "5aa268e0-0666-11f1-a8a4-2bf9576f784e"
response = requests.get(
    f"{BASE_URL}/energy-meters/{meter_id}/keys",
    headers=headers,
)
keys = response.json()

const meterId = "5aa268e0-0666-11f1-a8a4-2bf9576f784e";
const response = await fetch(`${BASE_URL}/energy-meters/${meterId}/keys`, {
  headers: { "X-API-Key": API_KEY },
});
const { data: keys } = await response.json();

Response

{
  "data": [
    "import_kwh",
    "export_kwh"
  ]
}
Key Description
import_kwh Cumulative energy imported from the grid (kWh)
export_kwh Cumulative energy exported to the grid (kWh)

Note

Only keys available on the meter are returned. A meter that only measures import will not include export_kwh.