Skip to main content

pyunipolsai

Async Python client for the Unipol (UnipolSai) Unibox telematics API: vehicle position, driving statistics, and alert events for the black box fitted under an Italian Unipol motor policy.

Built by reverse engineering the Android app and verifying every call against a live account. The findings behind it are written up in docs/FINDINGS.md.

import asyncio
from pyunipolsai import UnipolSaiClient


async def main():
    async with UnipolSaiClient(username="you@example.com", password="...") as client:
        for vehicle in await client.async_get_vehicles():
            position = await client.async_get_position(vehicle)
            print(
                vehicle.plate,
                position.latitude,
                position.longitude,
                position.timestamp,
                f"{position.quota.remaining} refreshes left",
            )


asyncio.run(main())

What it does

Method Returns Cost
async_get_vehicles() list[Vehicle], usable ones by default free
async_get_position(vehicle) Position free
async_get_position(vehicle, force_refresh=True) Position spends daily quota
async_get_services(vehicle) dict[str, Service] free
async_get_notifications(vehicle, service) list[Notification] free
async_get_crashes(vehicle) list[Crash] free
async_get_crash(vehicle, id) Crash with the reconstruction free
async_get_usage(vehicle) UsageStats free

Things this API does that will surprise you

The library handles all of these; they're listed so the behaviour isn't mistaken for a bug.

A bearer token is not enough. Login also sets F5 BIG-IP session cookies that must ride on every request. The client keeps one cookie-persisting session and treats a 403 as "log in again" rather than "refresh the token". A stored long-lived token is not a workable auth model here.

Plates are country-prefixed in URLs (IT-AB123CD). Pass a Vehicle or a bare plate; normalise_plate sorts it out.

Declared types lie. Dates are declared String in the app but sent as epoch milliseconds. Distances are metres, times are seconds. heading is a cardinal letter ("N"), not degrees. accuracy is a small quality grade, not a radius, which is why this library calls it Position.quality. Mapping a 1 onto something like Home Assistant's gps_accuracy would claim a one-metre fix.

There are two separate budgets. Position.quota is the daily cap on forced refreshes (observed limit: 5). Plain reads never touch it. Separately, Service.credits_available is a slower pool that pays for having a service switched on. rangeStatistics needs no credits at all, so driving statistics are free to poll.

force_refresh=True is fire and forget. It returns immediately with the old position and pending_request False; the flag goes true a few seconds later and the cycle takes roughly five minutes. It can finish without the position changing, which is what a car parked with the engine off looks like, and that costs no quota. Compare timestamp against the value you had before to tell success from give-up.

async_get_notifications returns only the most recent event despite the plural field name, so two events inside one poll interval collapse into one. The app receives these as push; there is no push path here.

The crash endpoints are unverified. Everything else here was checked against live traffic. The crash models come from the app's decompiled source, because the account this was developed against answers HTTP 404 on crashes and so has nothing to compare against. async_get_crashes flattens that 404 to an empty list, since there is no way to tell "no impacts on record" from "no crash detection on this contract". If you have real crash data and these fields are wrong, please open an issue.

A crash is a detection, not an accident. Crash.validated is true only when Unipol or the telematics provider has graded it as one. The list endpoint omits the reconstruction; fetch one by id for samples and strengths, and Crash.climax picks out the moment of impact.

date_range is a single letter. g is the whole contract period, t is a custom range needing epoch-millisecond start/end. Word-style values like LAST_MONTH are rejected.

Gateway credentials

Requests carry the app's IBM API Connect credentials (x-ibm-client-id, x-ibm-client-secret, x-unipol-tenant). Working defaults ship in const.py: they are app-global rather than per-user, and travel inside a public Play Store app, so they are no more secret than any baked-in mobile API key.

Unipol can rotate them. Override them if that happens, without waiting for a release:

UnipolSaiClient(
    username=..., password=..., client_id=..., client_secret=..., tenant=...
)

docs/CAPTURE.md explains how to capture new ones. It needs no account.

Install

pip install pyunipolsai

Developed in the ha-unipolsai repository alongside the Home Assistant integration that uses it, and released from a pyunipolsai-vX.Y.Z tag there.

Tests

pip install -e '.[test]'
pytest

The fixtures are real captured payloads with identifiers replaced.

Interoperability and European law

Unipol publishes no API for the Unibox, so the data the box records about a policyholder's own car is reachable only through their app. This library exists to close that gap, and the work behind it relies on exceptions European law provides for precisely this case: Article 5(3) and Article 6 of Directive 2009/24/EC, which permit studying a program and reproducing its code where that is indispensable to make an independently created program interoperate, with Article 8 rendering contrary contract terms null and void. Regulation (EU) 2023/2854, the Data Act, applicable since 12 September 2025, separately obliges the holder of connected-product data to make it available to the user (Articles 4 and 5), and GDPR Articles 15 and 20 cover the personal data in it.

Nothing here defeats authentication or circumvents a technical protection measure. It signs in with the account holder's own credentials, reads that account's own data through the endpoints the app itself uses, and respects the server-side quotas. The full reasoning and the reverse-engineering notes are in the repository.

Not legal advice.

Release files for pyunipolsai 0.2.0

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

Source distribution (sdist)

Source distribution for pyunipolsai 0.2.0
File Size Uploaded
pyunipolsai-0.2.0.tar.gz 17.0 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for pyunipolsai 0.2.0
File Interpreter ABI Platform
pyunipolsai-0.2.0-py3-none-any.whl Python 3 none any Details

Total release size: 32.2 kB

Release files / pyunipolsai-0.2.0.tar.gz

Download URL pyunipolsai-0.2.0.tar.gz
Size 17.0 kB
Tags Source
SHA-256 checksum
How to use checksums
4b90c8693a234207b20e2b0c02fda07d7e954e3ddc3ffa8ddd54f11584c97a81
BLAKE2b-256 checksum
How to use checksums
5fbeb70023dad9912e00700f55c7cb437caaeaed289750505e2a1ffe17e403c7
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.14

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Sep 20, 2026.

Transparency log

Release files / pyunipolsai-0.2.0-py3-none-any.whl

Download URL pyunipolsai-0.2.0-py3-none-any.whl
Size 15.2 kB
Tags Python 3
SHA-256 checksum
How to use checksums
d5a8e6f1e41c1b3b6edb9d77b298b8a4d17dd7407fbc01a80d56bcc4670ed0c3
BLAKE2b-256 checksum
How to use checksums
feae94f2c51b7612417c414f576aec9d750d4317196dd460bc95c83c487c1a4f
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.14

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Sep 20, 2026.

Transparency log

Release history Release notifications | RSS feed

This release

0.2.0 This release

2 release files

0.1.0

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page