Skip to content
/
Retrieve a subscription o...

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

List subscriptions

Request

List all the valid subscriptions that the authorization token has access to.

Security
oauth2(Required scopes:
subscription: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"user""offering"
Headers
EvEnergy-Versionnumber

Specify the version of this endpoint to use.

Value2
Accept-Languagestring

Indicates the natural language and locale that the client prefers.

curl -i -X GET \
  'https://developers.ev.energy/_mock/ev.energy-api-v2/subscriptions?page_before=xmpl01HNFZM7Q8FXASZXYZ6XM3TQRR&page_after=xmpl01HNFZM7Q8FXASZXYZ6XM3TQRR&page_size=10&expand=user' \
  -H 'Accept-Language: string' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'EvEnergy-Version: 2'

Responses

Returns a list of subscriptions.

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

Unique identifier for the given Subscription.

Example: "subsB1USP6YGD1VPIDJSHTZARUX11M"
urlstring(uri)read-onlyrequired
Example: "https://api.ev.energy/subscriptions/subsB1USP6YGD1VPIDJSHTZARUX11M"
offering(string or null) or SubscriptionOffering (object)

Reference of the offering.

One of:

Reference of the offering.

string or null(uri)
userstring or User (object)
One of:
string(uri)
]
Response
application/json
[
  {
    "id": "subsB1USP6YGD1VPIDJSHTZARUX11M",
    "url": "https://api.ev.energy/subscriptions/subsB1USP6YGD1VPIDJSHTZARUX11M",
    "offering": "https://api.ev.energy/v2/subscription_offerings/suboB1USP6YGD1VPIDJSHTZARUX11M",
    "user": "https://api.ev.energy/v2/user/user01HN2NJ9NMRZBXT1H6FT9N7735"
  }
]

Retrieve a subscription offering

Request

Retrieve a single, specific subscription offering's details.

Security
oauth2(Required scopes:
subscription:read
)
Path
offering_idstringrequired

The ID of the specific subscription offering to retrieve

Query
expandArray of strings

Specify a url field to expand into a nested resource.

Items Enum"user""offering"
Headers
EvEnergy-Versionnumber

Specify the version of this endpoint to use.

Value2
Accept-Languagestring

Indicates the natural language and locale that the client prefers.

curl -i -X GET \
  'https://developers.ev.energy/_mock/ev.energy-api-v2/subscription_offerings/{offering_id}?expand=user' \
  -H 'Accept-Language: string' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'EvEnergy-Version: 2'

Responses

Returns a single subscription offering.

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
idstringsubo[A-Z\d]{26}read-only

Unique identifier for the given Subscription Offering.

Example: "suboB1USP6YGD1VPIDJSHTZARUX11M"
urlstring(uri)read-only
Example: "https://api.ev.energy/v2/subscription_offerings/suboB1USP6YGD1VPIDJSHTZARUX11M"
namestring
Example: "ev.energy Solar Lifetime"
Response
application/json
{
  "id": "suboB1USP6YGD1VPIDJSHTZARUX11M",
  "url": "https://api.ev.energy/v2/subscription_offerings/suboB1USP6YGD1VPIDJSHTZARUX11M",
  "name": "ev.energy Solar Lifetime"
}

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