Developer Documentation

Comprehensive guide and interactive tester for My Gecko API.

Introduction

This documentation covers authentication, available endpoints, example requests, and an interactive "Try It Out" tester so you can exercise the API directly from the browser.

Authentication

All requests must include an API key using the HTTP Authorization header.

Header format
Authorization: Bearer YOUR_API_KEY

If the header is missing or the key is invalid, the API will return 401 Unauthorized.

Endpoints

GET /api/zavro/user/:id

Fetch user data by Discord ID.

GET /api/zavro/user/:id
Authorization: Bearer YOUR_API_KEY
Response (200)
{
  "discordId": "...",
  "discordUsername": "...",
  "beatleader": { /* provider data */ },
  "minecraft": { /* provider data */ }
}

GET /api/zavro/patreon

Returns Patreon-like status for a provided API key.

GET /api/zavro/patreon
Authorization: Bearer YOUR_API_KEY

Response:
{
  "active": true,
  "tier": "gold"
}

GET /api/hypixel/player/:uuid

Fetch Hypixel player data. The endpoint queries a primary provider using a server key and may normalize results.

GET /api/hypixel/player/<uuid>
Authorization: Bearer YOUR_API_KEY

Response (normalized):
{
  "uuid": "...",
  "username": "...",
  "online": null,
  "stats": { /* provider-specific */ },
  "source": "primary|secondary"
}

Example Requests

curl -H "Authorization: Bearer YOUR_API_KEY" https://your-app.vercel.app/api/zavro/user/123456789
fetch('/api/zavro/user/123456789', {
  headers: {
    Authorization: 'Bearer YOUR_API_KEY'
  }
})

Try It Out (LIVE TESTER)

Try It Out

No response yet. Enter an endpoint and API key, then click Send Request.
Note: Missing or invalid API key will result in a 401 Unauthorized response from the API.