Renault endpoints¶

This is a list of the endpoints available, and their characteristics.

Vehicle information endpoints¶

alerts¶

Base url:

/commerce/v1/accounts/{account_id}/kamereon/vehicles/{vin}/alerts

Sample return:

[
  {
    "id": "xxxxxxxxxx",
    "alertType": "proactive",
    "canArchitecture": "204",
    "alertCode": "crashairbagmalfunction",
    "trueValues": "1",
    "priority": 0,
    "minAge": 1,
    "minMileage": 100,
    "generateTime": 1440,
    "generateMileage": 15,
    "closeTime": 1440,
    "closeMileage": 36,
    "criticity": 3,
    "generateOccurrence": 3,
    "closeOccurrence": 10,
    "generateLead": 1,
    "notifSMS": 0,
    "notifMail": 1,
    "notifMybrand": 1,
    "notifSourceEvent": "CRIT3.RDVDEALER",
    "leadContactDays": 90,
    "notifContactDays": 5,
    "notifReminderDay": 15,
    "notifReminderCount": 0,
    "notifReminderCounter": 0,
    "notifReminderDate": "2024-03-15T00:00:00.000Z",
    "vin": "xxxxxxxxxxx",
    "registrationNumber": "xxxxxxxxxxxx",
    "countryCode": "IT",
    "deliveryDate": "2020-10-30T00:00:00.000Z",
    "brandComCode": "REN",
    "modelCode": "HJB",
    "partyId": "xxxxxxxxxxxxxxx",
    "partyCountry": "IT",
    "partyOrg": 0,
    "partyStaff": 0,
    "partyPhone": 1,
    "partySms": null,
    "partyMail": null,
    "partyPostal": null,
    "localeDefault": "it-IT",
    "dealerNumber": "xxxxxxxxxxx",
    "dealerNumberOrigin": "dealer_myr",
    "isConnected": 1,
    "mileageDate": "2024-02-29T00:00:00.000Z",
    "mileage": 63593,
    "yearMileage": 16064,
    "operationCode": null,
    "operationName": null,
    "operationType": null,
    "nextDate": null,
    "nextMileage": null,
    "reconductCount": 0,
    "isConnectedOperation": 0,
    "genReason": null,
    "endMileage": 70068,
    "status": 0,
    "creationDateTime": "2024-02-29T14:21:02.382Z",
    "lastUpdateDateTime": "2024-10-29T02:08:45.671Z",
    "inVehicleDateTime": "2024-02-29T14:21:15.000Z",
    "closureReason": "archived",
    "function": "the airbag",
    "shortDescription": "WARNING: Check Airbag",
    "longDescription": "WARNING: Check Airbag",
    "criticityName": "Major alert",
    "alertCodeTitle": "Defective airbag",
    "alertCodeSubTitle": "Details of the event",
    "alertCodeDescription": "The airbag must be inspected",
    "alertCodeDetailDescription": "We have detected a malfunction in your airbag system.\nYou must inspect it to ensure that the front passengers are protected if there is an impact. For further information, refer to the user manual of your vehicle below.",
    "iconUrl": "https://cap-static-medias.ope.apps.renault.com/images/crashAirbag.png",
    "detailImageUrl": "https://cap-static-medias.ope.apps.renault.com/images/crashAirbag.png",
    "userGuideUrl": "https://it.e-guide.renault.com/ita/",
    "mileageUnit": "km"
  }
]

Vehicle data endpoints¶

battery-status¶

Base url:

/commerce/v1/accounts/{account_id}/kamereon/kca/car-adapter/v2/cars/{vin}/battery-status

Sample return:

{
  "data": {
    "type": "Car",
    "id": "VF1AAAAA555777999",
    "attributes": {
      "timestamp": "2020-01-12T21:40:16Z",
      "batteryLevel": 60,
      "batteryTemperature": 20,
      "batteryAutonomy": 141,
      "batteryCapacity": 0,
      "batteryAvailableEnergy": 31,
      "plugStatus": 1,
      "chargingStatus": 1.0,
      "chargingRemainingTime": 145,
      "chargingInstantaneousPower": 27.0
    }
  }
}

