Latest Vehicle Locations

GET

vehicles

locations

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

{
  "results": [
    {
      "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,
      "odometer": 100,
      "fuel": {
        "primaryPercentage": 50,
        "secondaryPercentage": 50
      },
      "raw": []
    }
  ],
  "next": "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw"
}

This endpoint will call the provider’s API in real time to get the latest location of the vehicle. Please note: this endpoint will exclude vehicles that have no last known location.

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"

Query Parameters

cursor

string

Pagination cursor to start requests from

Example:

"cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw"

limit

integer

The maximum number of results to return in a page.

raw

boolean

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

vehicleIds

string

Comma separated list of vehicle IDs to filter for. Can filter up to 50 vehicles at a time.

driverIds

string

Comma separated list of driver IDs to filter for. Can filter up to 50 drivers at a time.

expand

enum<string>

Expand resources in the returned response

Available options:

vehicle,

driver,

vehicle,driver,

driver,vehicle

Response

200

application/json

results

object[]

required

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.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.odometer

number

Distance in kilometers

Example:

100

results.fuel

object

Fuel percentage

results.raw

object[]

List of the raw data used to normalize the common model. Response schemas will vary by provider.

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"

Get Vehicle Historical Vehicle Locations

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

{
  "results": [
    {
      "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,
      "odometer": 100,
      "fuel": {
        "primaryPercentage": 50,
        "secondaryPercentage": 50
      },
      "raw": []
    }
  ],
  "next": "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw"
}

API Reference

Authentication

Vehicles

Drivers

Hours of Service

Trips

Devices

Safety

Groups

Trailers

IFTA

Connections

Data Management

Providers

Issues

Webhook Events

Latest Vehicle Locations

Authorizations

Headers

Query Parameters

Response