Skip to main content
GET
/
vehicle
/
{deviceId}
curl
curl --request GET \
  --url 'https://api.amps.ai/vehicle/device_abc123' \
  --header 'x-api-key: amps_sk_test_xxxxxxxxxxxxxxxxxxxxxxxx'
{
  "success": true,
  "data": {
    "id": "device_vehicle_001",
    "vendor": "example_vendor_a",
    "sync": {
      "available": true,
      "lastPulledAt": "2026-05-07T09:23:45.000Z"
    },
    "metadata": {
      "model": "EV Sedan",
      "source": "live"
    },
    "state": {
      "batteryLevel": 64,
      "range": 184,
      "plugged": true,
      "charging": true,
      "fullyCharged": false,
      "batteryCapacity": 75,
      "chargeLimit": 80,
      "chargeRate": 7,
      "chargeTimeRemaining": 110,
      "maxCurrent": 32
    }
  },
  "meta": {
    "requestId": "req_8a2Bf3kP",
    "environment": "sandbox",
    "timestamp": "2026-06-02T12:00:00.000Z",
    "latencyMs": 12
  }
}

Authorizations

​
x-api-key
string
header
required

Path Parameters

​
deviceId
string
required

The unique identifier for the vehicle device

Example:

"device_abc123"

Query Parameters

​
expedite
boolean

Use expedite cache with 1 minute TTL instead of normal 15 minute TTL

Example:

false

Response

Vehicle state retrieved successfully

​
success
boolean
required

Always true for success responses.

​
data
Vehicle Response · object
required
​
meta
Response Meta · object
required

Metadata attached to every response: the request identifier, the serving environment, the build timestamp, and the server-side latency.