API Documentation

Use eggs.download in your custom resources

Static JSON API for Pterodactyl and Pelican eggs, versioned under /api/v1.

Data is rebuilt from the upstream GitHub repositories every few hours and served from Cloudflare's edge: CORS enabled, no auth, no rate limit. Responses carry an ETag; send If-None-Match for a cheap 304 and cache on your side instead of calling on every page load.

The .json URLs below are the canonical form. /api/v1/eggs, /api/v1/eggs?fields=name and /api/v1/eggs/:slug (and the legacy /api/eggs paths) are aliases for them. Query filters such as source and repo are no longer supported: filter the index client-side (every entry has source, repo and category).

OpenAPI 3.1 spec for generating clients: openapi.json

Endpoints

GET/api/v1/eggs/_index.json

Egg index: slug, name, category, repo, source.

GET/api/v1/eggs/_names.json

Sorted, unique egg names.

GET/api/v1/eggs/:slug.json

Full egg JSON + metadata + optional README.

Examples

# All games from Pterodactyl game-eggs (filter the index with jq)
curl -s "https://eggs.download/api/v1/eggs/_index.json" \
  | jq '[.[] | select(.source=="pterodactyl" and .repo=="game-eggs")]'

# Names only (great for icon tooling)
curl "https://eggs.download/api/v1/eggs/_names.json"

# Full details for one egg
curl "https://eggs.download/api/v1/eggs/paper.json"

Back home