Skip to main content
Version: 1.0

EHEIM Digital API

Welcome to the API documentation for EHEIM Digital products. This API provides comprehensive access to the full range of EHEIM Digital devices, enabling seamless integration and control. Whether you're building advanced aquarium management solutions or enhancing smart home capabilities, our API offers the flexibility and power you need.

The API supports all EHEIM Digital products running software version 2.0.1.x or later. With this documentation, you will find all the necessary resources, including detailed API calls, parameters, authentication methods, and usage examples to help you efficiently interact with your EHEIM devices.

Let’s dive in and explore how you can unlock the full potential of your EHEIM Digital products!

Important Notes:​

  • Time Values: All time values are expressed in minutes from midnight.
    For example, if you want to turn a device on at 3 PM (15:00), you need to calculate:
    15 hours * 60 minutes = 900 minutes.

  • Temperature Units: The temperature can be set in Celsius (°C) or Fahrenheit (°F), which you can choose on the Web UI. The selected unit will appear in the mUnit value:

    • 0 = Celsius (e.g., 23.5°C is represented as 235 in the device settings)
    • 1 = Fahrenheit (e.g., 72.5°F is represented as 725 in the device) Important: If you change the temperature unit, you'll need to resend all relevant parameters using the new unit.

  • nReduce Calculation: The value of nReduce is always based on the target temperature (sollTemp).
    For example, if your target temperature is 23°C and you want to lower it to 20.5°C at night, you calculate nReduce as:
    Target Temp - Desired Temp = nReduce ÷ 10
    -> 230 (23°C) - 205 (20.5°C) = 25 (2.5°C)

  • Device Address (to value): Every request must include the MAC address of the target device in the "to" value field.

  • Boolean Values: When sending true/false values, use 1 for true and 0 for false.

Authentication​

Example: username: api password: [default: admin]

Security Scheme Type:

http

HTTP Authorization Scheme:

basic

License

GNU AGPLv3