Skip to main content
GET
Get odometer (V2)

Overview

Returns the current odometer value and whether it is sourced from the vehicle’s CAN bus or GPS/GNSS.
Rate limit: 10 req/s · 120/min · 6,000/hr · 144,000/day

Endpoint

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

Path parameters

integer
required
Vehicle ID.

Response

200 OK — returns the odometer source and current 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 to the company the key belongs to and may restrict access to a vehicle allowlist and/or action set (see token claims).

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

Path Parameters

id
integer
required

Response

200 OK — Current odometer reading and source.

odometerSource
enum<string>

Active odometer source. CAN means the reading comes from the vehicle CAN bus; GPS means it is GPS/GNSS-derived.

Available options:
CAN,
GPS
odometerValue
number | null

Current odometer reading in kilometres from the active source. null if no telemetry is available yet.