GET

/v2.0/compatibility/matrix

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

Authorizationrequired
string

HTTP Basic Auth header containing the client_id and client_secret. The header is formed by concatenating the word “Basic”, a space, and a base64-encoded string consisting of the client_id, a colon :, and the client_secret.

Query

regionrequired
string

One of the following regions: US, CA or EUROPE

type
string

Queires for all engine types if none are specified.

make
string

A space-separated list of makes. Valid makes for a given region can be found in the makes section.

scope
string

A space-separated list of permissions. Queries for all permissions if none are specified.

curl 'https://api.smartcar.com/v2.0/compatibility/matrix?region={region}&make={makes}&type={type}&scope={permissions}' \
  -X GET \
  -H 'Authorization: Basic base64({client_id}:{client_secret})' \

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"
        ]
      }
    ]
  }