×
  (c) Pilot Telematics, 2024
 

List of vehicles

This API provides information about vehicles, including their current location, sensor data, and technical information.

How to retrieve data

Method

GET

Request address

To retrieve data, use the address:https://<address>/api/api.php?
<address> — the website address.

Request parameters

To obtain the required data, append the command to the request address.
  • cmd=list — command to retrieve the list of vehicles.
The format of the requested data is an array of vehicle data.

Example

API Request

https://<address>/api/api.php?cmd=list

API Response

{
"code": 0,
"msg": "OK",
"list":[
{
"agentid":9003,
"imei":"356307046873054",
"typeid":1,
"type":"Car",
"vehiclenumber":"Х444МР123",
"vin": "TRDFG65876",
"folder":"Geo-Center OOO",
"created_time":1414224633,
"current_mileage":881,
"status":{
"unixtimestamp":"1418744535",
"lat":"43.5562",
"lon":"39.9084",
"speed":0,
"dir":268,
"alt":246,
"satsinview":16,
"sensors":[
{
"name":"Parking",
"description":"TEST SPEED"
},
{
"name":"Fuel sensor",
"description":"Fuel sensor"
},
{
"name":"External power supply",
"description":"External power supply"
},
{
"name":"Ignition sensor",
"description":"Ignition sensor"
}
],
"sensors_status":[
{
"name":"Ignition sensor", // sensor name
"id":"1187852", // sensor id
"hum_value":"off", // readable value after calibration
"dig_value":"0", // digital value after calibration
"raw_value":"0", // raw value before calibration
"change_ts":"1627467122", // time of the last value change unixtimestamp
"group":"" // sensor group
},
{
"name":"External power supply",
"id":"1187851",
"hum_value":"26.27 V",
"dig_value":"26.27",
"raw_value":"26272",
"change_ts":"1627467122",
"group":""
},
{
"name":"Fuel sensor",
"id":"1187850",
"hum_value":"1 l",
"dig_value":"1",
"raw_value":"1",
"change_ts":"1626336197",
"group":""
}
]
}
}
]
}

Response parameters

The response is returned in JSON format and contains:
  • code — status code (0 indicates success)
  • msg — status message
  • list — array of vehicle objects, each containing:
  • agentid — unique identifier of the tracking device
  • imei — International Mobile Equipment Identity
  • typeid — numerical identifier of the vehicle type
  • type — type of vehicle
  • vehiclenumber — registration number of the vehicle
  • vin — vehicle identification number
  • folder — organizational group
  • created_time — time of addition to the system in Unix timestamp format
  • current_mileage — current mileage
  • status — information about the current status:
  • unixtimestamp — time of the last update
  • lat — latitude
  • lon — longitude
  • speed — speed
  • dir — direction of movement in degrees
  • alt — altitude above sea level
  • satsinview — number of visible GPS satellites
  • sensors — array of available sensors
  • sensors_status — detailed status of each sensor, including:
  • name — name of the sensor
  • id — identifier of the sensor
  • hum_value — actual value after calibration
  • dig_value — digital value after calibration
  • raw_value — raw value before calibration
  • change_ts — time of the last value change
  • group — sensor group