API Documentation: Vehicles Tracking

GET /api/units/:usdot

This endpoint retrieves live tracking details for vehicles in our network. It provides information such as vehicle location, unit identifier, VIN, and more.

URL

https://app.onroadnetworks.com/api/units/:usdot

Parameters:

  • :usdot (required): The USDOT number associated with the units.

Authentication

To access this endpoint, the following headers must be included in the request:

Key:x-api-key
Value:API key value
Key:provider-token
Value:Provider token value

Example

cURL
curl --location --request GET 'https://app.onroadnetworks.com/api/units/:usdot' --header 'x-api-key: ${key}' --header 'provider-token: ${token}'

Response format

JSON
{
  "units": [{
    	"truckNumber": "string",
    	"vin": "string",
    	"coordinates": { "lat": 0.0, "lng": 0.0 },
    	"timestamp": "string date"
  		}, 
  		{...},
  		{...}]
}

Generating API Key

API keys can be generated by following the steps below:

  1. Click on your profile avatar in the top right corner
  2. Go to the “Settings” page by clicking on the button in the menu that appears
  3. Click on the “API Keys” tab
  4. Click on the “Add key” button and create a new key
Step №1
First step
Step №2
Second step
Step №3
Third step
Step №4
Fourth step

Test Data

Endpoint:https://app.onroadnetworks.com/api/units/:usdot
USDOT:0
x-api-key:2b2y38VUi9AWSSUQRn5GD8eKLuKFlORBV7rk-8dCmFTAonRoadELD
provider-token:1R8xFqCfchWVnjjQonRoadELD
cURL
curl --location --request GET 'https://app.onroadnetworks.com/api/units/0' --header 'x-api-key: 2b2y38VUi9AWSSUQRn5GD8eKLuKFlORBV7rk-8dCmFTAonRoadELD' --header 'provider-token: 1R8xFqCfchWVnjjQonRoadELD'

Notes

  • Ensure that the API key and provider token are kept secure and not exposed in client-side code.
  • The response includes all units currently active for the given USDOT number; if no units are active, the “units“ array will be empty.
  • All timestamps are in ISO 8601 format.