Device Definitions Endpoints

Developer Notes

As of 2024, Device Definitions are now stored in Tableland - a decentralized cloud database.

Base URLs

https://device-definitions-api.dimo.zone


Device Definitions Lookup

Get Device Definitions by Make Model Year

GET {baseUrl}/device-definitions

Retrieves a specific device definition by make, model, and year of the vehicle.

Query Parameters

NameTypeDescription

make*

String

Make of the vehicle.

model*

String

Model of the vehicle.

year*

Number

Year of the vehicle.

{
    "deviceDefinitionId": "26G4j1YDKZhFeCsn12MAlyU3Y2H",
    "external_id": "lexus/nx",
    "name": "2021 Lexus NX",
    "imageUrl": "https://i.fuelapi.com/31271b03ca0f439190a0b8c6f47bc448/29313/2/2/color_1280_001/MY2021/14512/14512_cc1280_001_4Y1.jpg",
    "source": "parkers",
    "hardware_template_id": "",
    "make": {
        "id": "2681cTRIYnN4uTGARvAu9BCPis7",
        "name": "Lexus",
        "logo_url": null,
        "oem_platform_name": "Lexus Enform",
        "tokenId": 69,
        "nameSlug": "lexus",
        "external_ids": {
            "edmunds": "200705856",
            "parkers": "lexus"
        },
        "externalIdsTyped": [
            {
                "vendor": "edmunds",
                "id": "200705856"
            },
            {
                "vendor": "parkers",
                "id": "lexus"
            }
        ],
        "metadata": null,
        "metadataTyped": null,
        "hardware_template_id": null,
        "created_at": "0001-01-01T00:00:00Z",
        "updated_at": "0001-01-01T00:00:00Z"
    },
    "type": {
        "type": "vehicle",
        "make": "Lexus",
        "model": "NX",
        "year": 2021,
        "subModels": null,
        "makeSlug": "lexus",
        "modelSlug": "nx"
    },
    "vehicleData": {},
    "metadata": "eyJ2ZWhpY2xlX2luZm8iOiB7Im1wZyI6ICIyNSIsICJtcGdfY2l0eSI6ICIyMiIsICJiYXNlX21zcnAiOiAiMzc2MTAiLCAiZnVlbF90eXBlIjogIkdhc29saW5lIiwgIndoZWVsYmFzZSI6ICIxMDUgV0IiLCAiZ2VuZXJhdGlvbiI6ICIxIiwgIm1wZ19oaWdod2F5IjogIjI4IiwgImRyaXZlbl93aGVlbHMiOiAiRldEIiwgIm51bWJlcl9vZl9kb29ycyI6ICI0IiwgInBvd2VydHJhaW5fdHlwZSI6ICJJQ0UiLCAibWFudWZhY3R1cmVyX2NvZGUiOiAiOTgyMCIsICJmdWVsX3RhbmtfY2FwYWNpdHlfZ2FsIjogIjE1LjkifX0=",
    "verified": true,
    "externalIds": [
        {
            "vendor": "parkers",
            "id": "lexus/nx"
        }
    ],
    "deviceIntegrations": [
        {
            "id": "22N2xaPOq2WW2gAHBHd0Ikn4Zob",
            "type": "API",
            "style": "Webhook",
            "vendor": "SmartCar",
            "region": "Americas",
            "features": [
                {
                    "featureKey": "<feature_key>",
                    "supportLevel": 0
                }
            ]
        },
        {
            "id": "27qftVRWQYpVDcO5DltO5Ojbjxk",
            "type": "Hardware",
            "style": "Addon",
            "vendor": "AutoPi",
            "region": "Americas",
            "features": [
                {
                    "featureKey": "<feature_key>",
                    "supportLevel": 0
                }
            ]
        },
        {
            "id": "27qftVRWQYpVDcO5DltO5Ojbjxk",
            "type": "Hardware",
            "style": "Addon",
            "vendor": "AutoPi",
            "region": "Europe",
            "features": [
                {
                    "featureKey": "<feature_key>",
                    "supportLevel": 0
                }
            ]
        }
    ],
    "compatibleIntegrations": [
        {
            "id": "22N2xaPOq2WW2gAHBHd0Ikn4Zob",
            "type": "API",
            "style": "Webhook",
            "vendor": "SmartCar",
            "region": "Americas",
            "features": [
                {
                    "featureKey": "<feature_key>",
                    "supportLevel": 0
                }
            ]
        },
        {
            "id": "27qftVRWQYpVDcO5DltO5Ojbjxk",
            "type": "Hardware",
            "style": "Addon",
            "vendor": "AutoPi",
            "region": "Americas",
            "features": [
                {
                    "featureKey": "<feature_key>",
                    "supportLevel": 0
                }
            ]
        },
        {
            "id": "27qftVRWQYpVDcO5DltO5Ojbjxk",
            "type": "Hardware",
            "style": "Addon",
            "vendor": "AutoPi",
            "region": "Europe",
            "features": [
                {
                    "featureKey": "<feature_key>",
                    "supportLevel": 0
                }
            ]
        }
    ],
    "deviceStyles": [],
    "deviceAttributes": [
        {
            "name": "<attribute_name>",
            "label": "",
            "description": "",
            "type": "",
            "required": false,
            "value": "<attribute_value>",
            "options": null
        }
    ]
}

