Skip to main content
ScholarSynch

Developer portal

Manage API keys, view usage, and read the API docs.

1. Register
You're already registered if you can see this page. The Developers tab in the top nav is your home base from now on.
2. Create an API key
Go to API Keys, click New key, and pick the scopes your integration needs. The raw key is shown once after creation — copy it immediately into a secret manager. If you lose it, rotate the key to get a new one.
3. Make your first request
Send your key in the X-API-Key header. Example: list five colleges.
curl -H "X-API-Key: $CSC_API_KEY" \
  https://api.scholarsyn.ch/api/colleges?limit=5
Authentication

All requests must include X-API-Key: <your-key>. Keys are scoped to specific endpoints — requesting an endpoint outside your key's scopes returns 403.

Rate limits
Limits are enforced per API key. Per-minute is a sliding window; per-day is a fixed UTC bucket.
TierPer-minute (incl. burst)Per-dayHow to get it
free401,000Default for new keys
basic15010,000Contact support
pro700100,000Contact 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.

Key rotation

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.

Errors
StatusMeaningCommon causes
401UnauthenticatedMissing, malformed, expired, or revoked key
403Insufficient scopeKey is valid but lacks the scope the endpoint requires. Body: {message, required, granted}
404Not foundResource ID does not exist (foreign keys also 404 — existence is not disclosed)
422Validation errorBad query/path parameter, unknown scope on key creation
429Rate limit exceededSee the rate-limit section above for the body shape and headers
Next steps

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.

Scopes

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.