aztu-api

A JavaScript library for interacting with the Azerbaijan Technical University (AzTU) LMS system.

This library provides a simple, promise-based API to authenticate a student and access announcements, profile information, transcript, schedule, lectures, tasks, and attendance records.

Installation

To install the library, type in terminal:

npm install aztu-api

Usage

All methods are available on a Student instance after logging in. Examples are provided in the src/examples folder.

import Student from "aztu-api";

const student = new Student({
	user_id: "YOUR_STUDENT_ID",
	password: "YOUR_PASSWORD"
});

await student.login();

// Fetch various data
const announcements = await student.announcements();
const info = await student.info();
const examPassword = await student.examPassword();
const transcript = await student.transcript();
const schedule = await student.schedule();
const lectures = await student.lectures();
const tasks = await student.tasks();
const attendance = await student.attendance();

| Example | Description | File | |---------|-------------|------| | login() | Authenticate a student and obtain a token | login.js | | announcements() | Fetch and display student announcements | announcements.js | | info() | Retrieve the student's profile information | info.js | | examPassword() | Get the student's exam password | examPassword.js | | transcript() | Fetch the transcript with semester lectures | transcript.js | | schedule() | Retrieve the weekly schedule | schedule.js | | lectures() | List all lectures for the student | lectures.js | | tasks() | Fetch and display student tasks | tasks.js | | attendance() | Retrieve attendance records | attendance.js |

All examples import Student class and demonstrate usage. You can run them with Node.js.

Caching

All data-fetching methods cache their results internally.

By default, cached data is returned on subsequent calls. To force a fresh request, pass false as the first argument:

await student.transcript(false);

Error Handling

Most methods throw an AuthenticationError if the user is not authenticated or if the server rejects the request.

try {
	await student.transcript();
} catch (err) {
	if (err.name === "AuthenticationError") {
		console.error("Authentication failed");
	}
}

Disclaimer

This library is intended for educational and research purposes only.

Access to the LMS requires valid student credentials and is limited to authorized users. This project is not officially affiliated with Azerbaijan Technical University.

The author does not encourage misuse, automated abuse, or access beyond the permissions granted to the authenticated user.

License

See the LICENSE file for license rights and restrictions. (ISC)