Live Data
Context
The Live Data API provides real-time information about your sites — including the current status of every charging point and a time-series view of site-level power consumption and limits. This data mirrors what is shown in the ChargePilot Dashboard live view.
Available Endpoints
GET /live/site/{id}/charging-points- Retrieve the current status of all charging points at a siteGET /live/site/{id}/power-and-limits- Retrieve time-series power and limit data for a site
GET /live/site/{id}/charging-points
Returns the current live status of every charging point at the given site, including plug-in state, active session energy, state of charge, and any OCPP errors.
Path Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
id | string | Yes | The ID of the site to query |
Query Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
sort_field | string | No | Field to sort results by — see Sort Fields |
sort_order | asc | desc | No | Sort direction |
take | number | No | Number of records to return (max 100) |
skip | number | No | Number of records to skip, for pagination |
only_currently_plugged_in | boolean | No | When true, only returns charging points with an active plug-in. Accepts true or false. |
search_text | string | No | Free-text filter applied against charging point names and RFID names |
Response
{
"charging_points": [
/* array of ChargingPoint objects */
],
"count": 12
}| Field | Type | Description |
|---|---|---|
charging_points | array | List of charging point objects (see Data) |
count | number | Total number of matching charging points |
GET /live/site/{id}/power-and-limits
Returns time-series data for site-level power consumption and current limits over the given time range. Each entry represents a measurement chunk, with per-phase breakdowns and the active limit at that point in time.
Path Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
id | string | Yes | The ID of the site to query |
Query Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
from | string (ISO 8601) | Yes | Start of the time range |
to | string (ISO 8601) | Yes | End of the time range (max 24 hours after from) |
fuse | number | No | Filter results to a specific fuse value |
Response
[
/* array of SitePowerAndLimits objects */
]An array of SitePowerAndLimits objects ordered by chunk_start ascending.
Data
Charging Point Fields
| Field | Type | Required | Description |
|---|---|---|---|
id | number | Yes | Internal numeric identifier for the charging point |
uuid | string | Yes | UUID of the charging point |
status | string | Yes | Current status — see Status Values |
name | string | Yes | Display name of the charging point |
prioritized | boolean | Yes | Whether this charging point has been given charging priority |
charger_id | string | Yes | ID of the parent charging station |
device_id | string | Yes | Device identifier used for communication |
ocpp_error | object | No | Active OCPP error, if any — contains code (string) and vendor_code (string | null) |
rfid | string | No | RFID tag ID of the current or last session |
rfid_name | string | No | Display name associated with the RFID tag |
rfid_time | string (ISO 8601) | No | Timestamp when the RFID tag was presented |
charging_power | number | No | Current charging power (W) |
current_type | string | No | AC or DC |
inbound_power_limit | number | No | Active inbound power limit applied to this charging point (W) |
session_energy_consumed | number | No | Energy consumed in the current or most recent session (Wh) |
state_of_charge | number | No | Battery state of charge of the connected vehicle (%) |
state_of_charge_time | string (ISO 8601) | No | Timestamp of the last state-of-charge reading |
plug_in_time | string (ISO 8601) | No | Timestamp when the vehicle was plugged in |
target_soc | number | No | Target state of charge set for the session (%) |
Status Values
| Value | Description |
|---|---|
available | Charging point is ready and available |
charging | A vehicle is actively charging |
error | An OCPP error is active on this charging point |
finishing | The session is finishing (e.g. stopping transaction) |
offline | The charging station is not reachable |
paused_ev | Charging is paused by the vehicle (e.g. battery full, vehicle-side limit) |
paused_lm | Charging is paused by load management |
preparing | A vehicle is connected but charging has not yet started |
unavailable | The charging point has been set to unavailable |
unknown | Status cannot be determined |
Sort Fields
The sortField query parameter accepts any of the following values:
| Value | Description |
|---|---|
name | Sort by charging point name |
status | Sort by current status |
rfid_name | Sort by the RFID tag display name |
charging_power | Sort by current charging power |
session_energy_consumed | Sort by energy consumed this session |
state_of_charge | Sort by vehicle state of charge |
plug_in_time | Sort by when the vehicle was plugged in |
Site Power and Limits Fields
Each object in the response array represents one measurement chunk.
| Field | Type | Required | Description |
|---|---|---|---|
chunk_start | string (ISO 8601) | Yes | Timestamp marking the start of this measurement chunk |
total_current_phase1 | number | Yes | Total site current on phase 1 (A) |
total_current_phase2 | number | Yes | Total site current on phase 2 (A) |
total_current_phase3 | number | Yes | Total site current on phase 3 (A) |
total_power | number | Yes | Total site power consumption (W) |
fleet_current_phase1 | number | Yes | Fleet (EV charging) current on phase 1 (A) |
fleet_current_phase2 | number | Yes | Fleet (EV charging) current on phase 2 (A) |
fleet_current_phase3 | number | Yes | Fleet (EV charging) current on phase 3 (A) |
fleet_power | number | Yes | Total fleet (EV charging) power (W) |
inbound_opt_current_limit_phase1 | number | Yes | Optimised inbound current limit on phase 1 (A) |
inbound_opt_current_limit_phase2 | number | Yes | Optimised inbound current limit on phase 2 (A) |
inbound_opt_current_limit_phase3 | number | Yes | Optimised inbound current limit on phase 3 (A) |
inbound_current_limit | number | Yes | Active inbound current limit for the site (A) |
power_factor_phase1 | number | No | Power factor on phase 1 |
power_factor_phase2 | number | No | Power factor on phase 2 |
power_factor_phase3 | number | No | Power factor on phase 3 |
inbound_power_limit | number | No | Active inbound power limit for the site (W) |
overridden_inbound_current_limit | number | No | Manual override value for the inbound current limit (A), if active |
overridden_inbound_power_limit | number | No | Manual override value for the inbound power limit (W), if active |