Skip to main content

How do I use Sparky's local API?

Connect Sparky directly to your own systems via the local API

Sparky has a built-in local API that lets you read P1 data directly on your home network, without going through the Chargee cloud. This is useful if you want to integrate Sparky with your own software, home automation systems, or dashboards.

Availability

The local API is enabled by default from firmware version 95 on Sparky and version 105 on Flint. Check whether the API is active via Profile > Address > My Home > Local API.

Discovering Sparky on your network

Sparky and Flint are automatically discoverable via mDNS (also known as Bonjour or Zeroconf). You don't need to know the IP address. Use the following command to discover Sparky dns-sd -B _chargee_p1._tcp. Sparky is also reachable via the legacy service on port 3602.

Available endpoints

GET /api

basic device information (firmware version, serial number, API version)

GET /api/v1/data

most recent P1 measurement in JSON, including consumption, feed-in, gas and phase data

GET /api/v1/telegram

raw DSMR telegram for use in your own systems

GET /api/v1/identify

makes the status light blink green for 5 seconds to identify the device

Compatibility mode

Want to use Sparky as a drop-in replacement for another P1 meter without software changes? Enable compatibility mode via Profile > Address > My Home > Local API > Previous P1 meters. This enables legacy mDNS broadcasting.

Full technical documentation

For all parameters, example responses and advanced options, download the full API documentation.

Did this answer your question?