POST
/
realtime
/
device
curl --request POST \
  --url https://api.pathstack.io/realtime/device \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "filters": {
    "connection_ids": [
      "<string>"
    ],
    "tags": [
      "<string>"
    ],
    "device_ids": [
      "<string>"
    ],
    "connection_devices": [
      {
        "connection_id": "<string>",
        "system_device_ids": [
          "<string>"
        ]
      }
    ]
  },
  "options": {
    "include_speed": true,
    "include_driver_id": true
  }
}'
{
  "data": [
    {
      "connection_id": "<string>",
      "device_id": "<string>",
      "system_device_id": "<string>",
      "position": {
        "timestamp": "<string>",
        "longitude": 123,
        "latitude": 123,
        "heading": 123,
        "speed": {
          "speed_kph": 123
        },
        "driver_id": {
          "format": "text",
          "value": "<string>"
        }
      }
    }
  ]
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

x-api-version
string
default:2024-03-27
Example:

"2024-03-27"

Body

application/json
filters
object | null
options
object | null

Response

200
application/json
Successful Response
data
object[]
required

Successful response payload