thameswaterapi 0.2.0

A Python client for retrieving hourly meter data from Thames Water

thameswaterapi

pip install thameswaterapi

A Python client for retrieving meter data from Thames Water.

This is a fork of thameswaterclient by Ayrton Bourn.

Python API

from thameswaterapi import ThamesWater

email = '[e-mail]'
password = '**********'

thames_water = ThamesWater(email=email, password=password)

If you have multiple accounts, you can specify which one to use:

thames_water = ThamesWater(email=email, password=password, account_number=123456789)

Listing accounts and meters

thames_water.get_account_numbers()  # [123456789011, 123456789012]
thames_water.get_meter_numbers()    # ['123456789']

Daily usage

from thameswaterapi import lines_to_timeseries

meters = thames_water.get_meters()
readings = lines_to_timeseries(meters.Lines)
for r in readings:
    print(r.start, r.usage, r.total)

Hourly usage

import datetime
from thameswaterapi import meter_usage_lines_to_timeseries

meter = thames_water.get_meter_numbers()[0]
start = datetime.datetime(2024, 10, 1)
end = datetime.datetime(2024, 10, 2)

meter_usage = thames_water.get_meter_usage(meter, start, end)
readings = meter_usage_lines_to_timeseries(start, meter_usage.Lines)
for r in readings:
    print(r.hour_start, r.usage, r.total)

Command line

python -m thameswaterapi EMAIL PASSWORD [options]

Options:

• --account-number N — use a specific contract account number (defaults to the account default)
• --list-accounts — list available contract account numbers and exit
• --list-meters — list meter serial numbers and exit
• --meter M — query a specific meter (defaults to first meter)

Examples:

# Show daily and hourly readings for the default account and first meter
python -m thameswaterapi [e-mail] mypassword

# List available account numbers
python -m thameswaterapi [e-mail] mypassword --list-accounts

# List meters on a specific account
python -m thameswaterapi [e-mail] mypassword --account-number 123456789012 --list-meters

# Query a specific meter
python -m thameswaterapi [e-mail] mypassword --meter 123456789