API Documentation: Vehicle VIN numbers
GET /api/vin-numbers/:usdot
This endpoint retrieves a list of VIN (Vehicle Identification Numbers) associated with a specified USDOT number.
URL
https://app.onroadnetworks.com/api/vin-numbers/:usdot
Parameters:
- :usdot (required): The USDOT number for which VIN numbers are being requested.
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/vin-numbers/:usdot' --header 'x-api-key: ${key}' --header 'provider-token: ${token}'
Response format
JSON
[ "1HGCM82633A004352", "1FAFP4041WF287392", ... ]
Generating API Key
API keys can be generated by following the steps below:
- Click on your profile avatar in the top right corner
- Go to the “Settings” page by clicking on the button in the menu that appears
- Click on the “API Keys” tab
- Click on the “Add key” button and create a new key
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/vin-numbers/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 only VIN numbers; no additional vehicle details are provided in this endpoint.
- This endpoint is useful for quick checks or initial data fetching before deeper vehicle-specific queries.