> ## 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.

# TractionBattery Signals

### IsHeaterActive

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

A boolean flag indicating whether the high voltage battery's heating system is currently operating.

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

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

### MaxRangeChargeCounter

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

A counter tracking the number of times the vehicle has been charged to its maximum range capacity.

<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": 42
    }
    ```
  </Expandable>
</ParamField>

### NominalCapacity

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

An object containing the gross battery capacity and a list of multiple available gross capacity configurations for the high voltage battery.

<ParamField path="body" type="object">
  <Expandable title="body properties">
    <ParamField path="source" type="string" required={false}>
      Identifies the origin or method used to determine the battery's gross capacity.

      **Possible values:** `SMARTCAR`, `USER_SELECTED`
    </ParamField>

    <ParamField path="capacity" type="number" required={false}>
      The total gross energy storage capacity of the high voltage battery, typically measured in kilowatt-hours (kWh).
    </ParamField>

    <ParamField path="availableCapacities" type="array" required={false}>
      An array containing multiple available gross capacity configurations for the high voltage battery.
    </ParamField>

    <Expandable title="Array item properties">
      <ParamField path="capacity" type="number" required={false}>
        The total gross energy storage capacity of the high voltage battery, typically measured in kilowatt-hours (kWh).
      </ParamField>

      <ParamField path="description" type="string" required={false}>
        A description of the specific battery capacity configuration, usually the trim of the vehicle.
      </ParamField>
    </Expandable>

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

    ```json Example theme={null}
    {
      "source": "SMARTCAR",
      "capacity": 75,
      "availableCapacities": [
        {
          "capacity": 55,
          "description": "Standard Range"
        },
        {
          "capacity": 75,
          "description": "Long Range"
        },
        {
          "capacity": 100,
          "description": "Performance"
        }
      ],
      "unit": "kWh"
    }
    ```
  </Expandable>
</ParamField>

### Range

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

Returns the most accurate real world estimate that is available. Estimated > Ideal > Rated.

<ParamField path="body" type="object">
  <Expandable title="body properties">
    <ParamField path="type" type="string" required={true}>
      **Possible values:** `DEFAULT`
    </ParamField>

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

    <ParamField path="additionalValues" type="array" required={true} />

    <Expandable title="Array item properties">
      <ParamField path="type" type="string" required={true}>
        **Possible values:** `IDEAL_CONDITIONS`, `ESTIMATED`, `RATED`
      </ParamField>

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

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

    ```json Example theme={null}
    {
      "value": 123.45,
      "type": "DEFAULT",
      "additionalValues": [
        {
          "type": "IDEAL_CONDITIONS",
          "value": 150
        },
        {
          "type": "ESTIMATED",
          "value": 140.75
        },
        {
          "type": "RATED",
          "value": 130.25
        }
      ],
      "unit": "km"
    }
    ```
  </Expandable>
</ParamField>

### StateOfCharge

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

The current charge level of the high voltage battery, expressed as a percentage (0 - 100).

<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": 78,
      "unit": "percent"
    }
    ```
  </Expandable>
</ParamField>