tobiasehlert/teslamateapi repository overview

⁠TeslaMateApi

TeslaMateApi is a RESTful API to get data collected by self-hosted data logger TeslaMate⁠ in JSON.

• Written in Golang⁠
• Data is collected from TeslaMate Postgres database and local MQTT Broker
• Endpoints return data in JSON format
• Send commands to your Tesla through the TeslaMateApi

⁠Table of Contents

• How to use⁠
  • Docker-compose⁠
  • Environment variables⁠
• API documentation⁠
  • Available endpoints⁠
  • Authentication⁠
  • Commands⁠
• Security information⁠
• Credits⁠

⁠How to use

You can either use it in a Docker container or go download the code and deploy it yourself on any server.

⁠Docker-compose

If you run the simple Docker deployment of TeslaMate, then adding this will do the trick. You'll have TeslaMateApi exposed at port 8080 locally then.

services:
  teslamateapi:
    image: tobiasehlert/teslamateapi:latest
    restart: always
    depends_on:
      - database
    environment:
      - ENCRYPTION_KEY=MySuperSecretEncryptionKey
      - DATABASE_USER=teslamate
      - DATABASE_PASS=secret
      - DATABASE_NAME=teslamate
      - DATABASE_HOST=database
      - MQTT_HOST=mosquitto
      - TZ=Europe/Berlin
    ports:
      - 8080:8080

If you are using TeslaMate Traefik setup in Docker with environment variables file (.env), then you can simply add this section to the services: section of the docker-compose.yml file:

services:
  teslamateapi:
    image: tobiasehlert/teslamateapi:latest
    restart: always
    depends_on:
      - database
    environment:
      - ENCRYPTION_KEY=${TM_ENCRYPTION_KEY}
      - DATABASE_USER=${TM_DB_USER}
      - DATABASE_PASS=${TM_DB_PASS}
      - DATABASE_NAME=${TM_DB_NAME}
      - DATABASE_HOST=database
      - MQTT_HOST=mosquitto
      - TZ=${TM_TZ}
    labels:
      - "traefik.enable=true"
      - "traefik.port=8080"
      - "traefik.http.middlewares.redirect.redirectscheme.scheme=https"
      - "traefik.http.middlewares.teslamateapi-auth.basicauth.realm=teslamateapi"
      - "traefik.http.middlewares.teslamateapi-auth.basicauth.usersfile=/auth/.htpasswd"
      - "traefik.http.routers.teslamateapi-insecure.rule=Host(`${FQDN_TM}`)"
      - "traefik.http.routers.teslamateapi-insecure.middlewares=redirect"
      - "traefik.http.routers.teslamateapi.rule=Host(`${FQDN_TM}`) && (Path(`/api`) || PathPrefix(`/api/`))"
      - "traefik.http.routers.teslamateapi.entrypoints=websecure"
      - "traefik.http.routers.teslamateapi.middlewares=teslamateapi-auth"
      - "traefik.http.routers.teslamateapi.tls.certresolver=tmhttpchallenge"

In this case, the TeslaMateApi would be accessible at teslamate.example.com/api/

⁠Environment variables

Basically the same environment variables for the database, mqqt and timezone need to be set for TeslaMateApi as you have for TeslaMate.

Required environment variables (even if there are some default values available)

Optional environment variables

Commands environment variables

⁠API documentation

More detailed documentation of every endpoint will come..

⁠Available endpoints

• GET /api
• GET /api/v1
• GET /api/v1/cars
• GET /api/v1/cars/:CarID
• GET /api/v1/cars/:CarID/battery-health
• GET /api/v1/cars/:CarID/charges
  • Supported parameters:
    • startDate (optional, use canonical UTC format in RFC3339)
    • endDate (optional, use canonical UTC format in RFC3339)
    • location (optional, filter by location name or address)
• GET /api/v1/cars/:CarID/charges/current
• GET /api/v1/cars/:CarID/charges/:ChargeID
• GET /api/v1/cars/:CarID/command
• POST /api/v1/cars/:CarID/command/:Command
• GET /api/v1/cars/:CarID/drives
  • Supported parameters:
    • startDate (optional, use canonical UTC format in RFC3339)
    • endDate (optional, use canonical UTC format in RFC3339)
    • minDistance (optional, filter by minimum trip distance, units based on TeslaMate settings)
    • maxDistance (optional, filter by maximum trip distance, units based on TeslaMate settings)
    • location (optional, filter by start or end location name or address)
• GET /api/v1/cars/:CarID/drives/:DriveID
• PUT /api/v1/cars/:CarID/logging/:Command
• GET /api/v1/cars/:CarID/logging
• GET /api/v1/cars/:CarID/status
• GET /api/v1/cars/:CarID/updates
• POST /api/v1/cars/:CarID/wake_up
• GET /api/v1/globalsettings
• GET /api/healthz
• GET /api/ping
• GET /api/readyz

⁠Authentication

If you want to use command or logging endpoints such as /api/v1/cars/:CarID/command/:Command, /api/v1/cars/:CarID/wake_up, or /api/v1/cars/:CarID/logging/:Command you need to add authentication to your request.

You need to specify a token yourself (called API_TOKEN) in the environment variables file, to set it. The token has the requirement to be a minimum of 32 characters long.

There are two main options available for authentication:

1. Adding extra header Authorization: Bearer <token> to your request. (recommended option)

   • Alternatively set API_TOKEN_HEADER to a custom header name (for example X-API-Token) and send the raw token in that header: X-API-Token: <token> (no "Bearer" prefix).

2. Adding URI parameter ?token=<token> to the endpoint you try to reach. (not a good option)

* Note: If you use the second option and your logs get compromised, your token will be leaked.

⁠Commands

Commands are not enabled by default.

You need to enable them in your environment variables (with ENABLE_COMMANDS=true) and you need to specify which commands you want to use as well.

There are 3 ways of using Commands:

1. Specific groups of commands can be enabled for example COMMANDS_ALERT=true will enable the alert⁠ commands group.

2. If you need a granular set of commands enabled COMMANDS_ALLOWLIST=/path/to/allow_list.json can be used to specify a JSON formatted list of commands⁠ to enable.

3. The most coarse option COMMANDS_ALL=true will enable all commands (specific groups and allow_list will be ignored).

* Note: if COMMANDS_ALL or any specific group of commands has been enabled COMMANDS_ALLOWLIST is ignored.

A list of possible commands can be found under environment variables⁠.

Regarding what fields you need to provide in the commands, we will referr to the timdorr/tesla-api⁠ documentation.

⁠Security information

There is no possibility to get access to your Tesla account tokens by this API and we'll keep it this way!

The data that is accessible is data like the cars, charges, drives, current status, updates and global settings.

Also, apply some authentication on your webserver in front of the container, so your data is not unprotected and too exposed. In the example above, we use the same .htpasswd file as used by TeslaMate.

If you have applied a level of authentication in front of the container API_TOKEN_DISABLE=true will allow commands without requiring the header or uri token value. But even then it's always rekommended to use an apikey.

⁠Credits

• Authors: Tobias Lindberg – List of contributors⁠
• Distributed under MIT License