Masterarbeit

Search

SearchSearch

Smartcar API

Jun 20, 202411 min read

Search Link: https://www.google.com/search?channel=fs&client=ubuntu-sn&q=postman+collection+13172949-de596180-4770-4b4c-b128-31679d28e170

Overview

GET /v2.0/vehicles/{vehicle_id}/tesla/status

Summary: Vehicle Status

Vehicle Status

PARAMETERS /v2.0/vehicles/{vehicle_id}/tesla/status

GET /v2.0/vehicles/{vehicle_id}/tesla/attributes

Summary: Extended Vehicle Info - Tesla

Extended Vehicle Info - Tesla

PARAMETERS /v2.0/vehicles/{vehicle_id}/tesla/attributes

GET /v2.0/vehicles/{vehicle_id}/tesla/charge/ammeter

Summary: Amperage

Amperage

POST /v2.0/vehicles/{vehicle_id}/tesla/charge/ammeter

Summary: Amperage

Amperage

PARAMETERS /v2.0/vehicles/{vehicle_id}/tesla/charge/ammeter

GET /v2.0/vehicles/{vehicle_id}/tesla/charge/completion

Summary: Charge Completion Time

Charge Completion Time

PARAMETERS /v2.0/vehicles/{vehicle_id}/tesla/charge/completion

GET /v2.0/vehicles/{vehicle_id}/tesla/charge/records

Summary: Charge Records

Charge Records

PARAMETERS /v2.0/vehicles/{vehicle_id}/tesla/charge/records

GET /v2.0/vehicles/{vehicle_id}/tesla/charge/records/billing

Summary: Charge Billing Records

Charge Billing Records

PARAMETERS /v2.0/vehicles/{vehicle_id}/tesla/charge/records/billing

GET /v2.0/vehicles/{vehicle_id}/tesla/charge/schedule

Summary: Charge Schedule

Charge Schedule

POST /v2.0/vehicles/{vehicle_id}/tesla/charge/schedule

Summary: Charge Schedule

Charge Schedule

PARAMETERS /v2.0/vehicles/{vehicle_id}/tesla/charge/schedule

GET /v2.0/vehicles/{vehicle_id}/tesla/charge/wattmeter

Summary: Wattage

Wattage

PARAMETERS /v2.0/vehicles/{vehicle_id}/tesla/charge/wattmeter

GET /v2.0/vehicles/{vehicle_id}/tesla/charge/voltmeter

Summary: Voltage

Voltage

PARAMETERS /v2.0/vehicles/{vehicle_id}/tesla/charge/voltmeter

GET /v2.0/vehicles/{vehicle_id}/tesla/thermometer/exterior

Summary: Exterior Temperature

Exterior Temperature

PARAMETERS /v2.0/vehicles/{vehicle_id}/tesla/thermometer/exterior

GET /v2.0/vehicles/{vehicle_id}/tesla/thermometer/interior

Summary: Interior Temperature

Interior Temperature

PARAMETERS /v2.0/vehicles/{vehicle_id}/tesla/thermometer/interior

GET /v2.0/vehicles/{vehicle_id}/tesla/compass

Summary: Compass

Compass

PARAMETERS /v2.0/vehicles/{vehicle_id}/tesla/compass

GET /v2.0/vehicles/{vehicle_id}/tesla/speedometer

Summary: Speed

Speed

PARAMETERS /v2.0/vehicles/{vehicle_id}/tesla/speedometer

GET /v2.0/vehicles/{vehicle_id}/tesla/cabin/climate

Summary: Cabin Climate

Cabin Climate

PARAMETERS /v2.0/vehicles/{vehicle_id}/tesla/cabin/climate

POST /v2.0/vehicles/{vehicle_id}/tesla/climate/cabin

Summary: Cabin Climate

Cabin Climate

PARAMETERS /v2.0/vehicles/{vehicle_id}/tesla/climate/cabin

GET /v2.0/vehicles/{vehicle_id}/tesla/cabin/defroster

Summary: Defroster

Defroster

PARAMETERS /v2.0/vehicles/{vehicle_id}/tesla/cabin/defroster

POST /v2.0/vehicles/{vehicle_id}/tesla/climate/defroster

Summary: Defroster

Defroster

PARAMETERS /v2.0/vehicles/{vehicle_id}/tesla/climate/defroster

GET /v2.0/vehicles/{vehicle_id}/tesla/climate/steering_wheel

