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(
  "school-name",
  "username",
  "password",
);

const client = new WebUntisClient(credentials);

await client.auth.login();

// Get what you need

await client.auth.logout();

Own Timetable

const range = {
  start: new Date("2026"),
  end: new Date("2027"),
}

await client.timetable.getOwn(range);

Class Timetable

const range = {
  start: new Date("2026"),
  end: new Date("2027"),
}

await client.timetable.getClass(range);

Homeworks

const range = {
  start: new Date("2026"),
  end: new Date("2027"),
}

await client.homeworks.get(range);

Absences

const range = {
  start: new Date("2026"),
  end: new Date("2027"),
}

await client.absences.get(range);

Data

client.data.get();

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.