Skip to content

List vehicle compatibility for a program

Request

List vehicle compatibility records for a specific program.

Returns all active vehicle models that are supported by the given program.

Security
oauth2(Required scopes: vehicle:read)
Path
program_idstringrequired

The ID of the specific Program to retrieve.

Query
expandArray of strings

Specify a url field to expand into a nested resource.

Items Value:"model"
Headers
EvEnergy-Versionnumber

Specify the version of this endpoint to use.

Value:2
EvEnergy-Userstringuser[A-Z\d]{26}

If the client is authenticated using Client Credentials, setting EvEnergy-User to a valid user ID allows requests to be made as if you were directly authenticated as that user.

Example:user01HN2NJ9NMRZBXT1H6FT9N7735
curl -i -X GET \
  'https://developers.ev.energy/_mock/ev.energy-api-v2/programs/{program_id}/vehicle_compatibility?expand=model' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'EvEnergy-User: user01HN2NJ9NMRZBXT1H6FT9N7735' \
  -H 'EvEnergy-Version: 2'

Responses

Return a list of vehicle compatibility records for the program.

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.

Value:2
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
Array [
can_control_chargebooleanread-only

Whether ev.energy can control charging for this vehicle model.

Example:true
modelstring or VehicleModel (object)read-only
One of:

Link to the vehicle model by default. Expanded to full object when ?expand=model is used.

string (uri)read-only
typestring or nullread-only

The vehicle type: BEV (Battery Electric Vehicle) or PHEV (Plug-in Hybrid Electric Vehicle).

Enum:"BEV""PHEV"null
Example:"BEV"
supported_countriesArray of stringsread-only

List of ISO 3166-1 alpha-2 country codes this vehicle is compatible in.

Example:
[
  "US",
  "CA"
]
start_yearintegerread-only

The first model year this compatibility applies to.

Example:2020
end_yearinteger or nullread-only

The last model year this compatibility applies to. Null if still in production.

Example:2026
]
Response
[
  {
    "can_control_charge": true,
    "model": "https://api.ev.energy/v2/vehicle_models/vmod01HSBR8Z36GD7A46K7M4R12VG0",
    "type": "BEV",
    "supported_countries": [ … ],
    "start_year": 2020,
    "end_year": 2026
  }
]