Skip to main content
The Start.gg integration allows you to fetch tournament entrants and match sets from Start.gg (formerly smash.gg) tournaments.

​
Authentication

All Start.gg endpoints require an API token to be configured in your boofstream config: 
{
  "startgg": {
    "token": "your-startgg-api-token"
  }
}

​
GET /startgg/init

Fetches tournament information and entrant data from a Start.gg tournament.
​
url
string
required
The full Start.gg tournament URL (e.g., https://start.gg/tournament/genesis-9/event/melee-singles)

​
Response

Returns an object containing tournament players and their information: 
{
  "players": [
    {
      "entrantId": 12345,
      "player": {
        "sponsor": "TSM",
        "name": "Leffen",
        "pronouns": "he/him",
        "twitter": "TSM_Leffen",
        "score": 0,
        "losers": false,
        "country": "se",
        "state": "",
        "seed": 1
      }
    }
  ]
}

​
Example Request

curl "http://localhost:1337/startgg/init?url=https://start.gg/tournament/genesis-9/event/melee-singles"

​
Notes

  • Currently supports up to 500 entrants per tournament
  • Includes tournament admins as special entrants with negative IDs
  • Country codes are automatically converted to ISO 2-letter codes
  • Missing player data (pronouns, twitter, location) will be returned as empty strings

​
GET /startgg/sets

Fetches all match sets from a Start.gg tournament event.
​
url
string
required
The full Start.gg tournament URL (e.g., https://start.gg/tournament/genesis-9/event/melee-singles)

​
Response

Returns an array of match sets: 
[
  {
    "id": "set_12345",
    "player1Id": 11111,
    "player2Id": 22222,
    "round": "Winners Round 1",
    "phase": "Pools",
    "completed": false
  }
]

​
Example Request

curl "http://localhost:1337/startgg/sets?url=https://start.gg/tournament/genesis-9/event/melee-singles"

​
Notes

  • Currently supports up to 500 sets per tournament
  • Only returns sets where both players are assigned (filters out empty slots)
  • The completed field indicates whether a winner has been reported
  • Player IDs correspond to the entrantId values returned by /startgg/init

​
Error Handling

If the API token is invalid or missing, requests will fail with GraphQL errors from the Start.gg API. Common errors:
  • 401 Unauthorized: Invalid or missing API token
  • 404 Not Found: Tournament URL does not exist
  • Rate Limited: Too many requests to Start.gg API

Build docs developers (and LLMs) love

Get started for freeTalk to us