Call Vehicle Data API

This explains the procedure for calling the Vehicle Data API with an example.

API URL

https://api.pleos.ai 

Header

Authorization API Header

Parameter	Type	Description	Required
Content-Type	string	application/json	Optional
Brand	string	Vehicle brand (hyundai/kia/genesis)	Required

Vehicle Data API Header

Parameter	Type	Description	Required
Authorization	string	Bearer accessToken	Required
Content-Type	string	application/json	Optional
Brand	string	Vehicle brand (hyundai/kia/genesis)	Required

Call Vehicle Data API

The Vehicle Data API allows you to call each API independently without a specific sequence. However, you must first acquire an access token before calling the Vehicle Data API.

1. Call the access token issuance API.
   • Refer to the Authentication document.
2. Request the vehicle owners's agreement for vehicle selection and connected car data sharing.
   • Refer to the Request for Data Sharing document.
3. Include the access token and Vehicle Identification Number(VIN) in the header and path parameters of the API request.
4. Call the Vehicle Data API and check the result.
   • To check the vehicle battery status, call the https://api.pleos.ai/v1/vehicles/{vin}/batteries API.
   curl

   curl -X GET "https://api.pleos.ai/v1/vehicles/{vin}/batteries" \
   -H "Authorization: Bearer <your_access_token>" \
   -H "Content-Type: application/json" \
   -H "Brand: hyundai"

Response Message

Success

200

{
  "data": {
    "ignition": {
      "status": "on",
      "ignitionDetails": [
        {
          "type": "ign1",
          "status": "on"
        },
        {
          "type": "ign3",
          "status": "on"
        },
        {
          "type": "acc",
          "status": "on"
        }
      ]
    },
    "sleepMode": "off",
    "odometer": {
      "value": 6549.2,
      "unit": "km"
    },
    "transmission": {
      "parkingPosition": false
    },
    "timestamp": "2025-09-01T09:10:00Z"
  },
  "meta": {
    "code": 200,
    "message": "Success",
    "success": true,
    "timestamp": "2025-09-01T11:00:00Z",
    "requestId": "835bdbd4-1105-4a8c-b438-a1b2c3d4f5g6"
  }
}

Failure

Error Response Format

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

info

For an explanation of the failure response format, refer to Error Response.