Authentication & API Keys

Every request to the API requires an API key, passed as the x-api-key request header.

Getting a Key

Option 1 — Web Login (Recommended)

1. Click Login in the top navigation bar.
2. Choose Discord or Google to authenticate.
3. After authenticating, you'll be redirected back to the site.
4. Click Profile in the top navigation bar to view your API key and manage your account.

Option 2 — Discord Bot

1. Join the Discord server.
2. Navigate to the #keys channel.
3. Run the /account register command.
4. The bot will send your key via private message.

Using Your Key

Pass your key in the x-api-key header on every request:

GET /v2/users/dymerz HTTP/1.1
Host: API_HOST
x-api-key: YOUR_API_KEY

danger

Never expose your API key in client-side code or public repositories.

Quota & Limits

Each request that uses ?refresh=true counts as 1 daily request toward your quota. Requests without ?refresh=true never consume quota.

Request type	Quota cost
Default (no ?refresh)	Free — never counted
?refresh=true	1000 requests per day limit

Quotas reset automatically every 24 hours.

Checking Your Quota Programmatically

Call GET /v2/me with your API key to retrieve live quota information without visiting the dashboard:

GET /v2/me HTTP/1.1
Host: API_HOST
x-api-key: YOUR_API_KEY

{
  "success": true,
  "message": "ok",
  "data": {
    "key": "YOUR_API_KEY",
    "provider": "YOUR_PROVIDER",
    "dailyRequestsRemaining": 847,
    "dailyRequestLimit": YOUR_DAILY_REQUEST_LIMIT,
    "role": "user"
  }
}

tip

See the Cookbook for a pattern that uses this endpoint to monitor quota and avoid unnecessary ?refresh=true calls.

Managing Your Key

After logging in, click Profile in the top navigation bar to visit your profile page where you can:

• View your API key (show/hide with toggle)
• Copy your key to clipboard
• View your remaining daily quota
• Renew your API key (generates a new one)
• Delete your account (permanently)