Retrieve a home battery make

Request

Retrieve details for a single, specific home battery make.

Security

oauth2(Required scopes: home_battery:read)

Path

home_battery_make_idstringrequired

The ID of the specific home battery make to retrieve.

EvEnergy-Versionnumber

Specify the version of this endpoint to use.

Value:2

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/home_battery_makes/{home_battery_make_id}' \
  -H 'Accept-Language: string' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'EvEnergy-Version: 2'

Responses

Return a single home battery 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

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

Unique identifier for the given Home Battery Make.

Example:"bmakK7XDPL63NNBDQ5DPB6K3TP87JA"

urlstring, (uri)read-only

Example:"https://api.ev.energy/v2/home_battery_makes/bmakK7XDPL63NNBDQ5DPB6K3TP87JA"

namestringread-only

Example:"Rivendell"

iconstring or null, (uri)read-only

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

Example:"https://cdn.example.com/rivendell.png"

onboarding_urlstring or nullread-only

A pre-constructed link to initiate onboarding for a home battery of this make. If it is null, then it cannot be onboarded with make alone. You should filter the list of home battery 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/home_battery_onboarding?make_id=bmakK7XDPL63NNBDQ5DPB6K3TP87JA&user_id=user01HN2NJ9NMRZBXT1H6FT9N7735&client_id=your_client_

modelsstring, (uri)read-only

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

Example:"https://api.ev.energy/v2/home_battery_models?make_id=bmakK7XDPL63NNBDQ5DPB6K3TP87JA"

Response

{
  "id": "bmakK7XDPL63NNBDQ5DPB6K3TP87JA",
  "url": "https://api.ev.energy/v2/home_battery_makes/bmakK7XDPL63NNBDQ5DPB6K3TP87JA",
  "name": "Rivendell",
  "icon": null,
  "onboarding_url": "https://api.ev.energy/v2/home_battery_onboarding?make_id=bmakK7XDPL63NNBDQ5DPB6K3TP87JA&client_id=clntK7XDPL63NNBDQ5DPB6K3TP87JA",
  "models": "https://api.ev.energy/v2/home_battery_models?make_id=bmakK7XDPL63NNBDQ5DPB6K3TP87JA"
}