KeyAtome PyPi

GitHub release

Get your energy consumption data from Atome, a Linky-compatible device made by Total/Direct-Energie. A account can have several linky. With this library, you can address them one by one

Installing

pip install pykeyatome

Use

The __main__.py is provided to show an example of use.

4 types of function provided by client.py in AtomeClient class:

login : to be logged to the server
get_user_reference : to know which linky you have addressed
get_live : to retrieve live statistics (instant power)
get_consumption : to retrieve the consumption (by day over 3 months)

Acknowledgments

Thanks to k20human for the original inspiration with https://github.com/k20human/domoticz-atome
Thanks to reverse engineering of Atome IOS APP performed by BaQs.
This project is a fork of https://github.com/BaQs/pyAtome (seems to be unmaintained)

Breaking change

V1.2.0 Since this version PyAtomeError exception is no more used. Instead login return False if error , and live/consumption return None

V1.3.0 Login return None if error

V2.0.0 1rst implementation of TotalEnergy V2 protocol : Login, Live, Day are available.

V2.1.0 Clean APIv1 i.e. no more period (day, week, month, year)

V3.0.0 1rst implementation of TotalEnergy V3 protocol (login) REFERENCE_ID is the ID in your TotalEnergy Profile USER_ID is something to retrieve via a dedicated script find_user_id.bash (https://github.com/jugla/pyKeyAtome/tree/master/find_user_id) You have to edit it to set your password.

V3.0.1 add return in case of success in login V3.0.2 check cookie during login V3.0.3 clean code

Metadata

Release files for pykeyatome 3.0.3

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for pykeyatome 3.0.3
File	Size	Uploaded
pykeyatome-3.0.3.tar.gz	4.8 kB	May 27, 2026	Details

Built distribution (wheel)

Table of built distributions (wheels) for pykeyatome 3.0.3
File	Interpreter	ABI	Platform	Reset
pykeyatome-3.0.3-py3-none-any.whl 5.6 kB May 27, 2026	Python 3	none	any	Details

Total release size: 10.4 kB

Release files / pykeyatome-3.0.3.tar.gz

Download URL	pykeyatome-3.0.3.tar.gz
Size	4.8 kB
Tags	Source
SHA-256 checksum How to use checksums	`9a513c949ac78dba43154a3405d9739935a08e004f89202d6d2a22b2442c984c`
BLAKE2b-256 checksum How to use checksums	`be3f8d61b2ec1fa15ca8fea0ef5ca36bd106b1621795e340b44009fcdea48bc0`
Upload date	May 27, 2026
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/6.2.0 CPython/3.13.5`

Release files / pykeyatome-3.0.3-py3-none-any.whl

Download URL	pykeyatome-3.0.3-py3-none-any.whl
Size	5.6 kB
Tags	Python 3
SHA-256 checksum How to use checksums	`6b41bcc1d7a539efb19448a8849c4dbdacd9e862c9b10229e08a90ca511f25b7`
BLAKE2b-256 checksum How to use checksums	`527604443b38421e083d8a0d8f58371278d0661c44d652874228e479faaf28d7`
Upload date	May 27, 2026
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/6.2.0 CPython/3.13.5`