SchoolDigger API Documentation

The interactive reference below lets you explore every endpoint, see request parameters and response schemas, and make live API calls directly from your browser.

Base URL: https://api.schooldigger.com Current version: v2.3 Auth: appID + appKey query params

SDKs & Code Examples

Official client libraries and ready-to-run examples to get you up and running fast.

Python SDK repo

pip install schooldigger
# Search schools in New Jersey
import schooldigger
cfg = schooldigger.Configuration()
cfg.api_key["appID"] = "YOUR_APP_ID"
cfg.api_key["appKey"] = "YOUR_APP_KEY"
api = schooldigger.SchoolsApi(schooldigger.ApiClient(cfg))
results = api.search_schools(st="NJ", q="Princeton")

JavaScript / TypeScript SDK repo

npm install schooldigger
// Search schools in New Jersey
import { SchoolsApi, Configuration } from 'schooldigger';
const api = new SchoolsApi(new Configuration({
apiKey: (name) => name === 'appID'
? 'YOUR_APP_ID' : 'YOUR_APP_KEY' }));
const res = await api.searchSchools({ st: "NJ", q: "Princeton" });

More Code Examples — Python, JavaScript, R, C#, curl

All Repositories

Batch Mode — combine multiple API calls into a single request

How it works

Send a POST request to https://api.schooldigger.com/batch
Set the content type to multipart/mixed
Include each API call as a separate part in the request body
Parse the multipart response — each part contains the result of one call

Python

import requests

BASE = "https://api.schooldigger.com"
CREDS = "appID=YOUR_APP_ID&appKey=YOUR_APP_KEY"

# Build multipart/mixed body with 3 API calls
boundary = "batch_boundary"
calls = [
  f"GET /v2.3/schools?st=NJ&q=Princeton&{CREDS} HTTP/1.1",
  f"GET /v2.3/schools?st=NJ&q=Trenton&{CREDS} HTTP/1.1",
  f"GET /v2.3/schools?st=NJ&q=Newark&{CREDS} HTTP/1.1",
]

body = ""
for call in calls:
  body += f"--{boundary}\r\nContent-Type: application/http\r\n\r\n{call}\r\n\r\n"
body += f"--{boundary}--"

resp = requests.post(
  f"{BASE}/batch",
  data=body,
  headers={"Content-Type": f"multipart/mixed; boundary={boundary}"}
)
print(resp.text)

JavaScript (Node.js)

const BASE = "https://api.schooldigger.com";
const CREDS = "appID=YOUR_APP_ID&appKey=YOUR_APP_KEY";
const boundary = "batch_boundary";

const calls = [
  `GET /v2.3/schools?st=NJ&q=Princeton&${CREDS} HTTP/1.1`,
  `GET /v2.3/schools?st=NJ&q=Trenton&${CREDS} HTTP/1.1`,
  `GET /v2.3/schools?st=NJ&q=Newark&${CREDS} HTTP/1.1`,
];

const body = calls.map(c =>
  `--${boundary}\r\nContent-Type: application/http\r\n\r\n${c}\r\n\r\n`
).join("") + `--${boundary}--`;

const resp = await fetch(`${BASE}/batch`, {
  method: "POST",
  headers: { "Content-Type": `multipart/mixed; boundary=${boundary}` },
  body
});
console.log(await resp.text());

Good to know

Up to 500 requests per batch call (we recommend keeping batches small for best performance)
Each request in a batch counts toward your rate limits individually — a batch of 20 = 20 API calls
The response is multipart/mixed — parse each part to get individual JSON responses
Works with any API version and endpoint

Tip: If you need a large section of the database, a bulk data download may be more efficient than batch API calls. Available on AWS Marketplace, Snowflake, and more.

Previous Versions

v1.0 v1.1 v1.2 v2.0 v2.1 v2.2

See what changed on the Change Log.

AI Integration

Building with LLMs? See our llms.txt for machine-readable API context.