Skip to content
/
VehicleModelWrite

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

VehicleTrimCreate

Request body for creating a custom vehicle trim.

namestringrequired

The name of the vehicle trim.

Example: "Custom Trim"
modelstring(uri)required

URL reference to the vehicle model this trim belongs to.

Example: "https://api.ev.energy/v2/vehicle_models/vmod01HSBR8Z36GD7A46K7M4R12VG0"
battery_size_watt_hoursinteger[ 1000 .. 300000 ]required

Battery size in watt hours. Must be between 1000 and 300000.

Example: 75500
{
  "name": "Custom Trim",
  "model": "https://api.ev.energy/v2/vehicle_models/vmod01HSBR8Z36GD7A46K7M4R12VG0",
  "battery_size_watt_hours": 75500
}

VehicleModelWrite

Fields that must be set when creating a VehicleModel resource.

namestringrequired

The name of the vehicle model.

Example: "Model 3"
makestring(uri)required

URL reference to the vehicle make.

Example: "https://api.ev.energy/v2/vehicle_makes/vmak01HRFHBCM7VBSWRPVYFBQMH2BR"
{
  "name": "Model 3",
  "make": "https://api.ev.energy/v2/vehicle_makes/vmak01HRFHBCM7VBSWRPVYFBQMH2BR"
}

VehicleModel

A resource representing a model of vehicle.

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

Unique identifier for the given Vehicle Model.

Example: "vmod01HSBR8Z36GD7A46K7M4R12VG0"
urlstring(uri)read-only
Example: "https://api.ev.energy/vehicle_models/vmod01HSBR8Z36GD7A46K7M4R12VG0"
namestringread-only
Example: "C40"
makestring or VehicleMake (object)
One of:
string(uri)
onboarding_urlstring or null(uri)

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

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?model_id=vmod01HN2P436099PEQ20B7TKPGTEJ&user_id=user01HN2NJ9NMRZBXT1H6FT9N7735"
trimsstring(uri)

A pre-constructed link to a list of vehicle trims filtered for this model.

Example: "https://api.ev.energy/vehicle_trims?model_id=vmod01HN2P436099PEQ20B7TKPGTEJ"
{
  "id": "vmod01HSBR8Z36GD7A46K7M4R12VG0",
  "url": "https://api.ev.energy/vehicle_models/vmod01HSBR8Z36GD7A46K7M4R12VG0",
  "name": "C40",
  "make": "https://api.ev.energy/v2/vehicle_makes/vmak01HRFHBCM7VBSWRPVYFBQMH2BR",
  "onboarding_url": "https://api.ev.energy/v2/vehicle_onboarding?model_id=vmod01HN2P436099PEQ20B7TKPGTEJ&user_id=user01HN2NJ9NMRZBXT1H6FT9N7735",
  "trims": "https://api.ev.energy/vehicle_trims?model_id=vmod01HN2P436099PEQ20B7TKPGTEJ"
}

Webhooks

Endpoints for configuring and managing webhooks.

Operations