Skip to content

Sites

Endpoints for interacting with sites containing multiple EVSEs.

Operations

List EVSE Sites

Request

List all available EVSE Sites

Security
oauth2(Required scopes: site:read)
Headers
EvEnergy-Versionnumber

Specify the version of this endpoint to use.

Value:2
EvEnergy-Userstringuser[A-Z\d]{26}

If the client is authenticated using Client Credentials, setting EvEnergy-User to a valid user ID allows requests to be made as if you were directly authenticated as that user.

Example:user01HN2NJ9NMRZBXT1H6FT9N7735
curl -i -X GET \
  https://developers.ev.energy/_mock/ev.energy-api-v2/evse_sites \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'EvEnergy-User: user01HN2NJ9NMRZBXT1H6FT9N7735' \
  -H 'EvEnergy-Version: 2'

Responses

OK

Headers
EvEnergy-Versionnumber

Indicates the version of the API that generated this response. If EvEnergy-Version was not specified in the request, this will be your OAuth application's default version.

Value:2
X-RateLimit-Limitnumber

The maximum number of requests that can be made to this endpoint per hour. Defaults to 1000 but may vary per client.

Default:1000
X-RateLimit-Remainingnumber

The number of requests remaining until this client's rate limit is reached.

Default:999
RetryAfternumber

The number of seconds until this client's requests will not be rate limited.

Default:3600
Bodyapplication/json
Array [
idstringsite[A-Z\d]{26}read-onlyrequired
urlstring, (uri)read-onlyrequired
Example:"https://api.ev.energy/v2/evse_sites/site01JX2SZ0WAFTDYVYY0JRAYREY7"
evsesArray of strings, (uri)read-onlyrequired

A list of all EVSEs that are currently associated with this site.

cpms_connectionstring or nullread-onlyrequired

The type of ChargePoint Management System that this site is connected to, if there is one.

Enum:null"CHARGEPOINT""SWTCH"
cpms_connection_display_namestring or null

A human-readable name for the Chargepoint Management System that the site is connected to.

Example:"ChargePoint"
user_connectedboolean or nullread-only

When authenticated as a specific user (eg. via the Authorisation Code grant type) or when the EvEnergy-User header is set to a valid user ID, this field will indicate whether the user is currently connected to this EVSE Site's CPMS. If the request is not made in the context of a user, or the site does not have a CPMS connection, this field will be null.

]
Response
[
  {
    "id": "site01JX2SZ0WAFTDYVYY0JRAYREY7",
    "url": "https://api.ev.energy/v2/evse_sites/site01JX2SZ0WAFTDYVYY0JRAYREY7",
    "evses": [ … ],
    "cpms_connection": null,
    "cpms_connection_display_name": "ChargePoint",
    "user_connected": true
  }
]