https://github.com/kritsel/tado-openapispec-v2
Community managed tado API definition (OpenAPI schema), documenting the operations in the https://my.tado.com/api/v2 tado API
https://github.com/kritsel/tado-openapispec-v2
api-definition openapi tado tado-api
Last synced: about 2 months ago
JSON representation
Community managed tado API definition (OpenAPI schema), documenting the operations in the https://my.tado.com/api/v2 tado API
- Host: GitHub
- URL: https://github.com/kritsel/tado-openapispec-v2
- Owner: kritsel
- License: mit
- Created: 2024-07-28T15:12:17.000Z (11 months ago)
- Default Branch: main
- Last Pushed: 2025-03-24T07:50:27.000Z (3 months ago)
- Last Synced: 2025-03-29T08:43:49.692Z (3 months ago)
- Topics: api-definition, openapi, tado, tado-api
- Language: Kotlin
- Homepage: https://kritsel.github.io/tado-openapispec-v2/
- Size: 281 KB
- Stars: 26
- Watchers: 1
- Forks: 3
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://github.com/kritsel/tado-openapispec-v2/releases)
[](https://github.com/kritsel/tado-openapispec-v2/stargazers)
[](https://github.com/kritsel/tado-openapispec-v2/commits/main/)
[](https://github.com/kritsel/tado-openapispec-v2/graphs/contributors)
*Full documentation is available in [this repo's Wiki](https://github.com/kritsel/tado-openapispec-v2/wiki).
This README is a summary.*
# About tadoº, tado API and this tado API definition
## tadoº and the tado API
tadoº (https://www.tado.com/) is a german based company which offers a smart thermostat solution
to control heating and air-conditioning in your home.
They sell hardware and subscription based add-on services.
These can be controlled via a mobile app or a webapp on their website.
The apps use a tado API which is available at https://my.tado.com/api/v2.
tadoº allows third-party developers to use this API for their own projects,
(see [here](https://community.tado.com/en-gb/discussion/23573/tado-x-breaking-api-changes))
but they do not provide any kind of support or publish documentation.
## tado API definition
This repository contains a community managed API definition for the
**tado API v2** which is hosted on https://my.tado.com/api. It uses OpenAPI v3.0.0 as its specification language.
The API definition is based on the experience of software developers who are experimenting
with the API to create their own solutions.
This API definition is not maintained or officially published by the tadoº company.
The contents of this API definition is a best-effort product.
There are no guarantees that this API definition is a complete and
correct representation of the actual API as exposed via https://my.tado.com/api/v2.
As the owner of the repo I do not have any ties to the tadoº company.
I simply like to create a space where knowledge about the tado API can be centralized and shared in a standardized form,
so it becomes easier for software developers interested in home automation to use the API.
Links to the API definition in various formats:
* **file in this GitHub repo**: [tado-openapispec-v2.yaml](tado-openapispec-v2.yaml)
* **raw content**: https://raw.githubusercontent.com/kritsel/tado-openapispec-v2/latest/tado-openapispec-v2.yaml
* **Swagger UI**: https://kritsel.github.io/tado-openapispec-v2/swagger.html
# API support for tadoº X
The tado API hosted on https://my.tado.com/api has limited support for tadoº X devices.
Tadoº hosts a separate API geared towards tadoº X.
More info is available at https://github.com/kritsel/tado-openapispec-v2/wiki/tado-X
# Acknowledgments
Without the groundwork done by **Stephen C. Phillips**
(https://blog.scphillips.com/posts/2017/01/the-tado-api-v2/)
and **Terence Eden** (https://shkspr.mobi/blog/2019/02/tado-api-guide-updated-for-2019/)
I would have never started experimenting with the tado API,
and this API definition would have never seen the light of day.
Additionally, the following GitHub members and repositories have been a great help:
* [**mattdavis90** Matt Davis](https://github.com/mattdavis90): https://github.com/mattdavis90/node-tado-client
* [**clambin** Christophe Lambin](https://github.com/clambin)
* [**wmalgadey** Wolfgang Malgadey](https://github.com/wmalgadey): sharing information about tadoº X support
# Contribute
Feel free to submit a PR or create an issue if you want to contribute to this
API definition.
Special request for owners of the new tado X hardware: if you have knowledge about any https://my.tado.com/ endpoints
described in this definition which do not work as described, please create an issue (or submit a PR) with
documentation improvement suggestions.