Get Vehicle Telemetry

curl --request GET \
  --url https://api.volteras.com/v1/vehicles/{vehicle_id}/telemetry \
  --header 'Authorization: Bearer <token>'

{
  "id": "<string>",
  "odometer": {
    "value": 123,
    "unit": "<string>",
    "timestamp": "2023-11-07T05:31:56Z"
  },
  "location": {
    "latitude": 123,
    "longitude": 123,
    "timestamp": "2023-11-07T05:31:56Z"
  },
  "elevation": {
    "value": 123,
    "unit": "<string>",
    "timestamp": "2023-11-07T05:31:56Z"
  },
  "stateOfCharge": {
    "value": 123,
    "unit": "<string>",
    "timestamp": "2023-11-07T05:31:56Z"
  },
  "chargingState": {
    "chargingState": "STARTING",
    "timestamp": "2023-11-07T05:31:56Z",
    "chargePortDoorOpen": true,
    "chargePortLatch": "ENGAGED"
  },
  "range": {
    "value": 123,
    "unit": "<string>",
    "timestamp": "2023-11-07T05:31:56Z"
  },
  "tirePressure": {
    "frontRightTire": 123,
    "frontLeftTire": 123,
    "rearRightTire": 123,
    "rearLeftTire": 123,
    "unit": "<string>",
    "timestamp": "2023-11-07T05:31:56Z"
  },
  "security": {
    "locked": true,
    "frontRightDoor": "OPEN",
    "frontLeftDoor": "OPEN",
    "rearRightDoor": "OPEN",
    "rearLeftDoor": "OPEN",
    "frontRightWindow": "OPEN",
    "frontLeftWindow": "OPEN",
    "rearLeftWindow": "OPEN",
    "rearRightWindow": "OPEN",
    "frontTrunk": "OPEN",
    "rearTrunk": "OPEN",
    "sunRoof": "OPEN",
    "timestamp": "2023-11-07T05:31:56Z"
  },
  "metadata": {
    "lastSeenAt": "2023-11-07T05:31:56Z",
    "consentId": "<string>",
    "accountId": "<string>"
  },
  "realRange": {
    "value": 123,
    "unit": "<string>",
    "timestamp": "2023-11-07T05:31:56Z"
  },
  "maxStateOfCharge": {
    "value": 123,
    "timestamp": "2023-11-07T05:31:56Z",
    "unit": "percent"
  },
  "chargeRemainingTime": {
    "value": 123,
    "timestamp": "2023-11-07T05:31:56Z",
    "unit": "minutes"
  },
  "chargePowerLevel": {
    "value": 123,
    "timestamp": "2023-11-07T05:31:56Z",
    "unit": "kw"
  },
  "chargeCurrentLimit": {
    "value": 123,
    "timestamp": "2023-11-07T05:31:56Z",
    "unit": "amps"
  },
  "energyRemaining": {
    "value": 123,
    "unit": "<string>",
    "timestamp": "2023-11-07T05:31:56Z"
  },
  "minStateOfCharge": {
    "value": 123,
    "timestamp": "2023-11-07T05:31:56Z",
    "unit": "percent"
  }
}

Vehicle Telemetry

Get Vehicle Telemetry

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.

GET

vehicles

{vehicle_id}

telemetry

Get Vehicle Telemetry

curl --request GET \
  --url https://api.volteras.com/v1/vehicles/{vehicle_id}/telemetry \
  --header 'Authorization: Bearer <token>'

{
  "id": "<string>",
  "odometer": {
    "value": 123,
    "unit": "<string>",
    "timestamp": "2023-11-07T05:31:56Z"
  },
  "location": {
    "latitude": 123,
    "longitude": 123,
    "timestamp": "2023-11-07T05:31:56Z"
  },
  "elevation": {
    "value": 123,
    "unit": "<string>",
    "timestamp": "2023-11-07T05:31:56Z"
  },
  "stateOfCharge": {
    "value": 123,
    "unit": "<string>",
    "timestamp": "2023-11-07T05:31:56Z"
  },
  "chargingState": {
    "chargingState": "STARTING",
    "timestamp": "2023-11-07T05:31:56Z",
    "chargePortDoorOpen": true,
    "chargePortLatch": "ENGAGED"
  },
  "range": {
    "value": 123,
    "unit": "<string>",
    "timestamp": "2023-11-07T05:31:56Z"
  },
  "tirePressure": {
    "frontRightTire": 123,
    "frontLeftTire": 123,
    "rearRightTire": 123,
    "rearLeftTire": 123,
    "unit": "<string>",
    "timestamp": "2023-11-07T05:31:56Z"
  },
  "security": {
    "locked": true,
    "frontRightDoor": "OPEN",
    "frontLeftDoor": "OPEN",
    "rearRightDoor": "OPEN",
    "rearLeftDoor": "OPEN",
    "frontRightWindow": "OPEN",
    "frontLeftWindow": "OPEN",
    "rearLeftWindow": "OPEN",
    "rearRightWindow": "OPEN",
    "frontTrunk": "OPEN",
    "rearTrunk": "OPEN",
    "sunRoof": "OPEN",
    "timestamp": "2023-11-07T05:31:56Z"
  },
  "metadata": {
    "lastSeenAt": "2023-11-07T05:31:56Z",
    "consentId": "<string>",
    "accountId": "<string>"
  },
  "realRange": {
    "value": 123,
    "unit": "<string>",
    "timestamp": "2023-11-07T05:31:56Z"
  },
  "maxStateOfCharge": {
    "value": 123,
    "timestamp": "2023-11-07T05:31:56Z",
    "unit": "percent"
  },
  "chargeRemainingTime": {
    "value": 123,
    "timestamp": "2023-11-07T05:31:56Z",
    "unit": "minutes"
  },
  "chargePowerLevel": {
    "value": 123,
    "timestamp": "2023-11-07T05:31:56Z",
    "unit": "kw"
  },
  "chargeCurrentLimit": {
    "value": 123,
    "timestamp": "2023-11-07T05:31:56Z",
    "unit": "amps"
  },
  "energyRemaining": {
    "value": 123,
    "unit": "<string>",
    "timestamp": "2023-11-07T05:31:56Z"
  },
  "minStateOfCharge": {
    "value": 123,
    "timestamp": "2023-11-07T05:31:56Z",
    "unit": "percent"
  }
}

