API Endpoints

Detailed reference for all available API endpoints.

Competitions

List Competitions

GET /api/v1/competitions

Query parameters:

| Parameter | Type | Description | |-----------|------|-------------| | game_system | string | Filter by game system slug | | status | string | upcoming, active, completed | | limit | integer | Results per page (max 100) | | offset | integer | Pagination offset |

Example response:

{
  "data": [
    {
      "id": "comp_abc123",
      "name": "Weekly Tournament #42",
      "game_system": "tekken-8",
      "format": "swiss",
      "status": "active",
      "player_count": 24,
      "created_at": "2025-01-20T10:00:00Z"
    }
  ],
  "meta": {
    "total": 156,
    "limit": 20,
    "offset": 0
  }
}

Get Competition

GET /api/v1/competitions/:id

Returns full competition details including settings and current state.

Get Standings

GET /api/v1/competitions/:id/standings

Returns current standings with records and tiebreaker values.

Players

Get Player

GET /api/v1/players/:id

Returns public player profile information.

Get Player Stats

GET /api/v1/players/:id/stats

Query parameters:

| Parameter | Type | Description | |-----------|------|-------------| | game_system | string | Filter stats by game | | period | string | all, season, month |

Get Player Matches

GET /api/v1/players/:id/matches

Returns match history with pagination.

Matches

Create Match

POST /api/v1/matches

Request body:

{
  "competition_id": "comp_abc123",
  "player_1_id": "player_xyz",
  "player_2_id": "player_abc",
  "winner_id": "player_xyz",
  "score": "2-1",
  "details": {
    "games": [
      { "winner": "player_xyz", "map": "arena-1" },
      { "winner": "player_abc", "map": "arena-2" },
      { "winner": "player_xyz", "map": "arena-3" }
    ]
  }
}

Get Match

GET /api/v1/matches/:id

Returns full match details.

Organizations

Get Organization

GET /api/v1/organizations/:id

List Organization Competitions

GET /api/v1/organizations/:id/competitions

Webhooks (Planned)

Subscribe to real-time events:

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

Configure webhooks in your organization settings.

SDKs (Planned)

Official SDKs will be available for:

• JavaScript/TypeScript
• Python
• Go

Community SDKs welcome—let us know what you're building.