yama-client 0.2.1

The official Python client for the Yama access-control API.

Docs: https://python.yamasystems.com/ · REST API: https://app.yamasystems.com/api/v2/docs/ · Source: https://github.com/YASS-Ltd/yama-python

Manage a building's access codes and read its call log from Python. The client handles auth, pagination, retries and errors, and gives you typed objects back.

Install

uv add yama-client  # or: pip install yama-client

Quick start

Create an API key in the Yama portal under Settings › API keys, with read access to access codes and the call log, and set it as YAMA_API_KEY. Keep it out of source control.

from datetime import datetime, timezone

from yama import Yama

client = Yama()  # reads YAMA_API_KEY

for code in client.codes.list():
    print(code.name, code.expires_at)

start = datetime(2026, 10, 1, tzinfo=timezone.utc)
end = datetime(2026, 11, 1, tzinfo=timezone.utc)  # exclusive: all of October
for call in client.calls.list(start=start, end=end):
    print(call.started_at, call.result)

What you get

• Typed: Pydantic models with UTC-aware datetimes, so your editor autocompletes.
• Every item: iterating a list yields every item, and each call in the call log comes once.
• Safe retries: on 429 (honouring Retry-After), 5xx and network errors, for every call, creates included: a code is never created twice.
• Clear errors: one exception class per kind of failure, listed in the docs.
• Forward-compatible: new fields and enum values from the API don't break your code.
• Small: two dependencies, httpx and Pydantic. Python 3.10 and newer.

Versioning

SemVer, targeting version 2 of the Yama API (/api/v2/). Release notes are on GitHub Releases.

Contributing

Bug reports and ideas are welcome in issues. Development uses uv and just: just check runs everything CI does. Report security issues privately; see SECURITY.md.

Licence

MIT © Yama Access Software Systems Ltd.