Devices and tracking

Devices

Device management

Fetch a list of Devices

GET

https://demo.traccar.org/api/devices

Without any params, returns a list of the user's devices

Fetch a list of Devices

curl -X GET 'https://demo.traccar.org/api/devices' \
  -H 'Authorization: Basic WU9VUl9VU0VSTkFNRTpZT1VSX1BBU1NXT1JE'

const response = await fetch('https://demo.traccar.org/api/devices', {
  method: 'GET',
  headers: {
    'Authorization': 'Basic WU9VUl9VU0VSTkFNRTpZT1VSX1BBU1NXT1JE',
  },
});

const data = await response.text();

import requests

response = requests.get(
    'https://demo.traccar.org/api/devices',
    headers={
        'Authorization': 'Basic WU9VUl9VU0VSTkFNRTpZT1VSX1BBU1NXT1JE',
    },
)
print(response.text)

200

[
  {
    "id": 0,
    "name": "string",
    "uniqueId": "string",
    "status": "string",
    "disabled": true,
    "lastUpdate": "2024-01-15T09:30:00Z",
    "positionId": 0,
    "groupId": 0,
    "phone": "string",
    "model": "string",
    "contact": "string",
    "category": "string",
    "attributes": {}
  }
]

Parameters

allbooleanquery

Can only be used by admins or managers to fetch all entities

userIdintegerquery

Standard users can use this only with their own userId

idintegerquery

To fetch one or more devices. Multiple params can be passed like id=31&id=42

uniqueIdstringquery

To fetch one or more devices. Multiple params can be passed like uniqueId=333331&uniqieId=44442

excludeAttributesbooleanquery

Exclude attributes field from device payload

limitintegerquery

Limit the number of returned results

offsetintegerquery

Offset for pagination

keywordstringquery

Search keyword filter (searches name, uniqueId, phone, model, contact)

Response

200OKArray<Device>

Response fields application/json

Array<Device>

Show child attributes

idinteger<int64>

Unique identifier assigned by Traccar

namestring

Human friendly device label

uniqueIdstring

Hardware or protocol specific unique identifier

statusstring

Current connection status such as online, offline, or unknown

disabledboolean

Whether the device is disabled by an administrator

lastUpdatestring<date-time> | null

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

positionIdinteger<int64> | null

Identifier of the last known position

groupIdinteger<int64> | null

Parent group identifier when the device is assigned to a group

phonestring | null

Contact phone number used for SMS commands

modelstring | null

Device model or hardware revision

contactstring | null

Responsible person's contact information

categorystring | null

Free form category used for grouping devices in the UI

attributesobject

Custom attributes for protocol or business specific data

400Bad Request

No permission

Authorization

BasicAuthhttp (basic)

ApiKeyhttp (bearer)

Create a Device

POST

https://demo.traccar.org/api/devices

Create a Device

curl -X POST 'https://demo.traccar.org/api/devices' \
  -H 'Authorization: Basic WU9VUl9VU0VSTkFNRTpZT1VSX1BBU1NXT1JE' \
  -H 'Content-Type: application/json' \
  --data-raw '{
  "id": 0,
  "name": "string",
  "uniqueId": "string",
  "status": "string",
  "disabled": true,
  "lastUpdate": "2024-01-15T09:30:00Z",
  "positionId": 0,
  "groupId": 0,
  "phone": "string",
  "model": "string",
  "contact": "string",
  "category": "string",
  "attributes": {}
}'

const body = `{
  "id": 0,
  "name": "string",
  "uniqueId": "string",
  "status": "string",
  "disabled": true,
  "lastUpdate": "2024-01-15T09:30:00Z",
  "positionId": 0,
  "groupId": 0,
  "phone": "string",
  "model": "string",
  "contact": "string",
  "category": "string",
  "attributes": {}
}`;

const response = await fetch('https://demo.traccar.org/api/devices', {
  method: 'POST',
  headers: {
    'Authorization': 'Basic WU9VUl9VU0VSTkFNRTpZT1VSX1BBU1NXT1JE',
    'Content-Type': 'application/json',
  },
  body,
});

const data = await response.text();

import requests

body = '''{
  "id": 0,
  "name": "string",
  "uniqueId": "string",
  "status": "string",
  "disabled": true,
  "lastUpdate": "2024-01-15T09:30:00Z",
  "positionId": 0,
  "groupId": 0,
  "phone": "string",
  "model": "string",
  "contact": "string",
  "category": "string",
  "attributes": {}
}'''

