Skip to main content
GET
Live Position

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

customerId
string
required

Query Parameters

vehicleIds
string[]

Comma separated list of vehicle identifiers (alphanumeric).

groupIds
string[]

Comma separated list of group ids.

driverIds
string[]

Comma separated list of driver identifiers (alphanumeric).

fromDateTime
string<date-time>

Start date and time for the tracking data retrieval

showAllVehicleStatus
boolean

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
string

Locale for the response data.

hideSpeedIfSpeedSensitive
boolean

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).

assetRegistration
string

Registration of the asset.

assetName
string

Friendly name of the asset.

assetVin
string

The vehicle identification number (VIN) of the asset.

assetId
string

Unique, unchangeable system generated identifier (alphanumeric) for the asset.

driverId
string

Unique, unchangeable system generated identifier (alphanumeric) for the driver.

driverName
string

Name of the driver of the vehicle.

driverGroupId
string

Unique, unchangeable system generated identifier (alphanumeric) for the group the driver has been assigned to.

driverGroupName
string

Name of the group the driver has been assigned to.

assetGroupId
string

Unique, unchangeable system generated identifier (alphanumeric) for the group the asset has been assigned to.

assetGroupName
string

Name of the group the asset has been assigned to.

date
string<date-time>

Date and time of the tracking event.

status
string

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

eventType
string

Category for the most recent tracking event status of the vehicle. Can be one of the following:

  • driving
  • idling
  • stopped
  • ping
  • input
  • unknown
  • defect

speed
number<double>

The current speed of the vehicle (in kph). Not included if optional input parameter hideSpeedIfSpeedSensitive was set to true.

odometer
number<double>

Odometer (in km) for the latest tracking event that has been received.

heading
number<double>

Compass heading of the vehicle in degrees clockwise from north. For example: North = 0, East = 90, South = 180 and West = 270.

latitude
number<double>

Asset latitude position.

longitude
number<double>

Asset longitude position.

road
string

The name of the road where the asset is.

roadNumber
string

The road number where the asset is.

city
string

The name of the city where the asset is.

postCode
string

The postcode where the asset is.

country
string

The name of the country where the asset is.

formattedAddress
string

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

division
string

The region / county / State from the address. For example: Normandy, Worcestershire, Tuscany, Arizona

locationName
string

Name of a POI location if the vehicle is within the geo-fence boundary of a POI location.

locationGroupName
string

The name of the location category assigned to this POI location.

locationId
string

The identifier (alphanumeric) for the POI location.

inputs
object[]

Array of inputs.

inputEvents
object[]

Array of input events

privacy
boolean

Boolean (true / false) to indicate if the journey is a private journey.

tags
string[]

Comma separated list of tags for the asset.

Comma separated list of tags for the asset.

assetType
string

Asset type, for example, BUS, CAR, CAR_ESTATE, CAR_SPORTS etc.

energyType
string

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.

fuelType
string[]

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

electricRangeKm
number<float>

The range for an electric vehicle based on the electric vehicle battery level percentage.

electricRangeKmEstimated
boolean

Boolean (true/false) if the range was estimated - true if estimated, false if received from the vehicle.

electricBatteryLevelPercent
number<float>

The electric vehicle battery level as a percentage.

electricBatteryLevelPercentEstimated
boolean

Boolean (true/false) if the electric vehicle battery level was estimated - true if estimated, false if received from the vehicle.

electricCharging
boolean

Boolean (true/false) if the electric vehicle battery is being charged - true if being charged, false otherwise.

electricChargingTimeRemainingMins
number<float>

Remaining minutes until the electric vehicle battery is fully charged.

fuelLevelLitres
number<float>

The fuel level in litres. If fuel level is received then either fuelLevelPercentage or fuelLevelLitres will be returned.

fuelLevelPercentage
number<float>

The fuel level as a percentage. If fuel level is received then either fuelLevelPercentage or fuelLevelLitres will be returned.

engineTotalHours
number<float>

Engine hours for the latest tracking event that has been received (format is decimal hours)

engineRpm
number<float>

Engine RPM

engineTotalHoursType
enum<string>

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.

Available options:
CAN,
ESTIMATED
serialNumber
integer<int64>

The serial number of the Calamp tracking device on the vehicle that sent this tracking event

ignitionStatus
enum<string>

Ignition status of the vehicle

Available options:
ON,
OFF
batteryVoltage
number<float>

Charge level of the battery powering the OBU

externalPowerVoltage
number<float>

Charge level of an external power source supplying energy.

activeFaultCodes
string[]

Comma separated list of active fault codes on the vehicle.

Comma separated list of active fault codes on the vehicle.