Location Signals

IsAtHome

GET /vehicles/{vehicleId}/signals/location-isathome

A boolean indicating if the vehicle is at home. Vehicle owners can set their home location in their OEM application.

body · object

Show body properties

value · boolean

Example

{
  "value": true
}

PreciseLocation

GET /vehicles/{vehicleId}/signals/location-preciselocation

An object containing information about a vehicle’s precise location.

body · object

Show body properties

heading · number

The precise angular heading of the vehicle.

latitude · number

The vehicle’s current geographic latitude coordinate.

direction · string

A cardinal or intercardinal direction representing the vehicle’s current heading or orientation.

Possible values: N, NE, E, SE, S, SW, W, NW

longitude · number

The vehicle’s current geographic longitude coordinate.

locationType · string

Indicates whether the location-related fields are expected to update in real time or when the vehicle is parked.

Possible values: LAST_PARKED, CURRENT

Example

{
  "latitude": 51.5014,
  "longitude": -0.1419,
  "direction": "NE",
  "heading": 45.3,
  "locationType": "CURRENT"
}