OpensourceNITJ - API

By Developers, For Developers

Features:

• Get student details using roll number
• Get simplified view of timetable to embed into your applications
• Get real-time library seat availability

Routes

Health Check

GET /health

Returns the health status of the API server.

Response (200)

{
  "status": "ok",
  "uptime": 12345.67,
  "timestamp": "2026-01-16T14:32:10.123Z"
}

Field	Type	Description
status	string	Health status of the API
uptime	number	Server uptime in seconds
timestamp	string	ISO 8601 timestamp

---

Get Library Seat Availability

GET /library/getSeats

Returns real-time library seat availability information across all floors.

Response (200)

{
  "totalAvailableSeats": 390,
  "totalCapacity": 390,
  "capacity": [
    {
      "floor": "Floor 1",
      "occupiedSeats": 0,
      "availableSeats": 114,
      "totalSeats": 114,
      "availableSeatIds": [1, 2, 3]
    }
  ]
}

Field	Type	Description
totalAvailableSeats	number	Total available seats in the library
totalCapacity	number	Total seating capacity of the library
capacity	object[]	Floor-wise seating statistics

capacity Object

Field	Type	Description
floor	string	Floor name
occupiedSeats	number	Number of occupied seats on the floor
availableSeats	number	Number of available seats on the floor
totalSeats	number	Total seats available on the floor
availableSeatIds	number[]	Available seat numbers relative to the floor

Error Response (404)

{
  "error": "Library information not found"
}

Field	Type	Description
error	string	Error message

---

Get Student Group (First Year Only)

GET /students/getGroup

Returns the group and subgroup (e.g., B6, a) of a first-year student based on their roll number.

Query Parameters

Parameter	Type	Description
rollNumber	string	Required. Roll number of student

Response (200)

{
  "group": "B6",
  "subGroup": "a"
}

Field	Type	Description
group	string	Student group (A1-B6)
subGroup	string	Student subgroup (a, b, c)

Error Response (404)

Group not found for the provided roll number.

---

Get First Year Timetable

GET /timetable/year/1

Returns the timetable for first-year students.

Query Parameters

Parameter	Type	Description
group	string	Required. Group (A1–B6)

Response (200)

{
  "timetableData": {
    "Monday": {
      "period1": [
        [
          {
            "subject": "Maths",
            "faculty": "Dr. Sharma",
            "room": "LT-1"
          }
        ]
      ]
    }
  },
  "notes": ["Practical classes start next week"]
}

timetableData structure

Record<
  string,
  Record<
    string,
    Array<
      Array<{
        subject: string;
        faculty: string;
        room: string;
      }>
    >
  >
>;

Field	Type	Description
subject	string	Subject name
faculty	string	Faculty name
room	string	Room or lab

Field	Type	Description
notes	string[]	Additional timetable notes

Error Response (400)

{
  "error": "Invalid group parameter"
}

Field	Type	Description
error	string	Error message

---

Base URL

https://api.opensourcenitj.com