Jupiterp API v0 Docs (pre-release)

Introduction

Welcome to the Jupiterp API, a free and open-source API to get detailed course data for the University of Maryland. Currently, the API is in pre-release phase and is unstable; expect breaking changes, but the information in these docs should be correct and up-to-date.

For any questions or bugs, please contact admin@jupiterp.com.

Feel free to view or contribute to the project on GitHub.

Endpoints

/v0/

(back to endpoints)

This is the base endpoint for v0 of the Jupiterp API. It will simply return a HTTP StatusOK with some text to indicate that the Jupiterp API is online.

/v0/courses

(back to endpoints)

Gets a list of courses that match the given query parameters. This endpoint does not return section information; for section info, use the sections endpoint listed below.

Query parameters

Output

Examples

Getting multiple specific courses

Request: GET http://api.jupiterp.com/v0/courses?courseCodes=CMSC131,MATH141

Response:

[
        {
            "course_code": "CMSC131",
            "name": "Object-Oriented Programming I",
            "min_credits": 4,
            "max_credits": null,
            "gen_eds": null,
            "conditions": [
            "Corequisite: MATH140. ",
            "Credit only granted for: CMSC131, CMSC133 or CMSC141."
            ],
            "description": "Introduction to programming and computer science.
            Emphasizes understanding and implementation of applications using
            object-oriented techniques. Develops skills such as program design and
            testing as well as implementation of programs using a graphical IDE.
            Programming done in Java."
        },
        {
            "course_code": "MATH141",
            "name": "Calculus II",
            "min_credits": 4,
            "max_credits": null,
            "gen_eds": null,
            "conditions": [
            "Prerequisite: Minimum grade of C- in MATH140."
            ],
            "description": "Continuation of MATH140, including techniques of
            integration, improper integrals, applications of integration (such as
            volumes, work, arc length, moments), inverse functions, exponential and
            logarithmic functions, sequences and series."
        }
        ]
        

Getting courses that satisfy Gen-Ed requirements

Request: GET http://api.jupiterp.com/v0/courses?genEds=DVUP,DSSP&limit=2&sortBy=courseCode.asc

Response:

[
        {
            "course_code": "AAST351",
            "name": "Asian Americans and Media",
            "min_credits": 3,
            "max_credits": null,
            "gen_eds": [
            "DSSP",
            "DVUP"
            ],
            "conditions": [
            "Credit only granted for: AAST351, AAST398M or AAST398N. ",
            "Formerly: AAST398M, AAST398N."
            ],
            "description": "From yellow peril invaders to model minority allies, Asian 
            Americans have crafted their own dynamic cultural expressions in a number 
            of media from film, television, and music to fashion, sports, and food that
            reveal and contest the contradictions of the U.S. nation-state. Asian
            American culture also uniquely sits at the nexus of immigration flows and
            digital technologies, providing a transnational lens to view the US place
            in the world. This advanced course, then, will introduce students to the
            study and practice of Asian American culture as multiple , hybrid, and
            heterogeneous. It will do so through three sections: section one will
            introduce students to classical, cultural, and media concepts as well as
            relevant keywords outlined by Asian American Studies scholars; section two
            will review the work of Asian American cultural theorists; section three
            will focus on analyses of particular Asian American cultural productions.
            In doing so, students will gain an understanding of the shifting and
            interlocking tensions among the local, the national, and the global that
            form the cultural geographies of Asian America."
        },
        {
            "course_code": "AMST320",
            "name": "(Dis)ability in American Film",
            "min_credits": 3,
            "max_credits": null,
            "gen_eds": [
            "DSHU",
            "DSSP",
            "DVUP"
            ],
            "conditions": [
            "Credit only granted for: AMST320 or AMST328X. ",
            "Formerly: AMST328X."
            ],
            "description": "Explores the connection between film and disability
            through an analysis of independent and mainstream American films in various
            film genres. Specifically, we will consider how these film representations
            reflect and/or challenge the shifting social perspectives of disability
            over the 20th and 21st centuries.  Beginning with the presentation of
            disability as theatrical spectacle in the traveling sideshow and early
            cinema, we will work our way through film history to develop an
            understanding of our society's complicated relationship with disability."
        }
        ]
        

/v0/courses/minified

(back to endpoints)

Gets a minified list of courses that satisfy the given parameters. Takes the same parameters as the /v0/courses endpoint, but returns only the course code and title.

Query parameters

Same as the parameters for /v0/courses; see here.

Output

Examples

Getting courses with a specific prefix

Request: GET http://api.jupiterp.com/v0/courses/minified?prefix=ASTR4&sortBy=name.asc

Response:

[
        {
            "course_code": "ASTR422",
            "name": "Cosmology"
        },
        {
            "course_code": "ASTR421",
            "name": "Galaxies"
        },
        {
            "course_code": "ASTR498",
            "name": "Special Problems in Astronomy"
        }
        ]
        

