Appearance
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 keyGET /sites/{id}- Retrieve a specific site by ID
Data
Each site object contains the following fields:
| Field | Type | Description |
|---|---|---|
id | string | Unique identifier for the site |
name | string | Display name of the site |
timezone | string | IANA timezone of the site (e.g. Europe/Berlin) |
local_controller | object | The local controller managing this site |
fuse_tree | array | Hierarchical representation of the site's fuse/load management tree |
Local Controller
| Field | Type | Description |
|---|---|---|
id | string | Unique identifier for the local controller |
name | string | Display name of the local controller |
serial_no | string | Hardware serial number |
device_id | string | Device 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.
| Field | Type | Description |
|---|---|---|
type | string | Node type (e.g. fuse, charging station, connector group) |
parameters | object | Configuration and limits for this node |
children | array | Child nodes, each following the same fuse tree structure |
Node Parameters
| Field | Type | Description |
|---|---|---|
name | string | Display name of the node |
limit | number | Maximum current limit (A) |
inbound_limit | number | Maximum inbound current limit (A) |
outbound_limit | number | Maximum outbound current limit (A) |
fallback | number | Fallback current value |
pending_fallback_value | number | Fallback value awaiting activation |
fallback_status | string | Status of the fallback |
order | number | Display/processing order among sibling nodes |
depth | string | Depth level within the fuse tree |
fuse_id | string | Identifier of the associated fuse |
firmware_version | string | Firmware version of the node's hardware |
additional_comments | string | Free-text notes |
meter | object | Meter configuration attached to this node (if any) |
connectors | array | Charging connectors attached to this node (if any) |
Meter
| Field | Type | Description |
|---|---|---|
is_producer | boolean | Whether the meter measures a power producer (e.g. solar) |
producer_name | string | Name of the producer |
producer_current | number | Current reading from the producer (A) |
is_consumer | boolean | Whether the meter measures a power consumer |
consumer_name | string | Name of the consumer |
max_possible_current | number | Maximum current the meter can handle (A) |
fallback_value | number | Fallback current value for this meter |
primary_transformer_ratio | number | Primary winding ratio of an attached transformer |
secondary_transformer_ratio | number | Secondary winding ratio of an attached transformer |
Connectors
| Field | Type | Description |
|---|---|---|
id | string | Unique identifier for the connector |
name | string | Display name of the connector |
connector_id | string | OCPP connector ID |
charging_station_id | string | ID of the parent charging station |
priority | number | Charging priority relative to other connectors |
charging_capability | number[] | Supported charging current levels (A) |
discharge_capability | number[] | Supported discharging current levels (A), for V2G-capable connectors |