aioimmich
Asynchronous library to fetch albums and assests from immich. The main purpose of this library is the integration of an immich instance into Home Assistant.
⚠️ this is in early development state ⚠️
breaking changes may occure at every time.
Requirements
- Python >= 3.11
- aiohttp
Installation
pip install aioimmich
Examples
Get all albums
import asyncio
import aiohttp
from aioimmich import Immich
async def main():
async with aiohttp.ClientSession() as session:
immich = Immich(session, "<API-KEY>", "<IMMICH-IP>")
await immich.async_setup()
for album in await immich.albums.async_get_all_albums():
print(f"Album: {album.album_name} contains {album.asset_count} assets")
if __name__ == "__main__":
asyncio.run(main())
Download an asset
import asyncio
import aiohttp
from aioimmich import Immich
async def main():
async with aiohttp.ClientSession() as session:
immich = Immich(session, "<API-KEY>", "<IMMICH-IP>")
await immich.async_setup()
asset_bytes = await immich.assets.async_view_asset("<ASSET-ID>", size="fullsize")
with open(f"my_nice_picture.jpg", "wb") as fh:
fh.write(asset_bytes)
if __name__ == "__main__":
asyncio.run(main())
Get server info
import asyncio
import aiohttp
from aioimmich import Immich
async def main():
async with aiohttp.ClientSession() as session:
immich = Immich(session, "<API-KEY>", "<IMMICH-IP>")
await immich.async_setup()
about_info = await api.server.async_get_about_info()
print(f"Version: {about_info.version}")
print(f"Is licensed: {about_info.licensed}")
storage_info = await api.server.async_get_storage_info()
print(f"Disk Available: {storage_info.disk_available}")
print(f"Disk Available (raw): {storage_info.disk_available_raw} bytes")
print(f"Disk Size: {storage_info.disk_size}")
print(f"Disk Size (raw): {storage_info.disk_size_raw} bytes")
print(f"Disk Usage: {storage_info.disk_usage_percentage}%")
print(f"Disk Use: {storage_info.disk_use}")
print(f"Disk Use (raw): {storage_info.disk_use_raw} bytes")
if __name__ == "__main__":
asyncio.run(main())
References
You like my work?
1 maintainer
Metadata
1 maintainer
Release files for aioimmich 0.18.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| aioimmich-0.18.0-py3-none-any.whl | Python 3 | none | any | Details |
Release files / aioimmich-0.18.0-py3-none-any.whl
| Download URL | aioimmich-0.18.0-py3-none-any.whl |
|---|---|
| Size | 21.3 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
1fe76fde9b63f0dbeff92d7c396fbdd40445eb22e002012561ce3f7d7a958c58
|
|
BLAKE2b-256 checksum How to use checksums |
c5e088a675b373ae4e8cda34ec08e706ce15fd4ea65ddaeccb01c8447b0206b5
|
| 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 Oct 8, 2026.
Transparency log
