documentation
Note that this is in-progress and currently does not cover everything supported.
The root endpoint of the API is
https://cobalt.sandstone.workers.dev
General query parameters
Currently, the only query parameter supported by all endpoints is
format, which can have
three possible values:
-
json- the default. Format the response as JSON -
html- Format the response as a proper HTML document -
html-fragment- Format the response as an embeddable HTML fragment. Suitable for usage in the context of something like htmx
Endpoints
-
/query- Search/filter available courses and course sections - Get a document containing requested course and course section information.
- TODO: add a list explaining each available query parameter for this endpoint.
-
/semesters- Get available semesters -
/departments- Get available departments -
/instructors- Get available instructors -
/buildings- Get available buildings -
Get a mapping of display values to internal values (used for the
/queryendpoint) for the requested item. These are formatted like this when JSON is requested:{ "2023|F": "Fall 2023", "2022|F": "Fall 2022" }