GET/api/partner/v1/cars/{carId}/gps/position

Car position

Where one car is right now.

The newest fix of a single car; {carId} may be our id or your own. A car with no device, or one whose device has never reported inside the retention window, answers 404 — never a success with an empty body.

Authorization

X-Api-Key header

Send your partner key on every request. The key is bound to exactly one owner account.

Path parameters

carIdstringpathrequired

Response

200 · application/json

successbooleanrequired

dataobject

A vehicle's newest fix.

carIdstring

externalCarIdstringnullable

plateNumberstringnullable

plateStatestringnullable

trackerIdstring <uuid>

imeistringnullable

sourcestringnullable

sourceNamestringnullable

tsUtcstring <date-time>

When the fix was taken (UTC).

latnumber

lonnumber

speedKmhnumber

speedMphnumber

headingDegintegernullable

Course over ground, 0-359°, 0 = north. Null when the feed reports no heading.

ignitionbooleannullable

Null when the feed carries no ignition signal.

satellitesintegernullable

ageSecondsinteger

How old the fix was when you asked.

onlineboolean

The fix is under 15 minutes old.

errorstringnullable

Status codes

200The car's newest fix.

401Missing, unknown or revoked API key.

404The resource does not exist under this owner.