> ## Documentation Index
> Fetch the complete documentation index at: https://smartcar.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Charge Signals

### Amperage

<Badge color="green">GET</Badge> `/vehicles/{vehicleId}/signals/charge-amperage`

Current amperage flowing to the electric vehicle during a charging session, measured in amps.

<ParamField path="body" type="object">
  <Expandable title="body properties">
    <ParamField path="unit" type="string" required={false} />

    <ParamField path="value" type="number" required={false} />

    ```json Example theme={null}
    {
      "value": 33,
      "unit": "ampere"
    }
    ```
  </Expandable>
</ParamField>

### AmperageMax

<Badge color="green">GET</Badge> `/vehicles/{vehicleId}/signals/charge-amperagemax`

The maximum available amps available to charge.

<ParamField path="body" type="object">
  <Expandable title="body properties">
    <ParamField path="unit" type="string" required={false} />

    <ParamField path="value" type="number" required={false} />

    ```json Example theme={null}
    {
      "value": 48,
      "unit": "ampere"
    }
    ```
  </Expandable>
</ParamField>

### AmperageRequested

<Badge color="green">GET</Badge> `/vehicles/{vehicleId}/signals/charge-amperagerequested`

The requested amps to charge the vehicle.

<ParamField path="body" type="object">
  <Expandable title="body properties">
    <ParamField path="unit" type="string" required={false} />

    <ParamField path="value" type="number" required={false} />

    ```json Example theme={null}
    {
      "value": 48,
      "unit": "ampere"
    }
    ```
  </Expandable>
</ParamField>

### ChargeLimits

<Badge color="green">GET</Badge> `/vehicles/{vehicleId}/signals/charge-chargelimits`

Object containing the default (global) charge limit configuration and configurations based on location, and charging type (AC or DC)

<ParamField path="body" type="object">
  <Expandable title="body properties">
    <ParamField path="values" type="array" required={false} />

    <Expandable title="Array item properties">
      <ParamField path="type" type="string" required={false}>
        **Possible values:** `GLOBAL`, `LOCATION`, `CHARGING_TYPE`
      </ParamField>

      <ParamField path="limit" type="number" required={false} />

      <ParamField path="condition" type="object" required={false} />

      <Expandable title="condition properties">
        <ParamField path="name" type="string" required={false} />

        <ParamField path="address" type="string" required={false} />

        <ParamField path="latitude" type="number" required={false} />

        <ParamField path="longitude" type="number" required={false} />

        <ParamField path="chargingType" type="string" required={false} />
      </Expandable>
    </Expandable>

    <ParamField path="activeLimit" type="number" required={false}>
      Maximum state of charge (SoC) limit currently configured, expressed as a percentage.
    </ParamField>

    <ParamField path="unit" type="string" required={false} />

    ```json Example theme={null}
    {
      "activeLimit": 80,
      "values": [
        {
          "type": "GLOBAL",
          "limit": 80
        },
        {
          "type": "LOCATION",
          "condition": {
            "name": "Home",
            "address": "123 2nd street",
            "latitude": 90,
            "longitude": 90
          },
          "limit": 72
        },
        {
          "type": "CHARGING_TYPE",
          "condition": {
            "chargingType": "AC"
          },
          "limit": 52
        }
      ],
      "unit": "percent"
    }
    ```
  </Expandable>
</ParamField>

### ChargePortStatusColor

<Badge color="green">GET</Badge> `/vehicles/{vehicleId}/signals/charge-chargeportstatuscolor`

Current status indicator color displayed on or around the vehicle's charging port.

<ParamField path="body" type="object">
  <Expandable title="body properties">
    <ParamField path="value" type="string" required={false} />

    ```json Example theme={null}
    {
      "value": "Green"
    }
    ```
  </Expandable>
</ParamField>

### ChargeRate

<Badge color="green">GET</Badge> `/vehicles/{vehicleId}/signals/charge-chargerate`

Current rate at which range is being added to the vehicle during an active charging session

<ParamField path="body" type="object">
  <Expandable title="body properties">
    <ParamField path="unit" type="string" required={false} />

    <ParamField path="value" type="number" required={false} />

    ```json Example theme={null}
    {
      "value": 48,
      "unit": "km/h"
    }
    ```
  </Expandable>
</ParamField>

### ChargeRecords

<Badge color="green">GET</Badge> `/vehicles/{vehicleId}/signals/charge-chargerecords`

Collection of historical charging session data stored by the vehicle.

