Streaming APIs

Site Level Live Status

API users can get real-time live status data on demand for a given system. Users can retrieve real-time power values for PV Production, Grid Import/Export, Consumption, Battery Charge/Discharge, Generator, and EVSE. The API supports multi-Envoy aggregation, summing power values across multiple gateways and applying intelligent field resolution for Battery State of Charge (SOC), Battery Mode, and Grid Status. EVSE data supports multiple chargers, returning charger serial numbers as a list and aggregating consumption power across all active chargers. The live status stream is provided for 30 seconds by default and can be configured using the duration parameter (minimum 30 seconds, maximum 300 seconds).

get/api/v4/systems/{system_id}/live_data

Request

Path parameters

system_idinteger required

The unique numeric ID of the system

Headers

durationinteger

Duration of the stream in seconds. Default=30, Min=30, Max=300, e.g=30

Response

successful operation

Changes

No recorded changes to this operation across all 1 revision of this API.