Vehicles API
The Vehicles API is the core of Livepin integrations. Use it to onboard vehicles, read live and historical position data, run commands, and fetch telemetry for your own UI and workflows.
Vehicle model
- Name
id- Type
- integer
- Description
Internal vehicle identifier.
- Name
imei- Type
- string
- Description
Tracker IMEI for hardware identity.
- Name
vehicle_no- Type
- string
- Description
Vehicle registration number.
- Name
vehicle_type- Type
- string
- Description
Vehicle type (TRUCK, CAR, etc.).
- Name
active- Type
- boolean
- Description
Whether the vehicle is currently active.
- Name
is_primary- Type
- boolean
- Description
Primary device indicator.
- Name
sim_no- Type
- string
- Description
SIM card number.
- Name
expiry- Type
- string
- Description
Subscription expiry date.
- Name
is_dashcam- Type
- boolean
- Description
Dashcam capability indicator.
- Name
dashcam_total_channels- Type
- integer
- Description
Number of dashcam channels.
- Name
gps_model- Type
- object
- Description
GPS tracker model details including manufacturer and specifications.
- Name
vehicle- Type
- object
- Description
Vehicle details including owner and secondary users.
- Name
vehicle_status- Type
- string
- Description
Current vehicle state (IDLE, RUNNING, STOPPED, NO_DATA, etc.).
- Name
location_data- Type
- object
- Description
Current location with coordinates, speed, altitude, and alarm data.
- Name
battery_percent- Type
- number
- Description
Device battery percentage.
- Name
report- Type
- object
- Description
Daily metrics including running distance, durations, and speed statistics.
- Name
address- Type
- string
- Description
Reverse geocoded address from latest location.
- Name
last_vehicle_status- Type
- object
- Description
Previous vehicle status with timestamp.
Core endpoints
- Name
POST /api/vehicles/add- Description
- Add a vehicle to the account.
- Name
PUT /api/vehicles/:id- Description
- Update vehicle metadata.
- Name
GET /api/vehicles- Description
- List all vehicles.
- Name
GET /api/v2/vehicles- Description
- List vehicles (v2 payload).
- Name
GET /api/vehicles/:vehicleId- Description
- Get one vehicle.
- Name
GET /api/v2/vehicles/:vehicleNo- Description
- Get vehicle by number (v2).
- Name
GET /api/vehicles/latest_locations- Description
- Latest locations for fleet.
- Name
GET /api/vehicles/:vehicleId/location- Description
- Latest location for one vehicle.
- Name
GET /api/vehicles/:vehicleId/location-history- Description
- Historical path for a date.
- Name
GET /api/vehicles/:vehicleId/report- Description
- Vehicle-level report snapshot.
List vehicles (v2)
curl "$LIVEPIN_API_BASE_URL/api/v2/vehicles" \
-H "Authorization: Bearer $JWT_TOKEN"
Vehicle location history
curl -G "$LIVEPIN_API_BASE_URL/api/vehicles/:vehicleId/location-history" \
-H "Authorization: Bearer $JWT_TOKEN" \
-d record_date=29/4/2026
Latest location
curl "$LIVEPIN_API_BASE_URL/api/vehicles/:vehicleId/location" \
-H "Authorization: Bearer $JWT_TOKEN"
Tracking controls
Use control endpoints when your product needs direct device actions.
- Name
POST /api/vehicles/:id/location-update-intervals- Description
Update upload interval strategy.
- Name
GET /api/vehicles/:id/location-update-intervals- Description
Read interval configuration.
- Name
POST /api/vehicles/:vehicleId/set-engine-cut-off- Description
Engine cut-off control.
- Name
POST /api/vehicles/:id/set-buzzer-sound- Description
Buzzer command.
- Name
POST /api/vehicles/:id/set-on-demand-tracking- Description
Enable on-demand tracking.
- Name
POST /api/vehicles/set-command- Description
Send arbitrary command to tracker.
- Name
GET /api/vehicles/:id/fuel-calibration- Description
Fuel calibration profile.
- Name
GET /api/vehicles/:id/fuel-consumption- Description
Fuel consumption analytics.
- Name
GET /api/gps-models- Description
- Supported tracker/GPS models.