response = requests.post(
    'https://demo.traccar.org/api/devices',
    data=body.encode('utf-8'),
    headers={
        'Authorization': 'Basic WU9VUl9VU0VSTkFNRTpZT1VSX1BBU1NXT1JE',
        'Content-Type': 'application/json',
    },
)
print(response.text)

Request Body

{
  "id": 0,
  "name": "string",
  "uniqueId": "string",
  "status": "string",
  "disabled": true,
  "lastUpdate": "2024-01-15T09:30:00Z",
  "positionId": 0,
  "groupId": 0,
  "phone": "string",
  "model": "string",
  "contact": "string",
  "category": "string",
  "attributes": {}
}

200

{
  "id": 0,
  "name": "string",
  "uniqueId": "string",
  "status": "string",
  "disabled": true,
  "lastUpdate": "2024-01-15T09:30:00Z",
  "positionId": 0,
  "groupId": 0,
  "phone": "string",
  "model": "string",
  "contact": "string",
  "category": "string",
  "attributes": {}
}

Body

application/json

idinteger<int64>

Unique identifier assigned by Traccar

namestring

Human friendly device label

uniqueIdstring

Hardware or protocol specific unique identifier

statusstring

Current connection status such as online, offline, or unknown

disabledboolean

Whether the device is disabled by an administrator

lastUpdatestring<date-time> | null

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

positionIdinteger<int64> | null

Identifier of the last known position

groupIdinteger<int64> | null

Parent group identifier when the device is assigned to a group

phonestring | null

Contact phone number used for SMS commands

modelstring | null

Device model or hardware revision

contactstring | null

Responsible person's contact information

categorystring | null

Free form category used for grouping devices in the UI

attributesobject

Custom attributes for protocol or business specific data

Response

200OKDevice

Response fields application/json

idinteger<int64>

Unique identifier assigned by Traccar

namestring

Human friendly device label

uniqueIdstring

Hardware or protocol specific unique identifier

statusstring

Current connection status such as online, offline, or unknown

disabledboolean

Whether the device is disabled by an administrator

lastUpdatestring<date-time> | null

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

positionIdinteger<int64> | null

Identifier of the last known position

groupIdinteger<int64> | null

Parent group identifier when the device is assigned to a group

phonestring | null

Contact phone number used for SMS commands

modelstring | null

Device model or hardware revision

contactstring | null

Responsible person's contact information

categorystring | null

Free form category used for grouping devices in the UI

attributesobject

Custom attributes for protocol or business specific data

400Bad Request

Bad request

401Unauthorized

Unauthorized

Authorization

BasicAuthhttp (basic)

ApiKeyhttp (bearer)

Fetch a Device

GET

https://demo.traccar.org/api/devices/{id}

Fetch a Device

curl -X GET 'https://demo.traccar.org/api/devices/0' \
  -H 'Authorization: Basic WU9VUl9VU0VSTkFNRTpZT1VSX1BBU1NXT1JE'

const response = await fetch('https://demo.traccar.org/api/devices/0', {
  method: 'GET',
  headers: {
    'Authorization': 'Basic WU9VUl9VU0VSTkFNRTpZT1VSX1BBU1NXT1JE',
  },
});

const data = await response.text();

import requests

response = requests.get(
    'https://demo.traccar.org/api/devices/0',
    headers={
        'Authorization': 'Basic WU9VUl9VU0VSTkFNRTpZT1VSX1BBU1NXT1JE',
    },
)
print(response.text)

200

{
  "id": 0,
  "name": "string",
  "uniqueId": "string",
  "status": "string",
  "disabled": true,
  "lastUpdate": "2024-01-15T09:30:00Z",
  "positionId": 0,
  "groupId": 0,
  "phone": "string",
  "model": "string",
  "contact": "string",
  "category": "string",
  "attributes": {}
}

Parameters

idintegerrequiredpath

Response

200OKDevice

Response fields application/json

idinteger<int64>

Unique identifier assigned by Traccar

namestring

Human friendly device label

uniqueIdstring

Hardware or protocol specific unique identifier

statusstring

Current connection status such as online, offline, or unknown

disabledboolean

Whether the device is disabled by an administrator

lastUpdatestring<date-time> | null

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

positionIdinteger<int64> | null

Identifier of the last known position

groupIdinteger<int64> | null

Parent group identifier when the device is assigned to a group

phonestring | null

Contact phone number used for SMS commands

