Getting Started
Getting started with the MileIQ External API
The MileIQ External API is currently in alpha and available exclusively to MileIQ Teams customers on a request basis.
Welcome to the MileIQ External API
The MileIQ External API allows you to integrate MileIQ’s powerful mileage tracking capabilities into your own applications. This API provides access to valuable data from the MileIQ platform, enabling you to enhance your services with accurate mileage information.
Base URL
MileIQ’s External API is built on REST principles and is served over HTTPS. To ensure data privacy, unencrypted HTTP is not supported.
The Base URL for all API endpoints is:
Available Data
Through our API, you can access various types of data, including:
- Drive information
- Distance
- Duration
- Start and end location
- Vehicle details
- Custom location details
- Classification (Business, Personal)
- Purpose of trip
- Driver profile
- Vehicle details
Authentication
To use the MileIQ External API, you’ll need to authenticate your requests using a Bearer token provided by MileIQ. Make sure to include your API key in the header of each request.
Authentication to MileIQ’s External API is performed via the Authorization header with a Bearer token. To authenticate, you need to include the Authorization header with the word Bearer followed by your API key in your requests like so:
Request API Access
Apply for an API key to get started
Response Codes
The API returns standard HTTP response codes to indicate the success or failure of an API request. Here are a few examples:
| Code | Description |
|---|---|
200 | The request was successful. |
400 | The request was invalid or cannot be served. |
401 | The request requires user authentication. |
403 | The server understood the request, but refuses to authorize it. |
404 | The requested resource could not be found. |
429 | Too many requests. |
500 | The server encountered an unexpected condition which prevented it from fulfilling the request. |
Rate Limiting
Read more about rate limiting.