THE TOURNAMENT API (1.0.0)

Download OpenAPI specification:

tournaments

Create tournament bracket

Authorizations:
bearerAuth
Request Body schema: application/json
required
title
required
string [ 1 .. 100 ] characters

Tournament bracket title

detail
string or null <= 1000 characters

Tournament details

eventStatus
integer
Default: 0

Event status 0: Not set 1: Before event 2: In progress 3: Event ended

consolationRound
boolean
Default: false

Whether to hold third-place playoff

scoreLess
boolean
Default: false

Whether to hide scores

hideRoundLabel
boolean
Default: false

Whether to hide round labels

size
number <float> [ 50 .. 100 ]
Default: 100

Tournament bracket size(%)

nameWidth
number <float> [ 50 .. 300 ]
Default: 100

Team name display width(%)

scoreWidth
number <float> [ 20 .. 100 ]
Default: 40

Score display width(%)

required
Array of objects [ 4 .. 128 ] items

Team (participant) list

required
Array of objects >= 2 items [ items non-empty ]

Match results list for tournament bracket (single elimination format). Array structure depends on team count:

  • Each array element represents one tournament round
  • Element 0: First round, Element 1: Second round, etc.
  • Final round always includes both championship and 3rd place playoff

Example for 8 teams:

  • Element 0: 4 matches (Round 1: 8→4 teams)
  • Element 1: 2 matches (Round 2: 4→2 teams)
  • Element 2: 2 matches (Final round: Championship + 3rd place playoff)

Even for matches that have not yet been held or have undetermined results, all fields (score.0, score.1, winner, comment) must be included. Set these fields to null when results are undetermined.

noAds
boolean
Default: true

Hide advertisements

Responses

Request samples

Content type
application/json
{
  • "title": "10th National High School Baseball Championship",
  • "detail": "▽ 49 participating schools\n▽ Draw ceremony: August 4, 2024 (Sun)\n",
  • "eventStatus": 0,
  • "consolationRound": false,
  • "scoreLess": false,
  • "hideRoundLabel": false,
  • "size": 100,
  • "nameWidth": 100,
  • "scoreWidth": 40,
  • "teams": [
    ],
  • "results": [
    ],
  • "noAds": true
}

Response samples

Content type
application/json
{
  • "id": "wgotSv0tT9J3xrdFgWwt",
  • "tournament": {
    }
}

Update tournament bracket

Authorizations:
bearerAuth
path Parameters
id
required
string

Tournament bracket ID

Request Body schema: application/json
required
title
required
string [ 1 .. 100 ] characters

Tournament bracket title

detail
string or null <= 1000 characters

Tournament details

eventStatus
integer
Default: 0

Event status 0: Not set 1: Before event 2: In progress 3: Event ended

consolationRound
boolean
Default: false

Whether to hold third-place playoff

scoreLess
boolean
Default: false

Whether to hide scores

hideRoundLabel
boolean
Default: false

Whether to hide round labels

size
number <float> [ 50 .. 100 ]
Default: 100

Tournament bracket size(%)

nameWidth
number <float> [ 50 .. 300 ]
Default: 100

Team name display width(%)

scoreWidth
number <float> [ 20 .. 100 ]
Default: 40

Score display width(%)

required
Array of objects [ 4 .. 128 ] items

Team (participant) list

required
Array of objects >= 2 items [ items non-empty ]

Match results list for tournament bracket (single elimination format). Array structure depends on team count:

  • Each array element represents one tournament round
  • Element 0: First round, Element 1: Second round, etc.
  • Final round always includes both championship and 3rd place playoff

Example for 8 teams:

  • Element 0: 4 matches (Round 1: 8→4 teams)
  • Element 1: 2 matches (Round 2: 4→2 teams)
  • Element 2: 2 matches (Final round: Championship + 3rd place playoff)

Even for matches that have not yet been held or have undetermined results, all fields (score.0, score.1, winner, comment) must be included. Set these fields to null when results are undetermined.

noAds
boolean
Default: true

Hide advertisements

Responses

Request samples

Content type
application/json
{
  • "title": "10th National High School Baseball Championship",
  • "detail": "▽ 49 participating schools\n▽ Draw ceremony: August 4, 2024 (Sun)\n",
  • "eventStatus": 0,
  • "consolationRound": false,
  • "scoreLess": false,
  • "hideRoundLabel": false,
  • "size": 100,
  • "nameWidth": 100,
  • "scoreWidth": 40,
  • "teams": [
    ],
  • "results": [
    ],
  • "noAds": true
}

Response samples

Content type
application/json
{
  • "id": "wgotSv0tT9J3xrdFgWwt",
  • "tournament": {
    }
}

Get tournament bracket

Authorizations:
bearerAuth
path Parameters
id
required
string

Tournament bracket ID

Responses

Response samples

Content type
application/json
{
  • "id": "wgotSv0tT9J3xrdFgWwt",
  • "tournament": {
    }
}

Delete tournament bracket

Authorizations:
bearerAuth
path Parameters
id
required
string

Tournament bracket ID

Responses