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

Fetch a list of Users

Request

Security
BasicAuth or ApiKey
Query
userIdstring

Can only be used by admin or manager users

curl -i -X GET \
  -u <username>:<password> \
  'https://docs2.mygpsapi.com/_mock/openapi/users?userId=string'

Responses

OK

Bodyapplication/jsonArray [
idinteger(int64)
namestring
emailstring
phonestring or null
readonlyboolean
administratorboolean
mapstring or null
latitudenumber
longitudenumber
zoominteger
passwordstring
coordinateFormatstring or null
disabledboolean
expirationTimestring or null(date-time)

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

deviceLimitinteger
userLimitinteger
deviceReadonlyboolean
limitCommandsboolean
fixedEmailboolean
poiLayerstring or null
attributesobject
]
Response
application/json
[
  {
    "id": 0,
    "name": "string",
    "email": "string",
    "phone": "string",
    "readonly": true,
    "administrator": true,
    "map": "string",
    "latitude": 0,
    "longitude": 0,
    "zoom": 0,
    "password": "string",
    "coordinateFormat": "string",
    "disabled": true,
    "expirationTime": "2019-08-24T14:15:22Z",
    "deviceLimit": 0,
    "userLimit": 0,
    "deviceReadonly": true,
    "limitCommands": true,
    "fixedEmail": true,
    "poiLayer": "string",
    "attributes": {}
  }
]

Create a User

Request

Security
BasicAuth or ApiKey
Bodyapplication/jsonrequired
idinteger(int64)
namestring
emailstring
phonestring or null
readonlyboolean
administratorboolean
mapstring or null
latitudenumber
longitudenumber
zoominteger
passwordstring
coordinateFormatstring or null
disabledboolean
expirationTimestring or null(date-time)

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

deviceLimitinteger
userLimitinteger
deviceReadonlyboolean
limitCommandsboolean
fixedEmailboolean
poiLayerstring or null
attributesobject
curl -i -X POST \
  -u <username>:<password> \
  https://docs2.mygpsapi.com/_mock/openapi/users \
  -H 'Content-Type: application/json' \
  -d '{
    "id": 0,
    "name": "string",
    "email": "string",
    "phone": "string",
    "readonly": true,
    "administrator": true,
    "map": "string",
    "latitude": 0,
    "longitude": 0,
    "zoom": 0,
    "password": "string",
    "coordinateFormat": "string",
    "disabled": true,
    "expirationTime": "2019-08-24T14:15:22Z",
    "deviceLimit": 0,
    "userLimit": 0,
    "deviceReadonly": true,
    "limitCommands": true,
    "fixedEmail": true,
    "poiLayer": "string",
    "attributes": {}
  }'

Responses

OK

Bodyapplication/json
idinteger(int64)
namestring
emailstring
phonestring or null
readonlyboolean
administratorboolean
mapstring or null
latitudenumber
longitudenumber
zoominteger
passwordstring
coordinateFormatstring or null
disabledboolean
expirationTimestring or null(date-time)

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

deviceLimitinteger
userLimitinteger
deviceReadonlyboolean
limitCommandsboolean
fixedEmailboolean
poiLayerstring or null
attributesobject
Response
application/json
{
  "id": 0,
  "name": "string",
  "email": "string",
  "phone": "string",
  "readonly": true,
  "administrator": true,
  "map": "string",
  "latitude": 0,
  "longitude": 0,
  "zoom": 0,
  "password": "string",
  "coordinateFormat": "string",
  "disabled": true,
  "expirationTime": "2019-08-24T14:15:22Z",
  "deviceLimit": 0,
  "userLimit": 0,
  "deviceReadonly": true,
  "limitCommands": true,
  "fixedEmail": true,
  "poiLayer": "string",
  "attributes": {}
}

Update a User

Request

Security
BasicAuth or ApiKey
Path
idintegerrequired
Bodyapplication/jsonrequired
idinteger(int64)
namestring
emailstring
phonestring or null
readonlyboolean
administratorboolean
mapstring or null
latitudenumber
longitudenumber
zoominteger
passwordstring
coordinateFormatstring or null
disabledboolean
expirationTimestring or null(date-time)

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

deviceLimitinteger
userLimitinteger
deviceReadonlyboolean
limitCommandsboolean
fixedEmailboolean
poiLayerstring or null
attributesobject
curl -i -X PUT \
  -u <username>:<password> \
  'https://docs2.mygpsapi.com/_mock/openapi/users/{id}' \
  -H 'Content-Type: application/json' \
  -d '{
    "id": 0,
    "name": "string",
    "email": "string",
    "phone": "string",
    "readonly": true,
    "administrator": true,
    "map": "string",
    "latitude": 0,
    "longitude": 0,
    "zoom": 0,
    "password": "string",
    "coordinateFormat": "string",
    "disabled": true,
    "expirationTime": "2019-08-24T14:15:22Z",
    "deviceLimit": 0,
    "userLimit": 0,
    "deviceReadonly": true,
    "limitCommands": true,
    "fixedEmail": true,
    "poiLayer": "string",
    "attributes": {}
  }'

Responses

OK

Bodyapplication/json
idinteger(int64)
namestring
emailstring
phonestring or null
readonlyboolean
administratorboolean
mapstring or null
latitudenumber
longitudenumber
zoominteger
passwordstring
coordinateFormatstring or null
disabledboolean
expirationTimestring or null(date-time)

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

deviceLimitinteger
userLimitinteger
deviceReadonlyboolean
limitCommandsboolean
fixedEmailboolean
poiLayerstring or null
attributesobject
Response
application/json
{
  "id": 0,
  "name": "string",
  "email": "string",
  "phone": "string",
  "readonly": true,
  "administrator": true,
  "map": "string",
  "latitude": 0,
  "longitude": 0,
  "zoom": 0,
  "password": "string",
  "coordinateFormat": "string",
  "disabled": true,
  "expirationTime": "2019-08-24T14:15:22Z",
  "deviceLimit": 0,
  "userLimit": 0,
  "deviceReadonly": true,
  "limitCommands": true,
  "fixedEmail": true,
  "poiLayer": "string",
  "attributes": {}
}

Delete a User

Request

Security
BasicAuth or ApiKey
Path
idintegerrequired
curl -i -X DELETE \
  -u <username>:<password> \
  'https://docs2.mygpsapi.com/_mock/openapi/users/{id}'

Responses

No Content

Body

Permissions

User permissions and other object linking

Operations

Positions

Retrieving raw location information

Operations

Events

Retrieving event information

Operations

Reports

Reports generation

Operations

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