Documentation

Welcome to the Sukku documentation. Our platform provides developers with a structured REST interface to resolve Minecraft profiles, retrieve historical username data, and fetch custom cape configurations.

Getting Started

API Key Generation

All API access requires a valid Bearer token. We manage authentication entirely through our Discord integration rather than a web dashboard. You will need to join our Discord server to generate and manage your API key.

To obtain your credentials, join our community and run the /apikey create command in the designated bot channel. Our bot will send your secret token securely via Direct Message.

Core Features

Our API aggregates data from multiple microservices to provide a unified Minecraft profile schema. This simplifies the process of gathering related data points that would normally require multiple requests to different services.

Profiles & Skins

Resolves player UUIDs and nicknames, returning current skin texture URLs and metadata (slim or classic).

Cape Resolution

Detects and returns official Mojang capes as well as OptiFine capes in a single structured response.

Name Histories

Provides chronological lists of past usernames for a given player, utilizing our historical databases.

Network Bans

Check if a specific player is currently banned on supported competitive networks (e.g., Universocraft).

Authentication

All production requests must be directed to our API Gateway at:
https://api.sukku.dev

Include your API key in the Authorization header using the Bearer format. The gateway validates tokens in-memory to minimize latency.

Authorization: Bearer sk_yourkey_here

Note: Never expose your API Key in public web applications or client-side code. Doing so will compromise your quota and may lead to key revocation.

Rate Limits & Rules

The standard usage limit is 30 requests per minute per key.

When exceeding the quota, the API will return a 429 Too Many Requests status. The rate limit window resets at the start of the next minute.

  • Rate limits are bound to your API key, not your IP address.
  • Using multiple Discord accounts to generate keys and bypass limits is strictly prohibited.
  • You can monitor your real-time quota by checking the X-RateLimit-Remaining and X-RateLimit-Reset headers in the response.

Further Reading