> ## Documentation Index
> Fetch the complete documentation index at: https://docs.bilauitmcuti.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Today's Status

> Returns what is happening for a given date (defaults to today): class day, break, exam week, or study week from academic calendar data.



## OpenAPI

````yaml GET /api/v1/today
openapi: 3.0.3
info:
  title: Bila UiTM Cuti API
  version: '1'
  description: >-
    Unofficial API for UiTM academic calendar and Malaysian public holidays. Not
    affiliated with UiTM; verify important dates before production use.


    Rate limits (production): 500 requests per 60s per IP (CF-Connecting-IP) per
    endpoint; heavy calendar/meta modes (60 per 60s additional). GET /api/health
    is excluded. Cacheable successes expose RateLimit-Policy; 429 includes
    X-RateLimit-* / RateLimit / Retry-After. Optional remaining peek: GET
    /api/v1/rate-limit.
servers:
  - url: https://api.bilauitmcuti.com
security: []
paths:
  /api/v1/today:
    get:
      summary: Today's Status
      description: >-
        Returns what is happening for a given date (defaults to today): class
        day, break, exam week, or study week from academic calendar data.
      parameters:
        - name: group
          in: query
          required: true
          schema:
            type: string
            enum:
              - A
              - B
          description: >-
            Required. Select group first for session resolution. Accepted values
            are "A" or "B".
          example: A
        - name: date
          in: query
          required: false
          schema:
            type: string
          description: Target date in ISO format. Defaults to today's date when omitted.
          example: '2026-03-09'
        - name: session
          in: query
          required: false
          schema:
            type: string
          description: >-
            Session id from GET /api/v1/meta (`sessionOptions`). Do not
            hardcode; the published set changes each term. Omit to aggregate all
            sessions in the selected group.
          example: B-20264
        - name: program
          in: query
          required: false
          schema:
            type: string
            enum:
              - All
              - PreDiploma
              - Diploma
              - DiplomaPartTime
              - Bachelor
              - BachelorPartTime
              - Master
              - PhD
          description: Program filter, mainly for Group B sessions.
          example: Diploma
      responses:
        '200':
          description: Status snapshot for a date.
          headers:
            RateLimit-Policy:
              description: Published policies (RFC 9457).
              schema:
                type: string
                example: '"endpoint";q=500;w=60, "heavy";q=60;w=60'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TodayStatusResponse'
        '304':
          description: >-
            Not Modified. Empty body when If-None-Match matches the current
            ETag; Cache-Control and ETag headers are still sent.
          headers:
            RateLimit-Policy:
              description: Published policies (RFC 9457).
              schema:
                type: string
                example: '"endpoint";q=500;w=60, "heavy";q=60;w=60'
            ETag:
              description: Weak entity tag for this representation.
              schema:
                type: string
            Cache-Control:
              description: Caching policy for successful API responses.
              schema:
                type: string
        '400':
          description: >-
            Invalid or conflicting query parameters. Body: { error: string,
            detail?: string }.
          headers:
            X-RateLimit-Limit:
              description: >-
                Maximum requests allowed in the current window for the active
                bucket.
              schema:
                type: integer
            X-RateLimit-Remaining:
              description: >-
                Approximate remaining requests in the current window
                (best-effort per worker isolate; not authoritative across edge
                locations).
              schema:
                type: integer
            X-RateLimit-Reset:
              description: Unix timestamp when the current rate-limit window resets.
              schema:
                type: integer
            RateLimit-Policy:
              description: Published policies (RFC 9457).
              schema:
                type: string
                example: '"endpoint";q=500;w=60, "heavy";q=60;w=60'
            RateLimit:
              description: Active bucket quota (RFC 9457), e.g. `"endpoint";r=499;t=42`.
              schema:
                type: string
            Retry-After:
              description: Seconds until the current rate-limit window resets.
              schema:
                type: integer
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '429':
          description: >-
            Rate limited (500 requests per 60s per endpoint per IP; heavy modes
            add 60 per 60s). Check Retry-After and rate-limit headers. Body
            includes error, detail, and retryAfter (seconds).
          headers:
            X-RateLimit-Limit:
              description: >-
                Maximum requests allowed in the current window for the active
                bucket.
              schema:
                type: integer
            X-RateLimit-Remaining:
              description: >-
                Approximate remaining requests in the current window
                (best-effort per worker isolate; not authoritative across edge
                locations).
              schema:
                type: integer
            X-RateLimit-Reset:
              description: Unix timestamp when the current rate-limit window resets.
              schema:
                type: integer
            RateLimit-Policy:
              description: Published policies (RFC 9457).
              schema:
                type: string
                example: '"endpoint";q=500;w=60, "heavy";q=60;w=60'
            RateLimit:
              description: Active bucket quota (RFC 9457), e.g. `"endpoint";r=499;t=42`.
              schema:
                type: string
            Retry-After:
              description: Seconds until the current rate-limit window resets.
              schema:
                type: integer
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
components:
  schemas:
    TodayStatusResponse:
      type: object
      required:
        - apiVersion
        - baseUrl
        - date
        - sessionResolved
        - filters
        - statuses
        - primaryStatus
        - matchedActivities
      properties:
        apiVersion:
          type: string
        baseUrl:
          type: string
        date:
          type: string
          format: date
        sessionResolved:
          $ref: '#/components/schemas/SessionRef'
        filters:
          type: object
          required:
            - program
          properties:
            program:
              type: string
              nullable: true
        statuses:
          type: array
          items:
            type: string
        primaryStatus:
          type: string
        matchedActivities:
          type: array
          items:
            $ref: '#/components/schemas/CalendarActivity'
    ApiError:
      type: object
      required:
        - error
      properties:
        error:
          type: string
          description: Short machine-friendly error code or message.
        detail:
          type: string
          description: Human-readable explanation (optional).
        retryAfter:
          type: integer
          description: Seconds to wait before retrying; present on 429 responses.
    SessionRef:
      type: object
      required:
        - id
        - label
        - group
      properties:
        id:
          type: string
        label:
          type: string
        group:
          type: string
    CalendarActivity:
      type: object
      required:
        - name
        - startDate
        - endDate
        - type
        - group
      properties:
        name:
          type: string
          description: Activity title or label.
        startDate:
          type: string
          format: date
          description: Start date (ISO date).
        endDate:
          type: string
          format: date
          description: End date (ISO date).
        type:
          type: string
          description: >-
            Activity category (typical values: lecture, break, examination,
            registration, other).
        group:
          type: string
          description: Group code (e.g. A or B).
        duration:
          type: string
        details:
          type: string
        programType:
          type: string
        programTypes:
          type: array
          items:
            type: string
        allStudents:
          type: boolean
          description: When true, row applies to all students / cohort-wide.
        regionalStartDate:
          type: string
        regionalEndDate:
          type: string

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.