Authorizations

Authorization

string

header

required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

vehicle_id

string

required

Unique internal identifier for the vehicle.

Response

200 - application/json

Successful Response

string

required

odometer

VehicleOdometer · object

required

Show child attributes

odometer.value

number | null

required

Odometer reading.

odometer.unit

string | null

required

Unit of length. Defaults to SI unit 'km'.

odometer.timestamp

string<date-time> | null

required

Timestamp in ISO 8601 format: YYYY-MM-DDThh:mm:ssTZD.

location

VehicleTelemetryLocation · object

required

Show child attributes

location.latitude

number | null

required

Latitude ranges between -90 and 90 degrees, inclusive. Coordinate reference system is WGS84.

location.longitude

number | null

required

Longitude ranges between -180 and 180 degrees, inclusive. Coordinate reference system is WGS84.

location.timestamp

string<date-time> | null

required

Location timestamp in ISO 8601 format: YYYY-MM-DDThh:mm:ssTZD.

elevation

VehicleElevation · object

required

Show child attributes

elevation.value

number | null

required

Elevation reading.

elevation.unit

string | null

required

Unit of length. Defaults to SI unit 'm'.

elevation.timestamp

string<date-time> | null

required

Timestamp in ISO 8601 format: YYYY-MM-DDThh:mm:ssTZD.

stateOfCharge

VehicleStateOfCharge · object

required

Show child attributes

stateOfCharge.value

number | null

required

State of charge reading.

stateOfCharge.unit

string | null

required

No unit. Percentage indicating the state of charge of the battery pack.

stateOfCharge.timestamp

string<date-time> | null

required

Timestamp in ISO 8601 format: YYYY-MM-DDThh:mm:ssTZD.

chargingState

VehicleChargingState · object

required

Show child attributes

chargingState.chargingState

enum<string> | null

required

Charging state reading.

Available options:

STARTING,

STOPPED,

CHARGING,

COMPLETE,

DISCONNECTED,

NO_POWER,

CONNECTED,

INVALID

chargingState.timestamp

string<date-time> | null

required

Timestamp in ISO 8601 format: YYYY-MM-DDThh:mm:ssTZD.

chargingState.chargePortDoorOpen

boolean | null

required

Whether the charge port door is open.

chargingState.chargePortLatch

enum<string> | null

required

Whether the charge port latch is closed.

Available options:

ENGAGED,

DISENGAGED,

BLOCKING,

INVALID

range

VehicleRange · object

required

Show child attributes

range.value

number | null

required

Range reading.

range.unit

string | null

required

Unit of length. Defaults to SI unit 'km'.

range.timestamp

string<date-time> | null

required

Timestamp in ISO 8601 format: YYYY-MM-DDThh:mm:ssTZD.

tirePressure

VehicleTirePressure · object

required

Show child attributes

tirePressure.frontRightTire

number | null

required

Front right tire pressure reading.

tirePressure.frontLeftTire

number | null

required

Front left tire pressure reading.

tirePressure.rearRightTire

number | null

required

Rear right tire pressure reading.

tirePressure.rearLeftTire

number | null

required

Rear left tire pressure reading.

tirePressure.unit

string | null

required

Unit of pressure. Defaults to SI unit 'kPa'.

tirePressure.timestamp

string<date-time> | null

required

Timestamp in ISO 8601 format: YYYY-MM-DDThh:mm:ssTZD.

security

VehicleSecurity · object

required

Show child attributes

security.locked

boolean | null

required

Vehicle lock status.

security.frontRightDoor

enum<string> | null

required

Front right door lock status.

Available options:

OPEN,

CLOSED

