Skip to content

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

Vehicles

Endpoints for interacting with vehicles.

Schemas

Vehicle

A resource representing a single, physical electric vehicle.

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

Unique identifier for the given Vehicle.

Example: "vhcl01HRFF3SEVSCRAV9B3CHVDFN0H"
urlstring(uri)read-only
Example: "https://api.ev.energy/v2/vehicles/vhcl01HRFF3SEVSCRAV9B3CHVDFN0H"
trimstring or VehicleTrim (object)read-only

Defaults to a url, but can be expanded to the full Trim resource via the expand query parameter.

One of:

Defaults to a url, but can be expanded to the full Trim resource via the expand query parameter.

string(uri)read-only
userstring or User (object)

Defaults to a url, but can be expanded to the full User resource via the expand query parameter.

Example: "https://api.ev.energy/v2/users/user01HN2NJ9NMRZBXT1H6FT9N7735"
One of:

Defaults to a url, but can be expanded to the full User resource via the expand query parameter.

string(uri)
latest_status_log(string or null) or VehicleStatusLog (object)

An expandable reference to the most recent status log for this Vehicle. This can be requested or expanded to get the most accurate information we have on the device's current status.

Example: "https://api.ev.energy/v2/vehicles/vhcl01HRFF3SEVSCRAV9B3CHVDFN0H/status_logs/2024-04-17T09:39:45.994584Z/"
One of:

An expandable reference to the most recent status log for this Vehicle. This can be requested or expanded to get the most accurate information we have on the device's current status.

string or null(uri)
charging_sub_sessionsstring(uri)

Provides a pre-constructed URL to list charging sub-sessions involving this Vehicle.

Example: "https://api.ev.energy/charging_sub_sessions/?vehicle_id=vhcl01HRFF3SEVSCRAV9B3CHVDFN0H"
integratedanyread-only

Whether we have an integration with this vehicle.

  • UNINTEGRATED: This vehicle is not integrated
  • ACTIVE: This vehicle is integrated and the connection is working.
  • INACTIVE: This vehicle has been integrated but the connection has been severed, usually because the user needs to reconnect it.
Enum"UNINTEGRATED""ACTIVE""INACTIVE"
maximum_charge_limit_percentageinteger[ 50 .. 100 ]

The target state of charge of the car as a percentage between 50 and 100. The car will not be smart charged above this value. Can be null if target charge level has not been set or we don't know the car's battery size.

Default 100
{
  "id": "vhcl01HRFF3SEVSCRAV9B3CHVDFN0H",
  "url": "https://api.ev.energy/v2/vehicles/vhcl01HRFF3SEVSCRAV9B3CHVDFN0H",
  "trim": "https://api.ev.energy/v2/trim/vehicle_trim01HRFHBCM7VBSWRPVYFBQMH2BR",
  "user": "https://api.ev.energy/v2/users/user01HN2NJ9NMRZBXT1H6FT9N7735",
  "latest_status_log": "https://api.ev.energy/v2/vehicles/vhcl01HRFF3SEVSCRAV9B3CHVDFN0H/status_logs/2024-04-17T09:39:45.994584Z/",
  "charging_sub_sessions": "https://api.ev.energy/charging_sub_sessions/?vehicle_id=vhcl01HRFF3SEVSCRAV9B3CHVDFN0H",
  "integrated": "UNINTEGRATED",
  "maximum_charge_limit_percentage": 100
}

Vehicle

Fields that can (or must) be set when creating a Vehicle resource.

trimstring(uri)required
Example: "https://api.ev.energy/v2/trim/vehicle_trim01HRFHBCM7VBSWRPVYFBQMH2BR"
userstring(uri)

Required if using Client Credentials authentication.

Example: "https://api.ev.energy/v2/users/user01HN2NJ9NMRZBXT1H6FT9N7735"
{
  "trim": "https://api.ev.energy/v2/trim/vehicle_trim01HRFHBCM7VBSWRPVYFBQMH2BR",
  "user": "https://api.ev.energy/v2/users/user01HN2NJ9NMRZBXT1H6FT9N7735"
}

VehicleTrim

A resource representing a "trim level" of a particular vehicle model, which captures a specific set of features.

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

Unique identifier for the given Vehicle Trim.

Example: "trim01HRFHBCM7VBSWRPVYFBQMH2BR"
urlstring(uri)read-only
Example: "https://api.ev.energy/v2/vehicle_trim/trim01HRFHBCM7VBSWRPVYFBQMH2BR"
namestringread-only
Example: "Recharge Core (69 kWh)"
modelstring or VehicleModel (object)
One of:
string(uri)
onboarding_urlstring or null(uri)read-only

A pre-constructed link to initiate onboarding for a vehicle with this trim. If it is null, then we do not support intergrating with this vehicle and you should POST the trim to /vehicles to create an unintegrated vehicle.

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/vehicle_onboarding?trim_id=trim01HN2NZ1040Y8E77CQGXADC2TZ&user_id=user01HN2NJ9NMRZBXT1H6FT9N7735"
{
  "id": "trim01HRFHBCM7VBSWRPVYFBQMH2BR",
  "url": "https://api.ev.energy/v2/vehicle_trim/trim01HRFHBCM7VBSWRPVYFBQMH2BR",
  "name": "Recharge Core (69 kWh)",
  "model": "http://example.com",
  "onboarding_url": "https://api.ev.energy/v2/vehicle_onboarding?trim_id=trim01HN2NZ1040Y8E77CQGXADC2TZ&user_id=user01HN2NJ9NMRZBXT1H6FT9N7735"
}

Webhooks

Endpoints for configuring and managing webhooks.

Operations