--- title: "Get Vehicle Telemetry" method: GET path: "/v1/vehicles/{vehicle_id}/telemetry" tags: ["Vehicle Telemetry"] --- # Get Vehicle Telemetry `GET /v1/vehicles/{vehicle_id}/telemetry` ## Request - Base URL: `https://api.volteras.com` - URL: `https://api.volteras.com/v1/vehicles/{vehicle_id}/telemetry` - Auth: OAuth 2 - Client credentials - Token URL: `/v1/oauth2/token` scopes: `vehicle:telemetry` - TypeScript: (a function with typed inputs; its response is checked against the schema) Retrieve telemetry data for the specified vehicle. The telemetry data provides essential information about the vehicle's status and performance. **Parameters:** - `vehicle_id`: The unique identifier (ID) of the vehicle to retrieve telemetry data for. **Returns:** - Telemetry data for the vehicle. Telemetry Information returned might include: - Odometer: The total distance traveled by the vehicle, recorded in kilometers. The timestamp indicates when the odometer reading was taken. - Location: The current latitude and longitude coordinates of the vehicle's position on Earth's surface. The timestamp indicates when the location reading was captured. - Elevation: The vehicle's altitude above sea level, measured in meters. The timestamp shows when the elevation reading was recorded. - State of Charge: The battery's state of charge, expressed as a percentage. The timestamp indicates when the charge level was last updated. - Charging State: Indicates whether the vehicle is actively charging or not. The timestamp reveals the time of the charging state observation. - Range: The estimated driving range of the vehicle on its current battery charge, provided in kilometers. The timestamp shows when the range reading was taken. **Note:** - The `vehicle_id` should correspond to a valid and existing vehicle identifier. 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 - VehicleTelemetry - `id` string, required - `odometer` VehicleOdometer, required - `value` number, nullable, required: Odometer reading. - `unit` string, nullable, required: Unit of length. Defaults to SI unit 'km'. - `timestamp` string, date-time, nullable, required: Timestamp in ISO 8601 format: YYYY-MM-DDThh:mm:ssTZD. - `location` VehicleTelemetryLocation, required - `latitude` number, nullable, required: Latitude ranges between -90 and 90 degrees, inclusive. Coordinate reference system is WGS84. - `longitude` number, nullable, required: Longitude ranges between -180 and 180 degrees, inclusive. Coordinate reference system is WGS84. - `timestamp` string, date-time, nullable, required: Location timestamp in ISO 8601 format: YYYY-MM-DDThh:mm:ssTZD. - `elevation` VehicleElevation, required - `value` number, nullable, required: Elevation reading. - `unit` string, nullable, required: Unit of length. Defaults to SI unit 'm'. - `timestamp` string, date-time, nullable, required: Timestamp in ISO 8601 format: YYYY-MM-DDThh:mm:ssTZD. - `speed` VehicleSpeed, required - `value` number, nullable, required: Speed reading. - `unit` string, nullable, required: Unit of speed. Defaults to SI unit 'm/s'. - `timestamp` string, date-time, nullable, required: Timestamp in ISO 8601 format: YYYY-MM-DDThh:mm:ssTZD. - `heading` VehicleHeading, required - `value` number, nullable, required: Heading reading in degrees. - `unit` string, nullable, required: Unit of angle. Defaults to 'degree'. - `timestamp` string, date-time, nullable, required: Timestamp in ISO 8601 format: YYYY-MM-DDThh:mm:ssTZD. - `stateOfCharge` VehicleStateOfCharge, required - `value` number, nullable, required: State of charge reading. - `unit` string, nullable, required: No unit. Percentage indicating the state of charge of the battery pack. - `timestamp` string, date-time, nullable, required: Timestamp in ISO 8601 format: YYYY-MM-DDThh:mm:ssTZD. - `chargingState` VehicleChargingState, required - `chargingState` 'STARTING' | 'STOPPED' | 'CHARGING' | 'COMPLETE' | 'DISCONNECTED' | 'NO_POWER' | 'CONNECTED' | 'INVALID', required: Enum for charging status. - `timestamp` string, date-time, nullable, required: Timestamp in ISO 8601 format: YYYY-MM-DDThh:mm:ssTZD. - `chargePortDoorOpen` boolean, nullable, required: Whether the charge port door is open. - `chargePortLatch` 'ENGAGED' | 'DISENGAGED' | 'BLOCKING' | 'INVALID', required: Enum for charge port latch status. - `range` ConnectModelsSchemasVehicleVehicleTelemetryVehicleRange, required - `value` number, nullable, required: Range reading. - `unit` string, nullable, required: Unit of length. Defaults to SI unit 'km'. - `timestamp` string, date-time, nullable, required: Timestamp in ISO 8601 format: YYYY-MM-DDThh:mm:ssTZD. - `tirePressure` VehicleTirePressure, required - `frontRightTire` number, nullable, required: Front right tire pressure reading. - `frontLeftTire` number, nullable, required: Front left tire pressure reading. - `rearRightTire` number, nullable, required: Rear right tire pressure reading. - `rearLeftTire` number, nullable, required: Rear left tire pressure reading. - `unit` string, nullable, required: Unit of pressure. Defaults to SI unit 'kPa'. - `timestamp` string, date-time, nullable, required: Timestamp in ISO 8601 format: YYYY-MM-DDThh:mm:ssTZD. - `security` VehicleSecurity, required - `locked` boolean, nullable, required: Vehicle lock status. - `frontRightDoor` 'OPEN' | 'CLOSED', required: Enum for lock status. - `frontLeftDoor` 'OPEN' | 'CLOSED', required: Enum for lock status. - `rearRightDoor` 'OPEN' | 'CLOSED', required: Enum for lock status. - `rearLeftDoor` 'OPEN' | 'CLOSED', required: Enum for lock status. - `frontRightWindow` 'OPEN' | 'CLOSED', required: Enum for lock status. - `frontLeftWindow` 'OPEN' | 'CLOSED', required: Enum for lock status. - `rearLeftWindow` 'OPEN' | 'CLOSED', required: Enum for lock status. - `rearRightWindow` 'OPEN' | 'CLOSED', required: Enum for lock status. - `frontTrunk` 'OPEN' | 'CLOSED', required: Enum for lock status. - `rearTrunk` 'OPEN' | 'CLOSED', required: Enum for lock status. - `sunRoof` 'OPEN' | 'CLOSED', required: Enum for lock status. - `timestamp` string, date-time, nullable, required: Timestamp in ISO 8601 format: YYYY-MM-DDThh:mm:ssTZD. - `metadata` VehicleMetaData, required - `lastSeenAt` string, date-time, nullable, required: The last recorded interaction with the vehicle endpoints. This is a timestamp in ISO 8601 format: YYYY-MM-DDThh:mm:ssTZD. - `consentId` string, nullable, required: Unique identifier for the consent that was used to retrieve the vehicle data. - `accountId` string, nullable, required: Unique identifier for the account that was used to retrieve the vehicle data. - `registrationDate` string, date, nullable: Vehicle registration date (ISO 8601, day granularity). Captured at vehicle upload; used as the date-axis baseline for service-interval alerts. - `realRange` VehicleRealRange, required - `value` number, nullable: Range reading. - `unit` string, nullable: Unit of length. - `timestamp` string, date-time, nullable: Timestamp in ISO 8601 format: YYYY-MM-DDThh:mm:ssTZD. - `maxStateOfCharge` VehicleChargeMaxStateOfCharge, required - `value` number, nullable, required: Target state of charge (as a percentage) set in the vehicle. - `unit` 'percent' - `timestamp` string, date-time, nullable, required: Timestamp in ISO 8601 format: YYYY-MM-DDThh:mm:ssTZD. - `chargeRemainingTime` VehicleChargeRemainingTime, required - `value` integer, nullable, required: Remaining time to full charge in minutes. - `unit` 'minutes' - `timestamp` string, date-time, nullable, required: Timestamp in ISO 8601 format: YYYY-MM-DDThh:mm:ssTZD. - `chargePowerLevel` VehicleChargePowerLevel, required - `value` number, nullable, required: Power level of the charger in kW. - `unit` 'kw' - `timestamp` string, date-time, nullable, required: Timestamp in ISO 8601 format: YYYY-MM-DDThh:mm:ssTZD. - `chargeCurrentLimit` VehicleChargeCurrentLimit, required - `value` number, nullable, required: Current limit of the charger in amps. - `unit` 'amps' - `timestamp` string, date-time, nullable, required: Timestamp in ISO 8601 format: YYYY-MM-DDThh:mm:ssTZD. - `energyRemaining` VehicleEnergyRemainingKwh, required - `value` number, nullable, required: Energy remaining reading. - `unit` string, nullable, required: No unit. Energy remaining of the battery pack in kWh. - `timestamp` string, date-time, nullable, required: Timestamp in ISO 8601 format: YYYY-MM-DDThh:mm:ssTZD. - `minStateOfCharge` VehicleChargeMinStateOfCharge, required - `value` number, nullable, required: Minimum state of charge set in the vehicle. If this is above 0, the vehicle will always charge immediately when plugged in until the minimum state of charge is reached. - `unit` 'percent' - `timestamp` string, date-time, nullable, required: Timestamp in ISO 8601 format: YYYY-MM-DDThh:mm:ssTZD. --- [API](https://skmtc.dev/volteras/apis/volteras-connect.md) - [All operations](https://skmtc.dev/volteras/apis/volteras-connect/llms.txt) - [OpenAPI document](https://skmtc.dev/volteras/apis/volteras-connect/revisions/efc902486155?raw)