List Vehicle Charging History

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

{
  "results": [
    {
      "id": "<string>",
      "vehicleId": "<string>",
      "startedAt": "2023-11-07T05:31:56Z",
      "endedAt": "2023-11-07T05:31:56Z",
      "chargeDuration": 123,
      "latitude": 123,
      "longitude": 123,
      "kwhFromGrid": 123,
      "kwhInHvb": 123,
      "startStateOfCharge": 123,
      "endStateOfCharge": 123,
      "externalTemperature": 123,
      "kwMedian": 123
    }
  ],
  "nextPageToken": "<string>",
  "totalResults": 123
}

Vehicle Charging History

List Vehicle Charging History

Retrieve a list of charging history sessions for the provided vehicle.

Parameters:

vehicle_id: The unique identifier (ID) of the vehicle to retrieve charging history for.

Returns:

A paginated list of vehicle charging history sessions.

This endpoint allows you to retrieve a paginated list of charging history sessions for a specific vehicle identified by its unique vehicle_id. The list is ordered by the starting time of each charging session, with the most recent sessions appearing first.

Note:

The vehicle_id should correspond to a valid and existing vehicle identifier.

Find details on list filter syntax in our documentation here.

Possible Codes in Error Response (see Errors for error response schema and meaning of codes):

AUTHENTICATION_ERROR
PAGE_SIZE_TOO_LARGE
PAGINATED_QUERY_FILTER_CHANGED
REQUEST_VALIDATION_ERROR
RESOURCE_NOT_FOUND
SERVER_ERROR

GET

vehicles

{vehicle_id}

charging-history

List Vehicle Charging History

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

{
  "results": [
    {
      "id": "<string>",
      "vehicleId": "<string>",
      "startedAt": "2023-11-07T05:31:56Z",
      "endedAt": "2023-11-07T05:31:56Z",
      "chargeDuration": 123,
      "latitude": 123,
      "longitude": 123,
      "kwhFromGrid": 123,
      "kwhInHvb": 123,
      "startStateOfCharge": 123,
      "endStateOfCharge": 123,
      "externalTemperature": 123,
      "kwMedian": 123
    }
  ],
  "nextPageToken": "<string>",
  "totalResults": 123
}

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.

Query Parameters

maxPageSize

integer

Max size of the returned list.

pageToken

string | null

Page token used for pagination.

filter

string | null

Listing filter schema.

Response

200 - application/json

Successful Response

results

VehicleChargingSession · object[]

required

Returned data from the listing query.

Show child attributes

nextPageToken

string | null

required

Next page token used for pagination.

totalResults

integer

required

Total result count.

Get Vehicle Charging History Get Vehicle Range

⌘I

Documentation Index

Authorizations

Path Parameters

Query Parameters

Response