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.

The gameId, title and region filter query parameters are each named after the tournament field they match. The title and region filters each accept an array of values, sent comma-joined (region=NA,EU) or as a repeated key (region=NA&region=EU). Each value is split on commas and trimmed, so a title containing a comma cannot be matched exactly, and an empty value is refused with a 400. The number of title values times the number of region values may not exceed 30, and a search over that is refused with a 400. If a tournament has the same corresponding field value as any of the array values, it will be included in the response. For example, the query parameter region with values NA and EU will return all tournaments with region equal to either ‘NA’ or ‘EU’. Any query parameter this page does not list is refused with a 400.

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
        }
      ],
      "region": "Global",
      "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,

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

How many tournaments one page holds, at most 100. A larger value is refused with a 400.

Required range: 1 <= x <= 100

gameId

string

required

The game whose tournaments to list. An empty value is refused with a 400.

title

string[]

Tournament titles to match, comma-joined or as a repeated key. Each value is split on commas and trimmed, an empty value is refused with a 400, and the title values times the region values may not exceed 30.

region

string[]

Tournament regions to match, comma-joined or as a repeated key. Each value is split on commas and trimmed, an empty value is refused with a 400, and the title values times the region values may not exceed 30.

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 holding fewer than perPage items is the last page and has no cursor.

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
        }
      ],
      "region": "Global",
      "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