Skip to content
Schedules/
ScheduleInterval

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

ScheduleInterval

A schedule interval represents a charging instruction for a specific time period within a charging session. It specifies the charging current (in milliamps) that should be applied during that period.

started_atstring(date-time)read-only

The start time of the period this schedule applies to. Always aligned to half-hour boundaries (:00 or :30).

Example: "2024-01-01T02:00:00Z"
interval_secondsinteger or nullread-only

The duration of this schedule in seconds. Currently always 1800 seconds (30 minutes), or null for boost sessions which have no defined end time.

Example: 1800
current_milliampsintegerread-only

The charging current in milliamps that should be applied during this period. A value of 0 means no charging.

Example: 7400
schedule_typestringread-only

The type of scheduling that generated this instruction.

  • INITIAL_CHARGE_TIME: Initial charge to condition the battery
  • BATTERY_WARMING: Pre-warming the hour before the ready-by-time
  • SMART: Optimised smart charging
  • BOOST: Immediate charging at maximum rate
  • SOLAR_ONLY: Charging only from solar generation
  • SOLAR_SMART: Combined solar and smart charging
  • V2G_DISCHARGE: Vehicle-to-grid discharge
  • V2G_CHARGEBACK: Charging back after V2G discharge
  • LEGACY: Legacy schedules from before type tracking
Enum"INITIAL_CHARGE_TIME""BATTERY_WARMING""SMART""BOOST""SOLAR_ONLY""SOLAR_SMART""V2G_DISCHARGE""V2G_CHARGEBACK""LEGACY"
Example: "SMART"
dispatched_atstring or null(date-time)read-only

When this schedule was last sent to the device. Null if not yet dispatched.

Example: "2024-01-01T02:00:15Z"
created_atstring(date-time)read-only

When this schedule was created.

Example: "2024-01-01T01:55:00Z"
{
  "started_at": "2024-01-01T02:00:00Z",
  "interval_seconds": 1800,
  "current_milliamps": 7400,
  "schedule_type": "SMART",
  "dispatched_at": "2024-01-01T02:00:15Z",
  "created_at": "2024-01-01T01:55:00Z"
}

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