Skip to content
/
Retrieve a vehicle make

Retrieve a vehicle make

Request

Retrieve details for a single, specific vehicle make.

Anonymous callers are rate limited to 50 requests per hour per IP.

Path
vehicle_make_idstringvmak[A-Z\d]{26}required

The ID of the specific vehicle make to retrieve.

Example:vmak01HRFHBCM7VBSWRPVYFBQMH2BR
Headers
EvEnergy-Versionnumber

Specify the version of this endpoint to use.

Value:2
curl -i -X GET \
  https://developers.ev.energy/_mock/ev.energy-api-v2/vehicle_makes/vmak01HRFHBCM7VBSWRPVYFBQMH2BR \
  -H 'EvEnergy-Version: 2'

Responses

Return a single vehicle make.

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

Unique identifier for the given Vehicle Make.

Example:"vmak01HRFHBCM7VBSWRPVYFBQMH2BR"
urlstring, (uri)read-onlyrequired
Example:"https://api.ev.energy/v2/vehicle_makes/vmak01HRFHBCM7VBSWRPVYFBQMH2BR"
namestringread-onlyrequired
Example:"Volvo"
iconstring or null, (uri)read-onlyrequired

A url for an image of the make's logo.

Example:"https://cdn.example.com/volvo.png"
onboarding_urlstring or nullread-onlyrequired

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

Your client_id and the user's user_id are automatically included based on your authentication token. 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/?make_id=vmak01HN2P75GBNFRJPCZJXEFVXH5E&user_id=user01HN2NJ9NMRZBXT1H6FT9N7735&client_id=your_client_id"
modelsstring, (uri)read-onlyrequired

A pre-constructed link to a list of vehicle models filtered for this make.

Example:"https://api.ev.energy/vehicle_models?make_id=vmak01HN2P75GBNFRJPCZJXEFVXH5E"
subscription_namestring or nullread-only

Full OEM telematics subscription name required for vehicle connectivity (e.g. 'Volkswagen We Connect ID'). Null if no subscription is required.

Example:"Volkswagen We Connect ID"
subscription_packagestring or nullread-only

Specific OEM subscription package required (e.g. 'We Connect ID'). Null if no subscription is required.

Example:"We Connect ID"
Response
{
  "id": "vmak01HRFHBCM7VBSWRPVYFBQMH2BR",
  "url": "https://api.ev.energy/v2/vehicle_makes/vmak01HRFHBCM7VBSWRPVYFBQMH2BR",
  "name": "Volvo",
  "icon": "https://cdn.example.com/volvo.png",
  "onboarding_url": "https://api.ev.energy/v2/vehicle_onboarding/?make_id=vmak01HN2P75GBNFRJPCZJXEFVXH5E&user_id=user01HN2NJ9NMRZBXT1H6FT9N7735&client_id=your_client_id",
  "models": "https://api.ev.energy/vehicle_models?make_id=vmak01HN2P75GBNFRJPCZJXEFVXH5E",
  "subscription_name": "Volkswagen We Connect ID",
  "subscription_package": "We Connect ID"
}