KATforge API Documentation

One unified API for every KATforge product: authentication, user accounts, OAuth, and the games Lextris, Gear Goblins, and Stumper.

Quickstart

Make your first API call in under five minutes.

SDK

Use the official @katforge/api TypeScript SDK.

Reference

Every endpoint, request shape, and response code.

Games

Architecture and contributor docs for each KATforge game, starting with Stumper.

What's in the box

  • REST endpoints for auth, users, OAuth, and the three games — fully described with request/response shapes, validation rules, and example payloads.
  • Real-time SSE streams via Mercure, used for Stumper multiplayer lobbies.
  • OAuth 2.0 server so first- and third-party apps can sign in users with their KATforge accounts.
  • Cross-domain SSO via short-lived passport tokens.
  • Official TypeScript SDK (@katforge/api) with browser, Capacitor, and Node support.

Three ways to call the API

Pick whichever fits your stack:

  1. The SDK — recommended for any TypeScript/JavaScript project. Handles auth, refresh, storage, and error mapping for you. Install →
  2. Raw fetch — works anywhere; you handle the JWT lifecycle yourself. Authentication guide →
  3. The interactive reference — try every endpoint right from your browser using the live "Try it" panel. Open reference →

API status

Live API status: https://api.katforge.com/v1/health-check

Need help? Open an issue on GitHub or use the contact form.