curl "https://api.smartcar.com/v2.0/vehicles/{id}/security" \
    -H "Authorization: Bearer {token}" \
    -X "GET"

lock_status = vehicle.lock_status()

const lockStatus = await vehicle.lockStatus();

LockStatus lockStatus = vehicle.lockStatus();

lock_status  = vehicle.lock_status

{
	"isLocked" : false,
	"doors" : [
		{"type": "frontLeft" , "status" : "CLOSED"},
		{"type": "frontRight" , "status" : "OPEN"},
		{"type": "backRight" , "status" : "CLOSED"},
		{"type": "backLeft" , "status" : "CLOSED"}
	],
	"windows" : [
		{"type": "frontLeft" , "status" : "CLOSED"},
		{"type": "frontRight" , "status" : "CLOSED"},
		{"type": "backRight" , "status" : "UNKNOWN"},
		{"type": "backLeft" , "status" : "CLOSED"}
	],
	"sunroof" : [
		{"type": "sunroof" , "status" : "CLOSED"}
	], 	
	"storage" : [
		{"type": "rear" , "status" : "UNKNOWN"},
		{"type": "front" , "status" : "CLOSED"}
	],
	"chargingPort" : [ 
		{"type" : "chargingPort", "status" : "CLOSED" } 
	]
}

curl "https://api.smartcar.com/v2.0/vehicles/{id}/security" \
    -H "Authorization: Bearer {token}" \
    -X "GET"

lock_status = vehicle.lock_status()

const lockStatus = await vehicle.lockStatus();

LockStatus lockStatus = vehicle.lockStatus();

lock_status  = vehicle.lock_status

{
	"isLocked" : false,
	"doors" : [
		{"type": "frontLeft" , "status" : "CLOSED"},
		{"type": "frontRight" , "status" : "OPEN"},
		{"type": "backRight" , "status" : "CLOSED"},
		{"type": "backLeft" , "status" : "CLOSED"}
	],
	"windows" : [
		{"type": "frontLeft" , "status" : "CLOSED"},
		{"type": "frontRight" , "status" : "CLOSED"},
		{"type": "backRight" , "status" : "UNKNOWN"},
		{"type": "backLeft" , "status" : "CLOSED"}
	],
	"sunroof" : [
		{"type": "sunroof" , "status" : "CLOSED"}
	], 	
	"storage" : [
		{"type": "rear" , "status" : "UNKNOWN"},
		{"type": "front" , "status" : "CLOSED"}
	],
	"chargingPort" : [ 
		{"type" : "chargingPort", "status" : "CLOSED" } 
	]
}

The Vehicles API v2.0 will be deprecated by Q4 of 2026. We recommend migrating to the latest version as soon as possible to ensure continued support and access to new features.

Permission

read_security

Request

Path

string

required

The vehicle ID of the vehicle you are making a request to.

curl "https://api.smartcar.com/v2.0/vehicles/{id}/security" \
    -H "Authorization: Bearer {token}" \
    -X "GET"

lock_status = vehicle.lock_status()

const lockStatus = await vehicle.lockStatus();

LockStatus lockStatus = vehicle.lockStatus();

lock_status  = vehicle.lock_status

Response

boolean

Indicates the current lock status of the vehicle as reported by the OEM.

[object]

An array of the open status of the vehicle’s doors.

Show doors

string

The location of the door.

string

Indicates the current state of the vehicle’s door. UNKNOWN indicates the vehicle supports this status, but did not provide a valid status for the request

[object]

An array of the open status of the vehicle’s windows.

Show windows

string

The location of the window.

string

Indicates the current state of the vehicle’s window. UNKNOWN indicates the vehicle supports this status, but did not provide a valid status for the request

[object]

An array of the open status of the vehicle’s sunroofs.

Show sunroofs

string

The location of the sunroof.

string

Indicates the current state of the vehicle’s sunroof. UNKNOWN indicates the vehicle supports this status, but did not provide a valid status for the request

[object]

An array of the open status of the vehicle’s storages. For internal combustion and plug-in hybrid vehicles front refers to the engine hood. For battery vehicles, this will be the front trunk.

Show storage

string

The location of the storage.

string

Indicates the current state of the vehicle’s storage. UNKNOWN indicates the vehicle supports this status, but did not provide a valid status for the request

[object]

An array of the open status of the vehicle’s charging port.

Show chargingPort

string

The location of the charging port.

string

Indicates the current state of the vehicle’s charging port. UNKNOWN indicates the vehicle supports this status, but did not provide a valid status for the request

{
	"isLocked" : false,
	"doors" : [
		{"type": "frontLeft" , "status" : "CLOSED"},
		{"type": "frontRight" , "status" : "OPEN"},
		{"type": "backRight" , "status" : "CLOSED"},
		{"type": "backLeft" , "status" : "CLOSED"}
	],
	"windows" : [
		{"type": "frontLeft" , "status" : "CLOSED"},
		{"type": "frontRight" , "status" : "CLOSED"},
		{"type": "backRight" , "status" : "UNKNOWN"},
		{"type": "backLeft" , "status" : "CLOSED"}
	],
	"sunroof" : [
		{"type": "sunroof" , "status" : "CLOSED"}
	], 	
	"storage" : [
		{"type": "rear" , "status" : "UNKNOWN"},
		{"type": "front" , "status" : "CLOSED"}
	],
	"chargingPort" : [ 
		{"type" : "chargingPort", "status" : "CLOSED" } 
	]
}

Notes

The open status array(s) will be empty if a vehicle has partial support.
The request will error if lockStatus can not be retrieved from the vehicle or the brand is not supported.

Location Odometer

⌘I

Introduction

Authorization

Connections

Webhooks

Vehicle Data

Vehicle Commands

Compatibility

API 2.0 Reference (Legacy)

Vehicle Commands (Legacy)

Management API (Legacy)

Compatibility API (Legacy)

Lock Status

Permission

Request

Response

Notes

​Permission

​Request

​Response

​Notes

Permission

Request

Response

Notes