Zum Hauptinhalt springen

Positions

Get a List of Positions

This endpoint returns a list of historical positions recorded by a specific I LOCK IT device.

Positions are updated at different intervals depending on the firmware version and device type.
You can use the deviceId, from, and to parameters to define your query range.

info

Positions are retained for 32 days maximum.

tipp

Use Forwarding to get real time positions instead of polling the API


Authentication

Type: Basic Authentication
Credentials: Email + Password


Method & Endpoint

Method: GET
Endpoint: https://tracking.ilockit.bike/api/positions


Query Parameters

KeyRequiredTypeDescription
deviceIdYesintegerID of the I LOCK IT device
fromYesdatetimeStart of the time range (ISO 8601 format)
toYesdatetimeEnd of the time range (ISO 8601 format)

🕒 Timestamps must be in UTC format (e.g., 2024-02-01T00:00:00Z).


HTTP Headers

accept: application/json
Authorization: Basic <base64(email:password)>

Response

Returns a list of position records including latitude, longitude, speed, and more.

[
{
"id": 102341972,
"attributes": {
"sat": 8,
"distance": 82.69,
"totalDistance": 66136.23,
"motion": true
},
"deviceId": 30331,
"type": null,
"protocol": "topin",
"serverTime": "2025-07-27T19:57:59.000+0000",
"deviceTime": "2025-07-27T19:57:59.000+0000",
"fixTime": "2025-07-27T19:57:59.000+0000",
"outdated": false,
"valid": true,
"latitude": 45.13976,
"longitude": 13.57179,
"altitude": 481,
"speed": 1.07991,
"course": 38,
"address": null,
"accuracy": 0,
"network": null
}
]

Parameters

  • sat: Number of satellites used for the GPS fix.
  • distance: Distance (in meters) from the last known position.
  • totalDistance: Total distance traveled by the device (in meters).
  • motion: Indicates if the device is currently moving (true or false).
  • deviceId: Internal ID of the device assigned by the server.
  • serverTime: Time when the server received the position (UTC).
  • deviceTime: Time when the device recorded the position (UTC).
  • fixTime: Time of the actual GPS fix.
  • latitude: Latitude in decimal degrees.
  • longitude: Longitude in decimal degrees.
  • altitude: Altitude above sea level (in meters).
  • speed: Current speed in kilometers per hour (km/h).
  • course: Direction of movement in degrees (0–360, 0 = North).
  • accuracy: Estimated accuracy of the location (in meters). ((only relevant for wifi positions)
  • network: found wifi networks (only relevant for 4G locks)

Notes

  • The number of returned positions depends on the queried time span.
  • Older devices may report fewer fields (e.g., missing speed or altitude).
  • Make sure deviceId is valid and assigned to your user account.
  • If no parameters are provided the API will respond with the last position of each device (one position per device)