API

The Yalies API can be used to programmatically query information about the student body in your own programs and software projects. Data is served in a developer-friendly JSON format.

Authentication

In order to verify your identity, you must create an API key below. When making HTTPS queries to the API, you must include this key in the Authorization header, prepended by the word Bearer.

You should keep your API key a secret as if it were a password, as anyone with access to it can act on your behalf. Do not ship your API key with your client code, and do not commit it to version control. For more information, see Secure Your Secrets with .env.

Documentation

View the API documentation on Github Wiki.

Migrating from V1? View the migration guide.