Class Sizes API

The Class Sizes API provides access to historical data on average class sizes across different departments and academic terms at Albion College.

Endpoint


GET /api/data/class-sizes

Authentication

All requests to this endpoint require authentication using an API key. You can provide your API key in one of the following ways:

HTTP Header: X-API-Key: your_api_key
Bearer Token: Authorization: Bearer your_api_key
Query Parameter: ?apiKey=your_api_key

If you don’t have an API key, you can obtain one from your dashboard settings .

Query Parameters

Parameter	Type	Required	Description
`departmentId`	Integer	No	Filter results by department ID
`term`	String	No	Filter results by academic term (e.g., “Fall 2023”)
`page`	Integer	No	Page number for pagination (default: 1)
`limit`	Integer	No	Number of results per page (default: 100, max: 1000)
`sortBy`	String	No	Field to sort by (`term`, `department`, `average_class_size`)
`sortOrder`	String	No	Sort order (`asc` or `desc`)

Note: If neither departmentId nor term is provided, the API returns data for all departments and terms.

Response Format

The API returns a JSON response with the following structure:


{
  "success": true,
  "data": [
    {
      "id": 1,
      "department": "Biology",
      "term": "Fall 2023",
      "average_class_size": 24.5
    },
  ],
  "pagination": {
    "total": 150,
    "page": 1,
    "limit": 100,
    "totalPages": 2
  }
}

Response Fields

Field	Description
`success`	Boolean indicating if the request was successful
`data`	Array of class size records
`data[].id`	Unique identifier for the record
`data[].department`	Name of the academic department
`data[].term`	Academic term (e.g., “Fall 2023”)
`data[].average_class_size`	Average number of students per class
`pagination.total`	Total number of records available
`pagination.page`	Current page number
`pagination.limit`	Number of records per page
`pagination.totalPages`	Total number of pages available

Examples

cURL

Get All Class Sizes


curl -X GET "https://openalbion.org/api/data/class-sizes" \
  -H "X-API-Key: your_api_key"

Filter by Department


curl -X GET "https://openalbion.org/api/data/class-sizes?departmentId=5" \
  -H "X-API-Key: your_api_key"

Filter by Term


curl -X GET "https://openalbion.org/api/data/class-sizes?term=Fall%202023" \
  -H "X-API-Key: your_api_key"

Pagination and Sorting


curl -X GET "https://openalbion.org/api/data/class-sizes?page=2&limit=50&sortBy=average_class_size&sortOrder=desc" \
  -H "X-API-Key: your_api_key"

Python

Get All Class Sizes


import requests
 
url = "https://openalbion.org/api/data/class-sizes"
headers = {
    "X-API-Key": "your_api_key"
}
 
response = requests.get(url, headers=headers)
data = response.json()
 
print(data)

Filter by Department


import requests
 
url = "https://openalbion.org/api/data/class-sizes"
headers = {
    "X-API-Key": "your_api_key"
}
params = {
    "departmentId": 5
}
 
response = requests.get(url, headers=headers, params=params)
data = response.json()
 
print(data)

Filter by Term with Pagination


import requests
 
url = "https://openalbion.org/api/data/class-sizes"
headers = {
    "X-API-Key": "your_api_key"
}
params = {
    "term": "Fall 2023",
    "page": 1,
    "limit": 50
}
 
response = requests.get(url, headers=headers, params=params)
data = response.json()
 
print(data)

JavaScript

Get All Class Sizes


fetch("https://openalbion.org/api/data/class-sizes", {
  method: "GET",
  headers: {
    "X-API-Key": "your_api_key"
  }
})
  .then(response => response.json())
  .then(data => console.log(data))
  .catch(error => console.error("Error:", error));

Using Async/Await


async function getClassSizes() {
  try {
    const response = await fetch("https://openalbion.org/api/data/class-sizes?departmentId=5", {
      method: "GET",
      headers: {
        "X-API-Key": "your_api_key"
      }
    });
    
    const data = await response.json();
    console.log(data);
  } catch (error) {
    console.error("Error:", error);
  }
}
 
getClassSizes();

PHP

Get All Class Sizes


<?php
$url = "https://openalbion.org/api/data/class-sizes";
 
$curl = curl_init($url);
curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
curl_setopt($curl, CURLOPT_HTTPHEADER, [
    "X-API-Key: your_api_key"
]);
 
$response = curl_exec($curl);
$data = json_decode($response, true);
 
curl_close($curl);
print_r($data);
?>

Filter by Department


<?php
$url = "https://openalbion.org/api/data/class-sizes?departmentId=5";
 
$curl = curl_init($url);
curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
curl_setopt($curl, CURLOPT_HTTPHEADER, [
    "X-API-Key: your_api_key"
]);
 
$response = curl_exec($curl);
$data = json_decode($response, true);
 
curl_close($curl);
print_r($data);
?>

Error Responses

Status Code	Description
401	Authentication error (missing or invalid API key)
500	Server error

Example error response:


{
  "success": false,
  "error": "API key missing",
  "message": "Please provide an API key via X-API-Key header, Authorization: Bearer header, or apiKey query parameter.",
  "docs": "https://docs.openalbion.org"
}