ERE (beta)
Scoped ERE data API for customers who have shared their data. This API is in preview; breaking changes may occur.
List ERE Chargers
Returns charger metadata for the shared chargers. With an OAuth application token the full shared set is returned in a single response with no pagination. With a provider API credential the response is paginated via limit/skip (a per-key consent can cover thousands of chargers) and carries meta.total. See the ERE integration guide for more information on how to integrate.
API credentialere:readereQuery parameters2
200ERE chargers application/json
Whether the customer has shared anything with this connection. none = nothing shared yet (an OAuth selected share naming nothing, or an API credential with no active consents) — the empty feed is a misconfiguration to fix, not a correctly-empty result. active = a sharing grant exists, even if it currently resolves to zero chargers (e.g. dynamic scopes or removed chargers). Always present.
activenonedataEreCharger[]
The Road account that owns the charger.
Highest single-connector power in kW, derived from the connector set.
EVSE id of the charger. Join key for the sessions feed.
connectorsEreChargerConnector[]Per-connector detail.
Per-connector detail.
Connector number on the charger.
EVSE id this connector belongs to.
Connector format (for example socket or cable).
Maximum current the connector supports, in amperes.
Maximum power the connector supports, in kW.
Maximum voltage the connector supports, in volts.
Operator's own physical reference for the connector, where set.
Power type (for example AC single/three phase, or DC).
Connector standard (for example the socket/plug type).
locationobjectPostal address and position of the charger's location.
Postal address and position of the charger's location.
coordinatesobjectWGS84 position of the location, in decimal degrees. Absent when the location has no position set.
WGS84 position of the location, in decimal degrees. Absent when the location has no position set.
Model, as reported by the station.
Number of connectors on the station.
The pairing serial printed on the station, falling back to the OCPP-reported boot serial for stations registered without one.
usageReimbursementobject[]The raw reimbursement split for the charger's location. One entry means a
dedicated arrangement; more than one means a split. The raw split is passed
through so an ERE partner can resolve edge cases itself.
The raw reimbursement split for the charger's location. One entry means a dedicated arrangement; more than one means a split. The raw split is passed through so an ERE partner can resolve edge cases itself.
entityobject
accountusercreditreimburseThe reimbursed user, when a single user is named in the reimbursement policy.
Manufacturer, as reported by the station.
400Invalid Request application/json
errorobject
401Unauthorized application/json
errorobject
403Forbidden: missing a required permission, or no access to this resource application/json
errorobject
404Not Found application/json
errorobject
500Internal server error application/json
errorobject
List ERE Sessions
Returns ERE-relevant charging sessions (CDRs): completed sessions that passed data-integrity validation. With an OAuth application token (ere scope) this is the acting user's data, on the chargers shared with the app. With a provider API credential carrying the ERE Data API permission (plus your provider header) this spans every charger consented to that credential in the dashboard. Supports delta sync: pass the meta.nextSince from a previous response back as updatedSince (an opaque cursor — do not parse or construct it); omit it on the first call. meta.nextSince is the only pagination field this endpoint returns. For the qualification rules, data model and ingestion guidance, see the ERE integration guide.
API credentialere:readereQuery parameters2
200ERE sessions application/json
Whether the customer has shared anything with this connection. none = nothing shared yet (an OAuth selected share naming nothing, or an API credential with no active consents) — the empty feed is a misconfiguration to fix, not a correctly-empty result. active = a sharing grant exists, even if it currently resolves to zero chargers (e.g. dynamic scopes or removed chargers). Always present.
activenonedataEreSession[]
Identifier of the Road account (organisation) the session belongs to.
EVSE id of the charger the session ran on. Joins to chargePointId on the charger.
Connector on the charger the vehicle was plugged into.
When the session ended (UTC). Always present, since only completed sessions are served.
Energy delivered during the session, in kWh.
locationobjectPostal address of the charger's location.
Postal address of the charger's location.
Meter register reading at session start, in Wh: the raw OCPP register
value, unconverted (note energyKwh is kWh). 0 is a genuine reading
(fresh meter). Always present: a completed session without meter values
is excluded and marked invalid upstream (UNKNOWN_METER_VALUES), and this
feed only serves valid sessions.
Meter register reading at session stop, in Wh: the raw OCPP register
value, unconverted (note energyKwh is kWh). 0 is a genuine reading.
Always present, same invariant as meterStart.
The OCPP transaction id of the session as exchanged with the charge point, for reconciling sessions across CPMSs. Omitted when not recorded on the session.
Stable unique identifier of the session. Use it as the upsert key when ingesting the feed.
When charging started (UTC).
SHA-256 hash (hex) of the charge token UID used to authorise the session. A stable pseudonymous identifier: it groups sessions charged with the same token without exposing the token itself.
metaobject
Opaque delta-sync cursor. Pass back verbatim as the next request cursor; do not parse.