/
v3.0.11Get access

subscribeToUpcomingGamesWithSport

This API provides a real-time subscription for pre-match/upcoming games, delivering a complete data tree that starts from the Sport level down to individual matches. It is primarily used to build large navigation menus or "Upcoming Events" lists where games need to be grouped by their specific sport and geographic region. Data structure sport -> region -> competition -> game

Request parameters:

NameDescriptionTypeValuesDefault
sportAlias
Filters the response to a specific sport (e.g., 'Soccer').string--
competitionIds
An array used to fetch only specific leagues instead of every league in that sport. Need to pass competitions' numeric idsarray--
favorite
A boolean flag to prioritize or filter games marked as "user favorites."booleantrue / false-
gameId
Allows the subscription to focus on a single specific match if needed.number--
isOlympicAvailable
Feature toggles that include extra metadata if olympic feature is active for the upcoming games.booleantrue / false-
isBetBuilderAvailable
Feature toggles that include extra metadata if bet builder features is active for the upcoming games.booleantrue / false-

Call example:

subscribeToUpcomingGamesWithSport({
  sportAlias: 'Soccer'
})

Response examples:

{
  sport: {
    '1': {
      id: 1,
      alias: 'Soccer',
      region: {
        '20001': {
          id: 20001,
          name: 'Europe',
          alias: 'Europe',
          competition: {
            '566': {
              id: 566,
              name: 'UEFA Champions League',
              order: 1,
              game: {
                '29706036': {
                  id: 29706036,
                  start_ts: 1780156800,
                  team1_name: 'Paris Saint-Germain',
                  team2_name: 'Arsenal'
                }
              }
            },
            '1861': {
              id: 1861,
              name: 'UEFA Europa League',
              order: 2,
              game: {
                '29715659': {
                  id: 29715659,
                  start_ts: 1779303600,
                  team1_name: 'Freiburg',
                  team2_name: 'Aston Villa'
                }
              }
            }
          }
        },
        '830001': {
          id: 830001,
          name: 'France',
          alias: 'France',
          competition: {
            '548': {
              id: 548,
              name: 'Ligue 1',
              order: 5001,
              game: {
                '29635607': {
                  id: 29635607,
                  start_ts: 1778691600,
                  team1_name: 'Stade Brestois',
                  team2_name: 'Strasbourg Alsace'
                }
              }
            }
          }
        }
      }
    }
  }
}