Summary: Steering Heater

Steering Heater

POST /v2.0/vehicles/{vehicle_id}/tesla/climate/steering_wheel

Summary: Steering Heater

Steering Heater

PARAMETERS /v2.0/vehicles/{vehicle_id}/tesla/climate/steering_wheel

GET /v2.0/vehicles/{vehicle_id}/tesla/virtual_key

Summary: Virtual Key Status

Virtual Key Status

PARAMETERS /v2.0/vehicles/{vehicle_id}/tesla/virtual_key

GET /v2.0/vehicles/{vehicle_id}/{make}/charge/voltmeter

Summary: Voltage

Voltage

PARAMETERS /v2.0/vehicles/{vehicle_id}/{make}/charge/voltmeter

GET /v2.0/vehicles/{vehicle_id}/{make}/charge/completion

Summary: Charge Completion Time

Charge Completion Time

PARAMETERS /v2.0/vehicles/{vehicle_id}/{make}/charge/completion

GET /v2.0/vehicles/{vehicle_id}/{make}/charge/records

Summary: Charge Records

Charge Records

PARAMETERS /v2.0/vehicles/{vehicle_id}/{make}/charge/records

GET /v2.0/vehicles/{vehicle_id}/{make}/charge/schedule_by_location

Summary: Charge Schedule by Location

Charge Schedule by Location

PUT /v2.0/vehicles/{vehicle_id}/{make}/charge/schedule_by_location

Summary: Charge Schedule by Location

Charge Schedule by Location

PARAMETERS /v2.0/vehicles/{vehicle_id}/{make}/charge/schedule_by_location

GET /v2.0/vehicles/{vehicle_id}/nissan/charge/schedule

Summary: Charge Schedule

Charge Schedule

POST /v2.0/vehicles/{vehicle_id}/nissan/charge/schedule

Summary: Charge Schedule

Charge Schedule

PARAMETERS /v2.0/vehicles/{vehicle_id}/nissan/charge/schedule

GET /v2.0/user

Summary: User

Description

Returns a paged list of all vehicles connected to the application for the current authorized user.

Query Parameters

ParameterTypeRequiredDescription
limitintegerfalseNumber of vehicles to return (default: 10).
offsetintegerfalseA vehicle ID (UUID v4).

Response Body

NameTypeDesciprtion
vehiclesarrayAn array of vehicle IDs.
vehicles.[]stringA vehicle ID (UUID v4).
pagingobjectMetadata about the current list of elements.
paging.countintegerThe total number of elements for the entire query (not just the given page).
paging.offsetintegerThe current start index of the returned list of elements.

GET /v2.0/vehicles/

Summary: All Vehicles

Description

Returns a paged list of all vehicles connected to the application for the current authorized user.

Query Parameters

ParameterTypeRequiredDescription
limitintegerfalseNumber of vehicles to return (default: 10).
offsetintegerfalseA vehicle ID (UUID v4).

Response Body

NameTypeDesciprtion
vehiclesarrayAn array of vehicle IDs.
vehicles.[]stringA vehicle ID (UUID v4).
pagingobjectMetadata about the current list of elements.
paging.countintegerThe total number of elements for the entire query (not just the given page).
paging.offsetintegerThe current start index of the returned list of elements.

GET /v2.0/vehicles/{vehicle_id}/permissions

Summary: Application Permissions

Description

Returns a list of the permissions that have been granted to your application in relation to this vehicle.

Query Parameters

ParameterTypeRequiredDescription
limitintegerfalseNumber of permissions to return (default: 25).
offsetintegerfalseA vehicle ID (UUID v4).

Response Body

NameTypeDesciprtion
permissionsarrayAn array of permissions.
permissions.[]stringA permission.
pagingobjectMetadata about the current list of elements.
paging.countintegerThe total number of elements for the entire query (not just the given page).
paging.offsetintegerThe current start index of the returned list of elements.

PARAMETERS /v2.0/vehicles/{vehicle_id}/permissions

GET /v2.0/vehicles/{vehicle_id}

Summary: Vehicle Info

Permission

Returns a single vehicle object, containing identifying information.

Permission

read_vehicle_info

Response Body

NameTypeDescription
idstringA vehicle ID (UUID v4).
makestringThe manufacturer of the vehicle.
modelintegerThe model of the vehicle.
yearintegerThe model year.

