Skip to content

Sites

Context

The Sites API provides endpoints for retrieving site details, including your chargers and charging points as configured within ChargePilot.

Available Endpoints

  • GET /sites - Retrieve all sites associated with the API key
  • GET /sites/{id} - Retrieve a specific site by ID

Data

Each site object contains the following fields:

FieldTypeDescription
idstringUnique identifier for the site
namestringDisplay name of the site
timezonestringIANA timezone of the site (e.g. Europe/Berlin)
local_controllerobjectThe local controller managing this site
fuse_treearrayHierarchical representation of the site's fuse/load management tree

Local Controller

FieldTypeDescription
idstringUnique identifier for the local controller
namestringDisplay name of the local controller
serial_nostringHardware serial number
device_idstringDevice identifier used for communication

Fuse Tree

The fuse tree is a recursive structure representing the electrical hierarchy of the site — from the main fuse down to individual charging points.

FieldTypeDescription
typestringNode type (e.g. fuse, charging station, connector group)
parametersobjectConfiguration and limits for this node
childrenarrayChild nodes, each following the same fuse tree structure

Node Parameters

FieldTypeDescription
namestringDisplay name of the node
limitnumberMaximum current limit (A)
inbound_limitnumberMaximum inbound current limit (A)
outbound_limitnumberMaximum outbound current limit (A)
fallbacknumberFallback current value
pending_fallback_valuenumberFallback value awaiting activation
fallback_statusstringStatus of the fallback
ordernumberDisplay/processing order among sibling nodes
depthstringDepth level within the fuse tree
fuse_idstringIdentifier of the associated fuse
firmware_versionstringFirmware version of the node's hardware
additional_commentsstringFree-text notes
meterobjectMeter configuration attached to this node (if any)
connectorsarrayCharging connectors attached to this node (if any)

Meter

FieldTypeDescription
is_producerbooleanWhether the meter measures a power producer (e.g. solar)
producer_namestringName of the producer
producer_currentnumberCurrent reading from the producer (A)
is_consumerbooleanWhether the meter measures a power consumer
consumer_namestringName of the consumer
max_possible_currentnumberMaximum current the meter can handle (A)
fallback_valuenumberFallback current value for this meter
primary_transformer_rationumberPrimary winding ratio of an attached transformer
secondary_transformer_rationumberSecondary winding ratio of an attached transformer

Connectors

FieldTypeDescription
idstringUnique identifier for the connector
namestringDisplay name of the connector
connector_idstringOCPP connector ID
charging_station_idstringID of the parent charging station
prioritynumberCharging priority relative to other connectors
charging_capabilitynumber[]Supported charging current levels (A)
discharge_capabilitynumber[]Supported discharging current levels (A), for V2G-capable connectors