Base URL
Authentication
RoLearn supports three authentication paths. Which one you use depends on the client.Browser / web app — HttpOnly cookies + CSRF
Browser / web app — HttpOnly cookies + CSRF
Desktop / CLI / server-to-server — Bearer JWT
Desktop / CLI / server-to-server — Bearer JWT
Non-browser clients authenticate with the access token as a bearer credential:The login endpoint returns the access token in the JSON body for these
clients (browsers ignore it and use the cookie instead). Refresh via
POST /api/auth/refresh.Third-party apps — read-only API key
Third-party apps — read-only API key
Programmatic read access uses an API key sent in the Only keys with the
X-API-Key header:read scope authenticate the public read API. Ingest
keys (sdk:ingest / ingest:telemetry) are rejected here — they authenticate
only the SDK ingest endpoints. API-key access carries its own generous read
limits but no write features (no tracking, no Dev Lens, no revenue sim).Token lifecycle
- Refresh:
POST /api/auth/refreshrotates the refresh token (single-use, replay-protected) and issues a fresh access token. - Logout:
POST /api/auth/logoutbumps the account’s token version, revoking all existing sessions durably (single-active-session model). - OAuth sign-in: Google, Roblox, Discord, and Twitter/X are supported via the standard authorization-code flow in addition to email + password.
The CSRF requirement and cookie model apply only to the first-party web app.
Bearer and
X-API-Key clients are not subject to CSRF (they carry no ambient
cookie credential).Rate Limits
Rate limits vary by plan and endpoint. The API returns standard HTTP 429 responses when limits are exceeded.Response Format
All responses are JSON. Successful responses return the data directly. Errors return:Plan-Based Access
Many endpoints gate their response based on your subscription plan:- Explorer (Free): Limited data (e.g., 20 trending games, score-only ML predictions)
- Builder: Extended data (e.g., 100 trending games, detailed predictions)
- Studio / Enterprise: Full access (unlimited results, AI features, confidence intervals)
Endpoint surface
This reference documents the core market, game-intelligence, and account endpoints. The full API is much larger — additional groups include:| Area | Prefix | Auth |
|---|---|---|
| Multiplatform SDK (ingest, analytics, segments, experiments, export) | /api/sdk/* | SDK ingest key / session |
| Brand Workspace (Enterprise) | /api/brand/*, /api/team-games/* | session (Enterprise) |
| Team & RBAC | /api/team/* | session (Enterprise) |
| Intelligence (success patterns, DNA, creator feed, clones) | /api/intelligence/* | session |
| Keyword intelligence | /api/keywords/* | session |
| Update impact | /api/update-impact/* | session |
| UGC catalog | /api/ugc/* | none (public) |
| Marketplace | /api/marketplace/* | session |
| Ad Performance (Enterprise) | /api/ads/* | session / ads token |
| RLBot | /api/rlbot/* | session |
| Billing / checkout | /api/billing/* | session / webhook |
The complete, always-current spec is served as OpenAPI at
/openapi.json. Filter by path prefix to
find a specific group (e.g. everything under /api/sdk). The SDK endpoints are
also documented on the dedicated SDK docs site.
