Standard API

Getting Started

  • These APIs accept JSON in the request body.

  • They return JSON in the response body.

General Response Structure

{
  "status": "SUCCESS|FAILURE",
  "data": { "<data>" },
  "err": "<Error-code>",
  "msg": "<Description>"
}
  • < > means “replace with your actual data.”

  • status can be either SUCCESS or FAILURE.

  • If err is not null, data will usually be null.

  • data can be a JSON object ({}) or a JSON array ([]).


Conventions

  • All times (e.g., starttime, endtime) must be in UTC Epoch milliseconds. Example: Monday, Feb 23, 2015, 12:00:00 AM (UTC+05:30) => 1424629800000.

  • “Last” data means the most recent data available (could be a minute ago or a year ago, depending on the device).

  • Some APIs may not work if the data needed isn’t available (marked as Restricted).


Rate Limit

API Type
Allowed Calls per Vehicle per Day

History Data API

24 calls/vehicle/day

Latest Data API

720 calls/vehicle/day

Note:

  • Maximum 3 API calls per second

  • Keep at least 400ms delay between each API call

  • If the limit is exceeded, you will receive HTTP status code 429 (Too Many Requests)

For example, if your rate limit is 720 calls per day, you can request the latest data at most 720 times per vehicle, per day.


Common API Parameters

  • vehicleno: The vehicle’s registration number.

  • starttime: The start of a time range in epoch milliseconds.

  • endtime: The end of a time range in epoch milliseconds.


Last updated