Skip to main content
API docs by Redocly

JLR Data Hub API (1.0.0)

Download OpenAPI specification:Download

Connected Data Services: connecteddataservices@jaguarlandrover.com

The JLR Data Hub API lets you securely access data from your connected Jaguar and Land Rover vehicles. Use it to read vehicle details, status, journeys, location, and electric-vehicle data on demand.

Browsing the Metadata Catalog (signal categories and fields) is public and needs no sign-in. Accessing vehicle data requires an access token; see the Authentication guides for how to obtain one and make your first request.

Health

Platform health monitoring

Health

Health check that returns the status of all backend services. This endpoint is publicly accessible and does not require authentication. Returns 200 if all services are healthy, 503 if one or more services are unhealthy.

Responses

Response samples

Content type
application/json
{
  • "status": "UP",
  • "services": {
    }
}

Metadata Catalog

Signal category and signal field discovery

List Categories

List all signal categories. This endpoint is publicly accessible and does not require authentication.

query Parameters
name
string

Filter categories by name (partial match).

vin
string = 17 characters

Filter categories to those available for a specific vehicle.

usership
string
Enum: "sole-user" "shared-user" "corporate"

Usership type of the vehicle. Required when the vin parameter is provided.

Responses

Response samples

Content type
application/json
{
  • "items": [
    ]
}

List Category Signals

List signals for a specific category. This endpoint is publicly accessible and does not require authentication.

path Parameters
categoryId
required
string

Kebab-case category identifier.

query Parameters
page
integer >= 0
Default: 0
Examples: page=0

Zero-based page index for paginated results.

size
integer [ 1 .. 100 ]
Default: 20
Examples: size=20

Number of items per page.

sort
Array of strings
Examples: sort=createdAt,desc

Sort criteria in the format field,direction (e.g., createdAt,desc). Multiple sort criteria can be provided.

vin
string = 17 characters

Filter signals to those available for a specific vehicle.

usership
string
Enum: "sole-user" "shared-user" "corporate"

Usership type of the vehicle. Required when the vin parameter is provided.

streamable
boolean

Filter signals by streamable status.

dataType
string

Filter signals by data type.

name
string

Filter signals by name (partial match).

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "page": {
    }
}

List Signals

List all signals across all categories. This endpoint is publicly accessible and does not require authentication.

query Parameters
page
integer >= 0
Default: 0
Examples: page=0

Zero-based page index for paginated results.

size
integer [ 1 .. 100 ]
Default: 20
Examples: size=20

Number of items per page.

sort
Array of strings
Examples: sort=createdAt,desc

Sort criteria in the format field,direction (e.g., createdAt,desc). Multiple sort criteria can be provided.

vin
string = 17 characters

Filter signals to those available for a specific vehicle.

usership
string
Enum: "sole-user" "shared-user" "corporate"

Usership type of the vehicle. Required when the vin parameter is provided.

category
string

Filter signals by category identifier.

streamable
boolean

Filter signals by streamable status.

dataType
string

Filter signals by data type.

name
string

Filter signals by name (partial match).

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "page": {
    }
}

Vehicle Data

Vehicle details, status, journeys, location, and EV data

Vehicle Details

Retrieve vehicle details and capabilities.

Authorizations:
OAuth2Bearer
path Parameters
vin
required
string = 17 characters

Vehicle Identification Number.

header Parameters
DPoP
required
string
Examples: eyJhbGciOiJFUzI1NiIsInR5cCI6ImRwb3Arand0IiwiandrIjp7Imt0eSI6IkVDIiwiY3J2IjoiUC0yNTYiLCJ4IjoiLi4uIiwieSI6Ii4uLiJ9fQ.eyJqdGkiOiItQndDM0VTYzZhY2MybFRjIiwiaHRtIjoiR0VUIiwiaHR1IjoiaHR0cHM6Ly9hcGkuZXhhbXBsZS5jb20vdjEvcGFja2FnZXMiLCJpYXQiOjE3MDUzMTI2MDB9.signature

DPoP proof JWT (RFC 9449).

Responses

Response samples

Content type
application/json
{
  • "Vehicle": {
    }
}

Vehicle Status

Retrieve real-time vehicle status.

Authorizations:
OAuth2Bearer
path Parameters
vin
required
string = 17 characters

Vehicle Identification Number.