<ParamField path="body" type="object">
  <Expandable title="body properties">
    <ParamField path="values" type="array" required={true} />

    <Expandable title="Array item properties">
      <ParamField path="id" type="string" required={false}>
        Unique OEM identifier assigned to the specific charging session.
      </ParamField>

      <ParamField path="cost" type="object" required={false} />

      <Expandable title="cost properties">
        <ParamField path="currency" type="string" required={false}>
          Three-letter currency code representing the monetary unit used for the charging session transaction.
        </ParamField>

        <ParamField path="otherAmount" type="number" required={false}>
          Monetary value representing all non-energy related charges incurred during the charging session.
        </ParamField>

        <ParamField path="energyAmount" type="number" required={false}>
          Monetary value representing the cost specifically for the electrical energy consumed during the charging session.
        </ParamField>
      </Expandable>

      <ParamField path="endTime" type="string" required={false}>
        Timestamp marking when a charging session was completed or terminated.
      </ParamField>

      <ParamField path="location" type="object" required={false} />

      <Expandable title="location properties">
        <ParamField path="name" type="string" required={false}>
          Descriptive text identifier for the facility or establishment where the charging session occurred.
        </ParamField>

        <ParamField path="address" type="string" required={false}>
          Structured or formatted text representing the physical street address where the charging session took place.
        </ParamField>

        <ParamField path="latitude" type="number" required={false}>
          Numerical value representing the north-south position of the charging location on Earth's surface.
        </ParamField>

        <ParamField path="longitude" type="number" required={false}>
          Numerical value representing the east-west position of the charging location on Earth's surface.
        </ParamField>
      </Expandable>

      <ParamField path="startTime" type="string" required={false}>
        Timestamp marking when a charging session was initiated.
      </ParamField>

      <ParamField path="energyAdded" type="number" required={false}>
        Total amount of electrical energy drawn from the charging source during the charging session, measured in kilowatt-hours (kWh).
      </ParamField>

      <ParamField path="chargingType" type="string" required={false}>
        Type of charging used during the recorded charging session.
      </ParamField>

      <ParamField path="isPublicCharger" type="boolean" required={false}>
        Boolean indicator that shows whether the charging session occurred at a public charging station rather than at a private or home charging location.
      </ParamField>

      <ParamField path="endStateOfCharge" type="number" required={false}>
        Percentage value indicating the vehicle's battery state of charge (SoC) at the conclusion of a charging session.
      </ParamField>

      <ParamField path="startStateOfCharge" type="number" required={false}>
        Percentage value indicating the vehicle's battery state of charge (SoC) at the beginning of a charging session.
      </ParamField>
    </Expandable>

    ```json Example theme={null}
    {
      "values": [
        {
          "startTime": "2023-10-15T19:30:00.000Z",
          "endTime": "2023-10-16T06:45:00.000Z",
          "startStateOfCharge": 25,
          "endStateOfCharge": 90,
          "energyAdded": 65.2,
          "isPublicCharger": false,
          "chargingType": "DC",
          "cost": {
            "currency": "GBP",
            "energyAmount": 12.56,
            "otherAmount": 0
          },
          "location": {
            "latitude": 51.5014,
            "longitude": -0.1419,
            "name": "Home",
            "address": "123 Park Lane, London SW1A 1AA"
          },
          "id": "CHG-20231015-A39B"
        }
      ]
    }
    ```
  </Expandable>
</ParamField>

### ChargerPhases

<Badge color="green">GET</Badge> `/vehicles/{vehicleId}/signals/charge-chargerphases`

The number of phases available from the connected charger.

<ParamField path="body" type="object">
  <Expandable title="body properties">
    <ParamField path="unit" type="string" required={false} />

    <ParamField path="value" type="integer" required={false} />

    ```json Example theme={null}
    {
      "value": 3
    }
    ```
  </Expandable>
</ParamField>

### ChargeTimers

<Badge color="green">GET</Badge> `/vehicles/{vehicleId}/signals/charge-chargetimers`

Object containing the default (GLOBAL) charge timer configuration and configurations based on location, and charing type (AC or DC)