Get Device Definitions by Device Definition ID

GET {baseUrl}/device-definitions/{deviceDefinitionId}

Retrieves a specific device definition by Device Definition ID.

Path Parameters

NameTypeDescription

deviceDefinitionId*

String

Device Definition ID

{
    "deviceDefinitionId": "26G4j1YDKZhFeCsn12MAlyU3Y2H",
    "external_id": "lexus/nx",
    "name": "2021 Lexus NX",
    "imageUrl": "https://i.fuelapi.com/31271b03ca0f439190a0b8c6f47bc448/29313/2/2/color_1280_001/MY2021/14512/14512_cc1280_001_4Y1.jpg",
    "source": "parkers",
    "hardware_template_id": "",
    "make": {
        "id": "2681cTRIYnN4uTGARvAu9BCPis7",
        "name": "Lexus",
        "logo_url": null,
        "oem_platform_name": "Lexus Enform",
        "tokenId": 69,
        "nameSlug": "lexus",
        "external_ids": {
            "edmunds": "200705856",
            "parkers": "lexus"
        },
        "externalIdsTyped": [
            {
                "vendor": "edmunds",
                "id": "200705856"
            },
            {
                "vendor": "parkers",
                "id": "lexus"
            }
        ],
        "metadata": null,
        "metadataTyped": null,
        "hardware_template_id": null,
        "created_at": "0001-01-01T00:00:00Z",
        "updated_at": "0001-01-01T00:00:00Z"
    },
    "type": {
        "type": "vehicle",
        "make": "Lexus",
        "model": "NX",
        "year": 2021,
        "subModels": null,
        "makeSlug": "lexus",
        "modelSlug": "nx"
    },
    "vehicleData": {},
    "metadata": "eyJ2ZWhpY2xlX2luZm8iOiB7Im1wZyI6ICIyNSIsICJtcGdfY2l0eSI6ICIyMiIsICJiYXNlX21zcnAiOiAiMzc2MTAiLCAiZnVlbF90eXBlIjogIkdhc29saW5lIiwgIndoZWVsYmFzZSI6ICIxMDUgV0IiLCAiZ2VuZXJhdGlvbiI6ICIxIiwgIm1wZ19oaWdod2F5IjogIjI4IiwgImRyaXZlbl93aGVlbHMiOiAiRldEIiwgIm51bWJlcl9vZl9kb29ycyI6ICI0IiwgInBvd2VydHJhaW5fdHlwZSI6ICJJQ0UiLCAibWFudWZhY3R1cmVyX2NvZGUiOiAiOTgyMCIsICJmdWVsX3RhbmtfY2FwYWNpdHlfZ2FsIjogIjE1LjkifX0=",
    "verified": true,
    "externalIds": [
        {
            "vendor": "parkers",
            "id": "lexus/nx"
        }
    ],
    "deviceIntegrations": [
        {
            "id": "22N2xaPOq2WW2gAHBHd0Ikn4Zob",
            "type": "API",
            "style": "Webhook",
            "vendor": "SmartCar",
            "region": "Americas",
            "features": [
                {
                    "featureKey": "<feature_key>",
                    "supportLevel": 0
                }
            ]
        },
        {
            "id": "27qftVRWQYpVDcO5DltO5Ojbjxk",
            "type": "Hardware",
            "style": "Addon",
            "vendor": "AutoPi",
            "region": "Americas",
            "features": [
                {
                    "featureKey": "<feature_key>",
                    "supportLevel": 0
                }
            ]
        },
        {
            "id": "27qftVRWQYpVDcO5DltO5Ojbjxk",
            "type": "Hardware",
            "style": "Addon",
            "vendor": "AutoPi",
            "region": "Europe",
            "features": [
                {
                    "featureKey": "<feature_key>",
                    "supportLevel": 0
                }
            ]
        }
    ],
    "compatibleIntegrations": [
        {
            "id": "22N2xaPOq2WW2gAHBHd0Ikn4Zob",
            "type": "API",
            "style": "Webhook",
            "vendor": "SmartCar",
            "region": "Americas",
            "features": [
                {
                    "featureKey": "<feature_key>",
                    "supportLevel": 0
                }
            ]
        },
        {
            "id": "27qftVRWQYpVDcO5DltO5Ojbjxk",
            "type": "Hardware",
            "style": "Addon",
            "vendor": "AutoPi",
            "region": "Americas",
            "features": [
                {
                    "featureKey": "<feature_key>",
                    "supportLevel": 0
                }
            ]
        },
        {
            "id": "27qftVRWQYpVDcO5DltO5Ojbjxk",
            "type": "Hardware",
            "style": "Addon",
            "vendor": "AutoPi",
            "region": "Europe",
            "features": [
                {
                    "featureKey": "<feature_key>",
                    "supportLevel": 0
                }
            ]
        }
    ],
    "deviceStyles": [],
    "deviceAttributes": [
        {
            "name": "<attribute_name>",
            "label": "",
            "description": "",
            "type": "",
            "required": false,
            "value": "<attribute_value>",
            "options": null
        }
    ]
}