modelstring | null

Device model or hardware revision

contactstring | null

Responsible person's contact information

categorystring | null

Free form category used for grouping devices in the UI

attributesobject

Custom attributes for protocol or business specific data

401Unauthorized

Unauthorized

404Not Found

Not found

Authorization

BasicAuthhttp (basic)

ApiKeyhttp (bearer)

Update a Device

PUT

https://demo.traccar.org/api/devices/{id}

Update a Device

curl -X PUT 'https://demo.traccar.org/api/devices/0' \
  -H 'Authorization: Basic WU9VUl9VU0VSTkFNRTpZT1VSX1BBU1NXT1JE' \
  -H 'Content-Type: application/json' \
  --data-raw '{
  "id": 0,
  "name": "string",
  "uniqueId": "string",
  "status": "string",
  "disabled": true,
  "lastUpdate": "2024-01-15T09:30:00Z",
  "positionId": 0,
  "groupId": 0,
  "phone": "string",
  "model": "string",
  "contact": "string",
  "category": "string",
  "attributes": {}
}'

const body = `{
  "id": 0,
  "name": "string",
  "uniqueId": "string",
  "status": "string",
  "disabled": true,
  "lastUpdate": "2024-01-15T09:30:00Z",
  "positionId": 0,
  "groupId": 0,
  "phone": "string",
  "model": "string",
  "contact": "string",
  "category": "string",
  "attributes": {}
}`;

const response = await fetch('https://demo.traccar.org/api/devices/0', {
  method: 'PUT',
  headers: {
    'Authorization': 'Basic WU9VUl9VU0VSTkFNRTpZT1VSX1BBU1NXT1JE',
    'Content-Type': 'application/json',
  },
  body,
});

const data = await response.text();

import requests

body = '''{
  "id": 0,
  "name": "string",
  "uniqueId": "string",
  "status": "string",
  "disabled": true,
  "lastUpdate": "2024-01-15T09:30:00Z",
  "positionId": 0,
  "groupId": 0,
  "phone": "string",
  "model": "string",
  "contact": "string",
  "category": "string",
  "attributes": {}
}'''

response = requests.put(
    'https://demo.traccar.org/api/devices/0',
    data=body.encode('utf-8'),
    headers={
        'Authorization': 'Basic WU9VUl9VU0VSTkFNRTpZT1VSX1BBU1NXT1JE',
        'Content-Type': 'application/json',
    },
)
print(response.text)

Request Body

{
  "id": 0,
  "name": "string",
  "uniqueId": "string",
  "status": "string",
  "disabled": true,
  "lastUpdate": "2024-01-15T09:30:00Z",
  "positionId": 0,
  "groupId": 0,
  "phone": "string",
  "model": "string",
  "contact": "string",
  "category": "string",
  "attributes": {}
}

200

{
  "id": 0,
  "name": "string",
  "uniqueId": "string",
  "status": "string",
  "disabled": true,
  "lastUpdate": "2024-01-15T09:30:00Z",
  "positionId": 0,
  "groupId": 0,
  "phone": "string",
  "model": "string",
  "contact": "string",
  "category": "string",
  "attributes": {}
}

Body

application/json

idinteger<int64>

Unique identifier assigned by Traccar

namestring

Human friendly device label

uniqueIdstring

Hardware or protocol specific unique identifier

statusstring

Current connection status such as online, offline, or unknown

disabledboolean

Whether the device is disabled by an administrator

lastUpdatestring<date-time> | null

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

positionIdinteger<int64> | null

Identifier of the last known position

groupIdinteger<int64> | null

Parent group identifier when the device is assigned to a group

phonestring | null

Contact phone number used for SMS commands

modelstring | null

Device model or hardware revision

contactstring | null

Responsible person's contact information

categorystring | null

Free form category used for grouping devices in the UI

attributesobject

Custom attributes for protocol or business specific data

Parameters

idintegerrequiredpath

Response

200OKDevice

Response fields application/json

idinteger<int64>

Unique identifier assigned by Traccar

namestring

Human friendly device label

uniqueIdstring

Hardware or protocol specific unique identifier

statusstring

Current connection status such as online, offline, or unknown

disabledboolean

Whether the device is disabled by an administrator

lastUpdatestring<date-time> | null

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

positionIdinteger<int64> | null

Identifier of the last known position

groupIdinteger<int64> | null

Parent group identifier when the device is assigned to a group

phonestring | null

Contact phone number used for SMS commands

