README.md

The University of Waterloo API allows anyone to build applications using data from the uWaterloo websites. The API currently features more than 40 methods of accessing various datasets across the University network.

If you find an error in the documentation, file an issue or send a pull request.

Disclaimer

Review the 'No Warranty' section of the University of Waterloo ODL before using this data. If building services upon this data, please inform your users of the inherent risks (as a best practice).

Version 2 (legacy) Documentation

Accessing the API

All calls are made to the following URL with the required parameters for a given service.

https://api.uwaterloo.ca/v2/

In order to make an API call, you must have a valid API Key (at this time we are not issuing new keys pending a replacement version). The data is returned in json and xml where the output format can be specified in the request URL

Client Libraries (Community supported)

Please address any customer service issues regarding client libraries to the community developers of the libraries. If you would like your library to be added, please make a pull request.

• UWaterlooDriver (Python)
• UWaterlooAPI (Python)
• UWAPI (NodeJS)
• UWaterloo-API (NodeJS)
• UWaterlooAPI (Ruby)
• UWaterlooAPI (C#)
• UWAPI.go (Golang)
• UWDart (Dart)
• UWaterloo-API (Java)
• UW-Open-Data-API (Java)
• uwaterloo-api (Java)
• WatSwift (Swift)
• UWAPI-PHP (PHP)
• uw-api-objc (Objective-C)

Endpoints

Food Services

• /foodservices/menu
• /foodservices/notes
• /foodservices/diets
• /foodservices/outlets
• /foodservices/locations
• /foodservices/watcard
• /foodservices/announcements
• /foodservices/products/{product_id}
• /foodservices/{year}/{week}/menu
• /foodservices/{year}/{week}/notes
• /foodservices/{year}/{week}/announcements

FEDS

• /feds/events
• /feds/events/{id}
• /feds/locations

Course

• /courses
• /courses/{subject}
• /courses/{course_id}
• /courses/{class_number}/schedule
• /courses/{subject}/{catalog_number}
• /courses/{subject}/{catalog_number}/schedule
• /courses/{subject}/{catalog_number}/prerequisites
• /courses/{subject}/{catalog_number}/examschedule
• See Terms endpoint for bulk data
• See Codes endpoint for subject listings

Awards/Scholarships

• /awards/graduate
• /awards/undergraduate

Events

• /events
• /events/{site}
• /events/{site}/{id}
• /events/holidays

Blogs

• /blogs/{site}
• /blogs/{site}/{id}

News

• /news
• /news/{site}
• /news/{site}/{id}

Opportunities/Jobs

• /opportunities
• /opportunities/{site}
• /opportunities/{site}/{id}

Services

• /services/{site}

Weather

• /weather/current

Terms

• /terms/list
• /terms/{term}/courses
• /terms/{term}/examschedule
• /terms/{term}/{subject}/schedule
• /terms/{term}/{subject}/{catalog_number}/schedule
• /terms/{term}/enrollment
• /terms/{term}/{subject}/enrollment
• /terms/{term}/importantdates
• /terms/{term}/infosessions

Resources

• /resources/tutors
• /resources/infosessions
• /resources/goosewatch
• /resources/sunshinelist

Definitions and Codes

• /codes/units
• /codes/terms
• /codes/groups
• /codes/subjects
• /codes/instructions

Building

• /buildings/list
• /buildings/{building_code}
• /buildings/{building}/{room}/courses
• /buildings/{building_code}/accesspoints
• /buildings/{building_code}/vendingmachines

Points of Interest

• /poi/atms
• /poi/greyhound
• /poi/helplines
• /poi/libraries
• /poi/photospheres
• /poi/defibrillators
• /poi/constructionsites
• /poi/accessibleentrances
• /poi/visitorinformation

Parking

• /parking/watpark
• /parking/lots/meter
• /parking/lots/permit
• /parking/lots/visitor
• /parking/lots/shortterm
• /parking/lots/accessible
• /parking/lots/motorcycle

Transit

• /transit/grt
• /transit/grt/stops

People Directory Search

• /directory/{user_id}

Wireless

• /wireless/usage
• /wireless/usage/{building_code}
• /wireless/clients
• /wireless/rogues
• /wireless/auth
• /wireless/historical/usage
• /wireless/historical/usage/{building_code}
• /wireless/historical/clients
• /wireless/historical/rogues
• /wireless/historical/auth

API

• /api/usage
• /api/services
• /api/methods
• /api/versions
• /api/changelog

Server

• /server/time
• /server/codes

Contributing

If you would like to offer your suggestions or report any problems regarding the API, simply create a new issue on the issues tab of the OpenData Repository and assign it an appropriate label.

Categories

• Bug
• Enhancement
• Question
• Data Request

Restrictions

Usage

The API is now free to use with unlimited calls!

Data

The intent of data offered through this API is limited to publicly visible data only. Private data such as student specific information is out of the API's scope.

Contact

If you have any inquiries or suggestions, please feel free to contact us at https://uwaterloo.ca/api/contact-us.

Please consider subscribing to our mailing list in order to receive updates on the API and follow discussions.

License

• University of Waterloo Open Data Licensing (ODL) Agreement v1