LitLeagues API Documentation

Overview

The LitLeagues API currently only supports the JSON content type.

⚠️ LITLEAGUES API AND THIS WEBPAGE ARE CURRENTLY UNDERGOING REFACTOR TO SUPPORT PROTOCOL BUFFERS AND BETTER DOCUMENTATION! ⚠️

⚠️ PROTOCOL BUFFERS ARE NOT CONSIDERED STABLE YET! THEY'LL BE STABLE ONCE LITLEAGUES 1.0.0 IS RELEASED! ⚠️

API Hostname

api.litleagues.com

Table of Contents

Protocol Buffers

Leagues

Tournaments

Constants

Swift

Custom

League Endpoints

Generate

POST league/generate

Generate a League Schedule

Request Body

LeagueRequestPayload

Response Body

  • id UUID

    Randomly generated unique identifier for this response.

  • results Array<LeagueGeneratedSchedule>

    Generation results.

  • error (optional) String

    Encountered error while trying to generate the requested schedule.

Tournament Endpoints

Generate

POST tournament/generate

Generate a Tournament Schedule

Request Body

  • format String

    The tournament's format on how to determine a winner.

    EXAMPLE: bo,3

  • seedCalculation TournamentSeedCalculationType

    How seeds are calculated.

  • matchupType TournamentMatchupOrder

    How matchups are ordered.

  • locations UInt32

    Number of available locations.

  • teamsPerLocation UInt32

    Number of teams that can fit at one location at the same time.

  • poolsCount UInt32

    Number of pools.

  • poolMatchupFormats (optional) Array<String>

    How a winner is determined for each pool.

  • poolMatchupTypes (optional) Array<TournamentMatchupOrder>

    How matchups are ordered for each pool.

  • poolLocations (optional) Array<UInt32>

    Number of locations in each pool.

  • poolTeamsPerLocation (optional) Array<UInt32>

    Number of teams that can fit at one location, at the same time, for each pool.

  • entries Array<TournamentEntry>

    The participating teams, and their settings.

Response Body

TournamentGenerationResult