header Parameters
DPoP
required
string
Examples: eyJhbGciOiJFUzI1NiIsInR5cCI6ImRwb3Arand0IiwiandrIjp7Imt0eSI6IkVDIiwiY3J2IjoiUC0yNTYiLCJ4IjoiLi4uIiwieSI6Ii4uLiJ9fQ.eyJqdGkiOiItQndDM0VTYzZhY2MybFRjIiwiaHRtIjoiR0VUIiwiaHR1IjoiaHR0cHM6Ly9hcGkuZXhhbXBsZS5jb20vdjEvcGFja2FnZXMiLCJpYXQiOjE3MDUzMTI2MDB9.signature

DPoP proof JWT (RFC 9449).

Responses

Response samples

Content type
application/json
{
  • "Vehicle": {
    },
  • "timestamp": "2024-06-15T14:30:00Z"
}

Vehicle Journeys

Retrieve vehicle journey history.

Authorizations:
OAuth2Bearer
path Parameters
vin
required
string = 17 characters

Vehicle Identification Number.

query Parameters
page
integer >= 0
Default: 0
Examples: page=0

Zero-based page index for paginated results.

size
integer [ 1 .. 100 ]
Default: 20
Examples: size=20

Number of items per page.

sort
Array of strings
Examples: sort=createdAt,desc

Sort criteria in the format field,direction (e.g., createdAt,desc). Multiple sort criteria can be provided.

from
string <date-time>

Filter journeys starting from this date-time (inclusive).

to
string <date-time>

Filter journeys up to this date-time (inclusive).

header Parameters
DPoP
required
string
Examples: eyJhbGciOiJFUzI1NiIsInR5cCI6ImRwb3Arand0IiwiandrIjp7Imt0eSI6IkVDIiwiY3J2IjoiUC0yNTYiLCJ4IjoiLi4uIiwieSI6Ii4uLiJ9fQ.eyJqdGkiOiItQndDM0VTYzZhY2MybFRjIiwiaHRtIjoiR0VUIiwiaHR1IjoiaHR0cHM6Ly9hcGkuZXhhbXBsZS5jb20vdjEvcGFja2FnZXMiLCJpYXQiOjE3MDUzMTI2MDB9.signature

DPoP proof JWT (RFC 9449).

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "page": {
    }
}

Vehicle Location

Retrieve current vehicle location.

Authorizations:
OAuth2Bearer
path Parameters
vin
required
string = 17 characters

Vehicle Identification Number.

header Parameters
DPoP
required
string
Examples: eyJhbGciOiJFUzI1NiIsInR5cCI6ImRwb3Arand0IiwiandrIjp7Imt0eSI6IkVDIiwiY3J2IjoiUC0yNTYiLCJ4IjoiLi4uIiwieSI6Ii4uLiJ9fQ.eyJqdGkiOiItQndDM0VTYzZhY2MybFRjIiwiaHRtIjoiR0VUIiwiaHR1IjoiaHR0cHM6Ly9hcGkuZXhhbXBsZS5jb20vdjEvcGFja2FnZXMiLCJpYXQiOjE3MDUzMTI2MDB9.signature

DPoP proof JWT (RFC 9449).

Responses

Response samples

Content type
application/json
{
  • "Vehicle": {
    },
  • "timestamp": "2024-06-15T14:30:00Z"
}

Electric Vehicle Data

Retrieve electric vehicle data.

Authorizations:
OAuth2Bearer
path Parameters
vin
required
string = 17 characters

Vehicle Identification Number.

header Parameters
DPoP
required
string
Examples: eyJhbGciOiJFUzI1NiIsInR5cCI6ImRwb3Arand0IiwiandrIjp7Imt0eSI6IkVDIiwiY3J2IjoiUC0yNTYiLCJ4IjoiLi4uIiwieSI6Ii4uLiJ9fQ.eyJqdGkiOiItQndDM0VTYzZhY2MybFRjIiwiaHRtIjoiR0VUIiwiaHR1IjoiaHR0cHM6Ly9hcGkuZXhhbXBsZS5jb20vdjEvcGFja2FnZXMiLCJpYXQiOjE3MDUzMTI2MDB9.signature

DPoP proof JWT (RFC 9449).

Responses

Response samples

Content type
application/json
{
  • "Vehicle": {
    },
  • "timestamp": "2024-06-15T14:30:00Z"
}