Device Data API Endpoints
Last updated
Was this helpful?
Last updated
Was this helpful?
This is a deprecated API
https://device-data-api.dimo.zone
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.
GET
/v1/user/device-data/{userDeviceId}/status
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.
userDeviceId*
String
Authorization*
String
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.
userDeviceId*
String
startDate
String
endDate
String
Authorization*
String
userDeviceId*
String
Authorization*
String
DIMO Warning
This endpoint will be deprecated for non-J1939 developers, please use instead. For J1939 protocol developers, please reach out to the DIMO team to retain access to this API.
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.
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.
Authorization*
String
Retrieves the Vehicle Raw Status by the Vehicle identified with the provided Vehicle ID.
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.
Authorization*
String
Retrieves the Vehicle History by the Vehicle identified with the provided Vehicle ID.
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.
startDate
String
endDate
String
Authorization*
String
Retrieves a daily summary of distances driven (in kilometers) tracked on the user device.
userDeviceId*
String
time_zone*
String
Authorization*
String
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.
userDeviceId*
String
Authorization*
String
For userDeviceId
, please refer to the User Device entity under .
Bearer authentication using the access_token
generated from the .
GET
/v1/user/device-data/{userDeviceId}/historical
This endpoint returns the historical data of a given time period, the data volume is very large so please handle with care.
For userDeviceId
, please refer to the User Device entity under .
Starting timestamp in the (YYYY-MM-DD). Defaults to 2 weeks ago if not specified.
Ending timestamp in the (YYYY-MM-DD). Defaults to today if not specified.
Bearer authentication using the access_token
generated from the .
POST
/v1/user/device-data/{userDeviceId}/export/json/email
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 .
For userDeviceId
, please refer to the User Device entity under .
Bearer authentication using the access_token
generated from the .
GET
/v1/vehicle/{tokenId}/status
Bearer authentication using the token
generated from the .
GET
/v1/vehicle/{tokenId}/status-raw
Bearer authentication using the token
generated from the .
GET
/v1/vehicle/{tokenId}/history
This endpoint returns the historical data of a given time period, the data volume is very large so please handle with care.
Starting timestamp in the (YYYY-MM-DD). Defaults to 2 weeks ago if not specified.
Ending timestamp in the (YYYY-MM-DD). Defaults to today if not specified.
Bearer authentication using the token
generated from the .
GET
/v1/user/device-data/{userDeviceId}/daily-distance
For userDeviceId
, please refer to the User Device entity under .
Timezone in format. Common examples are America/Los_Angeles
and America/New_York
; etcetera source files (Etc/GMT-0
) is also supported.
Bearer authentication using the access_token
generated from the .
GET
/v1/user/device-data/{userDeviceId}/distance-driven
For userDeviceId
, please refer to the User Device entity under .
Bearer authentication using the access_token
generated from the .