Historical Vehicle Locations

GET

vehicles

{vehicleId}

locations

curl --request GET \
  --url https://api.withterminal.com/tsp/v1/vehicles/{vehicleId}/locations \
  --header 'Authorization: Bearer <token>' \
  --header 'Connection-Token: <connection-token>'

{
  "results": [
    {
      "id": "vcl_loc_01D8ZQFGHVJ858NBF2Q7DV9MNC",
      "sourceId": "123456789",
      "provider": "geotab",
      "vehicle": "vcl_01D8ZQFGHVJ858NBF2Q7DV9MNC",
      "driver": "drv_01D8ZQFGHVJ858NBF2Q7DV9MNC",
      "locatedAt": "2021-01-06T03:24:53.000Z",
      "location": {
        "longitude": -122.4194155,
        "latitude": 37.7749295
      },
      "address": {
        "formatted": "1.5 miles from Austin, TX"
      },
      "heading": 25,
      "speed": 95.33,
      "metadata": {
        "modifiedAt": "2023-11-07T05:31:56Z"
      },
      "raw": []
    }
  ],
  "next": "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw"
}

Note:

Given the large volume of location data available, we encourage customers to accept compressed (gzip) responses in order to maximize throughput. This is supported with many popular HTTP clients. Result limits vary depending on if results are compressed or not.

Authorizations

Authorization

string

header

required

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

Headers

Connection-Token

string

required

The token returned when a user authenticated their account. This authorizes access to a specific account.

Example:

"con_tkn_22vUhkC6tgre4kwaYfUkCDA1rzn6eyb4"

Path Parameters

vehicleId

string

required

Vehicle to retrieve breadcrumb locations for

Query Parameters

cursor

string

Pagination cursor to start requests from

Example:

"cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw"

limit

integer

The maximum number of results to return in a page.

startAt

string

Timestamp to start from - defaults to beginning of history

Example:

"2021-01-06T03:24:53.000Z"

endAt

string

Timestamp to end at - defaults to now

Example:

"2021-01-06T03:24:53.000Z"

raw

boolean

Include raw responses used to normalize model. Used for debugging or accessing unique properties that are not unified.

Response

200

application/json

results

object[]

required

results.id

string

required

Unique identifier for the vehicle location in Terminal.

Example:

"vcl_loc_01D8ZQFGHVJ858NBF2Q7DV9MNC"

results.provider

string

required

Every provider has a unique code to identify it across Terminal's system. You can find each provider's code under provider details.

Example:

"geotab"

results.vehicle

required

The ID of the vehicle that the location is tracking.

Example:

"vcl_01D8ZQFGHVJ858NBF2Q7DV9MNC"

results.locatedAt

string

required

ISO 8601 date

Example:

"2021-01-06T03:24:53.000Z"

results.location

object

required

results.sourceId

string

The ID used to represent the entity in the source system.

Example:

"123456789"

results.driver

The driver that was driving the vehicle at

Example:

"drv_01D8ZQFGHVJ858NBF2Q7DV9MNC"

results.address

object

Reverse geocoded address details for locations when available at the source.

results.heading

number

Heading in degrees

Example:

25

results.speed

number

Speed in KPH rounded to 2 decimal places.

Example:

95.33

results.metadata

object

Internal metadata about the time series.

results.raw

object[]

Raw data fetched from the source provider. Most of our endpoints support a raw query parameter that will append a list of the raw requests used to form our common model. This can be helpful for leveraging unique fields that are not part of our unified model.

Example:

[]

string

Cursor used for pagination.

Example:

"cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw"

Latest Vehicle Locations Historical Vehicle Stats

curl --request GET \
  --url https://api.withterminal.com/tsp/v1/vehicles/{vehicleId}/locations \
  --header 'Authorization: Bearer <token>' \
  --header 'Connection-Token: <connection-token>'

{
  "results": [
    {
      "id": "vcl_loc_01D8ZQFGHVJ858NBF2Q7DV9MNC",
      "sourceId": "123456789",
      "provider": "geotab",
      "vehicle": "vcl_01D8ZQFGHVJ858NBF2Q7DV9MNC",
      "driver": "drv_01D8ZQFGHVJ858NBF2Q7DV9MNC",
      "locatedAt": "2021-01-06T03:24:53.000Z",
      "location": {
        "longitude": -122.4194155,
        "latitude": 37.7749295
      },
      "address": {
        "formatted": "1.5 miles from Austin, TX"
      },
      "heading": 25,
      "speed": 95.33,
      "metadata": {
        "modifiedAt": "2023-11-07T05:31:56Z"
      },
      "raw": []
    }
  ],
  "next": "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw"
}

API Reference

Authentication

Vehicles

Drivers

Hours of Service

Trips

Devices

Safety

Groups

Trailers

IFTA

Connections

Data Management

Providers

Issues

Webhook Events

Historical Vehicle Locations

Authorizations

Headers

Path Parameters

Query Parameters

Response