Tournaments

Lists a game's tournaments.

Lists the tournaments of the game you name in gameId, one page at a time, filtered and sorted by the query parameters you send.

Each filter is named after the tournament field it matches. A filter whose name ends in Range takes a min and a max, either of which you can leave out to leave that end open (see DateRange and NumberRange). Any other filter takes a list of values, and a tournament matches when its field equals any one of them: title with “Friday Night Cup” and “Saturday Showdown” lists the tournaments with either title.

sort names the field to sort by, and order sorts it ascending or descending.

Page through results with the cursor and perPage query parameters. To fetch the next page, pass the cursor a response returns, unchanged. Keep paging until a response has no cursor.

GET

tournaments

Lists a game's tournaments.

curl --request GET \
  --url https://staging.blumint.io/api/tournaments/search \
  --header 'X-Api-Key: <api-key>'

const options = {method: 'GET', headers: {'X-Api-Key': '<api-key>'}};

fetch('https://staging.blumint.io/api/tournaments/search', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "items": [
    {
      "gameId": "raini-the-lords-of-light",
      "id": "6a6d45ea-d41e-41df-97e2-320783a90f7b",
      "title": "Deck Boss Version 3",
      "gameTitle": "Raini:The Lords of Light",
      "endpoint": null,
      "date": "2023-05-04T17:00:00.000Z",
      "endDate": "2023-05-04T19:30:00.000Z",
      "imgUrl": "https://firebasestorage.googleapis.com/v0/b/blumint-development.appspot.com/o/Game%2Fraini-the-lords-of-light%2FRTLOLTourneyThumbnail-128x128.png?alt=media&token=a5b33dcd-7cef-4db1-a36a-5878a2921ddf",
      "blurb": {
        "title": "Raini:The Lords of Light Tournament",
        "description": "Join us for an exciting single-elimination tournament with a $50 prize pool!",
        "rules": [
          "No cheating",
          "Participants must check-in before the event"
        ]
      },
      "sponsors": [
        {
          "name": "SupraOracles",
          "imgUrl": "https://firebasestorage.googleapis.com/v0/b/blumint-development.appspot.com/o/Game%2Fbig-time%2FSupraOraclesLogo.png?alt=media&token=2403e048-af79-45e8-8da0-341ae5a5d21c",
          "redirectUrl": "https://supraoracles.com/",
          "width": 200,
          "height": 200
        }
      ],
      "type": "tournament",
      "region": "Global",
      "bracketType": "single-elimination",
      "maxTeamCount": 32,
      "phase": "registration",
      "tournamentDetails": [
        {
          "title": "Registration And Check In",
          "body": "All players must register to participate in this tournament. You may register via the panel below. You will be prompted to provide your Discord ID and email address."
        }
      ],
      "checkInTime": "2023-05-04T16:00:00.000Z",
      "readyTime": "2023-05-04T16:55:00.000Z",
      "scoreOption": [
        {
          "name": "Score",
          "units": "Points",
          "value": 100,
          "orderBy": "desc"
        }
      ]
    }
  ],
  "cursor": "6a6d45ea-d41e-41df-97e2-320783a90f7b"
}

Authorizations

X-Api-Key

string

header

required

Query Parameters

sort

enum<string>

default:date

The field to sort by.

Available options:

date,

endDate,

competitorCount,

maxTeamCount,

checkInTime,

readyTime

order

enum<string>

default:desc

The order of sorting (ascending or descending).

Available options:

asc,

desc

cursor

string

The cursor the previous page's response returned, passed unchanged. Leave it out for the first page.

perPage

integer

default:10

gameId

string

required

title

string[]

dateRange

object

A range of dates. Leave out min or max to leave that end open.

Show child attributes

Example:

{ "min": "2023-01-01T00:00:00Z" }

endDateRange

object

A range of dates. Leave out min or max to leave that end open.

Show child attributes

Example:

{ "min": "2023-01-01T00:00:00Z" }

type

string[]