Note

batteryTemperature is not always present.
batteryCapacity appears to always return 0.

On Zoe40 (model code X101VE):

chargingInstantaneousPower gives value in watts.
chargingStatus uses only a subset of ChargeStatus_ enum (NOT_IN_CHARGE = 0.0, CHARGE_IN_PROGRESS = 1.0, CHARGE_ERROR = -1.0)

On Zoe50 (model code X102VE):

batteryTemperature appears completely wrong.
chargingInstantaneousPower seems to return values in kilowatts, but the values still appear completely wrong.

charge-history¶

Base url:

/commerce/v1/accounts/{account_id}/kamereon/kca/car-adapter/v1/cars/{vin}/charge-history

Sample return:

{
  "data": {
    "type": "Car",
    "id": "VF1AAAAA555777999",
    "attributes": {
      "chargeSummaries": [
        {
          "day": "20201208",
          "totalChargesNumber": 2,
          "totalChargesDuration": 495,
          "totalChargesErrors": 0
        },
        {
          "day": "20201205",
          "totalChargesNumber": 1,
          "totalChargesDuration": 657,
          "totalChargesErrors": 0
        }
      ]
    }
  }
}

charge-mode¶

Base url:

/commerce/v1/accounts/{account_id}/kamereon/kca/car-adapter/v1/cars/{vin}/charge-mode

Sample return:

{
  "data": {
    "type": "Car",
    "id": "VF1AAAAA555777999",
    "attributes": { "chargeMode": "always" }
  }
}

Note

On older vehicles, such as Zoe40 (model code X101VE):: The return values appear to be always_charging and schedule_mode. This matches the vehicle_action.charge-mode action attributes.
On newer vehicles, such as Zoe50 (model code X102VE):: The return values appear to be always and scheduled. This DOES NOT match the vehicle_action.charge-mode action attributes.

charge-schedule¶

Base url:

/commerce/v1/accounts/{account_id}/kamereon/kca/car-adapter/v1/cars/{vin}/charge-schedule

Sample return:

Single:

{
  "data": {
    "type": "Car",
    "id": "VF1AAAAA555777999",
    "attributes": {
      "calendar": {
        "monday": [
          { "startTime": "2300", "duration": 480, "activationState": false }
        ],
        "tuesday": [
          { "startTime": "2300", "duration": 480, "activationState": false }
        ],
        "wednesday": [
          { "startTime": "2300", "duration": 480, "activationState": false }
        ],
        "thursday": [
          { "startTime": "2300", "duration": 480, "activationState": false }
        ],
        "friday": [
          { "startTime": "2300", "duration": 480, "activationState": false }
        ],
        "saturday": [
          { "startTime": "2300", "duration": 480, "activationState": false }
        ],
        "sunday": [
          { "startTime": "2300", "duration": 480, "activationState": false }
        ]
      }
    }
  }
}

charges¶

Base url:

/commerce/v1/accounts/{account_id}/kamereon/kca/car-adapter/v1/cars/{vin}/charges

Sample return:

{
  "data": {
    "type": "Car",
    "id": "VF1AAAAA555777999",
    "attributes": {
      "charges": [
        {
          "chargeStartDate": "2020-11-11T00:31:03Z",
          "chargeEndDate": "2020-11-11T08:30:17Z",
          "chargeDuration": 479,
          "chargeStartBatteryLevel": 15,
          "chargeEndBatteryLevel": 74,
          "chargeBatteryLevelRecovered": 59,
          "chargePower": "slow",
          "chargeStartInstantaneousPower": 3100,
          "chargeEndStatus": "ok"
        }
      ]
    }
  }
}

charging-settings¶

Base url:

/commerce/v1/accounts/{account_id}/kamereon/kca/car-adapter/v1/cars/{vin}/charging-settings

Sample return:

Single:

