---
title: "Get Vehicle State Of Health"
method: GET
path: "/v1/vehicles/{vehicle_id}/state-of-health"
tags: ["Vehicle State of Health"]
---

# Get Vehicle State Of Health

`GET /v1/vehicles/{vehicle_id}/state-of-health`

Retrieves state of health related information for the specified vehicle.
- Nominal battery pack capacity refers to the total amount of energy in kWh that the battery pack of the vehicle can
store, as per its specifications.
- Real battery pack capacity refers to the total amount of energy in kWh that the battery pack of the vehicle can
currently store, it's reflective of the actual state of the battery rather than a specification.
- State of health is defined as real battery pack capacity over nominal battery pack capacity, as percentage.

**Parameters:**
- `vehicle_id`: A unique identifier for the vehicle, which must correspond to a vehicle registered in our system.

**Returns:**
- A vehicle state of health instance encapsulating detailed battery pack information for the vehicle. The data
includes both the nominal battery pack capacity and the real (observed) maximum battery pack capacity based on data
retrieved directly from the vehicle and the specifications published by the OEMs.

**Raises:**
- `APIException`: Raised when the system cannot locate the vehicle's state of health details, due to an invalid
'vehicle_id' or absence of battery data. This results in a 404 Not Found status code.

**Note:**
- Endpoint is first available after observing a charging session that added at least 15% of state of charge and was
started above 20% state of charge.
- We recommend charging the vehicle overnight should the endpoint not be available immediately.
- This endpoint is reliant on the availability of the trim of the vehicle and supports certain OEMs.
Please see [state of health](/overview/state-of-health#supported-oems) for a list of supported OEMs


Possible Codes in Error Response (see [Errors](https://docs.volteras.com/api-reference/errors) for error response schema and meaning of codes):

- AUTHENTICATION_ERROR
- REQUEST_VALIDATION_ERROR
- RESOURCE_NOT_FOUND
- SERVER_ERROR

## Path parameters

- `vehicle_id` string, required — Unique internal identifier for the vehicle.

## Response `200`

Successful Response

- VehicleStateOfHealth
  - `vehicleId` string, required
  - `calculationDate` string, date, required
  - `stateOfHealth` string, nullable, required
  - `batteryCapacity` BatteryCapacity, required
    - `nominal` string, nullable, required
    - `real` string, nullable, required

---

[API](https://skmtc.net/volteras/apis/volteras-connect.md) · [All operations](https://skmtc.net/volteras/apis/volteras-connect/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/volteras/volteras-connect/revisions/bcb08bba814d/schema)