competitorCountRange

object

A range of whole numbers. Leave out min or max to leave that end open.

Show child attributes

Example:

{ "min": 0 }

region

string[]

bracketType

enum<string>[]

Available options:

single-elimination,

double-elimination,

heats,

no-bracket

maxTeamCountRange

object

A range of whole numbers. Leave out min or max to leave that end open.

Show child attributes

Example:

{ "min": 0 }

phase

enum<string>[]

Available options:

registration,

checkIn,

ready,

live,

finished

checkInTimeRange

object

A range of dates. Leave out min or max to leave that end open.

Show child attributes

Example:

{ "min": "2023-01-01T00:00:00Z" }

readyTimeRange

object

A range of dates. Leave out min or max to leave that end open.

Show child attributes

Example:

{ "min": "2023-01-01T00:00:00Z" }

Response

One page of tournaments for the requested game.

items

object[]

required

The matching tournaments, at most perPage of them. Each item is a full tournament record and can carry fields beyond the documented schema, which you must not rely on. Date fields are UTC ISO 8601 strings with a Z suffix and millisecond precision, for example 2023-05-04T16:00:00.000Z.

Show child attributes

cursor

string

Pass the returned cursor unchanged to fetch the next page. Keep paging until a response has no cursor. A page may hold fewer than perPage items and still have a next page.

Example:

"6a6d45ea-d41e-41df-97e2-320783a90f7b"

Lists a game's tournaments.

curl --request GET \
  --url https://staging.blumint.io/api/tournaments/search \
  --header 'X-Api-Key: <api-key>'

const options = {method: 'GET', headers: {'X-Api-Key': '<api-key>'}};

fetch('https://staging.blumint.io/api/tournaments/search', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "items": [
    {
      "gameId": "raini-the-lords-of-light",
      "id": "6a6d45ea-d41e-41df-97e2-320783a90f7b",
      "title": "Deck Boss Version 3",
      "gameTitle": "Raini:The Lords of Light",
      "endpoint": null,
      "date": "2023-05-04T17:00:00.000Z",
      "endDate": "2023-05-04T19:30:00.000Z",
      "imgUrl": "https://firebasestorage.googleapis.com/v0/b/blumint-development.appspot.com/o/Game%2Fraini-the-lords-of-light%2FRTLOLTourneyThumbnail-128x128.png?alt=media&token=a5b33dcd-7cef-4db1-a36a-5878a2921ddf",
      "blurb": {
        "title": "Raini:The Lords of Light Tournament",
        "description": "Join us for an exciting single-elimination tournament with a $50 prize pool!",
        "rules": [
          "No cheating",
          "Participants must check-in before the event"
        ]
      },
      "sponsors": [
        {
          "name": "SupraOracles",
          "imgUrl": "https://firebasestorage.googleapis.com/v0/b/blumint-development.appspot.com/o/Game%2Fbig-time%2FSupraOraclesLogo.png?alt=media&token=2403e048-af79-45e8-8da0-341ae5a5d21c",
          "redirectUrl": "https://supraoracles.com/",
          "width": 200,
          "height": 200
        }
      ],
      "type": "tournament",
      "region": "Global",
      "bracketType": "single-elimination",
      "maxTeamCount": 32,
      "phase": "registration",
      "tournamentDetails": [
        {
          "title": "Registration And Check In",
          "body": "All players must register to participate in this tournament. You may register via the panel below. You will be prompted to provide your Discord ID and email address."
        }
      ],
      "checkInTime": "2023-05-04T16:00:00.000Z",
      "readyTime": "2023-05-04T16:55:00.000Z",
      "scoreOption": [
        {
          "name": "Score",
          "units": "Points",
          "value": 100,
          "orderBy": "desc"
        }
      ]
    }
  ],
  "cursor": "6a6d45ea-d41e-41df-97e2-320783a90f7b"
}

Overview

Endpoints

Lists a game's tournaments.

Authorizations

Query Parameters

Response