Skip to main content
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='

  {
    "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"
        ]
      }
    ]
  }
The Compatibility API is an Enterprise feature. Please contact us to upgrade your plan.
Compatibility by region and make allows developers to query the latest version of our Compatibility Matrix based on region, engine type, make, and permission.

​
Request

Headers
​
Authorization
string
default:"Basic "
required
The HTTP Authorization header using the Basic authentication scheme.To construct the Authorization header value:
  1. Join your client_id and client_secret with a single colon (:).
  2. Base64-encode the resulting string: base64({client_id}:{client_secret})
  3. Prepend Basic (with a trailing space) to the encoded string.
Your final authorization header value should look like this:Basic bXktY2xpZW50LWlkOm15LWNsaWVudC1zZWNyZXQ=
Query
​
region
string
required
One of the following regions: US, CA or EUROPE
​
type
string
Queries for all engine types if none are specified.
​
make
string
A space-separated list of makes. This field is optional. If no make is specified, all makes will be returned.
​
scope
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='

​
Response

​
make
array
An array of models supported for the given make.
  {
    "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"
        ]
      }
    ]
  }