×
 

Vehicle list

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

How to get data

Method

GET

Request address

To get the data, use the address: https://<server_address>/api/api.php?

Request parameters

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

Example request

https://<server_address>/api/api.php?cmd=list&node=1
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
      },
      "extra_params": {
        "kmlimit": "2",
        "mvanumber": "12312",
        "make_model": "BMW"
      },
      "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",
          "id": "1187852",
          "hum_value": "off",
          "dig_value": "0",
          "raw_value": "0",
          "change_ts": "1627467122",
          "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": ""
        }
      ]
    }
  ]
}
In response to the API request, the following is returned:
  • code — status code (0 indicates success)
  • msg — status message
  • list — an array of vehicle objects, where each object contains:
  • agentid — unique identifier of the tracking device
  • imei — international Mobile Equipment Identity
  • typeid — numeric identifier of the vehicle type
  • type — type of vehicle
  • vehiclenumber — vehicle registration number
  • vin — vehicle Identification Number
  • folder — organizational group
  • created_time — time the vehicle was added to the system (in Unix timestamp format)
  • current_mileage — current mileage
  • status — current status information, including:
  • unixtimestamp — time of the latest update
  • lat — latitude
  • lon — longitude
  • speed — speed
  • dir — direction of movement (in degrees)
  • alt — altitude above sea level
  • satsinview — number of visible GPS satellites
  • extra_params — additional vehicle parameters. These may vary depending on configuration and object type, and may include:
  • kmlimit — mileage limit
  • mvanumber — vehicle number
  • make_model — make and model
  • sensors — array of available sensors
  • sensors_status — detailed status for each sensor, including:
  • name — sensor name
  • id — sensor identifier
  • hum_value — calibrated human-readable value
  • dig_value — calibrated digital value
  • raw_value — raw, uncalibrated value
  • change_ts — timestamp of the last value change
  • group — sensor group