Getting Started

The Krx.gg Public API provides read-only endpoints for public integrations. Use it to query product metadata such as the current version without requiring authentication.

All API requests are made to:

1https://krx.gg/api/v1

The public API endpoints do not require authentication. However, they are rate-limited to ensure fair usage.

To ensure quality of service, the public API enforces rate limits:

• Limit: 4 requests per 60 seconds per IP address
• Headers: Each response includes rate limit information in headers

Rate limit headers returned with each response:

1X-RateLimit-Limit: 5
X-RateLimit-Remaining: 4
X-RateLimit-Reset: 2026-03-01T12:34:56.789Z

If you exceed the rate limit, you'll receive a 429 Too Many Requests response:

1{
    "error": "Too Many Requests",
    "message": "Rate limit exceeded. Please try again later.",
    "retryAfter": 45
}

• All requests must use HTTPS.
• All responses are JSON.
• Errors use a consistent structure:

1{
    "error": "Error Type",
    "message": "Human-readable error description"
}

The API uses standard HTTP status codes:

Here is a minimal JavaScript template for calling public endpoints:

1async function callPublicApi(path) {
    try {
        const response = await fetch(`https://krx.gg/api/public/${path}`);

        const remaining = response.headers.get("X-RateLimit-Remaining") ?? "?";
        console.log(`Requests remaining: ${remaining}`);

        if (!response.ok) {
            const error = await response.json();
            throw new Error(error.message);
        }

        return await response.json();
    } catch (error) {
        console.error("API call failed:", error.message);
        return null;
    }
}

// Example usage
const result = await callPublicApi("products/reflex/version");
console.log(result);

1. Respect Rate Limits: Monitor the rate limit headers and implement backoff strategies
2. Cache Responses: Cache responses to reduce API calls
3. Handle Errors Gracefully: Always implement proper error handling
4. Use Stable Identifiers: Prefer slugs over display names where available
5. Check Headers: Use rate limit headers for retry and backoff logic