{
  "data": {
    "type": "Car",
    "id": "VF1AAAAA555777999",
    "attributes": {
      "mode": "scheduled",
      "schedules": [
        {
          "id": 1,
          "activated": true,
          "monday": {
            "startTime": "T12:00Z",
            "duration": 15
          },
          "tuesday": {
            "startTime": "T04:30Z",
            "duration": 420
          },
          "wednesday": {
            "startTime": "T22:30Z",
            "duration": 420
          },
          "thursday": {
            "startTime": "T22:00Z",
            "duration": 420
          },
          "friday": {
            "startTime": "T12:15Z",
            "duration": 15
          },
          "saturday": {
            "startTime": "T12:30Z",
            "duration": 30
          },
          "sunday": {
            "startTime": "T12:45Z",
            "duration": 45
          }
        }
      ]
    }
  }
}

Multiple:

{
  "data": {
    "type": "Car",
    "id": "VF1AAAAA555777999",
    "attributes": {
      "mode": "scheduled",
      "schedules": [
        {
          "id": 1,
          "activated": true,
          "monday": {
            "startTime": "T00:00Z",
            "duration": 450
          },
          "tuesday": {
            "startTime": "T00:00Z",
            "duration": 450
          },
          "wednesday": {
            "startTime": "T00:00Z",
            "duration": 450
          },
          "thursday": {
            "startTime": "T00:00Z",
            "duration": 450
          },
          "friday": {
            "startTime": "T00:00Z",
            "duration": 450
          },
          "saturday": {
            "startTime": "T00:00Z",
            "duration": 450
          },
          "sunday": {
            "startTime": "T00:00Z",
            "duration": 450
          }
        },
        {
          "id": 2,
          "activated": true,
          "monday": {
            "startTime": "T23:30Z",
            "duration": 15
          },
          "tuesday": {
            "startTime": "T23:30Z",
            "duration": 15
          },
          "wednesday": {
            "startTime": "T23:30Z",
            "duration": 15
          },
          "thursday": {
            "startTime": "T23:30Z",
            "duration": 15
          },
          "friday": {
            "startTime": "T23:30Z",
            "duration": 15
          },
          "saturday": {
            "startTime": "T23:30Z",
            "duration": 15
          },
          "sunday": {
            "startTime": "T23:30Z",
            "duration": 15
          }
        },
        {
          "id": 3,
          "activated": false
        },
        {
          "id": 4,
          "activated": false
        },
        {
          "id": 5,
          "activated": false
        }
      ]
    }
  }
}

cockpit¶

Base url:

/commerce/v1/accounts/{account_id}/kamereon/kca/car-adapter/v2/cars/{vin}/cockpit

Sample return:

{
  "data": {
    "type": "Car",
    "id": "VF1AAAAA555777123",
    "attributes": {
      "fuelAutonomy": 35.0,
      "fuelQuantity": 3.0,
      "totalMileage": 5566.78
    }
  }
}

{
  "data": {
    "type": "Car",
    "id": "VF1AAAAA555777999",
    "attributes": {
      "totalMileage": 49114.27
    }
  }
}

{
  "data": {
    "type": "Car",
    "id": "VF1AAAAA555777999",
    "attributes": { "totalMileage": 49114.27 }
  }
}

{
  "data": {
    "type": "Car",
    "id": "VF1AAAAA555777999",
    "attributes": {
      "fuelAutonomy": 0,
      "fuelQuantity": 0,
      "totalMileage": 5785.75
    }
  }
}

hvac-history¶

Base url:

/commerce/v1/accounts/{account_id}/kamereon/kca/car-adapter/v1/cars/{vin}/hvac-history

Sample return:

Sample data is not yet available for this endpoint.

Please check the Contributor Guide to provide a sample.

hvac-sessions¶

Base url:

/commerce/v1/accounts/{account_id}/kamereon/kca/car-adapter/v1/cars/{vin}/hvac-sessions

Sample return:

Sample data is not yet available for this endpoint.

Please check the Contributor Guide to provide a sample.

hvac-status¶

Base url:

/commerce/v1/accounts/{account_id}/kamereon/kca/car-adapter/v1/cars/{vin}/hvac-status

