Signals

GET signals

curl --request GET \
  --url https://vehicle.api.smartcar.com/v3/vehicles/{vehicleId}/signals \
  --header 'Authorization: Bearer <token>'

{
  "data": [
    {
      "id": "<string>",
      "type": "signal",
      "attributes": {
        "code": "charge-voltage",
        "name": "Voltage",
        "group": "Charge",
        "status": {
          "value": "SUCCESS"
        },
        "body": {
          "unit": "volts",
          "value": 85
        }
      },
      "meta": {
        "retrievedAt": 1696156800,
        "oemUpdatedAt": 1696156799
      },
      "links": {
        "self": "<string>",
        "values": "<string>",
        "vehicle": "<string>"
      }
    }
  ],
  "meta": {
    "page": 1,
    "pageSize": 10,
    "totalCount": 5
  },
  "links": {
    "self": "/vehicles/vehicle123/signals?page=1&pageSize=10",
    "first": "/vehicles/vehicle123/signals?page=1&pageSize=10",
    "previous": null,
    "next": "/vehicles/vehicle123/signals?page=2&pageSize=10",
    "last": "/vehicles/vehicle123/signals?page=5&pageSize=10"
  },
  "included": {
    "vehicle": {
      "id": "<string>",
      "type": "vehicle",
      "attributes": {
        "make": "<string>",
        "model": "<string>",
        "year": 123
      },
      "links": {
        "self": "<string>"
      }
    }
  }
}

GET

vehicles

{vehicleId}

signals

GET signals

curl --request GET \
  --url https://vehicle.api.smartcar.com/v3/vehicles/{vehicleId}/signals \
  --header 'Authorization: Bearer <token>'

{
  "data": [
    {
      "id": "<string>",
      "type": "signal",
      "attributes": {
        "code": "charge-voltage",
        "name": "Voltage",
        "group": "Charge",
        "status": {
          "value": "SUCCESS"
        },
        "body": {
          "unit": "volts",
          "value": 85
        }
      },
      "meta": {
        "retrievedAt": 1696156800,
        "oemUpdatedAt": 1696156799
      },
      "links": {
        "self": "<string>",
        "values": "<string>",
        "vehicle": "<string>"
      }
    }
  ],
  "meta": {
    "page": 1,
    "pageSize": 10,
    "totalCount": 5
  },
  "links": {
    "self": "/vehicles/vehicle123/signals?page=1&pageSize=10",
    "first": "/vehicles/vehicle123/signals?page=1&pageSize=10",
    "previous": null,
    "next": "/vehicles/vehicle123/signals?page=2&pageSize=10",
    "last": "/vehicles/vehicle123/signals?page=5&pageSize=10"
  },
  "included": {
    "vehicle": {
      "id": "<string>",
      "type": "vehicle",
      "attributes": {
        "make": "<string>",
        "model": "<string>",
        "year": 123
      },
      "links": {
        "self": "<string>"
      }
    }
  }
}

Authorizations

Authorization

string

header

required

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

Path Parameters

vehicleId

string

required

The unique identifier for the vehicle.

Response

List of signals for the vehicle

data

object[]

Show child attributes

data.id

string

The unique human readable identifier for the signal.

data.type

enum<string>

Available options:

signal

data.attributes

object

Show child attributes

data.attributes.code

string

The unique identifier for the data point.

data.attributes.name

string

The name of the datapoint, which is a human-readable identifier.

data.attributes.group

string

The group to which the data point belongs, used for categorization.

data.attributes.status

object

Show child attributes

data.attributes.status.value

enum<string>

The state of the signal, indicating whether it is active, inactive, or in an error state.

Available options:

SUCCESS,

ERROR,

UNAVAILABLE

data.attributes.status.error

object

Show child attributes

data.attributes.status.error.type

string

The type of error that occurred, indicating the nature of the issue.

data.attributes.status.error.code

string

A code representing the specific error, used for error handling and debugging.

data.attributes.status.error.description

string

A human-readable message describing the error.

data.attributes.status.error.resolution

object

Show child attributes

data.attributes.status.error.resolution.type

string

Describes types of actions to be take to resolve an error state

Example:

{
  "type": "CONNECTED_SERVICES_ACCOUNT",
  "code": "AUTHENTICATION_FAILED",
  "message": "The authentication for the connected services account failed.",
  "resolution": { "type": "REAUTHENTICATE" }
}

Example:

{
  "value": "ERROR",
  "error": {
    "type": "SignalError",
    "code": "SIGNAL_NOT_FOUND",
    "description": "The requested signal does not exist.",
    "resolution": { "type": "REAUTHENTICATE" }
  }
}

data.attributes.body

object

The body of the signal or attribute

Option 1
Option 2
Option 3
Option 4
Option 5
Option 6
Option 7

Show child attributes

data.attributes.body.unit

enum<string>

The unit of measurement related to the value

Available options:

volts,

ampere,

watts,

percentage,

degrees,

kilometers,

liters,

kilowatt-hours,

kilowatts,

bar,

seconds,

minutes,

hours,

degrees-celsius

data.attributes.body.value

number

The numerical value of the signal.

Example:

{
  "code": "charge-voltage",
  "name": "Voltage",
  "group": "Charge",
  "status": { "value": "SUCCESS" },
  "body": { "unit": "volts", "value": 85 }
}

data.meta

object

Show child attributes

data.meta.retrievedAt

integer<int64>

epoch time of the last retrieval of this data point

data.meta.oemUpdatedAt

integer<int64>

The epoch time of the last update of this data point by the OEM

Example:

{
  "retrievedAt": 1696156800,
  "oemUpdatedAt": 1696156799
}

data.links

object

Show child attributes

data.links.self

string

The URL to access the current resource.

data.links.values

string

URL to the values for this signal

data.links.vehicle

string

URL to the vehicle associated with this signal

meta

object

Show child attributes

meta.page

integer

The current page number of the paginated results.

meta.pageSize

integer

The number of items returned per page.

meta.totalCount

integer

The total number of items available across all pages.

Example:

{
  "page": 1,
  "pageSize": 10,
  "totalCount": 5
}

links

object

Show child attributes

links.self

string

The URL to access the current resource.

The URL to access the current page of results.

links.first

string

The URL to access the first page of results.

links.previous

string

The URL to access the previous page of results.

links.next

string

The URL to access the next page of results.

links.last

string

The URL to access the last page of results.

Example:

{
  "self": "/vehicles/vehicle123/signals?page=1&pageSize=10",
  "first": "/vehicles/vehicle123/signals?page=1&pageSize=10",
  "previous": null,
  "next": "/vehicles/vehicle123/signals?page=2&pageSize=10",
  "last": "/vehicles/vehicle123/signals?page=5&pageSize=10"
}

included

object

Show child attributes

included.vehicle

object

Show child attributes

included.vehicle.id

string

The unique identifier for the vehicle.

included.vehicle.type

enum<string>

Available options:

vehicle

included.vehicle.attributes

object

Show child attributes

included.vehicle.attributes.make

string

included.vehicle.attributes.model

string

included.vehicle.attributes.year

integer

included.vehicle.links

object

Show child attributes

included.vehicle.links.self

string

The URL to access the current resource.

Vehicle Signal

⌘I

Introduction

Webhooks

Vehicle Authorization & Permissions

Vehicle Data

Vehicle Commands

Management API

Compatibility API

Authorizations

Path Parameters

Response