/v0/courses/withSections

(back to endpoints)

Gets a list of full courses data and associated sections data. Each returned course also contains a (potentially-empty) list of sections for that course.

Query parameters

Output

Examples

Getting a course with sections data

Request: GET http://api.jupiterp.com/v0/courses/withSections?courseCodes=CMSC433

Response:

[
        {
            "course_code": "CMSC433",
            "name": "Programming Language Technologies and Paradigms",
            "min_credits": 3,
            "max_credits": null,
            "gen_eds": null,
            "conditions": [
            "Prerequisite: Minimum grade of C- in CMSC330; or must be in the
            (Computer Science (Doctoral), Computer Science (Master's)) program. ",
            "Restriction: Permission of CMNS-Computer Science department."
            ],
            "description": "Programming language technologies (e.g., object-oriented
            programming), their implementations and use in software design and
            implementation.",
            "sections": [
            {
                "holdfile": 0,
                "meetings": [
                "TuTh-11:00am-12:15pm-CSI-1115"
                ],
                "sec_code": "0101",
                "waitlist": 3,
                "open_seats": 0,
                "course_code": "CMSC433",
                "instructors": [
                "Anwar Mamat"
                ],
                "total_seats": 140
            },
            {
                "holdfile": null,
                "meetings": [
                "TuTh-3:30pm-4:45pm-IRB-0318"
                ],
                "sec_code": "0201",
                "waitlist": 0,
                "open_seats": 7,
                "course_code": "CMSC433",
                "instructors": [
                "Anwar Mamat"
                ],
                "total_seats": 50
            }
            ]
        }
        ]
        

/v0/sections

(back to endpoints)

Get sections for specific courses, or for all courses that match a course code prefix. Note that some courses don't have any sections; for example, most independent research courses, like ASTR498, will not return any sections.

Query parameters

Output

Examples

Getting all sections for a course

Request: GET http://api.jupiterp.com/v0/sections?courseCodes=CMSC433

Response:

[
        {
            "course_code": "CMSC433",
            "sec_code": "0101",
            "instructors": [
            "Anwar Mamat"
            ],
            "meetings": [
            "TuTh-11:00am-12:15pm-CSI-1115"
            ],
            "open_seats": 0,
            "total_seats": 140,
            "waitlist": 7,
            "holdfile": 0
        },
        {
            "course_code": "CMSC433",
            "sec_code": "0201",
            "instructors": [
            "Anwar Mamat"
            ],
            "meetings": [
            "TuTh-3:30pm-4:45pm-IRB-0318"
            ],
            "open_seats": 15,
            "total_seats": 50,
            "waitlist": 0,
            "holdfile": null
        }
        ]
        

/v0/instructors

(back to endpoints)

Get a list of all instructors and their average ratings, including instructors not actively teaching any courses.

Query parameters

Output

Examples

Getting high-rated, non-5 star instructors

Request: GET http://api.jupiterp.com/v0/instructors?ratings=gt.4.5&ratings=lt.5&limit=5&sortBy=average_rating.desc,name.desc

Response:

[
        {
            "slug": "gramlich_meredith",
            "name": "Meredith Gramlich",
            "average_rating": 4.9667
        },
        {
            "slug": "cropper",
            "name": "Maureen Cropper",
            "average_rating": 4.9474
        },
        {
            "slug": "gruber_sean",
            "name": "Sean Gruber",
            "average_rating": 4.9398
        },
        {
            "slug": "o’brien",
            "name": "Terrence O’Brien",
            "average_rating": 4.9375
        },
        {
            "slug": "zomback",
            "name": "Jenna Zomback",
            "average_rating": 4.9355
        }
        ]
        

/v0/instructors/active

(back to endpoints)

Get all instructors that are currently teaching a course, as listed on Testudo.

Query Parameters

Same as /v0/instructors; see here.

Output

Same as /v0/instructors; see here.

Examples

Getting instructors currently teaching a course

Request: GET http://api.jupiterp.com/v0/instructors/active?limit=5

Response:

[
        {
            "slug": "abadi_daniel",
            "name": "Daniel Abadi",
            "average_rating": 3.122
        },
        {
            "slug": "abasi",
            "name": "Ali Abasi",
            "average_rating": null
        },
        {
            "slug": "abbasi",
            "name": "Hossein Abbasi",
            "average_rating": 3.7791
        },
        {
            "slug": "abdul-alim",
            "name": "Jamaal Abdul-Alim",
            "average_rating": 3.25
        },
        {
            "slug": "abioye",
            "name": "Victor Abioye",
            "average_rating": null
        }
        ]
        

/v0/deptList

(back to endpoints)

Get a list of 4-letter department codes.

Query parameters

None

Output