Skip to content
/
User

ev.energy v2 API (2.0)

The official API for ev.energy, version 2.

Download OpenAPI description
ev.energy-API-v2.json
ev.energy-API-v2.yaml
Overview
URL
developers.ev.energy
ev.energy developers
developers@ev.energy
License
Proprietary
Languages
Servers
Mock server
https://developers.ev.energy/_mock/ev.energy-api-v2
Live API for both production and sandbox requests.
https://api.ev.energy/v2
Staging server for internal testing only.
https://api-staging.ev.energy/v2

Carbon

Endpoints for interacting with carbon intensity data.

Schemas
Operations

Charging Sessions

Endpoints related to records of charging.

Schemas
Operations
Webhooks

CSV

Endpoints that return CSV responses only and are not linkable to other endpoint data.

EVSEs

Endpoints for interacting with EVSEs.

Schemas
Operations

Notifications

Endpoints for communicating notifications.

Operations

Programs

Endpoints related to incentivised charging programs.

Operations

Rebates

Endpoints for interacting with rebates.

Schemas
Operations

Root

The root endpoint which lists all the top-level collections.

Operations

Schedules

Schema definitions for charging schedules.

Schemas

Sites

Endpoints for interacting with sites containing multiple EVSEs.

Operations

Solar

Endpoints for interacting with solar arrays and inverters.

Operations

Subscriptions

Endpoints for interacting with user subscriptions.

Operations

Support Tickets

Endpoints for interacting with customer support tickets.

Schemas
Operations

Tariffs

Endpoints related to energy suppliers and their tariffs.

Schemas
Operations

Users

Endpoints for interacting with users.

Schemas
Operations

User

A resource that represents an individual user in the ev.energy system.

idstringuser[A-Z\d]{26}read-onlyrequired

Unique identifier for the given user.

Example: "user01HN2NJ9NMRZBXT1H6FT9N7735"
urlstring(uri)read-onlyrequired
Example: "https://api.ev.energy/v2/users/user01HN2NJ9NMRZBXT1H6FT9N7735"
emailstring(email)
default_locationLocation (object)

LocationDetail is served when a single user is requested, otherwise Location is served for user lists.

Any of:

Location model for charging locations.

vehiclesArray of strings(uri)read-only
Example: ["https://api.ev.energy/v2/vehicles/vhcl01HRFF3SEVSCRAV9B3CHVDFN0H"]
evsesArray of strings(uri)read-only
Example: ["https://api.ev.energy/v2/evses/evse01HSH04XHZCT92RN018F0236ZM"]
{
  "id": "user01HN2NJ9NMRZBXT1H6FT9N7735",
  "url": "https://api.ev.energy/v2/users/user01HN2NJ9NMRZBXT1H6FT9N7735",
  "email": "user@example.com",
  "default_location": {
    "address_1": "string",
    "address_2": "string",
    "postal_code": "string",
    "country_code": "AD",
    "coordinates": { … },
    "tariff": "https://api.ev.energy/v2/tariffs/tari01HN2NJ9NMRZBXT1H6FT9N7735",
    "city": "string",
    "state": "string",
    "evse_site": "string"
  },
  "vehicles": [
    "https://api.ev.energy/v2/vehicles/vhcl01HRFF3SEVSCRAV9B3CHVDFN0H"
  ],
  "evses": [
    "https://api.ev.energy/v2/evses/evse01HSH04XHZCT92RN018F0236ZM"
  ]
}

List users

Request

List all the users that the authorization token has access to.

Security
oauth2(Required scopes:
user:read
)
Query
page_beforestring[a-z]{4}[A-Z\d]{26}

Return results from the page after this ID.

Example: page_before=xmpl01HNFZM7Q8FXASZXYZ6XM3TQRR
page_afterstring[a-z]{4}[A-Z\d]{26}

Return results from the page before this ID.

Example: page_after=xmpl01HNFZM7Q8FXASZXYZ6XM3TQRR
page_sizeinteger[ 1 .. 100 ]

Specify the number of results to return per page.

Default 25
Example: page_size=10
expandArray of strings

Specify a url field to expand into a nested resource.

Items Enum"default_location.tariff""default_location.tariff.supplier""default_location.evse_site"
Headers
EvEnergy-Versionnumber

Specify the version of this endpoint to use.

Value2
curl -i -X GET \
  'https://developers.ev.energy/_mock/ev.energy-api-v2/users?page_before=xmpl01HNFZM7Q8FXASZXYZ6XM3TQRR&page_after=xmpl01HNFZM7Q8FXASZXYZ6XM3TQRR&page_size=10&expand=default_location.tariff' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'EvEnergy-Version: 2'

Responses

Returns a list of Users.

Headers
Linkstring

Provides links to the previous and next pages of data, if they exist.

Example: "<https://api.ev.energy/v2/vehicles?page_size=25&page_before=vhcl01HRFF3SEVSCRAV9B3CHVDFN0H>; rel=\"previous\", <https://api.ev.energy/v2/vehicles?page_size=25&page_after=vhcl01HRFF3SEVSCRAV9B3CHVDFN0H>; rel=\"next\""
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.

Value2
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/jsonArray [
idstringuser[A-Z\d]{26}read-onlyrequired

Unique identifier for the given user.

Example: "user01HN2NJ9NMRZBXT1H6FT9N7735"
urlstring(uri)read-onlyrequired
Example: "https://api.ev.energy/v2/users/user01HN2NJ9NMRZBXT1H6FT9N7735"
emailstring(email)
default_locationLocation (object)

LocationDetail is served when a single user is requested, otherwise Location is served for user lists.

Any of:

Location model for charging locations.

vehiclesArray of strings(uri)read-only
Example: ["https://api.ev.energy/v2/vehicles/vhcl01HRFF3SEVSCRAV9B3CHVDFN0H"]
evsesArray of strings(uri)read-only
Example: ["https://api.ev.energy/v2/evses/evse01HSH04XHZCT92RN018F0236ZM"]
]
Response
application/json
[
  {
    "id": "user01HN2NJ9NMRZBXT1H6FT9N7735",
    "url": "https://api.ev.energy/v2/users/user01HN2NJ9NMRZBXT1H6FT9N7735",
    "email": "user@example.com",
    "default_location": { … },
    "vehicles": [ … ],
    "evses": [ … ]
  }
]

Create user

Request

Create an individual user in the ev.energy system.

Security
oauth2(Required scopes:
user:write
)
Headers
EvEnergy-Versionnumber

Specify the version of this endpoint to use.

Value2
Body
emailstring(email)
default_locationLocation (object)

LocationDetail is served when a single user is requested, otherwise Location is served for user lists.

Any of:

Location model for charging locations.

curl -i -X POST \
  https://developers.ev.energy/_mock/ev.energy-api-v2/users \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -H 'EvEnergy-Version: 2' \
  -d '{
    "email": "user@example.com",
    "default_location": {
      "address_1": "string",
      "address_2": "string",
      "postal_code": "string",
      "country_code": "AD",
      "coordinates": {
        "latitude": 51.52576576674041,
        "longitude": -0.08366433371722264
      },
      "tariff": "https://api.ev.energy/v2/tariffs/tari01HN2NJ9NMRZBXT1H6FT9N7735",
      "city": "string",
      "state": "string",
      "evse_site": "string"
    }
  }'

Responses

User Created Successfully.

Bodyapplication/json
idstringuser[A-Z\d]{26}read-onlyrequired

Unique identifier for the given user.

Example: "user01HN2NJ9NMRZBXT1H6FT9N7735"
urlstring(uri)read-onlyrequired
Example: "https://api.ev.energy/v2/users/user01HN2NJ9NMRZBXT1H6FT9N7735"
emailstring(email)
default_locationLocation (object)

LocationDetail is served when a single user is requested, otherwise Location is served for user lists.

Any of:

Location model for charging locations.

vehiclesArray of strings(uri)read-only
Example: ["https://api.ev.energy/v2/vehicles/vhcl01HRFF3SEVSCRAV9B3CHVDFN0H"]
evsesArray of strings(uri)read-only
Example: ["https://api.ev.energy/v2/evses/evse01HSH04XHZCT92RN018F0236ZM"]
Response
application/json
{
  "id": "user01HN2NJ9NMRZBXT1H6FT9N7735",
  "url": "https://api.ev.energy/v2/users/user01HN2NJ9NMRZBXT1H6FT9N7735",
  "email": "user@example.com",
  "default_location": {
    "address_1": "string",
    "address_2": "string",
    "postal_code": "string",
    "country_code": "AD",
    "coordinates": { … },
    "tariff": "https://api.ev.energy/v2/tariffs/tari01HN2NJ9NMRZBXT1H6FT9N7735",
    "city": "string",
    "state": "string",
    "evse_site": "string"
  },
  "vehicles": [
    "https://api.ev.energy/v2/vehicles/vhcl01HRFF3SEVSCRAV9B3CHVDFN0H"
  ],
  "evses": [
    "https://api.ev.energy/v2/evses/evse01HSH04XHZCT92RN018F0236ZM"
  ]
}

Retrieve user

Request

Retrieve information about a single, specific user.

Security
oauth2(Required scopes:
user:read
)
Path
user_idstring^(user[A-Z\d]{26})$required

The ID of the specific user to retrieve.

Query
expandArray of strings

Specify a url field to expand into a nested resource.

Items Enum"default_location.tariff""default_location.tariff.supplier""default_location.evse_site"
Headers
EvEnergy-Versionnumber

Specify the version of this endpoint to use.

Value2
curl -i -X GET \
  'https://developers.ev.energy/_mock/ev.energy-api-v2/users/{user_id}?expand=default_location.tariff' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'EvEnergy-Version: 2'

Responses

Returns a single User.

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.

Value2
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
idstringuser[A-Z\d]{26}read-onlyrequired

