Traccar API

https://www.traccar.org/traccar-api/
Admin
Traccar API provides access to all service functionality of Traccar, a free and open-source modern...
Tokens:783
Snippets:12
Trust Score:9.9
Update:2 days ago
Show doc for...
Tokens:
Raw
### GET /api/session

Source: https://www.traccar.org/traccar-api

Creates a session using an access token as an alternative to email and password login. The token is passed as a query parameter.

```APIDOC
## GET /api/session

### Description
Creates a session using an access token as an alternative to email and password login. The token is passed as a query parameter.

### Method
GET

### Endpoint
/api/session

### Parameters
#### Query Parameters
- **token** (string) - Required - The user access token.

### Request Example
```
/api/session?token=USER_TOKEN
```

### Response
#### Success Response (200)
Session created successfully.

```

--------------------------------

### Create session with token using /api/session?token=USER_TOKEN

Source: https://www.traccar.org/traccar-api

Use this request to create a session using an account token instead of email and password. Replace USER_TOKEN with your actual token. The token can be generated from the web app or via an API call.

```http
/api/session?token=USER_TOKEN

```

--------------------------------

### WebSocket /api/socket

Source: https://www.traccar.org/traccar-api

Provides a WebSocket endpoint for live updates. Session cookie is the only authorization option for this connection. Messages use a universal JSON format containing devices, positions, and events.

```APIDOC
## WebSocket /api/socket

### Description
Provides a WebSocket endpoint for live updates. Session cookie is the only authorization option for this connection. Messages use a universal JSON format containing devices, positions, and events.

### Method
WebSocket

### Endpoint
/api/socket

### Authorization
Session cookie required.

### Message Format
Each message in the WebSocket stream uses the following universal JSON format:

```json
{
  "devices": [...],
  "positions": [...],
  "events": [...]
}
```

Each array contains standard JSON objects: Device, Position, Event. If a message does not contain any objects of a certain type, the key is omitted.

```

--------------------------------

### WebSocket endpoint /api/socket

Source: https://www.traccar.org/traccar-api

Connect to this WebSocket endpoint for live updates. Session cookie is the only authorization option for the WebSocket connection.

```http
/api/socket

```

--------------------------------

### Universal JSON message format for WebSocket stream

Source: https://www.traccar.org/traccar-api

Each message in the WebSocket stream uses this universal JSON format. Arrays contain standard JSON objects: Device, Position, Event. If a message does not contain objects of a certain type, the key is omitted.

```json
{
  "devices": [...],
  "positions: [...],
  "events": [...]
}

```
Tokens:
Raw