> ## 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.

# Rate-Limit Status

> Returns published rate-limit policies and best-effort remaining quota for the caller. Does not consume rate-limit budget. Optional `pathname` selects which route to inspect (defaults to this endpoint). Optional `heavy=true` includes the heavy bucket in the primary view.



## OpenAPI

````yaml GET /api/v1/rate-limit
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/rate-limit:
    get:
      summary: Rate-Limit Status
      description: >-
        Returns published rate-limit policies and best-effort remaining quota
        for the caller. Does not consume rate-limit budget. Optional `pathname`
        selects which route to inspect (defaults to this endpoint). Optional
        `heavy=true` includes the heavy bucket in the primary view.
      parameters:
        - name: pathname
          in: query
          required: false
          schema:
            type: string
          description: >-
            API path to inspect (must start with `/`, e.g. `/api/v1/calendar`).
            Defaults to `/api/v1/rate-limit`.
          example: /api/v1/calendar
        - name: heavy
          in: query
          required: false
          schema:
            type: string
            enum:
              - 'true'
              - '1'
              - 'yes'
          description: >-
            When true (also accepts "1" or "yes"), response highlights the heavy
            bucket alongside endpoint policy.
          example: 'true'
      responses:
        '200':
          description: >-
            Published rate-limit policies and best-effort remaining quota. Does
            not consume rate-limit budget.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RateLimitStatusResponse'
components:
  schemas:
    RateLimitStatusResponse:
      type: object
      required:
        - apiVersion
        - baseUrl
        - enforcement
        - pathname
        - heavyMode
        - policies
        - endpoint
        - heavy
      properties:
        apiVersion:
          type: string
        baseUrl:
          type: string
        enforcement:
          type: string
        pathname:
          type: string
        heavyMode:
          type: boolean
        policies:
          type: array
          items:
            type: object
            required:
              - name
              - limit
              - period
            properties:
              name:
                type: string
                enum:
                  - endpoint
                  - heavy
              limit:
                type: integer
              period:
                type: integer
              appliesWhen:
                type: string
        endpoint:
          $ref: '#/components/schemas/RateLimitBucketSnapshot'
        heavy:
          $ref: '#/components/schemas/RateLimitBucketSnapshot'
    RateLimitBucketSnapshot:
      type: object
      required:
        - name
        - limit
        - period
        - reset
        - retryAfter
      properties:
        name:
          type: string
          enum:
            - endpoint
            - heavy
        limit:
          type: integer
        period:
          type: integer
          description: Window length in seconds.
        remaining:
          type: integer
          nullable: true
          description: Best-effort remaining count for this isolate; null when unknown.
        reset:
          type: integer
          description: Unix timestamp when the window resets.
        retryAfter:
          type: integer
          description: Seconds until reset from now.

````

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