TankMate
  • TankMate User Guide
    • TankMate WiFi Sensors
      • TankMate R3 WiFi Sensors
        • Set Up a New R3W WiFi Sensor
          • Tank Dimension Settings
          • Sensor Installation
          • Installation Video
        • Sensor Readings - R3
        • R3 Battery Replacement
      • TankMate v2 WiFi Sensors
        • v2 Battery Replacement
      • TankMate v1 WiFi Sensors
    • TankMate R3 LTE (Cellular) Sensors
      • Set Up a New R3L LTE / Cellular Sensor
      • Hardware Status - R3L Cellular / LTE Sensor
  • Troubleshooting - FAQ
  • Wi-Fi Connectivity
    • Check Status - v2 and R3W WiFi Sensors
    • Reconnect - R3 WiFi Level Sensor
    • Reconnect - v2 WiFi Level Sensor
    • Reconnect - v1 Level Sensor
    • Firmware Update - August 2023
    • Intermittent Data Issue - WiFi
    • Using BluConnect
    • Enabling Location Services
    • 2.4GHz WiFi Network
  • App User Guides
    • Mobile App
      • Tank Dimension Settings
      • Typical Tank Dimensions
      • Changing a TankMate Sensor
      • Multiple Sensors
      • Deleting a TankMate Account
    • TankMate API
  • Policies
    • Warranty
    • Privacy Policy
    • Terms of Use
Powered by GitBook
On this page
  1. App User Guides

TankMate API

Using the TankMate API service

PreviousDeleting a TankMate AccountNextWarranty

Last updated 1 year ago

An API subscription costs $49 / year, per account. This subscription is managed and billed through the new TankMate web app / portal - due for release in July 2024.

Note: API keys are free to trial for 30 days. Thereafter, an API subscription will be required.

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 , under the Settings tab - see image below.

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 web app
TankMate API Swagger UI documentation here
"status" and "level-data" endpoints
API Key accessed via the TankMate web app