Madgrades API

Sign in with Github

Documentation

Documentation is not yet complete.

All requests should be GET HTTP requests. You must provide your API token in the format of an Authorization header like so: 

Authorization: Token token=<your api token>

The API endpoints are listed below with the query string parameters that each endpoint supports. Parameters which are highlighted in yellow are required. Endpoints which are identified as being paginated also accept the parameters page (Number) and per_page (Number).

/v1/courses

A paginated list of courses.

Name Type Description Examples
instructor
instructors 		List (Number) Filter results by courses that have been taught by particular instructors. Provide a comma separated list of instructor ids.
  • 100191
  • 102516,103165: Find courses that have been taught by either 102516, or 103165.
number
numbers 		List (Number) Filter results by course number. Provide a comma separated list of numbers.
  • 252
  • 101,201: Find courses with the course number 101 or 201.
order String Set the direction of the sorted results. Must be one of the following:
  • asc (default): Ascending order.
  • desc: Descending order.
  • asc
  • desc
query String Filter results by a search query.
  • cs 252
  • Calculus
  • Spanish IV
sort String Set how the results are sorted. If provided, it must be one of the following:
  • name: Sort by the name of the course.
  • number (default): Sort by the course number.
  • relevance (default when query present): Sort by closeness to the search query.
  • name
  • number
  • relevance
subject
subjects 		List (String) Filter results by courses belonging/crosslisted to particular subjects. Provide a comma separated list of subject codes.
  • 266
  • 146,200,205: Find courses that belong to either 146, 200, or 205.
/v1/courses/:uuid

More detailed information on a course such as its course offerings.

No query string parameters.

/v1/subjects

A paginated list of subjects.

Name Type Description Examples
query String Filter results by a search query.
  • Science
  • Engineering
  • psych
/v1/instructors

A paginated list of instructors.

Name Type Description Examples
query String Filter results by a search query.
  • cs 252
  • Calculus
  • Spanish IV