PARAMETERS /v2.0/vehicles/{vehicle_id}

GET /v2.0/vehicles/{vehicle_id}/odometer

Summary: Odometer

Description

Returns the vehicle’s last known odometer reading.

Permission

read_odometer

Response Body

NameTypeDesciprtion
distancenumberThe current odometer of the vehicle (in kilometers by default or in miles using the sc-unit-system).

PARAMETERS /v2.0/vehicles/{vehicle_id}/odometer

GET /v2.0/vehicles/{vehicle_id}/location

Summary: Location

Description

Retrieve latitude and longitude of a vehicle.

Permission

read_location

Response Body

NameTypeDesciprtion
latitudenumberThe latitude (in degrees).
longitudenumberThe longitude (in degrees).

PARAMETERS /v2.0/vehicles/{vehicle_id}/location

GET /v2.0/vehicles/{vehicle_id}/tires/pressure

Summary: Tire pressure

Description

Returns the air pressure of each of the vehicle’s tires. Permission

read_tires

Example Response

NameTypeDescription
frontLeftnumberThe current air pressure of the front left tire (in kilopascals by default or in pounds per square inch using the sc-unit-system).
frontRightnumberThe current air pressure of the front right tire (in kilopascals by default or in pounds per square inch using the sc-unit-system).
backLeftnumberThe current air pressure of the back left tire (in kilopascals by default or in pounds per square inch using the sc-unit-system).
backRightnumberThe current air pressure of the back right tire (in kilopascals by default or in pounds per square inch using the sc-unit-system).

PARAMETERS /v2.0/vehicles/{vehicle_id}/tires/pressure

GET /v2.0/vehicles/{vehicle_id}/security

Summary: Lock Status

Lock Status

PARAMETERS /v2.0/vehicles/{vehicle_id}/security

POST /v1.0/vehicles/{vehicle_id}/security

Summary: Lock Vehicle

Description

Lock the vehicle

Permission

control_security

Response body

NameTypeBoolean
statusstringIf the request is successful, Smartcar will return “success” (HTTP 200 status).

PARAMETERS /v1.0/vehicles/{vehicle_id}/security

GET /v2.0/vehicles/{vehicle_id}/fuel

Summary: Fuel Tank

Description

Returns the status of the fuel remaining in the vehicle’s gas tank. Note: The fuel tank API is only available for vehicles sold in the United States.

Permission

read_fuel

Response Body

NameTypeDesciprtion
rangenumberThe estimated remaining distance the car can travel (in kilometers by default or in miles using the sc-unit-system).
percentRemainingnumberThe remaining level of fuel in the tank (in percent).
amountRemainingnumberThe amount of fuel in the tank (in liters by default or in gallons (U.S.) using the sc-unit-system).

PARAMETERS /v2.0/vehicles/{vehicle_id}/fuel

GET /v2.0/vehicles/{vehicle_id}/engine/oil

Summary: Engine Oil Life

Description

Returns the remaining life span of a vehicle’s engine oil.

Permission

read_engine_oil

Response body

NameTypeBoolean
lifeRemainingnumberThe engine oil’s remaining life span (as a percentage). Oil life is based on the current quality of the oil. (in percent).

PARAMETERS /v2.0/vehicles/{vehicle_id}/engine/oil

GET /v2.0/vehicles/{vehicle_id}/battery

Summary: EV Battery Level

Description

Retrieve EV battery level of a vehicle.

Permission

read_battery

Response body

