Planned endpoints

A preview of the API surface on our roadmap. Nothing on this page is built yet — the descriptions below are directional, and paths, parameters, and payloads will change before anything ships. For what you can call today, see the live surfaces linked in the callout.

What's live today

Two surfaces are available now: the Personal API (your own matches and stats — early access, entitlement-gated) and the public statistics exports (aggregate character win-rate & matchup CSVs for any signed-in user). See Authentication for keys and session auth, and browse every live endpoint in the interactive reference. Everything below is planned and not yet available.

Competitions

Read-only access to public competition data — list competitions, fetch a single competition, and pull live standings with records and tiebreaker values. Planned filters include game system, status, and pagination.

Discord bot integrations can already read competition data through the organization-key /api/v1/bot/* endpoints documented in the interactive reference. The public, per-user competition API described here is still planned.

Players

Public player profiles, aggregate stats, and match history. Data about your own account is already available through the Personal API; the public, any-player surface is planned.

Matches

Fetch match details and — from your own tools — report results. Today, match reporting happens in the app, and Discord bots report through the organization-key bot API.

Webhooks

Subscribe to competition and match events and receive them at your endpoint. Candidate events:

competition.created
competition.started
competition.completed
match.created
match.result

Overlays

Stream graphics and live-updating widgets for broadcasts. Planned.

Machine-readable spec

The live surface — not the planned endpoints above — is documented as OpenAPI 3.1:

Interactive reference: /api/reference
Raw spec: /api/openapi

Get notified

Want to know when more of the API opens up — or to enable the Personal API early access on your account? Contact us at api@tabletopleague.com.