<ParamField path="body" type="object">
  <Expandable title="body properties">
    <ParamField path="values" type="array" required={false} />

    <Expandable title="Array item properties">
      <ParamField path="type" type="string" required={false}>
        **Possible values:** `GLOBAL`, `LOCATION`, `CHARGING_TYPE`
      </ParamField>

      <ParamField path="condition" type="object" required={false} />

      <Expandable title="condition properties">
        <ParamField path="name" type="string" required={false} />

        <ParamField path="address" type="string" required={false} />

        <ParamField path="latitude" type="number" required={false} />

        <ParamField path="longitude" type="number" required={false} />

        <ParamField path="chargingType" type="string" required={false} />
      </Expandable>

      <ParamField path="schedules" type="array" required={false} />

      <Expandable title="Array item properties">
        <ParamField path="end" type="string" required={false} />

        <ParamField path="days" type="array" required={false} />

        <ParamField path="start" type="string" required={false} />
      </Expandable>

      <ParamField path="departureTimers" type="array" required={false} />

      <Expandable title="Array item properties">
        <ParamField path="days" type="array" required={false} />

        <ParamField path="time" type="string" required={false} />
      </Expandable>

      <ParamField path="isOEMOptimizationEnabled" type="boolean" required={false} />

      <ParamField path="scheduleId" type="string" required={false} />

      <ParamField path="scheduleType" type="string" required={false}>
        **Possible values:** `DAILY`, `WEEKLY`, `WORKWEEK`
      </ParamField>
    </Expandable>

    ```json Example theme={null}
    {
      "values": [
        {
          "type": "GLOBAL",
          "isOEMOptimizationEnabled": true,
          "schedules": [
            {
              "days": [
                "MONDAY",
                "TUESDAY",
                "WEDNESDAY",
                "THURSDAY",
                "FRIDAY"
              ],
              "start": "23:00:00",
              "end": "07:00:00"
            }
          ],
          "departureTimers": [
            {
              "days": [
                "MONDAY",
                "TUESDAY",
                "WEDNESDAY",
                "THURSDAY",
                "FRIDAY"
              ],
              "time": "08:30:00"
            }
          ]
        },
        {
          "type": "LOCATION",
          "condition": {
            "latitude": 51.5014,
            "longitude": -0.1419,
            "name": "Home",
            "address": "123 Main St, London"
          },
          "isOEMOptimizationEnabled": true,
          "schedules": [
            {
              "days": [
                "MONDAY",
                "TUESDAY",
                "WEDNESDAY",
                "THURSDAY",
                "FRIDAY"
              ],
              "start": "22:00:00",
              "end": "06:00:00"
            }
          ],
          "departureTimers": [
            {
              "days": [
                "MONDAY",
                "TUESDAY",
                "WEDNESDAY",
                "THURSDAY",
                "FRIDAY"
              ],
              "time": "08:00:00"
            }
          ],
          "scheduleId": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
          "scheduleType": "DAILY"
        },
        {
          "type": "CHARGING_TYPE",
          "condition": {
            "chargingType": "DC"
          },
          "isOEMOptimizationEnabled": true,
          "schedules": [
            {
              "days": [
                "MONDAY",
                "TUESDAY",
                "WEDNESDAY",
                "THURSDAY",
                "FRIDAY"
              ],
              "start": "22:00:00",
              "end": "06:00:00"
            }
          ],
          "departureTimers": [
            {
              "days": [
                "MONDAY",
                "TUESDAY"
              ],
              "time": "08:00:00"
            }
          ]
        }
      ]
    }
    ```
  </Expandable>
</ParamField>

### ChargingConnectorType

<Badge color="green">GET</Badge> `/vehicles/{vehicleId}/signals/charge-chargingconnectortype`

Identifier for the type of charging connector/inlet equipped on the vehicle.

<ParamField path="body" type="object">
  <Expandable title="body properties">
    <ParamField path="value" type="string" required={false} />

    ```json Example theme={null}
    {
      "value": "J1772"
    }
    ```
  </Expandable>
</ParamField>

### DetailedChargingStatus

<Badge color="green">GET</Badge> `/vehicles/{vehicleId}/signals/charge-detailedchargingstatus`

String value that provides detailed information about the current state of the charging process.

<ParamField path="body" type="object">
  <Expandable title="body properties">
    <ParamField path="value" type="string" required={false} />

    ```json Example theme={null}
    {
      "value": "CHARGING"
    }
    ```
  </Expandable>
</ParamField>

### EnergyAdded

<Badge color="green">GET</Badge> `/vehicles/{vehicleId}/signals/charge-energyadded`

Cumulative amount of electrical energy delivered to the vehicle during the current or most recent charging session, measured in kilowatt-hours (kWh).

