> For the complete documentation index, see [llms.txt](https://tankmate.gitbook.io/tankmate/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://tankmate.gitbook.io/tankmate/app-user-guides/tankmate-api.md).

# TankMate API

{% hint style="success" %}
A TankMate Premium Web Subscription is required to use the API service - AUD 49 / year, per account. This subscription is managed and billed through the new TankMate web app / portal.
{% endhint %}

### Accessing your API Key and User ID

To access your sensor data, a valid API Key is required, as well as your User ID (uid).  These can be accessed via the [TankMate web portal](https://tankmate.app/), under the Account tab.

The Tankmate API includes two endpoints:

* **Sensor status**: which returns the current state of all sensors linked to one account. This includes the current tank level, fill percentage etc. as well as the hardware status - such as the battery health, signal strength etc. 
* **Level data**: returns all readings for a specific sensor (deviceID), for the previous X number of days

#### Access the [TankMate API Swagger UI documentation here](https://api.tankmate.app/docs)

<figure><img src="/files/dvpjB82UfkAlGenSXm5Q" alt=""><figcaption><p>"status" and "level-data" endpoints</p></figcaption></figure>