The following endpoints defers back to using the Web3 access token given that API users are interacting with user devices under their personal possession. No additional permission is needed.
Retrieves vehicle-related status data from the user device. Regardless of connection type, this attempts to fetch information from the devices that the API user owns.
Path Parameters
Name
Type
Description
userDeviceId*
String
For userDeviceId, please refer to the User Device entity under Devices API.
Headers
Name
Type
Description
Authorization*
String
Bearer authentication using the access_token generated from the Web3 challenge.
Retrieves vehicle-related history data from the user device. Regardless of connection type, this attempts to fetch information from the devices that the API user owns.
⚠️ This endpoint returns the historical data of a given time period, the data volume is very large so please handle with care.
Path Parameters
Name
Type
Description
userDeviceId*
String
For userDeviceId, please refer to the User Device entity under Devices API.
Query Parameters
Name
Type
Description
startDate
String
Starting timestamp in the ISO8601 format (YYYY-MM-DD). Defaults to 2 weeks ago if not specified.
endDate
String
Ending timestamp in the ISO8601 format (YYYY-MM-DD). Defaults to today if not specified.
Headers
Name
Type
Description
Authorization*
String
Bearer authentication using the access_token generated from the Web3 challenge.
Enqueues a data export job for the user device identified by the userDeviceId. A link to download a JSON file of signals will be emailed to the address on file for the API user. This email is defined under the email.address if you look up the authenticated API user.
Path Parameters
Name
Type
Description
userDeviceId*
String
For userDeviceId, please refer to the User Device entity under Devices API.
Headers
Name
Type
Description
Authorization*
String
Bearer authentication using the access_token generated from the Web3 challenge.
{"status":"success","userId":"CioweGY5RDI2MzIzQWI0OTE33UE2ZDU3QzI2NTE1QjAxRGUwMTg1NTM3ODcSBHdlYjE","userDeviceId":"2UZb3drEbIkLdMFcvEFahjrX3X6","message":"your request has been received; data will be sent to the email associated with your account"}
Vehicle Data🔏
DIMO Warning
This endpoint will be deprecated for non-J1939 developers, please use Telemetry API References instead. For J1939 protocol developers, please reach out to the DIMO team to retain access to this API.
Developer Notes
To access the Vehicle data under the Device Data API, a token exchange transaction is required to obtain a 2nd JWT to get permission to access a given vehicle. Please check Token Exchange API prior to using this endpoint.
Retrieves the Vehicle Status by the Vehicle identified with the provided Vehicle ID.
Path Parameters
Name
Type
Description
tokenId*
String
Vehicle token ID, this is the token ID of your vehicle NFT. A prerequisite is to obtain a token that is permitted to access trips data for this specific vehicle.
Headers
Name
Type
Description
Authorization*
String
Bearer authentication using the token generated from the Token Exchange.
Retrieves the Vehicle Raw Status by the Vehicle identified with the provided Vehicle ID.
Path Parameters
Name
Type
Description
tokenId*
String
Vehicle token ID, this is the token ID of your vehicle NFT. A prerequisite is to obtain a token that is permitted to access trips data for this specific vehicle.
Headers
Name
Type
Description
Authorization*
String
Bearer authentication using the token generated from the Token Exchange.
{"vin": {"value":"JTJGARBZ0M5023425","source":"dimo/integration/22N2xaPOq2WW2gAHBHd0Ikn4Zob","timestamp":"2024-01-25T21:51:38Z" },"make": {"value":"LEXUS","source":"dimo/integration/22N2xaPOq2WW2gAHBHd0Ikn4Zob","timestamp":"2024-01-25T21:51:38Z" },"year": {"value":2021,"source":"dimo/integration/22N2xaPOq2WW2gAHBHd0Ikn4Zob","timestamp":"2024-01-25T21:51:38Z" },"model": {"value":"NX 300 5-DOOR SUV 4X2","source":"dimo/integration/22N2xaPOq2WW2gAHBHd0Ikn4Zob","timestamp":"2024-01-25T21:51:38Z" },"errors": {"value": [ {"type":"odometer","errorCode":502,"errorType":"UPSTREAM","resolution": {"type":"RETRY_LATER" }, "description": "Smartcar received an error from an upstream source. Please retry your request at a later time."
}, {"type":"tires/pressure","errorCode":502,"errorType":"UPSTREAM","resolution": {"type":"RETRY_LATER" }, "description": "Smartcar received an error from an upstream source. Please retry your request at a later time."
}, {"type":"fuel","errorCode":502,"errorType":"UPSTREAM","resolution": {"type":"RETRY_LATER" }, "description": "Smartcar received an error from an upstream source. Please retry your request at a later time."
}, {"type":"location","errorCode":502,"errorType":"UPSTREAM","resolution": {"type":"RETRY_LATER" }, "description": "Smartcar received an error from an upstream source. Please retry your request at a later time."
} ],"source":"dimo/integration/22N2xaPOq2WW2gAHBHd0Ikn4Zob","timestamp":"2024-01-25T21:51:38Z" },"timestamp": {"value":"2024-01-25T21:51:38.314435345Z","source":"dimo/integration/22N2xaPOq2WW2gAHBHd0Ikn4Zob","timestamp":"2024-01-25T21:51:38Z" },"vehicleId": {"value":"609324ff-c83d-419d-b240-f1fd98487e47","source":"dimo/integration/22N2xaPOq2WW2gAHBHd0Ikn4Zob","timestamp":"2024-01-25T21:51:38Z" }}
Retrieves the Vehicle History by the Vehicle identified with the provided Vehicle ID.
⚠️ This endpoint returns the historical data of a given time period, the data volume is very large so please handle with care.
Path Parameters
Name
Type
Description
tokenId*
String
Vehicle token ID, this is the token ID of your vehicle NFT. A prerequisite is to obtain a token that is permitted to access trips data for this specific vehicle.
Query Parameters
Name
Type
Description
startDate
String
Starting timestamp in the ISO8601 format (YYYY-MM-DD). Defaults to 2 weeks ago if not specified.
endDate
String
Ending timestamp in the ISO8601 format (YYYY-MM-DD). Defaults to today if not specified.
Headers
Name
Type
Description
Authorization*
String
Bearer authentication using the token generated from the Token Exchange.
Retrieves a total distance driven (in kilometers) tracked on the user device since connection was established. Returns 0 if no odometer data was ever received.
Path Parameters
Name
Type
Description
userDeviceId*
String
For userDeviceId, please refer to the User Device entity under Devices API.
Headers
Name
Type
Description
Authorization*
String
Bearer authentication using the access_token generated from the Web3 challenge.