Trips API

Base URLs

Production

https://trips-api.dimo.zone

---

Developer Notes

To access the Trips API, a token exchange transaction is required to obtain a 2nd JWT to get permission to access the vehicle's trip. Please check Token Exchange API prior to using this endpoint.

Getting a Trips History

List Vehicle Trips by Vehicle Token ID

GET {baseUrl}/v1/vehicle/{tokenId}/trips

Retrieves a list of trips taken 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	Vehicle JWT in Bearer Authentication format.

200: Success

{
    "trips": [
        {
            "id": "2hyZ4PrT9NNTLJXXRufpPFUPUxn",
            "start": {
                "time": "2024-06-16T20:01:25.397535Z",
                "location": {
                    "latitude": 36.157856,
                    "longitude": -115.334557
                },
                "estimatedLocation": {
                    "latitude": 36.15789,
                    "longitude": -115.334572
                }
            },
            "end": {
                "time": "2024-06-16T20:08:55.426886Z",
                "location": {
                    "latitude": 36.189941,
                    "longitude": -115.35775
                }
            },
            "droppedData": false
        }
    ],
    "totalPages": 5,
    "currentPage": 1
}

401: Unauthorized

{
    "code": 401,
    "message": "Invalid JWT."
}

Get Trips: Data SDK Function Calls

TypeScript

await dimo.trips.list({
    vehicleJwt, 
    tokenId
});

Python

dimo.trips.trips(vehicle_jwt, token_id)

C#

await dimoClient.TripsService.ListTripsByTokenIdAsync(
    authToken,
    tokenId
);

Entity Types

Trips

Trips are defined as the journeys between two waypoints. The trip entity stores the start time and the end time of each journey.