GET
/
vehicles
/
{id}
/
battery
/
nominal_capacity

/capacity is no longer maintained for US and Europe.

Please continue to use the old endpoint if you need this data for Canadian based vehicles as we complete the transition.

​
Permission

read_battery

​
Request

Path

​
id
string
required

The vehicle ID of the vehicle you are making a request to.

​
Response

​
availableCapacities
[capacities Object]

An array of capacites Objects.

​
capacity
Object | null
​
url
string | null

A URL that will launch the flow for a vehicle owner to specify the correct battery capacity for a vehicle. Please to ensure you append a redirect URI for us to send a response to once the user exits the flow.

Please see this article on how to handle the URL callback.

​
Case 1: Smartcar has determined the battery capacity

Single capacity
{
    "availableCapacities": [
        {
            "capacity" :  70.9,
            "description" : null  
        }
    ],
    "capacity": { 
        "nominal" :  70.9,
        "source": "SMARTCAR" 
    },
    "url" : null
}

​
Case 2: Unable to determine the battery capacity

Multiple capacites
{
    "availableCapacities": [
        {
            "capacity" :  70.9,
            "description" : null 
        },
        {
            "capacity" :  80.9,
            "description" : null 
        },
        {
            "capacity" :  90.9,
            "description" : "BEV:Extended Range" 
        }
    ],
    "capacity": null,
    "url" : "https://connect.smartcar.com/battery-capacity?vehicle_id=36ab27d0-fd9d-4455-823a-ce30af709ffc&client_id=8229df9f-91a0-4ff0-a1ae-a1f38ee24d07&token=90abecb6-e7ab-4b85-864a-e1c8bf67f2ad&response_type=vehicle_id&redirect_uri="
}

​
Case 3: User selected battery capacity

Multiple capacites
{
    "availableCapacities": [
        {
            "capacity" :  70.9,
            "description" : null 
        },
        {
            "capacity" :  80.9,
            "description" : null 
        },
        {
            "capacity" :  90.9,
            "description" : "BEV:Extended Range" 
        }
    ],
    "capacity": { 
	    "nominal" :  80.9,
	    "source": "USER_SELECTED" 
    },
    "url" : "https://connect.smartcar.com/battery-capacity?vehicle_id=36ab27d0-fd9d-4455-823a-ce30af709ffc&client_id=8229df9f-91a0-4ff0-a1ae-a1f38ee24d07&token=90abecb6-e7ab-4b85-864a-e1c8bf67f2ad&response_type=vehicle_id&redirect_uri="
}

Was this page helpful?

BatchBattery Level