Skip to main content

​
BlitzBoard Public API overview

This API reference is generated from the OpenAPI contract for /v1/blitz-api. Use it to sync seasons, teams, players, schedules, and team player statistics for the organization bound to your API key.

​
Authentication

All public endpoints require:
Create a key from Organizations → open an organization → generate key.

​
Typical flow

  1. List seasons with GET /v1/blitz-api/seasons and use a season _id when creating a team.
  2. List or create teams with GET/POST /v1/blitz-api/teams.
  3. Manage players under /v1/blitz-api/teams/{teamId}/players (create requires idem-key).
  4. Manage schedules with GET /v1/blitz-api/schedules?filter=live|upcoming, POST /v1/blitz-api/schedules (teamId in body), and /v1/blitz-api/schedules/{scheduleId} (detail/update/delete).
  5. Read player stats for one schedule with GET /v1/blitz-api/schedules/{scheduleId}/player-statistics (optional categories=…, optional teamId= to limit to one side; each row includes teamId / teamName).

OpenAPI Specification

The contract lives at api-reference/openapi.json. Endpoint pages below are generated from that file via the openapi: frontmatter pattern.