Unique identifier for the given user.

Example: "user01HN2NJ9NMRZBXT1H6FT9N7735"
urlstring(uri)read-onlyrequired
Example: "https://api.ev.energy/v2/users/user01HN2NJ9NMRZBXT1H6FT9N7735"
emailstring(email)
default_locationLocation (object)

LocationDetail is served when a single user is requested, otherwise Location is served for user lists.

Any of:

Location model for charging locations.

vehiclesArray of strings(uri)read-only
Example: ["https://api.ev.energy/v2/vehicles/vhcl01HRFF3SEVSCRAV9B3CHVDFN0H"]
evsesArray of strings(uri)read-only
Example: ["https://api.ev.energy/v2/evses/evse01HSH04XHZCT92RN018F0236ZM"]
Response
application/json
{
  "id": "user01HN2NJ9NMRZBXT1H6FT9N7735",
  "url": "https://api.ev.energy/v2/users/user01HN2NJ9NMRZBXT1H6FT9N7735",
  "email": "user@example.com",
  "default_location": {
    "address_1": "string",
    "address_2": "string",
    "postal_code": "string",
    "country_code": "AD",
    "coordinates": { … },
    "tariff": "https://api.ev.energy/v2/tariffs/tari01HN2NJ9NMRZBXT1H6FT9N7735",
    "city": "string",
    "state": "string",
    "evse_site": "string"
  },
  "vehicles": [
    "https://api.ev.energy/v2/vehicles/vhcl01HRFF3SEVSCRAV9B3CHVDFN0H"
  ],
  "evses": [
    "https://api.ev.energy/v2/evses/evse01HSH04XHZCT92RN018F0236ZM"
  ]
}

Update User

Request

Update user information.

Security
oauth2(Required scopes:
user:write
)
Path
user_idstring^(user[A-Z\d]{26})$required

The ID of the specific user to retrieve.

Query
expandArray of strings

Specify a url field to expand into a nested resource.

Items Enum"default_location.tariff""default_location.tariff.supplier""default_location.evse_site"
Headers
EvEnergy-Versionnumber

Specify the version of this endpoint to use.

Value2
Body
emailstring(email)
default_locationLocation (object)

LocationDetail is served when a single user is requested, otherwise Location is served for user lists.

Any of:

Location model for charging locations.

curl -i -X PATCH \
  'https://developers.ev.energy/_mock/ev.energy-api-v2/users/{user_id}?expand=default_location.tariff' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -H 'EvEnergy-Version: 2' \
  -d '{
    "email": "user@example.com",
    "default_location": {
      "address_1": "string",
      "address_2": "string",
      "postal_code": "string",
      "country_code": "AD",
      "coordinates": {
        "latitude": 51.52576576674041,
        "longitude": -0.08366433371722264
      },
      "tariff": "https://api.ev.energy/v2/tariffs/tari01HN2NJ9NMRZBXT1H6FT9N7735",
      "city": "string",
      "state": "string",
      "evse_site": "string"
    }
  }'

Responses

User updated successfully.

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.

Value2
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
Bodyapplication/json
idstringuser[A-Z\d]{26}read-onlyrequired

Unique identifier for the given user.

Example: "user01HN2NJ9NMRZBXT1H6FT9N7735"
urlstring(uri)read-onlyrequired
Example: "https://api.ev.energy/v2/users/user01HN2NJ9NMRZBXT1H6FT9N7735"
emailstring(email)
default_locationLocation (object)

LocationDetail is served when a single user is requested, otherwise Location is served for user lists.

Any of:

Location model for charging locations.

vehiclesArray of strings(uri)read-only
Example: ["https://api.ev.energy/v2/vehicles/vhcl01HRFF3SEVSCRAV9B3CHVDFN0H"]
evsesArray of strings(uri)read-only
Example: ["https://api.ev.energy/v2/evses/evse01HSH04XHZCT92RN018F0236ZM"]
Response
application/json
{
  "id": "user01HN2NJ9NMRZBXT1H6FT9N7735",
  "url": "https://api.ev.energy/v2/users/user01HN2NJ9NMRZBXT1H6FT9N7735",
  "email": "user@example.com",
  "default_location": {
    "address_1": "string",
    "address_2": "string",
    "postal_code": "string",
    "country_code": "AD",
    "coordinates": { … },
    "tariff": "https://api.ev.energy/v2/tariffs/tari01HN2NJ9NMRZBXT1H6FT9N7735",
    "city": "string",
    "state": "string",
    "evse_site": "string"
  },
  "vehicles": [
    "https://api.ev.energy/v2/vehicles/vhcl01HRFF3SEVSCRAV9B3CHVDFN0H"
  ],
  "evses": [
    "https://api.ev.energy/v2/evses/evse01HSH04XHZCT92RN018F0236ZM"
  ]
}

Vehicles

Endpoints for interacting with vehicles.

Schemas

Webhooks

Endpoints for configuring and managing webhooks.

Operations