<ParamField path="body" type="object">
  <Expandable title="body properties">
    <ParamField path="unit" type="string" required={false} />

    <ParamField path="value" type="number" required={false} />

    ```json Example theme={null}
    {
      "value": 35.6,
      "unit": "kWh"
    }
    ```
  </Expandable>
</ParamField>

### FastChargerType

<Badge color="green">GET</Badge> `/vehicles/{vehicleId}/signals/charge-fastchargertype`

Identifier for the specific DC fast charging standard currently connected to the vehicle. Indicates the protocol being used for high-power charging

<ParamField path="body" type="object">
  <Expandable title="body properties">
    <ParamField path="value" type="string" required={false} />

    ```json Example theme={null}
    {
      "value": "CCS"
    }
    ```
  </Expandable>
</ParamField>

### IsCharging

<Badge color="green">GET</Badge> `/vehicles/{vehicleId}/signals/charge-ischarging`

Boolean indicator that shows whether the electric vehicle is actively receiving power from a charging station or outlet.

<ParamField path="body" type="object">
  <Expandable title="body properties">
    <ParamField path="value" type="boolean" required={false} />

    ```json Example theme={null}
    {
      "value": true
    }
    ```
  </Expandable>
</ParamField>

### IsChargingCableConnected

<Badge color="green">GET</Badge> `/vehicles/{vehicleId}/signals/charge-ischargingcableconnected`

Boolean indicator that shows whether a charging cable is physically connected to the vehicle's charging port.

<ParamField path="body" type="object">
  <Expandable title="body properties">
    <ParamField path="value" type="boolean" required={false} />

    ```json Example theme={null}
    {
      "value": true
    }
    ```
  </Expandable>
</ParamField>

### IsChargingCableLatched

<Badge color="green">GET</Badge> `/vehicles/{vehicleId}/signals/charge-ischargingcablelatched`

Boolean indicator that shows whether the charging cable is securely locked to the vehicle's charging port.

<ParamField path="body" type="object">
  <Expandable title="body properties">
    <ParamField path="value" type="boolean" required={false} />

    ```json Example theme={null}
    {
      "value": true
    }
    ```
  </Expandable>
</ParamField>

### IsChargingPortFlapOpen

<Badge color="green">GET</Badge> `/vehicles/{vehicleId}/signals/charge-ischargingportflapopen`

Boolean indicator that shows whether the vehicle's charging port access door or flap is currently open.

<ParamField path="body" type="object">
  <Expandable title="body properties">
    <ParamField path="value" type="boolean" required={false} />

    ```json Example theme={null}
    {
      "value": true
    }
    ```
  </Expandable>
</ParamField>

### IsFastChargerPresent

<Badge color="green">GET</Badge> `/vehicles/{vehicleId}/signals/charge-isfastchargerpresent`

Boolean indicator that shows whether the vehicle is connected to a DC fast charging station.

<ParamField path="body" type="object">
  <Expandable title="body properties">
    <ParamField path="value" type="boolean" required={false} />

    ```json Example theme={null}
    {
      "value": false
    }
    ```
  </Expandable>
</ParamField>

### TimeToComplete

<Badge color="green">GET</Badge> `/vehicles/{vehicleId}/signals/charge-timetocomplete`

Estimated time remaining until the charging session reaches the activeLimit in minutes.

<ParamField path="body" type="object">
  <Expandable title="body properties">
    <ParamField path="unit" type="string" required={false} />

    <ParamField path="value" type="number" required={false} />

    ```json Example theme={null}
    {
      "value": 100,
      "unit": "min"
    }
    ```
  </Expandable>
</ParamField>

### Voltage

<Badge color="green">GET</Badge> `/vehicles/{vehicleId}/signals/charge-voltage`

Current voltage level being supplied to the electric vehicle during a charging session, measured in volts.

<ParamField path="body" type="object">
  <Expandable title="body properties">
    <ParamField path="unit" type="string" required={false} />

    <ParamField path="value" type="number" required={false} />

    ```json Example theme={null}
    {
      "value": 240,
      "unit": "volts"
    }
    ```
  </Expandable>
</ParamField>

### Wattage

<Badge color="green">GET</Badge> `/vehicles/{vehicleId}/signals/charge-wattage`

Current power delivery rate to the electric vehicle during a charging session, measured in watts.

<ParamField path="body" type="object">
  <Expandable title="body properties">
    <ParamField path="unit" type="string" required={false} />

    <ParamField path="value" type="number" required={false} />

    ```json Example theme={null}
    {
      "value": 10.7,
      "unit": "watts"
    }
    ```
  </Expandable>
</ParamField>