API Overview
Build integrations with Tabletop League using our REST API.
API Coming Soon
Our public API is currently in development. This documentation provides a preview of what's planned.
What You Can Build
The Tabletop League API will enable you to:
- Fetch competition data - Brackets, standings, and results
- Display player stats - Integrate ratings and match history
- Create matches - Log games from your own applications
- Build overlays - Stream graphics and live updates
- Automate workflows - Custom tournament management tools
API Principles
Our API follows these design principles:
- REST architecture - Standard HTTP methods and status codes
- JSON responses - All data returned as JSON
- Versioned endpoints -
/api/v1/prefix for stability - Rate limited - Fair usage limits to ensure reliability
- Authenticated - API keys for secure access
Base URL
https://tabletopleague.com/api/v1
Response Format
All successful responses follow this structure:
{
"data": { ... },
"meta": {
"timestamp": "2025-01-24T10:30:00Z"
}
}
Error responses include details:
{
"error": {
"code": "NOT_FOUND",
"message": "Competition not found",
"details": {}
}
}
Planned Endpoints
Competitions
| Endpoint | Description |
|----------|-------------|
| GET /competitions | List competitions |
| GET /competitions/:id | Get competition details |
| GET /competitions/:id/standings | Get current standings |
| GET /competitions/:id/matches | Get match results |
Players
| Endpoint | Description |
|----------|-------------|
| GET /players/:id | Get player profile |
| GET /players/:id/stats | Get player statistics |
| GET /players/:id/matches | Get match history |
Matches
| Endpoint | Description |
|----------|-------------|
| POST /matches | Create a new match |
| GET /matches/:id | Get match details |
Get Notified
Want to know when the API launches? Contact us at api@tabletopleague.com to join the waitlist.
Documentation Sections
- Authentication - How to authenticate your requests
- Endpoints - Detailed endpoint reference