These docs are for v1. Click to read the latest docs for v3.

Live Status

Use this API to get the real time status of all your vehicles. This data refreshes frequently and the API returns the most recent data.

🚧

Alternative Approach

You can subscribe to our webhooks for this event to receive data in real-time. For more information on webhooks and how to get started, please visit our webhook documentation

📘

Sample Request

https://api.azuga.com/azuga-ws/v1/live/location.json

API Response explanation

Field

Description

code

API Status Code

message

API Message (Success/Failure)

generatedAt

API generation timestamp in UTC

reason

The reason for failure

currentPage

The current page

totalPages

The total number of pages in the result

locations

An array of location objects

vehicleName

Name of the vehicle

date

Timestamp in UTC when the last activity occured

event

Last activity of the vehicle

activity

For Azuga internal use

speed

Speed of the vehicle in MPH

stopTime

Time between the last ignition OFF and the current system time

idleTime

Time period during which the vehicle was in the idle state

vehicleId

Unique identifier representing the vehicle

groupId

Unique identifier of the group associated with the vehicle

groupName

Name of the group associated with the vehicle

phoneNumber

Phone number of the driver

reserved1

Reserved variable for future use

reserved2

Reserved variable for future use

reserved3

Reserved variable for future use

reserved4

Reserved variable for future use

user

Object representing the details of the driver associated with the vehicle

userId

Unique identifier representing the user

firstName

First name of the driver

lastName

Last name of the driver

fullName

Full name of the driver

notInGroup

For Azuga internal use

deleted

Boolean representing whether the driver is active in the account

True = Deleted
False = Not Deleted

employeeId

EmployeeId of the driver

emailVerification

Boolean representing whether the email address of the driver is verified.

latitude

Latitude coordinate of the location

longitutde

Longitude coordinate of the location

lastKnownLat

Latitude of the previous record. This parameter is used when the device is unable to receive lat/lon coordinates

lastKnownLon

Longitude of the previous record. This parameter is used when the device is unable to receive lat/lon coordinates

lastKnownAddress

Address of the previous record. This parameter is used when the device is unable to receive lat/lon coordinates

lastKnownTime

Time of the previous record. This parameter is used when the device is unable to receive lat/lon coordinates

realLKL_address

This parameter stores valid last address of the location when the device was able to fetch the location coordinates. Customers can make use of this field when the device is unable to fetch lat/lon/address for multiple entries

realLKL_time

This parameter stores the time in UTC milliseconds when the device is able to fetch valid lat/lon coordinates. Customers can make use of this field when the device is unable to fetch lat/lon/address for multiple entries

cog

For Azuga internal use

storedLocation

Boolean indicates whether the location details are to be taken from stored values (previous entry/Last known entry)

location

Address of the location

Language
Credentials
Header
Click Try It! to start a request and see the response here!