Sample return:

{
  "data": {
    "type": "Car",
    "id": "UU1AAAAA555777123",
    "attributes": {
      "socThreshold": 30.0,
      "hvacStatus": "off",
      "lastUpdateTime": "2020-12-03T00:00:00Z"
    }
  }
}

{
  "data": {
    "type": "Car",
    "id": "VF1AAAAA555777999",
    "attributes": { "externalTemperature": 8.0, "hvacStatus": "off" }
  }
}

{
  "data": {
    "type": "Car",
    "id": "VF1AAAAA555777999",
    "attributes": { "socThreshold": 40, "hvacStatus": "on" }
  }
}

Note

On Zoe40 (model code X101VE):: hvacStatus seems to always report off, even when preconditioning is in progress.
On Zoe50 (model code X102VE):: This endpoint seem to be unavailable and returns an error 'err.func.403': 'Operation not supported Operation not supported for this can (C1A)'.

hvac-settings¶

Base url:

/commerce/v1/accounts/{account_id}/kamereon/kca/car-adapter/v1/cars/{vin}/hvac-settings

Sample return:

{
  "data": {
    "type": "Car",
    "id": "VF1AAAAA555777999",
    "attributes": {
      "dateTime": "2020-12-24T20:00:00.000Z",
      "mode": "scheduled",
      "schedules": [
        {
          "id": 1,
          "activated": false
        },
        {
          "id": 2,
          "activated": true,
          "wednesday": { "readyAtTime": "T15:15Z" },
          "friday": { "readyAtTime": "T15:15Z" }
        },
        {
          "id": 3,
          "activated": false
        },
        {
          "id": 4,
          "activated": false
        },
        {
          "id": 5,
          "activated": false
        }
      ]
    }
  }
}

location¶

Base url:

/commerce/v1/accounts/{account_id}/kamereon/kca/car-adapter/v1/cars/{vin}/location

Sample return:

{
  "data": {
    "type": "Car",
    "id": "VF1AAAAA555777999",
    "attributes": {
      "gpsLatitude": 48.1234567,
      "gpsLongitude": 11.1234567,
      "lastUpdateTime": "2020-02-18T16:58:38Z"
    }
  }
}

{
  "data": {
    "type": "Car",
    "id": "VF1AAAAA555777999",
    "attributes": {
      "gpsDirection": null,
      "gpsLatitude": 48.1234567,
      "gpsLongitude": 11.1234567,
      "lastUpdateTime": "2020-02-18T16:58:38Z"
    }
  }
}

lock-status¶

Base url:

/commerce/v1/accounts/{account_id}/kamereon/kca/car-adapter/v1/cars/{vin}/lock-status

Sample return:

{
  "data": {
    "type": "Car",
    "id": "VF1AAAAA555777999",
    "attributes": {
      "lockStatus": "locked",
      "doorStatusRearLeft": "closed",
      "doorStatusRearRight": "closed",
      "doorStatusDriver": "closed",
      "doorStatusPassenger": "closed",
      "hatchStatus": "closed",
      "lastUpdateTime": "2022-02-02T13:51:13Z"
    }
  }
}

{
  "data": {
    "type": "Car",
    "id": "VF1AAAAA555777999",
    "attributes": {
      "lockStatus": "unlocked",
      "doorStatusRearLeft": "closed",
      "doorStatusRearRight": "closed",
      "doorStatusDriver": "closed",
      "doorStatusPassenger": "closed",
      "hatchStatus": "closed",
      "lastUpdateTime": "2022-02-02T13:51:13Z"
    }
  }
}

notification-settings¶

Base url:

/commerce/v1/accounts/{account_id}/kamereon/kca/car-adapter/v1/cars/{vin}/notification-settings

Sample return:

Sample data is not yet available for this endpoint.

Please check the Contributor Guide to provide a sample.

pressure¶

Base url:

/commerce/v1/accounts/{account_id}/kamereon/kca/car-adapter/v1/cars/{vin}/pressure