Get Device Definitions by Search Filters

GET {baseUrl}/device-definitions/search

Retrieves a list of device definitions by search filters.

Query Parameters

NameTypeDescription

query*

String

Query filter

makeSlug

String

Make of the vehicle (e.g. audi, lexus, etc)

modelSlug

String

Model of the vehicle (e.g. Tacoma, Accord, etc)

year

Number

Year of the vehicle (e.g. 2024)

page

Number

Page number (for pagination, defaults to the 1st page)

pageSize

Number

Page size (to specify the items to show in one page)

{
  "deviceDefinitions": [
    {
      "id": "honda_civic_2024",
      "legacy_ksuid": "2cHBx0ue53KWvLwRIKXe37JM3Xc",
      "name": "2024 Honda Civic",
      "make": "Honda",
      "model": "Civic",
      "year": 2024,
      "imageUrl": ""
    },
    {
      "id": "honda_civic_2021",
      "legacy_ksuid": "22TEPrcGSEErjX1iZWYWS7rqiKW",
      "name": "2021 Honda Civic",
      "make": "Honda",
      "model": "Civic",
      "year": 2021,
      "imageUrl": ""
    },
    {
      "id": "honda_civic_2020",
      "legacy_ksuid": "22TEVCglLhLSvc1CTX1cFf1GEMn",
      "name": "2020 Honda Civic",
      "make": "Honda",
      "model": "Civic",
      "year": 2020,
      "imageUrl": ""
    },
    {
      "id": "honda_civic_2009",
      "legacy_ksuid": "22R03BKq72hyK7qJyeCUvS3Bm2a",
      "name": "2009 Honda Civic",
      "make": "Honda",
      "model": "Civic",
      "year": 2009,
      "imageUrl": ""
    },
    {
      "id": "honda_civic_2008",
      "legacy_ksuid": "22TFcRBccsx0aSTVJluPQwCyk9c",
      "name": "2008 Honda Civic",
      "make": "Honda",
      "model": "Civic",
      "year": 2008,
      "imageUrl": ""
    },
    {
      "id": "honda_civic_2005",
      "legacy_ksuid": "22TFvTjKWe0cJNxtY22AcyDFuaP",
      "name": "2005 Honda Civic",
      "make": "Honda",
      "model": "Civic",
      "year": 2005,
      "imageUrl": ""
    },
    {
      "id": "honda_civic_2004",
      "legacy_ksuid": "22R0BSSPfjjz7J5IEdYmscG91tP",
      "name": "2004 Honda Civic",
      "make": "Honda",
      "model": "Civic",
      "year": 2004,
      "imageUrl": ""
    },
    {
      "id": "honda_civic_2002",
      "legacy_ksuid": "22TEWBxruiCKA3aHz47IEaHGBJp",
      "name": "2002 Honda Civic",
      "make": "Honda",
      "model": "Civic",
      "year": 2002,
      "imageUrl": ""
    },
    {
      "id": "honda_civic_2000",
      "legacy_ksuid": "22TElboKOrhpXK5vKhsrMNUnfkm",
      "name": "2000 Honda Civic",
      "make": "Honda",
      "model": "Civic",
      "year": 2000,
      "imageUrl": ""
    }
  ],
  "facets": {
    "makes": [
      {
        "name": "Honda",
        "count": 9
      }
    ],
    "models": [
      {
        "name": "Civic",
        "count": 9
      }
    ],
    "years": [
      {
        "name": "2024",
        "count": 1
      },
      {
        "name": "2021",
        "count": 1
      },
      {
        "name": "2020",
        "count": 1
      },
      {
        "name": "2009",
        "count": 1
      },
      {
        "name": "2008",
        "count": 1
      },
      {
        "name": "2005",
        "count": 1
      },
      {
        "name": "2004",
        "count": 1
      },
      {
        "name": "2002",
        "count": 1
      },
      {
        "name": "2000",
        "count": 1
      }
    ]
  },
  "pagination": {
    "page": 1,
    "pageSize": 30,
    "totalItems": 9,
    "totalPages": 1
  }
}

Device Makes Lookup

List All Device Makes

GET {baseUrl}/device-makes

Retrieves a list of all device makes.

This is a long list, so I'm not going to display it for you...


Device Types Lookup

Get Device Types by ID

GET {baseUrl}/device-types/{deviceTypeId}

Retrieves a specific vehicle type by looking up the device identifier. This device identifier is a user-friendly name to the type of devices, such as vehicle, aftermarket_device

Path Parameters

NameTypeDescription

deviceTypeId*

String

Device Type ID

{
    // Response
}

Swagger Doc

Last updated