Skip to content

whatwatt Go API Documentation

Document Context

  • Purpose: Comprehensive introduction and navigation hub for whatwatt Go API documentation and integration guides
  • When to use: Starting point for new users, overview of all available integration methods, reference for documentation structure
  • Prerequisites: Basic understanding of energy monitoring concepts; familiarity with REST APIs or MQTT helpful but not required
  • Related to: All documentation sections - serves as central navigation point to specific integration guides
  • Validates against: Real device examples from whatwatt Go installations

Welcome to the comprehensive API documentation for whatwatt Go.

What is whatwatt Go?

whatwatt Go is a device that connects to compatible smart meters and exposes their data through its own REST API, MQTT integration, and local automation features. It is designed to give you real-time access to energy data.

Key Features

  • 🔌 Universal Compatibility: Works with all current Smart Meters from major manufacturers (Ensor, Iskraemeco, Kamstrup, Landis+Gyr, Sagemcom, Semax, NES, and Meter+Control)
  • ⚡ Real-Time Data: Instant access to energy consumption data
  • 🌐 Multiple Protocols: REST API and MQTT support
  • 🔐 Secure Communication: TLS/SSL encryption support
  • 📊 Rich Data Format: JSON responses with detailed meter information
  • 🏠 Local Control: Your data stays with you - no cloud dependency

Quick Start

Choose your integration method:

Perfect for web applications and simple polling scenarios.

# Check device availability and license type
curl http://192.168.1.100/api/v1/system

If .device.license.type is PLUS or higher, you can continue with meter polling endpoints such as /api/v1/report.

→ REST API Guide

Ideal for real-time applications and IoT integration.

Requires an active Plus or higher license for the built-in MQTT publisher.

```bash
# Subscribe on YOUR MQTT BROKER to the topic you configured in Device Settings → MQTT (publish.topic)
# Example: broker on localhost, topic prefix 'lab/energy/'
mosquitto_sub -h 127.0.0.1 -t "lab/energy/#" -v

# If your broker requires username/password authentication
# mosquitto_sub -h 127.0.0.1 -u USER -P PASS -t "lab/energy/#" -v
```

**[→ MQTT Guide](30-mqtt/index.md)**

Enterprise-grade security with TLS encryption.

Requires an active Plus or higher license because it uses the same built-in MQTT publisher.

```bash
# Connect to YOUR MQTT BROKER with TLS (mutual TLS optional)
mosquitto_sub -h 127.0.0.1 -p 8883 -v \
  --cafile ca.crt --cert client.crt --key client.key \
  -t "lab/energy/#"
```

**[→ Secure MQTT Setup](40-secure-mqtt/index.md)**

Documentation Structure

This documentation covers everything you need to integrate with whatwatt Go:

🚀 Getting Started

🔧 Device Information

📡 Integration Methods

⚙️ Configuration

📚 Reference

Energy Transition

The Energy Transition will only succeed if we can optimize our own energy consumption. This is only possible if we know our consumption in real time and can react accordingly.

Smart meters can expose measured data in real time through their local communication interfaces. whatwatt Go uses this interface to give you control over your energy data.

Data Ownership

Who owns your energy consumption data? The consumption data collected from your household belongs to you. You decide with whom you would like to share this data. whatwatt Go ensures your data stays local and under your control.

Need Help?