Skip to content
/
Make

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

Model

A resource representing a model of EVSEs.

idstringemod[A-Z\d]{26}read-only

Unique identifier for the given EVSE Model.

Example: "emod01HS9A004X5TB5JCMHENB5Z446"
urlstring(uri)read-only
Example: "https://api.ev.energy/v2/evse_models/emod01HS9A004X5TB5JCMHENB5Z446"
namestringread-only
Example: "EVWC2S22"
makestring or Make (object)
One of:
string(uri)
onboarding_urlstring or null(uri)read-only

A pre-constructed link to initiate onboarding for an EVSE with this model. If it is null, then we do not support intergrating with this EVSE and the user will need an integrated vehicle in order for us to be able to track their charging.

Note: if you are using client credentials authentication, the user ID will not be automatically included unless you set the EvEnergy-User header on your request.

Example: "https://api.ev.energy/v2/evse_onboarding?model_id=emod01HN2NJHAJJAQD32QJ4QXTDSGW&user_id=user01HN2NJ9NMRZBXT1H6FT9N7735"
{
  "id": "emod01HS9A004X5TB5JCMHENB5Z446",
  "url": "https://api.ev.energy/v2/evse_models/emod01HS9A004X5TB5JCMHENB5Z446",
  "name": "EVWC2S22",
  "make": "https://api.ev.energy/v2/evse_makes/emak01HS8FRMXGE3566EDXCMWGW5W4",
  "onboarding_url": "https://api.ev.energy/v2/evse_onboarding?model_id=emod01HN2NJHAJJAQD32QJ4QXTDSGW&user_id=user01HN2NJ9NMRZBXT1H6FT9N7735"
}

Make

A resource representing a manufacturer of EVSEs.

idstringemak[A-Z\d]{26}read-only

Unique identifier for the given EVSE Make.

Example: "emak01HS8FRXKJD5JZZ7ZN6W8H21P8"
urlstring(uri)read-only
Example: "https://api.ev.energy/v2/evse_makes/emak01HS8FRXKJD5JZZ7ZN6W8H21P8"
namestringread-only
Example: "BG SyncEV"
iconstring or null(uri)read-only

A url for an image of the make's logo.

Example: "https://cdn.example.com/volvo.png"
onboarding_urlstring or nullread-only

A pre-constructed link to initiate onboarding for an EVSE of this make. If it is null, then it cannot be onboarded with model alone. You should filter the list of EVSE models by this make and then have the user select their model.

Note: if you are using client credentials authentication, the user ID will not be automatically included unless you set the EvEnergy-User header on your request.

Example: "https://api.ev.energy/v2/evse_onboarding?make_id=emak01HN2NJQRGDQP0GBE1F7R6PB3D&user_id=user01HN2NJ9NMRZBXT1H6FT9N7735"
modelsstring

A pre-constructed link to a list of EVSE models filtered for this make.

Example: "https://api.ev.energy/v2/evse_models/?make_id=emak01HN2NJQRGDQP0GBE1F7R6PB3D"
{
  "id": "emak01HS8FRXKJD5JZZ7ZN6W8H21P8",
  "url": "https://api.ev.energy/v2/evse_makes/emak01HS8FRXKJD5JZZ7ZN6W8H21P8",
  "name": "BG SyncEV",
  "icon": "https://cdn.example.com/volvo.png",
  "onboarding_url": "https://api.ev.energy/v2/evse_onboarding?make_id=emak01HN2NJQRGDQP0GBE1F7R6PB3D&user_id=user01HN2NJ9NMRZBXT1H6FT9N7735",
  "models": "https://api.ev.energy/v2/evse_models/?make_id=emak01HN2NJQRGDQP0GBE1F7R6PB3D"
}

EVSECommandLog

Records a command that was sent to an EVSE.

urlstring(uri)read-only
Example: "https://api.ev.energy/v2/evses/evse01HSH04KDEWF6Z4DB2J77J74K5/command_logs/2024-04-17T09:39:45.984584Z/"
logged_atstring(date-time)read-only

The date and time when this command was logged by the ev.energy system.

evsestring or EVSE (object)
One of:
string(uri)
max_load_target_milliampsinteger or nullread-only

The target maximum load sent to the EVSE, in milliamps.

Example: 32000
is_enabled_targetboolean or nullread-only

The target state sent for is_enabled (i.e. free-vend mode).

Example: true
always_enabledboolean or nullread-only

Whether the EVSE should always be in is_enabled (i.e. free-vend) mode.

Example: false
reasonstring or nullread-only

The reason the command was sent to the EVSE.

Enum"SCHEDULED_CHARGING""REFRESH_SCHEDULES""STOP_CHARGE""START_CHARGE""SOLAR_CHARGE_NIGHTTIME_CHARGE_RATE""API_TRIGGERED_COMMAND""COMMISSIONING""CHARGING_SESSION""VEHICLE_TO_HOME""FREE_VEND"
Example: "SCHEDULED_CHARGING"
internal_command_idstring or null(uuid)read-only

Internal UUID to track this command dispatch. This links with device command logs.

Example: "d4e5f6a7-b8c9-0123-def0-123456789abc"
{
  "url": "https://api.ev.energy/v2/evses/evse01HSH04KDEWF6Z4DB2J77J74K5/command_logs/2024-04-17T09:39:45.984584Z/",
  "logged_at": "2019-08-24T14:15:22Z",
  "evse": "https://api.ev.energy/v2/evses/evse01HSH04KDEWF6Z4DB2J77J74K5",
  "max_load_target_milliamps": 32000,
  "is_enabled_target": true,
  "always_enabled": false,
  "reason": "SCHEDULED_CHARGING",
  "internal_command_id": "d4e5f6a7-b8c9-0123-def0-123456789abc"
}

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

Vehicles

Endpoints for interacting with vehicles.

Schemas

Webhooks

Endpoints for configuring and managing webhooks.

Operations