Sample return:

{
  "data": {
    "type": "Car",
    "id": "VF1AAAAA555777999",
    "attributes": {
      "flPressure": 2460,
      "frPressure": 2730,
      "rlPressure": 2790,
      "rrPressure": 2790,
      "flStatus": 0,
      "frStatus": 0,
      "rlStatus": 0,
      "rrStatus": 0
    }
  }
}

res-state¶

Base url:

/commerce/v1/accounts/{account_id}/kamereon/kca/car-adapter/v1/cars/{vin}/res-state

Sample return:

{
  "data": {
    "type": "ResState",
    "id": "VF1AAAAA555777999",
    "attributes": {
      "details": "Stopped, ready for RES",
      "code": "10"
    }
  }
}

{
  "data": {
    "type": "ResState",
    "id": "VF1AAAAA555777999",
    "attributes": {
      "details": "Running",
      "code": "42"
    }
  }
}

Vehicle KCM data endpoints¶

ev/settings¶

Base url:

/commerce/v1/accounts/{account_id}/kamereon/kcm/v1/vehicles/{vin}/ev/settings

Sample return:

Empty:

{
  "lastSettingsUpdateTimestamp": "2025-04-15T12:06:32.266Z",
  "delegatedActivated": false,
  "chargeModeRq": "SCHEDULED",
  "chargeTimeStart": "00:00",
  "chargeDuration": 9000,
  "preconditioningTemperature": 20.0,
  "preconditioningHeatedStrgWheel": false,
  "preconditioningHeatedRightSeat": false,
  "preconditioningHeatedLeftSeat": false,
  "programs": []
}

Single:

{
  "lastSettingsUpdateTimestamp": "2025-04-24T12:17:12.247Z",
  "delegatedActivated": false,
  "chargeModeRq": "SCHEDULED",
  "chargeTimeStart": "00:00",
  "chargeDuration": 9000,
  "preconditioningTemperature": 20.0,
  "preconditioningHeatedStrgWheel": false,
  "preconditioningHeatedRightSeat": false,
  "preconditioningHeatedLeftSeat": false,
  "programs": [
    {
      "programActivationStatus": true,
      "programType": "CHARGE_AND_PRECONDITIONING",
      "programDepartureTime": "02:00",
      "programActivationMonday": true,
      "programActivationTuesday": true,
      "programActivationWednesday": true,
      "programActivationThursday": true,
      "programActivationFriday": true,
      "programActivationSaturday": true,
      "programActivationSunday": true
    }
  ]
}

Multi:

{
  "lastSettingsUpdateTimestamp": "2025-12-30T17:03:18.644879Z",
  "delegatedActivated": false,
  "chargeModeRq": "SCHEDULED",
  "chargeTimeStart": "01:55",
  "chargeDuration": 300,
  "preconditioningTemperature": 19,
  "preconditioningHeatedStrgWheel": true,
  "preconditioningHeatedRightSeat": false,
  "preconditioningHeatedLeftSeat": false,
  "programs": [
    {
      "programActivationStatus": true,
      "programType": "CHARGE",
      "programDepartureTime": "07:30",
      "programActivationMonday": true,
      "programActivationTuesday": true,
      "programActivationWednesday": false,
      "programActivationThursday": false,
      "programActivationFriday": true,
      "programActivationSaturday": false,
      "programActivationSunday": false
    },
    {
      "programActivationStatus": true,
      "programType": "PRECONDITIONING",
      "programDepartureTime": "08:30",
      "programActivationMonday": false,
      "programActivationTuesday": false,
      "programActivationWednesday": false,
      "programActivationThursday": true,
      "programActivationFriday": false,
      "programActivationSaturday": false,
      "programActivationSunday": false
    },
    {
      "programActivationStatus": true,
      "programType": "CHARGE_AND_PRECONDITIONING",
      "programDepartureTime": "10:50",
      "programActivationMonday": false,
      "programActivationTuesday": false,
      "programActivationWednesday": true,
      "programActivationThursday": false,
      "programActivationFriday": false,
      "programActivationSaturday": true,
      "programActivationSunday": false
    }
  ]
}

