Skip to content

Traccar (6.10.0)

Traccar GPS tracking server API documentation. To use the API you need to have a server instance. For testing purposes you can use one of free demo servers. For production use you can install your own server or get a subscription service.

Download OpenAPI description
openapi.json
openapi.yaml
Overview
URL
https://www.traccar.org/
Traccar Support
support@traccar.org
License
Apache 2.0
Languages
Servers
Mock server
https://docs2.mygpsapi.com/_mock/openapi
Doha Dynamics API (Production)
https://mygpsapi.com/api

Server

Server information

Operations

Session

User session management

Operations

Devices

Device management

Operations

Groups

Group management

Operations

Users

User management

Operations

Permissions

User permissions and other object linking

Operations

Positions

Retrieving raw location information

Operations

Events

Retrieving event information

Operations

Reports

Reports generation

Operations

Fetch a list of Positions within the time period for the Devices or Groups

Request

At least one deviceId or one groupId must be passed

Security
BasicAuth or ApiKey
Query
deviceIdArray of integers
groupIdArray of integers
fromstring(date-time)required

in ISO 8601 format. eg. 1963-11-22T18:30:00Z

tostring(date-time)required

in ISO 8601 format. eg. 1963-11-22T18:30:00Z

curl -i -X GET \
  -u <username>:<password> \
  'https://docs2.mygpsapi.com/_mock/openapi/reports/route?deviceId=0&groupId=0&from=2019-08-24T14%3A15%3A22Z&to=2019-08-24T14%3A15%3A22Z'

Responses

OK

Body
Array [
idinteger(int64)
deviceIdinteger(int64)
protocolstring
deviceTimestring(date-time)

in ISO 8601 format. eg. 1963-11-22T18:30:00Z

fixTimestring(date-time)

in ISO 8601 format. eg. 1963-11-22T18:30:00Z

serverTimestring(date-time)

in ISO 8601 format. eg. 1963-11-22T18:30:00Z

validboolean
latitudenumber
longitudenumber
altitudenumber
speednumber

in knots

coursenumber
addressstring
accuracynumber
networkobject
geofenceIdsArray of integers
attributesobject
]
Response
[
  {
    "id": 0,
    "deviceId": 0,
    "protocol": "string",
    "deviceTime": "2019-08-24T14:15:22Z",
    "fixTime": "2019-08-24T14:15:22Z",
    "serverTime": "2019-08-24T14:15:22Z",
    "valid": true,
    "latitude": 0,
    "longitude": 0,
    "altitude": 0,
    "speed": 0,
    "course": 0,
    "address": "string",
    "accuracy": 0,
    "network": {},
    "geofenceIds": [ … ],
    "attributes": {}
  }
]

Fetch a list of Events within the time period for the Devices or Groups

Request

At least one deviceId or one groupId must be passed

Security
BasicAuth or ApiKey
Query
deviceIdArray of integers
groupIdArray of integers
typeArray of strings

% can be used to return events of all types

fromstring(date-time)required

in ISO 8601 format. eg. 1963-11-22T18:30:00Z

tostring(date-time)required

in ISO 8601 format. eg. 1963-11-22T18:30:00Z

curl -i -X GET \
  -u <username>:<password> \
  'https://docs2.mygpsapi.com/_mock/openapi/reports/events?deviceId=0&groupId=0&type=string&from=2019-08-24T14%3A15%3A22Z&to=2019-08-24T14%3A15%3A22Z'

Responses

OK

Body
Array [
idinteger(int64)
typestring
eventTimestring(date-time)

in ISO 8601 format. eg. 1963-11-22T18:30:00Z

deviceIdinteger(int64)
positionIdinteger(int64)
geofenceIdinteger(int64)
maintenanceIdinteger
attributesobject
]
Response
[
  {
    "id": 0,
    "type": "string",
    "eventTime": "2019-08-24T14:15:22Z",
    "deviceId": 0,
    "positionId": 0,
    "geofenceId": 0,
    "maintenanceId": 0,
    "attributes": {}
  }
]

Fetch a list of ReportSummary within the time period for the Devices or Groups

Request

At least one deviceId or one groupId must be passed

Security
BasicAuth or ApiKey
Query
deviceIdArray of integers
groupIdArray of integers
fromstring(date-time)required

in ISO 8601 format. eg. 1963-11-22T18:30:00Z

tostring(date-time)required

