Get Topology

Returns the electrical topology of a site the authenticated customer has access to: the grid connection point, solar PV arrays, battery (BMS), inverters, EV chargers, meters and circuits.

The topology is a tree rooted at the site. Battery and PV sensors sit in a DC sub-circuit behind the inverter rather than at the top level. Nodes with "kind": "sensor" expose an id that can be passed directly to GET /api/v2/devices/{synthId}/telemetry and a channels array listing the data channels available for that stream.

See the Topology key concept page for a full explanation and worked examples.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

Unique identifier of the site. Must start with site- (the canonical SiteId format); anything else fails the server-side decode check and returns a 400 rather than falling through to the authz / not-found path.

Query Params
boolean
Defaults to true

When true (default), PV optimisers and BMS nodes are compacted into their parent inverter/circuit node. The aggregated BMS node uses the __bb_agg suffix and its maxCapacity_J reflects the combined capacity of all battery blocks.

Responses

Language
URL
LoadingLoading…
Response
Choose an example:
application/json