tesla-api

? A Ruby gem and unofficial documentation of the Tesla JSON API for the Model S, Model X, and Model 3.

  • Owner: timdorr/tesla-api
  • Platform:
  • License:: MIT License
  • Category::
  • Topic:
  • Like:
    0
      Compare:

Github stars Tracking Chart

Referrals are back! Need a Tesla to test with? Get one with 1,000 miles of free supercharging

Do you work at Tesla? Get in contact! I'd love to help with making this API official.

Tesla JSON API

View Documentation

This is unofficial documentation of the Tesla JSON API used by the iOS and Android apps.
The API provides functionality to monitor and control the Model S (and future Tesla vehicles) remotely.
The project provides both a documentation of the API and a Ruby library for accessing it.

If any folks at Tesla are reading this, I'd love to help coordinate a developer program for your APIs. If there's any way I can be helpful, please feel free to get in contact. Also, I'd love to be in the beta firmware program :wink:

Ruby Gem Gem Version Build Status

This gem provides a basic wrapper around the API to easily query and command the car remotely.
It also provides access to the streaming API and a means to process data coming from it.

Installation

Add this line to your application's Gemfile:

gem 'tesla_api'

Or install it yourself:

gem install tesla_api

Usage

Here's a quick example:

require 'tesla_api'

tesla_api = TeslaApi::Client.new(email: email, client_id: client_id, client_secret: client_secret)
tesla_api.login!(password)
# Or if you have an access token:
tesla_api = TeslaApi::Client.new(access_token: access_token) 

model_s = tesla_api.vehicles.first # => <TeslaApi::Vehicle>

model_s.wake_up
model_s.auto_conditioning_start unless model_s.climate_state["is_auto_conditioning_on"]

model_s.set_charge_limit(90)
model_s.charge_start

charge_state = model_s.charge_state
puts "Your Model S is #{charge_state["charging_state"]} " +
     "with a SOC of #{charge_state["battery_level"]}% " + 
     "and an estimate range of #{charge_state["est_battery_range"]} miles"

Ruby portions are Copyright (c) 2014-Present Tim Dorr. Released under the terms of the
MIT license. See LICENSE for details.

Main metrics

Overview
Name With Ownertimdorr/tesla-api
Primary LanguageRuby
Program languageRuby (Language Count: 2)
Platform
License:MIT License
所有者活动
Created At2013-02-03 00:00:55
Pushed At2024-12-06 08:09:00
Last Commit At2024-12-06 10:09:00
Release Count19
Last Release Namev3.1.0 (Posted on )
First Release Namev0.1.0 (Posted on 2014-12-14 23:16:03)
用户参与
Stargazers Count2k
Watchers Count130
Fork Count536
Commits Count644
Has Issues Enabled
Issues Count263
Issue Open Count19
Pull Requests Count209
Pull Requests Open Count3
Pull Requests Close Count37
项目设置
Has Wiki Enabled
Is Archived
Is Fork
Is Locked
Is Mirror
Is Private