Skip to content

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 site
  • GET /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

ParameterTypeRequiredDescription
idstringYesThe ID of the site to query

Query Parameters

ParameterTypeRequiredDescription
sort_fieldstringNoField to sort results by — see Sort Fields
sort_orderasc | descNoSort direction
takenumberNoNumber of records to return (max 100)
skipnumberNoNumber of records to skip, for pagination
only_currently_plugged_inbooleanNoWhen true, only returns charging points with an active plug-in. Accepts true or false.
search_textstringNoFree-text filter applied against charging point names and RFID names

Response

json
{
  "charging_points": [
    /* array of ChargingPoint objects */
  ],
  "count": 12
}
FieldTypeDescription
charging_pointsarrayList of charging point objects (see Data)
countnumberTotal 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

ParameterTypeRequiredDescription
idstringYesThe ID of the site to query

Query Parameters

ParameterTypeRequiredDescription
fromstring (ISO 8601)YesStart of the time range
tostring (ISO 8601)YesEnd of the time range (max 24 hours after from)
fusenumberNoFilter results to a specific fuse value

Response

json
[
  /* array of SitePowerAndLimits objects */
]

An array of SitePowerAndLimits objects ordered by chunk_start ascending.


Data

Charging Point Fields

FieldTypeRequiredDescription
idnumberYesInternal numeric identifier for the charging point
uuidstringYesUUID of the charging point
statusstringYesCurrent status — see Status Values
namestringYesDisplay name of the charging point
prioritizedbooleanYesWhether this charging point has been given charging priority
charger_idstringYesID of the parent charging station
device_idstringYesDevice identifier used for communication
ocpp_errorobjectNoActive OCPP error, if any — contains code (string) and vendor_code (string | null)
rfidstringNoRFID tag ID of the current or last session
rfid_namestringNoDisplay name associated with the RFID tag
rfid_timestring (ISO 8601)NoTimestamp when the RFID tag was presented
charging_powernumberNoCurrent charging power (W)
current_typestringNoAC or DC
inbound_power_limitnumberNoActive inbound power limit applied to this charging point (W)
session_energy_consumednumberNoEnergy consumed in the current or most recent session (Wh)
state_of_chargenumberNoBattery state of charge of the connected vehicle (%)
state_of_charge_timestring (ISO 8601)NoTimestamp of the last state-of-charge reading
plug_in_timestring (ISO 8601)NoTimestamp when the vehicle was plugged in
target_socnumberNoTarget state of charge set for the session (%)

Status Values

ValueDescription
availableCharging point is ready and available
chargingA vehicle is actively charging
errorAn OCPP error is active on this charging point
finishingThe session is finishing (e.g. stopping transaction)
offlineThe charging station is not reachable
paused_evCharging is paused by the vehicle (e.g. battery full, vehicle-side limit)
paused_lmCharging is paused by load management
preparingA vehicle is connected but charging has not yet started
unavailableThe charging point has been set to unavailable
unknownStatus cannot be determined

Sort Fields

The sortField query parameter accepts any of the following values:

ValueDescription
nameSort by charging point name
statusSort by current status
rfid_nameSort by the RFID tag display name
charging_powerSort by current charging power
session_energy_consumedSort by energy consumed this session
state_of_chargeSort by vehicle state of charge
plug_in_timeSort by when the vehicle was plugged in

Site Power and Limits Fields

Each object in the response array represents one measurement chunk.

FieldTypeRequiredDescription
chunk_startstring (ISO 8601)YesTimestamp marking the start of this measurement chunk
total_current_phase1numberYesTotal site current on phase 1 (A)
total_current_phase2numberYesTotal site current on phase 2 (A)
total_current_phase3numberYesTotal site current on phase 3 (A)
total_powernumberYesTotal site power consumption (W)
fleet_current_phase1numberYesFleet (EV charging) current on phase 1 (A)
fleet_current_phase2numberYesFleet (EV charging) current on phase 2 (A)
fleet_current_phase3numberYesFleet (EV charging) current on phase 3 (A)
fleet_powernumberYesTotal fleet (EV charging) power (W)
inbound_opt_current_limit_phase1numberYesOptimised inbound current limit on phase 1 (A)
inbound_opt_current_limit_phase2numberYesOptimised inbound current limit on phase 2 (A)
inbound_opt_current_limit_phase3numberYesOptimised inbound current limit on phase 3 (A)
inbound_current_limitnumberYesActive inbound current limit for the site (A)
power_factor_phase1numberNoPower factor on phase 1
power_factor_phase2numberNoPower factor on phase 2
power_factor_phase3numberNoPower factor on phase 3
inbound_power_limitnumberNoActive inbound power limit for the site (W)
overridden_inbound_current_limitnumberNoManual override value for the inbound current limit (A), if active
overridden_inbound_power_limitnumberNoManual override value for the inbound power limit (W), if active