Web Untis Client

A Web Untis API Client to interact with Web Untis.

Caution

Work In Progress - Not feature complete yet

Examples

Login

const credentials = new Credentials(
    "WebUntisClient",
    "school-name",
    "username",
    "password",
);

const client = new WebUntisClient(credentials);

await client.login();

// Get what you need

await client.logout();

Own Timetable

const start = new Date("2026");
const end = new Date("2027");

await client.getOwnTimetable(start, end);

Class Timetable

const start = new Date("2026");
const end = new Date("2027");

await client.getClassTimetable(start, end);

Homeworks

const start = new Date("2026");
const end = new Date("2027");

await client.getHomeworks(start, end);

Absences

const start = new Date("2026");
const end = new Date("2027");

await client.getAbsences(start, end);

App data

await client.getAppData();

Profile data

await client.getProfile();

Installation

yarn add webuntis-client

npm i webuntis-client

pnpm i webuntis-client

License

MIT

Disclaimer

This is an unofficial client and is not affiliated with Untis GmbH.
Inspired by WebUntis.