ev/soc-levels¶

Base url:

/commerce/v1/accounts/{account_id}/kamereon/kcm/v1/vehicles/{vin}/ev/soc-level

Sample return:

{
  "lastEnergyUpdateTimestamp": "2025-04-18T06:51:09Z",
  "socMin": 20,
  "socTarget": 80
}

Action endpoints¶

actions/charge-mode¶

Base url:

/commerce/v1/accounts/{account_id}/kamereon/kca/car-adapter/v1/cars/{vin}/actions/charge-mode

Sample payload:

Use instant charging:

{
   "data": {
      "type": "ChargeMode",
      "attributes": {"action": "always_charging"}
   }
}

Use scheduled charging:

{
   "data": {
      "type": "ChargeMode",
      "attributes": {"action": "schedule_mode"}
   }
}

Please check the Contributor Guide to provide extra samples.

Note

All vehicles seem to use always_charging and schedule_mode.

On older vehicles, such as Zoe40 (model code X101VE):: This matches the vehicle_data.charge-mode return values: always_charging and schedule_mode.
On newer vehicles, such as Zoe50 (model code X102VE):: This DOES NOT match the vehicle_data.charge-mode return values which are: always and scheduled.

actions/charge-schedule¶

Base url:

/commerce/v1/accounts/{account_id}/kamereon/kca/car-adapter/v2/cars/{vin}/actions/charge-schedule

Sample payload:

Sample payload is not yet available for this endpoint.

Please check the Contributor Guide to provide a sample.

actions/charging-start¶

Base url:

/commerce/v1/accounts/{account_id}/kamereon/kca/car-adapter/v1/cars/{vin}/actions/charging-start

Sample payload:

Start charge:

{
   "data": {
      "type": "ChargingStart",
      "attributes": {"action": "start"}
   }
}

Stop charge:

{
   "data": {
      "type": "ChargingStart",
      "attributes": {"action": "stop"}
   }
}

Please check the Contributor Guide to provide extra samples.

actions/horn-lights¶

Base url:

/commerce/v1/accounts/{account_id}/kamereon/kca/car-adapter/v1/cars/{vin}/actions/horn-lights

Sample payload:

Start horn:

{
   "data": {
      "type": "HornLights",
      "attributes": {"action": "start", "target": "horn"}
   }
}

Start lights:

{
   "data": {
      "type": "HornLights",
      "attributes": {"action": "start", "target": "lights"}
   }
}

actions/hvac-start¶

Base url:

/commerce/v1/accounts/{account_id}/kamereon/kca/car-adapter/v1/cars/{vin}/actions/hvac-start

Sample payload:

Sample payload is not yet available for this endpoint.

Please check the Contributor Guide to provide a sample.

Note

On Zoe50 (model code X102VE):: Payload {'action': 'cancel'} to stop HVAC does not create errors but has no effect on the vehicle (Renault side limitation).

actions/hvac-schedule¶

Base url:

/commerce/v1/accounts/{account_id}/kamereon/kca/car-adapter/v2/cars/{vin}/actions/hvac-schedule

Sample payload:

Sample payload is not yet available for this endpoint.

Please check the Contributor Guide to provide a sample.

actions/refresh-location¶

Base url:

/commerce/v1/accounts/{account_id}/kamereon/kca/car-adapter/v1/cars/{vin}/actions/refresh-location

Sample payload:

Refresh location:

{
   "data": {
      "type": "RefreshLocation",
   }
}

KCM Action endpoints¶

charge/pause-resume¶

Base url:

/commerce/v1/accounts/{account_id}/kamereon/kcm/v1/vehicles/{vin}/charge/pause-resume

Sample return:

{
  "data": {
    "type": "ChargePauseResume",
    "id": "guid",
    "attributes": { "action": "resume" }
  }
}

{
  "data": {
    "type": "ChargePauseResume",
    "id": "guid",
    "attributes": { "action": "pause" }
  }
}