modelstring | null

Device model or hardware revision

contactstring | null

Responsible person's contact information

categorystring | null

Free form category used for grouping devices in the UI

attributesobject

Custom attributes for protocol or business specific data

400Bad Request

Bad request

401Unauthorized

Unauthorized

Authorization

BasicAuthhttp (basic)

ApiKeyhttp (bearer)

Delete a Device

DELETE

https://demo.traccar.org/api/devices/{id}

Delete a Device

curl -X DELETE 'https://demo.traccar.org/api/devices/0' \
  -H 'Authorization: Basic WU9VUl9VU0VSTkFNRTpZT1VSX1BBU1NXT1JE'

const response = await fetch('https://demo.traccar.org/api/devices/0', {
  method: 'DELETE',
  headers: {
    'Authorization': 'Basic WU9VUl9VU0VSTkFNRTpZT1VSX1BBU1NXT1JE',
  },
});

const data = await response.text();

import requests

response = requests.delete(
    'https://demo.traccar.org/api/devices/0',
    headers={
        'Authorization': 'Basic WU9VUl9VU0VSTkFNRTpZT1VSX1BBU1NXT1JE',
    },
)
print(response.text)

Parameters

idintegerrequiredpath

Response

204No Content

No Content

401Unauthorized

Unauthorized

Authorization

BasicAuthhttp (basic)

ApiKeyhttp (bearer)

Update total distance and hours of the Device

PUT

https://demo.traccar.org/api/devices/{id}/accumulators

Update total distance and hours of the Device

curl -X PUT 'https://demo.traccar.org/api/devices/0/accumulators' \
  -H 'Authorization: Basic WU9VUl9VU0VSTkFNRTpZT1VSX1BBU1NXT1JE' \
  -H 'Content-Type: application/json' \
  --data-raw '{
  "deviceId": 0,
  "totalDistance": 0,
  "hours": 0
}'

const body = `{
  "deviceId": 0,
  "totalDistance": 0,
  "hours": 0
}`;

const response = await fetch('https://demo.traccar.org/api/devices/0/accumulators', {
  method: 'PUT',
  headers: {
    'Authorization': 'Basic WU9VUl9VU0VSTkFNRTpZT1VSX1BBU1NXT1JE',
    'Content-Type': 'application/json',
  },
  body,
});

const data = await response.text();

import requests

body = '''{
  "deviceId": 0,
  "totalDistance": 0,
  "hours": 0
}'''

response = requests.put(
    'https://demo.traccar.org/api/devices/0/accumulators',
    data=body.encode('utf-8'),
    headers={
        'Authorization': 'Basic WU9VUl9VU0VSTkFNRTpZT1VSX1BBU1NXT1JE',
        'Content-Type': 'application/json',
    },
)
print(response.text)

Request Body

{
  "deviceId": 0,
  "totalDistance": 0,
  "hours": 0
}

Body

application/json

deviceIdinteger<int64>

Device identifier for the accumulator entry

totalDistancenumber

in meters

hoursnumber

Total engine hours recorded by the device

Parameters

idintegerrequiredpath

Response

204No Content

No Content

400Bad Request

Bad request

401Unauthorized

Unauthorized

Authorization

BasicAuthhttp (basic)

ApiKeyhttp (bearer)

Upload/Update Device image

POST

https://demo.traccar.org/api/devices/{id}/image

Upload/Update Device image

curl -X POST 'https://demo.traccar.org/api/devices/0/image' \
  -H 'Authorization: Basic WU9VUl9VU0VSTkFNRTpZT1VSX1BBU1NXT1JE'

const response = await fetch('https://demo.traccar.org/api/devices/0/image', {
  method: 'POST',
  headers: {
    'Authorization': 'Basic WU9VUl9VU0VSTkFNRTpZT1VSX1BBU1NXT1JE',
  },
});

const data = await response.text();

import requests

response = requests.post(
    'https://demo.traccar.org/api/devices/0/image',
    headers={
        'Authorization': 'Basic WU9VUl9VU0VSTkFNRTpZT1VSX1BBU1NXT1JE',
    },
)
print(response.text)

Request Body

"<binary>"

200

device.png

Body

image/*

string<binary>

Parameters

idintegerrequiredpath

Response

200OKstring

Response fields text/plain

string

400Bad Request

Invalid image type or size

404Not Found

Device not found

Authorization

BasicAuthhttp (basic)

ApiKeyhttp (bearer)

Docs by Sourcey