NameTypeBoolean
percentRemainingnumberAn EV battery’s state of charge (in percent).
rangenumberThe estimated remaining distance the vehicle can travel (in kilometers by default or in miles using the sc-unit-system.

PARAMETERS /v2.0/vehicles/{vehicle_id}/battery

GET /v2.0/vehicles/{vehicle_id}/battery/capacity

Summary: EV Battery Capacity

Description

Returns the total capacity of an electric vehicle’s battery.

Permission

read_battery

Response body

NameTypeBoolean
capacitynumberThe total capacity of the vehicle’s battery (in kilowatt-hours).

PARAMETERS /v2.0/vehicles/{vehicle_id}/battery/capacity

GET /v2.0/vehicles/{vehicle_id}/charge/limit

Summary: EV Charge Limit

EV Charge Limit

POST /v2.0/vehicles/{vehicle_id}/charge/limit

Summary: EV Charge Limit

EV Charge Limit

PARAMETERS /v2.0/vehicles/{vehicle_id}/charge/limit

GET /v2.0/vehicles/{vehicle_id}/charge

Summary: EV Charge Status

Description

Returns the current charge status of an electric vehicle.

Permission

read_charge

Response body

NameTypeBoolean
isPluggedInbooleanIndicates whether a charging cable is currently plugged into the vehicle’s charge port.
statestringIndicates whether the vehicle is currently charging. Options: CHARGING FULLY_CHARGED NOT_CHARGING

POST /v2.0/vehicles/{vehicle_id}/charge

Summary: Control Charge

Control Charge

PARAMETERS /v2.0/vehicles/{vehicle_id}/charge

GET /v2.0/compatibility

Summary: Compatibility

In the US, compatibility will return a breakdown by scope of what a car is capable of. In Europe, the check is based on the make of the car so will return only a true or false

The Compatibility API lets developers determine whether a given vehicle is compatible with Smartcar and whether it is capable of the features their application requires. Using this endpoint, developers can determine whether specific vehicles are eligible before sending a user through Smartcar Connect.

A compatible vehicle is one that:

  1. Has the hardware required for internet connectivity
  2. Belongs to the makes and models Smartcar is compatible with in the vehicle’s country

A vehicle is capable of given feature if:

  1. The vehicle supports the feature (e.g., a Ford Escape supports /fuel but a Mustang Mach-e does not)
  2. Smartcar supports the feature for the vehicle’s make

Note: The Compatibility API is currently available for vehicles sold in the United States. For other countries, please contact us to request early access. Our initial release for vehicles sold outside of the United States only supports checking compatibility. It does not yet support checking capabilities.

NameTypeBoolean
compatiblebooleantrue if the vehicle is likely compatible.*, false otherwise.
reasonstring | nullOne of the enum values described below if compatible is false, null otherwise.
capabilitiesarrayAn array containing the set of endpoints that the provided scope value can provide authorization for. This array will be empty if compatible is false
capabilities[].permissionstringOne of the permissions provided in the scope parameter.
capabilities[].endpointstringOne of the endpoints that the permission authorizes access to.
capabilities[].capablebooleantrue if the vehicle is likely capable of this feature.*, false otherwise.
capabilities[].reasonstring | nullOne of the enum values described below if capable is false, null otherwise.

Note: The compatibility of a vehicle depends on many factors including its make, model, model year, trim, package, and head unit. The Smartcar Compatibility API is optimized to return false positives rather than false negatives.

Enum Values

ParameterValueDescription
reasonVEHICLE_NOT_COMPATIBLEThe vehicle does not have the hardware required for internet connectivity.
MAKE_NOT_COMPATIBLESmartcar is not yet compatible with the vehicle’s make in the specified country.
capabilities[].reasonVEHICLE_NOT_CAPABLETThe vehicle does not support this feature.
SMARTCAR_NOT_CAPABLESmartcar is not capable of supporting the given feature on the vehicle’s make.

DELETE /v2.0/vehicles/{vehicle_id}/application

Summary: Revoke Access

Description

Revoke access for the current requesting application. This is the correct way to disconnect a vehicle.

Response body

NameTypeBoolean
statusstringIf the request is successful, Smartcar will return “success” (HTTP 200 status).

PARAMETERS /v2.0/vehicles/{vehicle_id}/application

POST /v2.0/vehicles/{vehicle_id}/webhooks/{webhook_id}

Summary: Subscribe

Description

Returns the current charge status of an electric vehicle.

Permission

read_charge

Response body

NameTypeBoolean
isPluggedInbooleanIndicates whether a charging cable is currently plugged into the vehicle’s charge port.
statestringIndicates whether the vehicle is currently charging. Options: CHARGING FULLY_CHARGED NOT_CHARGING

DELETE /v2.0/vehicles/{vehicle_id}/webhooks/{webhook_id}

Summary: Unsubscribe

Description

Returns the current charge status of an electric vehicle.

Permission

read_charge

Response body

NameTypeBoolean
isPluggedInbooleanIndicates whether a charging cable is currently plugged into the vehicle’s charge port.
statestringIndicates whether the vehicle is currently charging. Options: CHARGING FULLY_CHARGED NOT_CHARGING

PARAMETERS /v2.0/vehicles/{vehicle_id}/webhooks/{webhook_id}

Graph View

Backlinks

  • No backlinks found