Live Position
Returns the live position and status for a resource (driver or vehicle). The live position for a vehicle on a private journey is not returned. By default vehicles which have a status of SOLD are not included in the response.
If vehicleIds, driverIds or groupIds are not specified, then the live position for all vehicles is returned. If driverIds is specified, then the driver must be recorded with their vehicle for their live position to be returned. If groupIds is specified, then the current position for all drivers/vehicles in the specified groups are included in the output. Only one of vehicleIds, driverIds or groupIds can be specified as an input parameter.
Request Limit:
The request limit on this endpoint is one request every 15 seconds. You will receive an HTTP status code
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
Query Parameters
Comma separated list of vehicle identifiers (alphanumeric).
Comma separated list of group ids.
Comma separated list of driver identifiers (alphanumeric).
Start date and time for the tracking data retrieval
Boolean (true/false) to indicate if details of all vehicles should be included, irrespective of their status. If not specified, defaults to FALSE, so vehicles with a status of SOLD are excluded from the response.
Locale for the response data.
Boolean (true/false) to indicate if the vehicle speed should be excluded from the output if the driver;'s group (if there is a driver for the vehicle) or the vehicle's group has been defined to be speed sensitive. If not specified, defaults to FALSE, so the vehicle's speed is included in the response.
Response
Live position and status for a resource (driver or vehicle).
Registration of the asset.
Friendly name of the asset.
The vehicle identification number (VIN) of the asset.
Unique, unchangeable system generated identifier (alphanumeric) for the asset.
Unique, unchangeable system generated identifier (alphanumeric) for the driver.
Name of the driver of the vehicle.
Unique, unchangeable system generated identifier (alphanumeric) for the group the driver has been assigned to.
Name of the group the driver has been assigned to.
Unique, unchangeable system generated identifier (alphanumeric) for the group the asset has been assigned to.
Name of the group the asset has been assigned to.
Date and time of the tracking event.
The most recent tracking event received from the vehicle. Can be one of the following:
- behaviourHarshBraking
- behaviourOverSpeed
- behaviourExcessiveIdling
- behaviourHarshAcceleration
- behaviourHarshCornering
- behaviourEngineOverRevving
- toggleOff
- toggleOn
- stateChange
- ptoOnIdling
- ptoOnDriving
- ptoOff
- startOfJourney
- endOfJourney
- driving
- idling
- pingPosition
Category for the most recent tracking event status of the vehicle. Can be one of the following:
- driving
- idling
- stopped
- ping
- input
- unknown
- defect
The current speed of the vehicle (in kph). Not included if optional input parameter hideSpeedIfSpeedSensitive was set to true.
Odometer (in km) for the latest tracking event that has been received.
Compass heading of the vehicle in degrees clockwise from north. For example: North = 0, East = 90, South = 180 and West = 270.
Asset latitude position.
Asset longitude position.
The name of the road where the asset is.
The road number where the asset is.
The name of the city where the asset is.
The postcode where the asset is.
The name of the country where the asset is.
Country specific formatted address as a comma separated values using roadNumber, road, city, postcode and country. For example,
- UK addresses formatted as: roadNumber, road, city, postcode, country
- French addresses formatted as: roadNumber, road, postcode, city, country
The region / county / State from the address. For example: Normandy, Worcestershire, Tuscany, Arizona
Name of a POI location if the vehicle is within the geo-fence boundary of a POI location.
The name of the location category assigned to this POI location.
The identifier (alphanumeric) for the POI location.
Array of inputs.
Array of input events
Boolean (true / false) to indicate if the journey is a private journey.
Comma separated list of tags for the asset.
Comma separated list of tags for the asset.
Asset type, for example, BUS, CAR, CAR_ESTATE, CAR_SPORTS etc.
The energy type for the vehicle. Can be one of the following:
- UNDEFINED
- EV - Battery Electric Vehicle
- PHEV - Plug-in Hybrid Electric Vehicle
- HEV - Hybrid Electric Vehicle
- FECV - Fuel Cell Electric Vehicle (Hydrogen)
- ICE - Internal combustion engine
- CNG - Compressed Natural Gas
- LNG - Liquefied natural gas
- LPG - Liquefied petroleum gas
- BI-FUEL - multi-fuel engines capable of running on two fuels.
A list of the primary and secondary fuel types for the vehicle. Values in the list can included:
- PETROL
- DIESEL
- PROPANE
- METHANE
- ELECTRIC
- HYDROGEN
A list of the primary and secondary fuel types for the vehicle. Values in the list can included:
- PETROL
- DIESEL
- PROPANE
- METHANE
- ELECTRIC
- HYDROGEN
The range for an electric vehicle based on the electric vehicle battery level percentage.
Boolean (true/false) if the range was estimated - true if estimated, false if received from the vehicle.
The electric vehicle battery level as a percentage.
Boolean (true/false) if the electric vehicle battery level was estimated - true if estimated, false if received from the vehicle.
Boolean (true/false) if the electric vehicle battery is being charged - true if being charged, false otherwise.
Remaining minutes until the electric vehicle battery is fully charged.
The fuel level in litres. If fuel level is received then either fuelLevelPercentage or fuelLevelLitres will be returned.
The fuel level as a percentage. If fuel level is received then either fuelLevelPercentage or fuelLevelLitres will be returned.
Engine hours for the latest tracking event that has been received (format is decimal hours)
Engine RPM
Either ESTIMATED or CAN.
- CAN indicates the engineTotalHours value has been read from the vehicle's CANbus
- ESTIMATED indicates the engineTotalHours value has been calculated from the total vehicle journey times.
CAN, ESTIMATED The serial number of the Calamp tracking device on the vehicle that sent this tracking event
Ignition status of the vehicle
ON, OFF Charge level of the battery powering the OBU
Charge level of an external power source supplying energy.
Comma separated list of active fault codes on the vehicle.
Comma separated list of active fault codes on the vehicle.
