Get Vehicle Data

Description

Retrieve sensor-based vehicle source data, including door open status, tire pressure, and low fuel warning indicators.

Endpoint

GET https://api.pleos.ai/v1/vehicles/{vin}/status/data

Request

curl

curl -X GET "https://api.pleos.ai/v1/vehicles/{vin}/status/data?startDate=20250825&endDate=20250901&zoneId=UTC" \
  -H "Authorization: Bearer <your_access_token>" \
  -H "Brand: hyundai"

Header Params

Parameter	Type	Description	Required
Authorization	string	Access token	Required
Brand	string	Vehicle brand (hyundai/kia/genesis)	Required

Path Params

Parameter	Type	Description	Required
vin	string	VIN	Required

Query Params

Parameter	Type	Description	Required	Default
startDate	string	yyyyMMdd	Required	None
endDate	string	yyyyMMdd (Can only retrieve up to 7 days from the start date)	Required	None
zoneId	string	Timezone Id	Optional	UTC

Response

Success

200

{
  "data": {
    "trips": [
      {
        "triggerStartTime": "2025-09-01T10:00:00.000Z",
        "tripLength": 10000,
        "doors": {
          "openAssistance": [
            "close",
            "close",
            "close",
            "close",
            "close",
            "close",
            "close",
            "close",
            "close",
            "close"
          ],
          "openDriver": [
            "close",
            "close",
            "close",
            "close",
            "close",
            "close",
            "close",
            "close",
            "close",
            "close"
          ],
          "openRearLeft": [
            "close",
            "close",
            "close",
            "close",
            "close",
            "close",
            "close",
            "close",
            "close",
            "close"
          ],
          "openRearRight": [
            "close",
            "close",
            "close",
            "close",
            "close",
            "close",
            "close",
            "close",
            "close",
            "close"
          ]
        },
        "lamp": {
          "setting": [
            "lightSwOff",
            "lightSwOff",
            "lightSwOff",
            "lightSwOff",
            "lightSwOff",
            "lightSwOff",
            "lightSwOff",
            "lightSwOff",
            "lightSwOff",
            "lightSwOff"
          ]
        },
        "tire": {
          "pressureFrontLeft": [
            255, 255, 255, 255, 255, 255, 255, 255, 255, 255
          ],
          "pressureFrontRight": [
            255, 255, 255, 255, 255, 255, 255, 255, 255, 255
          ],
          "pressureRearLeft": [
            255, 255, 255, 255, 255, 255, 255, 255, 255, 255
          ],
          "pressureRearRight": [
            255, 255, 255, 255, 255, 255, 255, 255, 255, 255
          ],
          "pressureUnit": [
            "psi",
            "psi",
            "psi",
            "psi",
            "psi",
            "psi",
            "psi",
            "psi",
            "psi",
            "psi"
          ]
        },
        "warnings": {
          "lowFuelLevel": [
            "off",
            "off",
            "off",
            "off",
            "off",
            "off",
            "off",
            "off",
            "off",
            "off"
          ]
        },
        "outsideTemperature": {
          "value": [27.5, 27.5, 27.5, 27.5, 27.5, 27.5, 27.5, 27.5, 27.5, 27.5]
        }
      }
    ]
  },
  "meta": {
    "code": 200,
    "message": "Success",
    "success": "true",
    "timestamp": "2025-09-01T11:00:00Z",
    "requestId": "835bdbd4-1105-4a8c-b438-a1b2c3d4f5g6"
  }
}

data field	Type	Description
trips	array of object	Trip data
└──── triggerStartTime	string	Engine start time yyyy-MM-dd'T'HH:mm:ss.SSS'Z'
└──── tripLength	long	Driving trip length (unit: ms)
└── doors	object	Door status information
└────── openAssistance	array of string	Status of the front door on the passenger's side (open, close)
└────── openDriver	array of string	Status of the front door on the driver's side (open, close)
└────── openRearLeft	array of string	Status of the rear door on the left side (open, close)
└────── openRearRight	array of string	Status of the rear door on the right side (open, close)
└── lamp	object	Lamp status information
└────── setting	array of string	Status of the exterior lamp set by the user - lightSwOff: Lights off - tailSwOn: Tail lights on - headLampLowSwOn: Headlamps on - autoLightSwOn: Auto light feature on
└── tire	object	Tire pressure information
└────── pressureFrontLeft	array of number	Pressure of front left tire (0~254: valid, 255: invalid)
└────── pressureFrontRight	array of number	Pressure of front right tire (0~254: valid, 255: invalid)
└────── pressureRearLeft	array of number	Pressure of rear left tire (0~254: valid, 255: invalid)
└────── pressureRearRight	array of number	Pressure of rear right tire (0~254: valid, 255: invalid)
└────── pressureUnit	array of string	Unit of tire pressure (psi, kpa, bar)
└── warnings	object	Warning light information
└────── lowFuelLevel	array of string	Warning indication of status of whether the fuel level is running low (on, off)
└── outsideTemperature	object	Vehicle outside temperature information
└────── value	array of number	Measured temperature outside the vehicle (unit: °C, range: -40~60)

Calculation of values in units of tire pressure

According to the 'tire.pressureUnit' setting, pressure values such as 'tire.pressureFrontLeft' must be converted before use.

Tire pressure unit	Tire pressure value	Physical value conversion logic	Actual Physical Values
psi	52	No processing required	52 psi
kpa	72	value * 5	360 kpa
bar	36	value / 10	3.6 bar

Failure

4002

{
  "error": {
    "code": "4002",
    "message": "Invalid request parameters",
    "details": [],
    "timestamp": "2025-09-01T12:00:00Z",
    "requestId": "835bdbd4-1105-4a8c-b438-a1b2c3d4f5g6"
  }
}

[Error Code]

For detailed descriptions of error code, refer to Error Code.