Developer Documentation
/ Vehicles
Vehicle Information
Basic Information
This is an object representing a vehicle on the Teslascope service. Note: Some information is accessible if a vehicle is public, while additional information if an authenticated request is made.
{ "code": 200, "response": { "name": "Nautilus", "public_id": "corsair", "odometer": 29642.56, "model": "Model 3", "trim": "Performance", "year": "2018", "car_version": "2020.16.2.1", "battery": { "level": 42, "range": "122.62", "charge_limit_soc": 81, "charging_state": "Disconnected", "minutes_remaining": 0, "time_remaining": "0.00", "scheduled_charging_pending": false, "scheduled_charging_start_time": null }, "climate": { "inside": 77.2, "outside": 76.1, "is_auto_conditioning_on": false, "is_climate_on": false, "is_front_defroster_on": false, "is_rear_defroster_on": false, "seat_heaters": { "left": 0, "right": 0, "left_rear": 0, "center_rear": 0, "right_rear": 0 } }, "statistics": { "drives": 1080, "distance": 16490.14, "drives_duration": 1590554, "charges": 7, "supercharging": 0, "charges_duration": 311221, "charges_kwh": 125.97, "joined": "56 weeks and 1 days", "hw": "3.0" }, "vehicle": { "locked": true, "sentry_mode": false, "latitude": "[redacted]", "longitude": "[redacted]", "is_user_present": false, "windows": { "driver_front": false, "driver_rear": false, "passenger_front": false, "passenger_rear": false }, "config": { "color": "Red", "color_name": "Red Multicoat", "wheels": "Stiletto20DarkSquare", "spoiler": "Passive", "roof_color": "Glass" } } } }
Detailed Information
This is an object representing detailed vehicle information.
{ "code": 200, "response": { "id": 1, "vehicle_id": 1234567890, "special_vehicle_id": 1234567890, "public_id": "corsair", "vin": "[redacted]", "name": "Nautilus", "state": "online", "api_version": 42, "primary": 1, "logging": 1, "idle_override": 15, "recent_override": 10, "free_supercharging": 1, "fsd_enabled": 1, "eap_enabled": 1, "ap_enabled": 0, "shared_override": 1, "billing_day": 4, "private": 0, "country": "us", "restful": 1, "sleep_start_at": null, "sleep_end_at": null, "co2_saved": 73, "trees_planted": 1529, "safety_logging": 1, "specs": "[redacted]", "created_at": "2019-04-27T02:53:13.000000Z", "updated_at": "2022-11-15T14:55:30.000000Z", "recently_updated_at": "2022-11-15T14:55:30.000000Z", "recently_driven_at": null, "recently_charged_at": null, "recently_updated": false, "vehicle_config": { "id": 1, "vehicle_id": 1, "can_accept_navigation_requests": 1, "can_actuate_trunks": 1, "car_special_type": "base", "car_type": "model3", "charge_port_type": "US", "driver_assist": null, "eu_vehicle": 0, "mcu": 2, "exterior_color": "MidnightSilver", "exterior_trim": "Chrome", "interior_trim_type": null, "has_air_suspension": 0, "has_ludicrous_mode": 0, "key_version": 2, "motorized_charge_port": 1, "perf_config": "", "plg": "0", "rear_seat_heaters": 1, "roof_color": "Glass", "spoiler_type": "None", "trim_badging": "p74d", "wheel_type": "Pinwheel18", "created_at": "2019-04-27T02:57:02.000000Z", "updated_at": "2020-10-31T21:11:54.000000Z" }, "vehicle_state": { "id": 1, "vehicle_id": 1, "car_version": "2022.20.19 8088dce3f2cd", "hw_version": "3.0", "is_user_present": 0, "locked": 1, "odometer": "80996.162530", "sentry_mode": 0, "speed_limit_mode": 0, "valet_mode": 0, "current_limit_mph": 50, "max_limit_mph": 90, "min_limit_mph": 50, "software_update_status": "", "software_update_version": " ", "software_update_expected_duration": 2700, "software_update_download_perc": 0, "software_update_install_perc": 1, "fd_window": 0, "fp_window": 0, "rd_window": 0, "rp_window": 0, "tpms_pressure_fl": "2.875", "tpms_pressure_fr": "2.85", "tpms_pressure_rl": "2.85", "tpms_pressure_rr": "2.9", "sun_roof_state": null, "sun_roof_percent_open": null, "homelink_device_count": 0, "homelink_nearby": 0, "dashcam_state": null, "created_at": "2019-04-27T02:57:02.000000Z", "updated_at": "2022-11-15T14:55:31.000000Z" }, "climate_state": { "id": 1, "vehicle_id": 1, "driver_temp_setting": "21.10", "passenger_temp_setting": "21.10", "fan_status": "0.00", "inside_temp": "13.50", "outside_temp": "12.50", "max_avail_temp": "28.00", "min_avail_temp": "15.00", "is_auto_conditioning_on": 0, "is_climate_on": 0, "is_front_defroster_on": 0, "is_rear_defroster_on": 0, "is_preconditioning": 0, "smart_preconditioning": 0, "left_temp_direction": 488, "right_temp_direction": 488, "steering_wheel_heater": null, "seat_heater_left": 0, "seat_heater_right": 0, "seat_heater_rear_center": 0, "seat_heater_rear_left": 0, "seat_heater_rear_right": 0, "side_mirror_heaters": 0, "wiper_blade_heater": 0, "created_at": "2019-04-27T02:57:02.000000Z", "updated_at": "2021-12-19T01:13:31.000000Z" }, "charge_state": { "id": 1, "vehicle_id": 1, "battery_level": 45, "usable_battery_level": 45, "battery_range": "124.44", "est_battery_range": "112.25", "charge_enable_request": 1, "charge_energy_added": "7.12", "charge_limit_soc": 90, "charge_limit_soc_max": 100, "charge_limit_soc_min": 50, "charge_limit_soc_std": 90, "charge_port_cold_weather_mode": 0, "charge_port_door_open": 1, "charge_port_latch": "Engaged", "charge_rate": "4.60", "charger_power": 1, "charger_voltage": 116, "charging_state": "Charging", "minutes_to_full_charge": 1530, "time_to_full_charge": "25.50", "conn_charge_cable": "SAE", "fast_charger_brand": "", "fast_charger_type": "MCSingleWireCAN", "fast_charger_present": "", "scheduled_charging_pending": 0, "scheduled_charging_start_time": null, "created_at": "2019-04-27T02:57:02.000000Z", "updated_at": "2021-12-19T01:13:31.000000Z" }, "drive_state": { "id": 1, "vehicle_id": 1, "heading": 290, "latitude": "[redacted]", "longitude": "[redacted]", "native_location_supported": 1, "native_latitude": "[redacted]", "native_longitude": "[redacted]", "native_type": "wgs", "power": -1, "shift_state": null, "speed": null, "created_at": "2019-04-27T02:57:02.000000Z", "updated_at": "2021-12-19T01:13:31.000000Z" }, "locations": [ { "id": 1, "vehicle_id": 1, "category": "home", "name": "Corsair Abode", "description": "This is where I live.", "latitude": "[redacted]", "longitude": "[redacted]", "radius": "0.06", "geocode_id": 0, "created_at": "2020-05-09T12:02:12.000000Z", "updated_at": "2021-06-13T09:31:09.000000Z" }, { "id": 3148, "vehicle_id": 1, "category": "family", "name": "Mother's House", "description": null, "latitude": "[redacted]", "longitude": "[redacted]", "radius": "0.50", "geocode_id": 0, "created_at": "2021-06-15T02:33:16.000000Z", "updated_at": "2021-06-15T02:33:16.000000Z" } ], "safety_score": { "id": 1, "vehicle_id": 1, "start_date": "2022-10-17", "end_date": "2022-11-15", "drive_rating": 0, "safety_score": 94, "miles_driven": 747, "autopilot_miles_driven": 131, "drive_hours": 0, "as_count": 0, "as_decile": "0.0", "as_raw": "0.000000000000", "fcw_count": 0, "fcw_decile": "0.5", "fcw_avg": "8.0", "fcw_median": "0.0", "fcw_raw": "8.034660930855", "hr_decile": "0.7", "hr_avg": "22.0", "hr_median": "15.8", "hr_raw": "22.017823605708", "hb_decile": "0.2", "hb_avg": "0.9", "hb_median": "1.8", "hb_raw": "0.943059206587", "hc_decile": "0.5", "hc_avg": "2.3", "hc_median": "2.8", "hc_raw": "2.347879740311", "generated_safety_score": "93.735294117647", "miles_remaining": 8624, "total_miles_driven": 748, "total_autopilot_miles_driven": 132, "weighted_miles": 70114, "created_at": "2021-10-03T05:54:44.000000Z", "updated_at": "2021-10-03T05:54:44.000000Z", "timezone": null }, "reminders": [ { "id": 4, "vehicle_id": 1, "topic": "general", "comment": "Fix the crack in the rear windshield.", "odometer": 80999, "completed": 0, "reminded_at": "2022-11-15 14:55:32", "completed_at": null, "completed_at_odometer": null, "created_at": "2022-11-01T16:26:44.000000Z", "updated_at": "2022-11-15T14:55:32.000000Z" } ] } }
Reminders
Returns a list of reminders for the vehicle.
{ "code": 200, "response": [ { "id": 4, "vehicle_id": 1, "topic": "general", "comment": "Fix the crack in the rear windshield.", "odometer": 80999, "completed": 0, "reminded_at": "2022-11-15 14:55:32", "completed_at": null, "completed_at_odometer": null, "created_at": "2022-11-01T16:26:44.000000Z", "updated_at": "2022-11-15T14:55:32.000000Z" } ] }
Driving & Charging
Driving Sessions
This is a list of all driving sessions for a vehicle.
{ "code": 200, "response": { "current_page": 30, "data": [ { "id": 43074, "vehicle_id": 1, "name": null, "description": null, "distance": "4.660000", "duration": 1920, "avg_speed": 9, "efficiency": null, "battery_level_start": 49, "battery_range_start": "145.78", "battery_level_end": 47, "battery_range_end": "139.37", "latitude_start": "[redacted]", "longitude_start": "[redacted]", "latitude_end": "[redacted]", "longitude_end": "[redacted]", "private": 1, "type": "personal", "valet": 0, "hide_speeding": 1, "import_id": null, "created_at": "2022-11-05T02:29:05.000000Z", "updated_at": "2022-11-05T03:01:05.000000Z" }, { "id": 43104, "vehicle_id": 1, "name": null, "description": null, "distance": "2.490000", "duration": 420, "avg_speed": 22, "efficiency": null, "battery_level_start": 46, "battery_range_start": "137.66", "battery_level_end": 45, "battery_range_end": "135.10", "latitude_start": "[redacted]", "longitude_start": "[redacted]", "latitude_end": "[redacted]", "longitude_end": "[redacted]", "private": 1, "type": "personal", "valet": 0, "hide_speeding": 1, "import_id": null, "created_at": "2022-11-05T06:43:05.000000Z", "updated_at": "2022-11-05T06:50:05.000000Z" } ], "first_page_url": "https://teslascope.com/api/vehicle/corsair/drives?page=1", "from": 581, "next_page_url": "https://teslascope.com/api/vehicle/corsair/drives?page=31", "path": "https://teslascope.com/api/vehicle/corsair/drives", "per_page": 20, "prev_page_url": "https://teslascope.com/api/vehicle/corsair/drives?page=29", "to": 600 } }
Driving Session
Returns details for a specific driving session.
{ "code": 200, "response": { "id": 43074, "vehicle_id": 1, "name": null, "description": null, "distance": "4.660000", "duration": 1920, "avg_speed": 9, "efficiency": null, "battery_level_start": 49, "battery_range_start": "145.78", "battery_level_end": 47, "battery_range_end": "139.37", "latitude_start": "[redacted]", "longitude_start": "[redacted]", "latitude_end": "[redacted]", "longitude_end": "[redacted]", "private": 1, "type": "personal", "valet": 0, "hide_speeding": 1, "import_id": null, "created_at": "2019-11-05T02:29:05.000000Z", "updated_at": "2019-11-05T03:01:05.000000Z", "progress": [ { "id": 572312, "heading": 229, "latitude": "[redacted]", "longitude": "[redacted]", "odometer": "20436.572642", "shift_state": "D", "power": 2, "speed": 3, "battery_level": 49, "usable_battery_level": 49, "battery_range": "145.78", "est_battery_range": "127.15", "fan_status": "3.00", "inside_temp": "24.60", "outside_temp": "24.00", "is_auto_conditioning_on": 1, "is_climate_on": 1, "imported": 0, "created_at": "2019-11-05T02:29:05.000000Z", "updated_at": "2019-11-05T02:29:05.000000Z" }, { "id": 572317, "heading": 285, "latitude": "[redacted]", "longitude": "[redacted]", "odometer": "20436.616138", "shift_state": "D", "power": 45, "speed": 24, "battery_level": 49, "usable_battery_level": 49, "battery_range": "145.78", "est_battery_range": "126.24", "fan_status": "3.00", "inside_temp": "23.80", "outside_temp": "23.50", "is_auto_conditioning_on": 1, "is_climate_on": 1, "imported": 0, "created_at": "2019-11-05T02:30:05.000000Z", "updated_at": "2019-11-05T02:30:05.000000Z" } ] } }
Charging Sessions
Returns a list of all charging sessions for the vehicle.
{ "code": 200, "response": { "current_page": 20, "data": [ { "id": 411153, "vehicle_id": 1, "name": null, "battery_level_start": 49, "battery_range_start": "141.03", "battery_level_end": 73, "battery_range_end": "213.24", "charge_energy_added": "17.69", "charge_energy_calculated": "17.69", "charge_limit_soc": 81, "conn_charge_cable": "SAE", "fast_charger_brand": "", "fast_charger_type": "Tesla", "fast_charger_present": "1", "odometer": "43016.807648", "latitude": "[redacted]", "longitude": "[redacted]", "duration": 1012, "cost": "0.00", "currency": null, "private": 1, "import_id": null, "created_at": "2021-01-08T21:30:17.000000Z", "updated_at": "2021-05-25T05:37:09.000000Z" }, { "id": 411442, "vehicle_id": 1, "name": null, "battery_level_start": 10, "battery_range_start": "29.92", "battery_level_end": 64, "battery_range_end": "186.32", "charge_energy_added": "38.22", "charge_energy_calculated": "38.22", "charge_limit_soc": 81, "conn_charge_cable": "SAE", "fast_charger_brand": "", "fast_charger_type": "Tesla", "fast_charger_present": "1", "odometer": "43162.255117", "latitude": "[redacted]", "longitude": "[redacted]", "duration": 1471, "cost": "0.00", "currency": null, "private": 1, "import_id": null, "created_at": "2021-01-09T00:25:09.000000Z", "updated_at": "2021-05-25T05:37:09.000000Z" } ], "first_page_url": "https://teslascope.com/api/vehicle/corsair/charges?page=1", "from": 381, "next_page_url": "https://teslascope.com/api/vehicle/corsair/charges?page=21", "path": "https://teslascope.com/api/vehicle/corsair/charges", "per_page": 20, "prev_page_url": "https://teslascope.com/api/vehicle/corsair/charges?page=19", "to": 400 } }
Charging Session
Returns details for a specific charging session.
{ "code": 200, "response": { "id": 411153, "vehicle_id": 1, "name": null, "battery_level_start": 49, "battery_range_start": "141.03", "battery_level_end": 73, "battery_range_end": "213.24", "charge_energy_added": "17.69", "charge_energy_calculated": "17.69", "charge_limit_soc": 81, "conn_charge_cable": "SAE", "fast_charger_brand": "", "fast_charger_type": "Tesla", "fast_charger_present": "1", "odometer": "43016.807648", "latitude": "[redacted]", "longitude": "[redacted]", "duration": 1012, "cost": "0.00", "currency": null, "private": 1, "import_id": null, "created_at": "2021-01-08T21:30:17.000000Z", "updated_at": "2021-05-25T05:37:09.000000Z", "progress": [ { "id": 37485319, "charge_id": 411153, "battery_level": 49, "usable_battery_level": 49, "battery_range": "141.03", "est_battery_range": "123.92", "charge_energy_added": "14.03", "charge_limit_soc": 82, "charge_port_cold_weather_mode": 1, "charge_port_door_open": 1, "charge_port_latch": "Engaged", "conn_charge_cable": "SAE", "fast_charger_brand": "", "fast_charger_type": "Tesla", "fast_charger_present": "1", "charge_rate": "256.60", "charger_power": 63, "charger_voltage": 383, "charging_state": "Charging", "minutes_to_full_charge": 20, "time_to_full_charge": "0.33", "imported": 0, "created_at": "2021-01-08T21:30:17.000000Z", "updated_at": "2021-01-08T21:30:17.000000Z" }, { "id": 37485392, "charge_id": 411153, "battery_level": 50, "usable_battery_level": 50, "battery_range": "144.45", "est_battery_range": "126.92", "charge_energy_added": "14.87", "charge_limit_soc": 82, "charge_port_cold_weather_mode": 1, "charge_port_door_open": 1, "charge_port_latch": "Engaged", "conn_charge_cable": "SAE", "fast_charger_brand": "", "fast_charger_type": "Tesla", "fast_charger_present": "1", "charge_rate": "259.00", "charger_power": 63, "charger_voltage": 383, "charging_state": "Charging", "minutes_to_full_charge": 20, "time_to_full_charge": "0.33", "imported": 0, "created_at": "2021-01-08T21:30:49.000000Z", "updated_at": "2021-01-08T21:30:49.000000Z" } ] } }
Trip Management
Trips
Returns a list of all trips for the vehicle.
{ "code": 200, "response": [ { "id": 1, "vehicle_id": 25187, "name": "Example Trip", "description": null, "category": "general", "private": 0, "auto_add": 0, "created_at": "2025-01-15T03:30:51.000000Z", "updated_at": "2025-01-15T03:30:51.000000Z", "drive_ids": [], "charge_ids": [] } ] }
Trip
Returns details for a specific trip.
{ "code": 200, "response": { "id": 1, "vehicle_id": 25187, "name": "Example Trip", "description": null, "category": "general", "private": 0, "auto_add": 0, "created_at": "2025-01-15T03:30:51.000000Z", "updated_at": "2025-01-15T03:30:51.000000Z", "drive_ids": [], "charge_ids": [] } }
Trip (Add Item)
This is an object representing adding a drive or charging session to a trip.
{ "code": 200, "response": true }
Trip (Remove Item)
Removes a drive or charging session from a trip.
{ "code": 200, "response": true }
Location Management
Vehicle Locations
Returns a list of saved locations for the vehicle.
Create Location
Creates a new saved location for the vehicle.
Required Parameters
name
(string) - Name of the locationlatitude
(float) - Latitude coordinatelongitude
(float) - Longitude coordinate
Optional Parameters
description
(string) - Description of the locationcategory
(string) - Category of the locationradius
(float) - Radius of the geofence in milesnotify_on_enter
(boolean) - Whether to notify on enternotify_on_leave
(boolean) - Whether to notify on leave
Update Location
Updates an existing saved location for the vehicle.
Required Parameters
locationId
(integer) - ID of the location to update
Optional Parameters
name
(string) - Updated name of the locationdescription
(string) - Updated descriptionlatitude
(float) - Updated latitude coordinatelongitude
(float) - Updated longitude coordinateradius
(float) - Updated radius in milesnotify_on_enter
(boolean) - Updated notify on enter settingnotify_on_leave
(boolean) - Updated notify on leave setting
Remove Location
Removes a saved location from the vehicle.
Required Parameters
locationId
(integer) - ID of the location to remove
Vehicle Management
Activate Vehicle
Activates a vehicle, enabling all vehicle interactions and data collection.
Deactivate Vehicle
Deactivates a vehicle, disabling all vehicle interactions and data collection.
Update Vehicle Name
Updates the name of a vehicle.
Required Parameters
name
(string) - New name for the vehicle