Developer portal
Manage API keys, view usage, and read the API docs.
X-API-Key header. Example: list five colleges.curl -H "X-API-Key: $CSC_API_KEY" \
https://api.scholarsyn.ch/api/colleges?limit=5All requests must include X-API-Key: <your-key>. Keys are scoped to specific endpoints — requesting an endpoint outside your key's scopes returns 403.
| Tier | Per-minute (incl. burst) | Per-day | How to get it |
|---|---|---|---|
free | 40 | 1,000 | Default for new keys |
basic | 150 | 10,000 | Contact support |
pro | 700 | 100,000 | Contact support |
unlimited | — | — | Admin grant only |
Every API-key response carries X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset, X-RateLimit-Tier, plus matching *-Day variants for the daily quota. Use these to pace your client before you hit the ceiling.
When you exceed the limit you get 429 with a Retry-After header (seconds) and a JSON body:
{
"detail": "Rate limit exceeded",
"tier": "free",
"limit": 40,
"window": "minute",
"reset_at": "2026-04-08T12:34:00Z",
"upgrade_url": "/developer/portal"
}See the Usage page for live counters per key. Per-request totals are pending — see the note on the Usage page.
Rotate a key from the API Keys page when it has been exposed, when an employee leaves, or on a regular schedule (90 days is a reasonable default). Rotation atomically revokes the old key and issues a replacement with the same name, scopes, tier, and expiry. The new raw key is shown once — copy it into your secret manager before closing the modal.
If you only need to retire a key, use Revoke instead. Revocation is irreversible and idempotent; the key stops working immediately for both authentication and rate-limit lookups.
| Status | Meaning | Common causes |
|---|---|---|
401 | Unauthenticated | Missing, malformed, expired, or revoked key |
403 | Insufficient scope | Key is valid but lacks the scope the endpoint requires. Body: {message, required, granted} |
404 | Not found | Resource ID does not exist (foreign keys also 404 — existence is not disclosed) |
422 | Validation error | Bad query/path parameter, unknown scope on key creation |
429 | Rate limit exceeded | See the rate-limit section above for the body shape and headers |
Try the API explorer to call any endpoint interactively with your key.
Subscribe to the changelog (RSS available) to track breaking and non-breaking API changes.
read:colleges — College search and detail endpoints.
read:scholarships — Scholarship search and detail endpoints.
read:athletics — Athletic program endpoints.
read:locations — Location lookup endpoints.
read:programs — Program / major endpoints.