Skip to main content
GET
Get odometer (V2)

Overview

Returns the vehicle’s odometer source and the odometer reading read live from Flespi telemetry. For the platform’s own odometer, use odometer from Last position; Flespi’s value comes from a different pipeline and may differ.
Rate limit: 10 req/s · 30/min · 6,000/hr · 144,000/day

Endpoint

GET /v2/api/vehicles/{id}/odometer

Path parameters

integer
required
Public vehicle ID (deviceId).

Response

200 OK — returns the odometer source and Flespi’s live mileage reading.

Error responses

Authorizations

Authorization
string
header
required

JWT Bearer token obtained from POST /v2/api/authentication/token/api-key.

Lifetime: ~24 hours (86,399 seconds). Cache the token and reuse it. Re-authenticate 5 minutes before expiry.

Scoping: API key tokens are scoped by the key's company and its action set; see Token scoping.

No refresh endpoint — re-authenticate with your API key when the token expires.

Path Parameters

id
integer
required

Response

200 OK — Odometer source and Flespi's live mileage reading.

odometerSource
enum<string>

CAN when the latest odometer reading came from the CAN bus, otherwise GPS (including when the source is unknown). Always present.

Available options:
CAN,
GPS
odometerValue
number | null

Mileage (km) read live from Flespi: can.vehicle.mileage when odometerSource is CAN, otherwise Flespi's vehicle.mileage. Always null for vehicles not on the Flespi data provider, and also null when Flespi has no value or the call fails.