curl --request GET \
--url 'https://api.smartcar.com/v2.0/compatibility/matrix?region=US&type=BEV&make=tesla&scope=read_battery%20read_charge' \
--header 'Authorization: Basic bXktY2xpZW50LWlkOm15LWNsaWVudC1zZWNyZXQ='
const response = await fetch('https://api.smartcar.com/v2.0/compatibility/matrix?region=US&type=BEV&make=tesla&scope=read_battery%20read_charge', {
method: 'GET',
headers: {
'Authorization': 'Basic bXktY2xpZW50LWlkOm15LWNsaWVudC1zZWNyZXQ='
}
});
const data = await response.json();
import requests
url = "https://api.smartcar.com/v2.0/compatibility/matrix"
params = {
"region": "US",
"type": "BEV",
"make": "tesla",
"scope": "read_battery read_charge"
}
headers = {
"Authorization": "Basic bXktY2xpZW50LWlkOm15LWNsaWVudC1zZWNyZXQ="
}
response = requests.get(url, params=params, headers=headers)
data = response.json()
{
"NISSAN": [
{
"model": "LEAF",
"startYear": 2018,
"endYear": 2022,
"type": "BEV",
"endpoints": [
"EV battery",
"EV charging status",
"Location",
"Lock & unlock",
"Odometer"
],
"permissions": [
"read_battery",
"read_charge",
"read_location",
"control_security",
"read_odometer"
]
}
],
"TESLA": [
{
"model": "3",
"startYear": 2017,
"endYear": 2023,
"type": "BEV",
"endpoints": [
"EV battery",
"EV charging status",
"EV start & stop charge",
"Location",
"Lock & unlock",
"Odometer",
"Tire pressure"
],
"permissions": [
"read_battery",
"read_charge",
"control_charge",
"read_location",
"control_security",
"read_odometer",
"read_tires"
]
}
]
}
Compatibility API (Legacy)
By Region and Make
Compatibility will vary by model, year, and trim. This API is for reference purposes only and it showcases vehicle makes and models that may be compatible with Smartcar and it does not guarantee that a specific vehicle will be compatible.
GET
/
v2.0
/
compatibility
/
matrix
curl --request GET \
--url 'https://api.smartcar.com/v2.0/compatibility/matrix?region=US&type=BEV&make=tesla&scope=read_battery%20read_charge' \
--header 'Authorization: Basic bXktY2xpZW50LWlkOm15LWNsaWVudC1zZWNyZXQ='
const response = await fetch('https://api.smartcar.com/v2.0/compatibility/matrix?region=US&type=BEV&make=tesla&scope=read_battery%20read_charge', {
method: 'GET',
headers: {
'Authorization': 'Basic bXktY2xpZW50LWlkOm15LWNsaWVudC1zZWNyZXQ='
}
});
const data = await response.json();
import requests
url = "https://api.smartcar.com/v2.0/compatibility/matrix"
params = {
"region": "US",
"type": "BEV",
"make": "tesla",
"scope": "read_battery read_charge"
}
headers = {
"Authorization": "Basic bXktY2xpZW50LWlkOm15LWNsaWVudC1zZWNyZXQ="
}
response = requests.get(url, params=params, headers=headers)
data = response.json()
{
"NISSAN": [
{
"model": "LEAF",
"startYear": 2018,
"endYear": 2022,
"type": "BEV",
"endpoints": [
"EV battery",
"EV charging status",
"Location",
"Lock & unlock",
"Odometer"
],
"permissions": [
"read_battery",
"read_charge",
"read_location",
"control_security",
"read_odometer"
]
}
],
"TESLA": [
{
"model": "3",
"startYear": 2017,
"endYear": 2023,
"type": "BEV",
"endpoints": [
"EV battery",
"EV charging status",
"EV start & stop charge",
"Location",
"Lock & unlock",
"Odometer",
"Tire pressure"
],
"permissions": [
"read_battery",
"read_charge",
"control_charge",
"read_location",
"control_security",
"read_odometer",
"read_tires"
]
}
]
}
This endpoint is deprecated. Please use the new Compatible Vehicles page for up-to-date, signal-based compatibility data that is dynamically updated from the Smartcar platform.
Request
Headersstring
default:"Basic "
required
The HTTP Authorization header using the Basic authentication scheme.To construct the Authorization header value:
- Join your
client_idandclient_secretwith a single colon (:). - Base64-encode the resulting string:
base64({client_id}:{client_secret}) - Prepend
Basic(with a trailing space) to the encoded string.
Basic bXktY2xpZW50LWlkOm15LWNsaWVudC1zZWNyZXQ=string
required
One of the following regions:
US, CA or EUROPEstring
A space-separated list of makes. This field is optional. If no make is specified, all makes will be returned.
string
A space-separated list of permissions.
Queries for all permissions if none are specified.
curl --request GET \
--url 'https://api.smartcar.com/v2.0/compatibility/matrix?region=US&type=BEV&make=tesla&scope=read_battery%20read_charge' \
--header 'Authorization: Basic bXktY2xpZW50LWlkOm15LWNsaWVudC1zZWNyZXQ='
const response = await fetch('https://api.smartcar.com/v2.0/compatibility/matrix?region=US&type=BEV&make=tesla&scope=read_battery%20read_charge', {
method: 'GET',
headers: {
'Authorization': 'Basic bXktY2xpZW50LWlkOm15LWNsaWVudC1zZWNyZXQ='
}
});
const data = await response.json();
import requests
url = "https://api.smartcar.com/v2.0/compatibility/matrix"
params = {
"region": "US",
"type": "BEV",
"make": "tesla",
"scope": "read_battery read_charge"
}
headers = {
"Authorization": "Basic bXktY2xpZW50LWlkOm15LWNsaWVudC1zZWNyZXQ="
}
response = requests.get(url, params=params, headers=headers)
data = response.json()
Response
array
An array of models supported for the given
make.Show make
Show make
string
model for the given make.number
The earliest model year supported by Smartcar.
number
The latest model year supported by Smartcar.
array
An array of endpoints supported for the given
model.array
An array of
permissions supported for the given model. {
"NISSAN": [
{
"model": "LEAF",
"startYear": 2018,
"endYear": 2022,
"type": "BEV",
"endpoints": [
"EV battery",
"EV charging status",
"Location",
"Lock & unlock",
"Odometer"
],
"permissions": [
"read_battery",
"read_charge",
"read_location",
"control_security",
"read_odometer"
]
}
],
"TESLA": [
{
"model": "3",
"startYear": 2017,
"endYear": 2023,
"type": "BEV",
"endpoints": [
"EV battery",
"EV charging status",
"EV start & stop charge",
"Location",
"Lock & unlock",
"Odometer",
"Tire pressure"
],
"permissions": [
"read_battery",
"read_charge",
"control_charge",
"read_location",
"control_security",
"read_odometer",
"read_tires"
]
}
]
}
Was this page helpful?