security.frontLeftDoor

enum<string> | null

required

Front left door lock status.

Available options:

OPEN,

CLOSED

security.rearRightDoor

enum<string> | null

required

Rear right door lock status.

Available options:

OPEN,

CLOSED

security.rearLeftDoor

enum<string> | null

required

Rear left door lock status.

Available options:

OPEN,

CLOSED

security.frontRightWindow

enum<string> | null

required

Front right window lock status.

Available options:

OPEN,

CLOSED

security.frontLeftWindow

enum<string> | null

required

Front left window lock status.

Available options:

OPEN,

CLOSED

security.rearLeftWindow

enum<string> | null

required

Rear left window lock status.

Available options:

OPEN,

CLOSED

security.rearRightWindow

enum<string> | null

required

Rear right window lock status.

Available options:

OPEN,

CLOSED

security.frontTrunk

enum<string> | null

required

Front trunk lock status.

Available options:

OPEN,

CLOSED

security.rearTrunk

enum<string> | null

required

Rear trunk lock status.

Available options:

OPEN,

CLOSED

security.sunRoof

enum<string> | null

required

Sun roof lock status.

Available options:

OPEN,

CLOSED

security.timestamp

string<date-time> | null

required

Timestamp in ISO 8601 format: YYYY-MM-DDThh:mm:ssTZD.

metadata

VehicleMetaData · object

required

Show child attributes

metadata.lastSeenAt

string<date-time> | null

required

The last recorded interaction with the vehicle endpoints. This is a timestamp in ISO 8601 format: YYYY-MM-DDThh:mm:ssTZD.

Unique identifier for the consent that was used to retrieve the vehicle data.

metadata.accountId

string | null

required

Unique identifier for the account that was used to retrieve the vehicle data.

realRange

VehicleRealRange · object

required

Show child attributes

realRange.value

number | null

Range reading.

realRange.unit

string | null

Unit of length.

realRange.timestamp

string<date-time> | null

Timestamp in ISO 8601 format: YYYY-MM-DDThh:mm:ssTZD.

maxStateOfCharge

VehicleChargeMaxStateOfCharge · object

required

Show child attributes

maxStateOfCharge.value

number | null

required

Target state of charge (as a percentage) set in the vehicle.

maxStateOfCharge.timestamp

string<date-time> | null

required

Timestamp in ISO 8601 format: YYYY-MM-DDThh:mm:ssTZD.

maxStateOfCharge.unit

any

default:percent

chargeRemainingTime

VehicleChargeRemainingTime · object

required

Show child attributes

chargeRemainingTime.value

integer | null

required

Remaining time to full charge in minutes.

chargeRemainingTime.timestamp

string<date-time> | null

required

Timestamp in ISO 8601 format: YYYY-MM-DDThh:mm:ssTZD.

chargeRemainingTime.unit

any

default:minutes

chargePowerLevel

VehicleChargePowerLevel · object

required

Show child attributes

chargePowerLevel.value

number | null

required

Power level of the charger in kW.

chargePowerLevel.timestamp

string<date-time> | null

required

Timestamp in ISO 8601 format: YYYY-MM-DDThh:mm:ssTZD.

chargePowerLevel.unit

any

default:kw

chargeCurrentLimit

VehicleChargeCurrentLimit · object

required

Show child attributes

chargeCurrentLimit.value

number | null

required

Current limit of the charger in amps.

chargeCurrentLimit.timestamp

string<date-time> | null

required

Timestamp in ISO 8601 format: YYYY-MM-DDThh:mm:ssTZD.

chargeCurrentLimit.unit

any

default:amps

energyRemaining

VehicleEnergyRemainingKwh · object

required

Show child attributes

energyRemaining.value

number | null

required

Energy remaining reading.

energyRemaining.unit

string | null

required

No unit. Energy remaining of the battery pack in kWh.

energyRemaining.timestamp

string<date-time> | null

required

Timestamp in ISO 8601 format: YYYY-MM-DDThh:mm:ssTZD.

minStateOfCharge

VehicleChargeMinStateOfCharge · object

required

Show child attributes

minStateOfCharge.value

number | null

required

Minimum state of charge set in the vehicle. If this is present, the vehicle will always charge immediately when plugged in until the minimum state of charge is reached.

minStateOfCharge.timestamp

string<date-time> | null

required

Timestamp in ISO 8601 format: YYYY-MM-DDThh:mm:ssTZD.

minStateOfCharge.unit

any

default:percent

Upload Vehicle Get Vehicle Charging History

⌘I

Authentication

Accounts

Vehicles

Vehicle Telemetry

Vehicle Charging History

Vehicle Range

Vehicle State of Health

Vehicle Command Executions

Vehicle Alerts

Errors

Vehicle Connection

Vehicle Services

Vehicle Tires

Vehicle Manufacturer Alerts

Vehicle Eligibility

Rate Limit

Vehicle Charging Schedule

Vehicle Listening

Tags

Get Vehicle Telemetry

Authorizations

Path Parameters

Response