Background

Getting Started with uicAPI

Welcome to the uicAPI Documentation! Here you will find everything you need to get started with our API and access data programmatically. (Currently only supports CS classes, Work in progress)

Base URL

All API requests start with the following base URL:

https://uicapi.com/api/v1

Authentication

To access the API, you must include your API key in the request headers. If you don't have an API key yet, sign up on the Developer Dashboard and generate one.

Make sure to save your entire API key, as the LongKey will not be provided to you after the initial generation. If you lose your API key, you can generate a new one on the Developer Dashboard.

Header: Authorization: Bearer YOUR_API_KEY

Endpoint Examples

1. Get Class Data

  • URL: /api/v1/courses/dep/{DEP}
  • Method: GET
  • Description: Retrieve a list of all classes. 'DEP' can only equal to CS (as of now)
GET https://uic-api.xyz/api/v1/courses/dep/CS Authorization: Bearer YOUR_API_KEY

2. Get Grade Distribution by Instructor

  • URL: /api/v1/grade-dist/instructors
  • Method: GET
  • Description: Retrieve grade distribution for courses taught by a specific instructor.
  • Query Parameters:
    • first_name - Instructor's first name
    • last_name - Instructor's last name
GET https://uic-api.xyz/api/v1/grade-dist/instructors?first_name=John&last_name=Smith Authorization: Bearer YOUR_API_KEY

Error Codes

Here are the common errors you may encounter:

  • 400: Bad Request - Your request is invalid or missing required parameters.
  • 401: Unauthorized - Your API key is missing or invalid.
  • 404: Not Found - The requested resource does not exist.
  • 500: Internal Server Error - An error occurred on the server.

Support

If you have any questions or issues, contact our support team: