Developer Documentation

Hello world. This documentation is dedicated towards providing Tesla owners, enthusiasts, and fans with a collection of easy-to-understand APIs that give access to the data on our service. It is important to note that this service is unofficial and not directly associated with Tesla, Inc.

We always appreciate any feedback, feature requests, and bug reports you may have. For these topics, please reach out to our team via email.

This documentation and endpoints are a work in progress and may be altered without warning until finalized. Please send feedback to [email protected].

Authentication

The Teslascope API uses access keys to authenticate some requests that pretain to account or vehicle information. Please sign up for an account or login to create an API key if needed.

Errors

Teslascope uses HTTP response codes to indicate the success or failure of a request, in addition to a "code" value in all JSON responses.

Vehicles

All vehicle endpoints pretaining to our platform, Teslascope.

Information

GET https://teslascope.com/api/vehicle/:public_id

This is an object representing a vehicle on the Teslascope service. You can retrieve it to access basic information if a vehicle is public, or additional information if an authenticated request is made.

Attributes

name
string
String representing the vehicle's name, provided by the owner.
public_id
string
The unique identifier of the vehicle.
odometer
decimal
The odometer reading of the vehicle.
model
string
The model of the vehicle (ie: Model 3).
trim
string
The specific trim of the vehicle (ie: Performance).
year
integer
The year designated by the VIN.
car_version
string
The current software update version.
battery
array
Contains variables regarding battery / charging information.
  • level
  • range
  • charge_limit_soc
  • charging_state
  • minutes_remaining
  • time_remaining
  • scheduled_charging_pending
  • scheduled_charging_start_time
climate
array
Contains variables regarding climate information.
  • inside
  • outside
  • is_auto_conditioning_on
  • is_climate_on
  • is_front_defroster_on
  • is_rear_refroster_on
  • seat_heaters (array)
statistics
array
Contains various statistics about the vehicle.
  • drives
  • distance
  • drives_duration
  • charges
  • supercharging
  • charges_duration
  • charges_kwh
  • joined
  • hw (hardware)
vehicle
array
Contains variables regarding vehicle status.
  • locked
  • sentry_mode
  • latitude
  • longitude
  • is_user_present
  • windows (array)
  • config (array)
render_url
string
The URL used to render this vehicle.

Response

Update

GET https://teslascope.com/api/vehicle/:public_id/update (requires access token)

This is an object representing an attempt to update a vehicle.

code
integer
The status code of the request.
response
string
The response text of the request.

Response

Commands (Vehicle Controls)

GET https://teslascope.com/api/vehicle/:public_id/command/:command (requires access token)

This is an object representing a command sent to a vehicle.

A list of all valid values for command are: honkHorn, flashLights, enableSentryMode, disableSentryMode, startAC, stopAC, ventWindows, closeWindows, openTrunk, openFrunk, openChargeDoor, closeChargeDoor

code
integer
The status code of the request.
response
string
The response text of the request.

Response

Wake Up

GET https://teslascope.com/api/vehicle/:public_id/wakeup (requires access token)

This is an object representing an attempt to wake up a vehicle. Please note: This endpoint may need to be requested multiple times before succeeding.

code
integer
The status code of the request.
response
string
The response text of the request.

Response

State (Vehicle Status)

GET https://teslascope.com/api/vehicle/:public_id/state (requires access token)

This is an object representing the current state (ie: online, asleep, offline) of a vehicle.

code
integer
The status code of the request.
response
string
The response text of the request.

Response

Teslapedia

All vehicle endpoints pretaining to our platform, Teslascope.

Software Updates

GET https://teslascope.com/api/software/:version

This is an object representing a software update.

code
integer
The status code of the request.
response
array
The response array of the request.

Attributes

version
string
The software update version.
commit
string
The git commit of this software update.
count
integer
The count of vehicles currently on this software update.
totalCount
integer
The total count of vehicles on the Teslascope platform (for comparisons).
percentage
decimal
The percentage of vehicles on the Teslascope platform on this software update.
firstSpotted
timestamp
The timestamp of the first vehicle spotted with this software update.
parent
string
The software version that shares the same release notes as this.

Response