in ISO 8601 format. eg. 1963-11-22T18:30:00Z

curl -i -X GET \
  -u <username>:<password> \
  'https://docs2.mygpsapi.com/_mock/openapi/reports/summary?deviceId=0&groupId=0&from=2019-08-24T14%3A15%3A22Z&to=2019-08-24T14%3A15%3A22Z'

Responses

OK

Body
Array [
deviceIdinteger(int64)
deviceNamestring
maxSpeednumber

in knots

averageSpeednumber

in knots

distancenumber

in meters

spentFuelnumber

in liters

engineHoursinteger
]
Response
[
  {
    "deviceId": 0,
    "deviceName": "string",
    "maxSpeed": 0,
    "averageSpeed": 0,
    "distance": 0,
    "spentFuel": 0,
    "engineHours": 0
  }
]

Fetch a list of ReportTrips within the time period for the Devices or Groups

Request

At least one deviceId or one groupId must be passed

Security
BasicAuth or ApiKey
Query
deviceIdArray of integers
groupIdArray of integers
fromstring(date-time)required

in ISO 8601 format. eg. 1963-11-22T18:30:00Z

tostring(date-time)required

in ISO 8601 format. eg. 1963-11-22T18:30:00Z

curl -i -X GET \
  -u <username>:<password> \
  'https://docs2.mygpsapi.com/_mock/openapi/reports/trips?deviceId=0&groupId=0&from=2019-08-24T14%3A15%3A22Z&to=2019-08-24T14%3A15%3A22Z'

Responses

OK

Body
Array [
deviceIdinteger(int64)
deviceNamestring
maxSpeednumber

in knots

averageSpeednumber

in knots

distancenumber

in meters

spentFuelnumber

in liters

durationinteger
startTimestring(date-time)

in ISO 8601 format. eg. 1963-11-22T18:30:00Z

startAddressstring
startLatnumber
startLonnumber
endTimestring(date-time)

in ISO 8601 format. eg. 1963-11-22T18:30:00Z

endAddressstring
endLatnumber
endLonnumber
driverUniqueIdstring
driverNamestring
]
Response
[
  {
    "deviceId": 0,
    "deviceName": "string",
    "maxSpeed": 0,
    "averageSpeed": 0,
    "distance": 0,
    "spentFuel": 0,
    "duration": 0,
    "startTime": "2019-08-24T14:15:22Z",
    "startAddress": "string",
    "startLat": 0,
    "startLon": 0,
    "endTime": "2019-08-24T14:15:22Z",
    "endAddress": "string",
    "endLat": 0,
    "endLon": 0,
    "driverUniqueId": "string",
    "driverName": "string"
  }
]

Fetch a list of ReportStops within the time period for the Devices or Groups

Request

At least one deviceId or one groupId must be passed

Security
BasicAuth or ApiKey
Query
deviceIdArray of integers
groupIdArray of integers
fromstring(date-time)required

in ISO 8601 format. eg. 1963-11-22T18:30:00Z

tostring(date-time)required

in ISO 8601 format. eg. 1963-11-22T18:30:00Z

curl -i -X GET \
  -u <username>:<password> \
  'https://docs2.mygpsapi.com/_mock/openapi/reports/stops?deviceId=0&groupId=0&from=2019-08-24T14%3A15%3A22Z&to=2019-08-24T14%3A15%3A22Z'

Responses

OK

Body
Array [
deviceIdinteger(int64)
deviceNamestring
durationinteger
startTimestring(date-time)

in ISO 8601 format. eg. 1963-11-22T18:30:00Z

addressstring
latnumber
lonnumber
endTimestring(date-time)

in ISO 8601 format. eg. 1963-11-22T18:30:00Z

spentFuelnumber

in liters

engineHoursinteger
]
Response
[
  {
    "deviceId": 0,
    "deviceName": "string",
    "duration": 0,
    "startTime": "2019-08-24T14:15:22Z",
    "address": "string",
    "lat": 0,
    "lon": 0,
    "endTime": "2019-08-24T14:15:22Z",
    "spentFuel": 0,
    "engineHours": 0
  }
]

Notifications

User notifications management

Operations

Geofences

Geofence management

Operations

Commands

Sending commands to devices and stored command management

Operations

Attributes

Computed attributes management

Operations

Drivers

Drivers management

Operations

Maintenance

Maintenance management

Operations

Calendars

Calendar management

Operations

Statistics

Retrieving server statistics

Operations