# GhostEye Developer API

> GhostEye provides an authenticated JSON API for authorized OSINT and security research. The API lives on the main site; interactive docs are hosted on docs.ghosteye.org.

## Documentation
- [API documentation](https://docs.ghosteye.org/): overview, endpoint reference, interactive examples, and page-copy buttons for Claude, Cursor, Codex, and OpenCode.
- [Quickstart](https://docs.ghosteye.org/quickstart): create a key and make a first request.
- [API Introduction](https://docs.ghosteye.org/api-reference/introduction): base URL, authentication, rate limits, response format and HTTP errors.
- [Email OSINT](https://docs.ghosteye.org/api-reference/email)
- [Phone OSINT](https://docs.ghosteye.org/api-reference/phone)
- [Username Footprint](https://docs.ghosteye.org/api-reference/username)
- [Discord Lookup](https://docs.ghosteye.org/api-reference/discord)
- [GitHub OSINT](https://docs.ghosteye.org/api-reference/github)
- [Minecraft OSINT](https://docs.ghosteye.org/api-reference/minecraft)
- [Breach Database](https://docs.ghosteye.org/api-reference/breach)
- [Health Check](https://docs.ghosteye.org/api-reference/health)

## API basics
- Base URL: `https://ghosteye.org/api/v1`
- Authentication header: `X-API-Key: ge_live_...`
- Responses are JSON. Successful operations use `{ "ok": true, "data": ... }`; errors use `{ "ok": false, "err": "..." }` and an HTTP error status.
- Keep API keys on a trusted server, in environment variables or a secret manager. Never embed a key in browser code, public prompts, source control, or logs.
- API keys are managed in GhostEye Settings → Developer. API access requires the Starter plan or higher (administrator keys are exempt).
- Limits currently documented: Starter 40 requests/day, Pro 65/day, Elite 150/day; burst limit 10 requests/minute. Health checks are exempt. Limits can change; follow the live API docs and response messages.
- Use the API only for lawful, authorized purposes and respect applicable privacy and data-protection laws.

## Endpoints
| Method | Path | Required input |
| --- | --- | --- |
| GET | `/api/v1/email` | `email` |
| GET | `/api/v1/phone` | `phone` |
| GET | `/api/v1/username` | `username` |
| GET | `/api/v1/discord` | `uid` |
| GET or POST | `/api/v1/breach` | `query`; optional `type`, `sources` |
| GET or POST | `/api/v1/minecraft` | `query`; optional `type` |
| GET | `/api/v1/github` | `query` (username, owner/repo, or GitHub URL) |
| GET | `/api/v1/health` | none beyond the API-key header |

Use the endpoint pages for exact parameter validation, response fields, code examples, quota behavior, and live requests. Do not assume undocumented fields or endpoints.