Exporter for EKZ data provided on the http://my.ekz.ch customer portal.
Get it from PyPI:
$ python -m pip install ekzexport
You can then use the ekzexport
CLI.
To authenticate, you can either put your credentials into a JSON file
ekzexport.json
in your home directory:
{
"user": "myusername",
"password": "mypassword"
}
Or use the --user
and --password
options. The following examples use a JSON
file.
First, list your contracts to find the installation ID of interest:
$ ekzexport overview
Contracts
╷ ╷ ╷
Installation ID │ Address │ Move-in Date │ Move-out Date
╺━━━━━━━━━━━━━━━━━┿━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┿━━━━━━━━━━━━━━┿━━━━━━━━━━━━━━━╸
123 │ Somestreet 1, 8000 Someplace │ 2010-01-01 │ 2020-01-01
456 │ Some Other Street 2, 8001 Otherplace │ 2020-01-02 │
╵ ╵ ╵
With the installation ID, we can then figure out what kind of data is available for your account:
$ ekzexport installation 456 properties
Properties
╷ ╷
Property │ From │ Until
╺━━━━━━━━━━━━━━━━┿━━━━━━━━━━━━┿━━━━━━━━━━━━╸
CONTRACT │ 2020-01-02 │ 2024-05-01
SMART_METER │ 2020-01-02 │ 2024-05-01
VERB_15MIN │ 2020-01-02 │ 2024-05-01
VERB_TAG_EDM │ 2020-01-02 │ 2024-05-01
VERB_TAG_METER │ 2020-01-02 │ 2024-05-01
╵ ╵
If you do not see any entry for 15 minute values, you likely have to enable granular data on myEKZ first.
You can print consumption data to get an idea what is available:
$ ekzexport installation 456 data --type PK_VERB_TAG_EDM --from 2024-04-01 --to 2024-04-02 show
Consumption Data
╷ ╷ ╷
Time │ kWh │ Tariff │ Status
╺━━━━━━━━━━━━━━━━━━━━━┿━━━━━━━━┿━━━━━━━━┿━━━━━━━━╸
2024-04-01 00:00:00 │ 12.123 │ NT │ VALID
2024-04-01 00:00:00 │ 10.123 │ HT │ VALID
2024-04-02 00:00:00 │ 12.678 │ NT │ VALID
2024-04-02 00:00:00 │ 8.678 │ HT │ VALID
╵ ╵ ╵
But the more interesting use-case is to export data. Available exporters are:
csv
to sync data to a CSV file in the same format as myEKZ offersinfluxdb
to sync data to an InfluxDB 2.x server
The CLI's help command will provide further detail on the exporter-specific options, for example:
$ ekzexport installation 456 data export csv --help
If you're using a Linux distribution using systemd, you can create a service
and trigger to run the export periodically. To do so, create
/etc/systemd/system/ekzexport.service
with something like:
[Unit]
Description=Pull EKZ data
[Service]
Type=oneshot
ExecStart=/path/to/ekzexport/venv/bin/ekzexport installation 456 data export csv -f data.csv
WorkingDirectory=/path/to/ekzexport
This example assumes you created a Python virtualenv to install ekzexport
in (which keeps the dependencies local in the venv). You can also
set up an OnFailure
hook to send emails in case the export fails.
A corresponding timer can look something like this in /etc/systemd/system/ekzexport.timer
:
[Unit]
Description=Run ekzexport once a day
[Timer]
OnCalendar=*-*-* 04:00:00
RandomizedDelaySec=30m
Persistent=true
[Install]
WantedBy=timers.target
Please keep the randomized delay to avoid myEKZ getting a flood of requests at exactly 04:00 every night. Remember to enable and start the timer.