aiorentman

Unofficial asynchronous Python library to interact with the Rentman API. Requires Python >= 3.14.

This is a client for a documented public API, but it is not affiliated with or endorsed by Rentman B.V. Rentman runs one rolling API version and migrates integrations automatically, so the library pins its contract to the OpenAPI document it ships with and validates every endpoint against it.

Install

uv add aiorentman

Scope

The library covers the resources an RFID and materials project needs. Reads cover every documented GET path:

Writes cover every documented POST, PUT, and DELETE path:

Token

Rentman issues one static token per user, generated in the application under Configuration, Integrations. Only the last generated token is valid. Pass it explicitly or set RENTMAN_TOKEN:

import asyncio

from aiorentman import RentmanClient


async def main() -> None:
    async with RentmanClient(token="your-api-token") as client:
        page = await client.async_list_equipment()
        print(page.item_count, "materials on this page")


asyncio.run(main())

Querying

Every list method takes a Query with the field selection, sorting, filters, expansion, and paging that the API supports:

from aiorentman import Query, Sort, eq, lt

query = Query(
    fields=("name", "code", "price"),
    sort=(Sort("name"),),
    expand=("folder",),
    filters=(eq("code", "AUD-001"), lt("price", 200)),
    limit=100,
)
page = await client.async_list_equipment(query)

Filters support the relational operators the API documents: eq, neq, lt, lte, gt, gte, and is_null. Field names come straight from the API schema, including custom_<number> custom fields.

Linked fields such as equipment.folder hold a RentmanLink with the API path of the linked resource. Expand a field and the parser returns the full typed model instead.

RFID and materials

Rentman links every RFID tag to exactly one serial number, and the tag identifier lands in the qrcodes field of that serial number. The library exposes qrcodes as a parsed tuple. That field is generated by the Rentman backend, and the API can neither filter nor sort on it, so an RFID scan resolves against a local index built from a serial number sync:

index: dict[str, int] = {}
query = Query(fields=("serial", "qrcodes", "equipment"), limit=1500)
async for serial in client.async_iter_serial_numbers(query):
    for tag in serial.qrcodes:
        index[tag] = serial.id

The docs describe the full workflow, including expansion and availability checks: see docs/serial-numbers.rst.

Writing

Create and update methods take one payload class per resource, named after the model plus Payload. Fields left unset are left out of the request body, so an update touches only what the caller set:

from datetime import UTC, datetime

from aiorentman import RentmanLink, TaskPayload

task = await client.async_create_task(
    TaskPayload(
        color="#ff0000",
        name="Patch the rig",
        deadline=datetime(2026, 10, 6, 17, 0, tzinfo=UTC),
        status=RentmanLink("/taskstatuses/2"),
        custom={"custom_3": "truss"},
    )
)
await client.async_update_task(task.id, TaskPayload(color="#ff0000", name="Patched"))
await client.async_delete_task(task.id)

Datetime fields render as ISO 8601 and link fields take a RentmanLink holding the API path of the target. A create or update returns the parsed model of the saved object, or None when the response envelope degrades. A delete returns None. A 400 answer raises RentmanValidationError with the answer text in the message. Clearing a field to null is not supported, since fields left unset are not sent.

Rate limits

Rentman allows 10 requests per second, at most 20 concurrent requests, and 50.000 requests per day. The client enforces the first two by default. Pass requests_per_second=None to disable pacing, or lower it when several consumers share one account. Exceeding the server-side limits raises RentmanRateLimitError.

Errors

Development

uv sync
uv run python -m scripts.check

License

MIT. See LICENSE.