Sha256: 374ff431c747c5b6ab78a89ea21fbecf1d0535d1b9efeed12fec1aa8340d3efc

Contents?: true

Size: 1.56 KB

Versions: 10

Compression:

Stored size: 1.56 KB

Contents

# Introduction

This is unofficial documentation of the Tesla JSON API used by their iOS and Android apps. It features functionality to monitor and control their vehicle (Model S, Model X, and Model 3) and power (Powerwall) products. We currently have documentation for their vehicles, but always accept [pull requests](https://github.com/timdorr/tesla-api/pulls) for improvements and additions.

## Before You Begin

The base URI for all requests is `https://owner-api.teslamotors.com/` (except for the Streaming and Autopark APIs)

_All requests require a_ `User-Agent` _header with any value provided._ For Tesla's sake, it's recommended you identify your application in some way using this header.

## API Organization

The API for vehicles is organized into 3 primary surfaces:

### State and commands

Gives point-in-time data about the state of the vehicle and basic controls over certain functions of the vehicle. The state and command APIs loosely adhere to the REST standard, but differ in some crucial ways. As a result, you may not be able to use it with many REST tools and libraries out of the box.

### Streaming telemetry

Streams in data about the car's telemetry at up to half second increments. The underlying protocol is simply a streaming HTTP API that provides JSON objects at regular intervals.

### Autopark ("Summon")

A streaming command mode to control the automatic parking of HW1 (Autopilot v1) and HW2/HW2.5 (Autopilot v2) cars. This API uses a standard WebSocket that exchanges JSON objects to convey state information and issue commands during the Autopark session.

Version data entries

10 entries across 10 versions & 1 rubygems

Version Path
tesla_api-3.0.4 docs/README.md
tesla_api-3.0.3 docs/README.md
tesla_api-3.0.2 docs/README.md
tesla_api-3.0.1 docs/README.md
tesla_api-3.0.0 docs/README.md
tesla_api-2.0.0 docs/README.md
tesla_api-1.5.0 docs/README.md
tesla_api-1.4.1 docs/README.md
tesla_api-1.4.0 docs/README.md
tesla_api-1.3.0 docs/README.md