GET
/
trip
/
{trip_id}
/
position
curl --request GET \
  --url https://api.pathstack.io/trip/{trip_id}/position \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "latitude": 123,
      "longitude": 123,
      "time": "<string>",
      "speed_kilometres_per_hour": 123,
      "hdop": 123,
      "vdop": 123,
      "number_of_satellites": 123,
      "heading": 123,
      "odometer_kilometres": 123,
      "odometer_distance_metres": 123,
      "gps_distance_metres": 123,
      "id": "<string>",
      "trip_id": "<string>",
      "device_id": "<string>",
      "osm_road_classification": {
        "road_name": "<string>",
        "on_road": false,
        "distance_from_road_metres": 123
      }
    }
  ],
  "links": {
    "previous": "<string>",
    "current": "<string>",
    "next": "<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-26
Example:

"2024-03-26"

Path Parameters

trip_id
string
required

Trip ID of the Positions to be returned

Query Parameters

page
integer
default:0

Page number for pagination (zero-indexed)

Required range: x >= 0
include_osm_road_classification
boolean
default:0

Return road name and distance from the road centreline for points which lie on a road. Values are null if the point is not on a road.

Response

200
application/json
Successful Response
data
object[]
required

Successful response payload