/
v3.0.11Get access

subscribeToPrematchGamesWithSport

This API is specifically designed for time-sensitive pre-match filtering. It allows you to subscribe to games that are starting within a specific upcoming window (e.g., the next 2 hours or the next 24 hours), grouped by the full sport -> region -> competition hierarchy.

Request parameters:

Name
DescriptionTypeValuesDefault
timePeriod
Filters games based on kickoff time. string"all", "future", "today", "tomorrow"-
hours
Filters games based on kickoff time, (e.g., only show games starting in the next 6 hours).number--
timeZone
Ensures the start times (timestamps) are relative to the user's local time or a specific global offset.number--
sportAlias
Filters the results to a specific sport (e.g., 'Soccer').string--
regionAlias
Filters the results to a specific country/continent.string--
competitionId
Narrows the subscription down to a single league.number--
isCloudAvailable
Internal flag for events with cloud-based featurebooleantrue / false-
isOlympicAvailable
Filter to include or exclude Olympic-specific event data.booleantrue / false-
isBetBuilderAvailable
If true, only returns matches that support builder bets.booleantrue / false-

Parameters marked with must be included in the request

Call example:

subscribeToPrematchGamesWithSport({
  sportAlias: 'Soccer',
  regionAlias: 'England',
  competitionId: 1840
})

Response examples:

{
  sport: {
    '1': {
      id: 1,
      name: 'Football',
      region: {
        '2570001': {
          id: 2570001,
          competition: {
            '1840': {
              id: 1840,
              game: {
                '29614719': {
                  id: 29614719,
                  start_ts: 1778940000,
                  team2_name: 'Manchester City',
                  team1_name: 'Chelsea',
                  team1_reg_name: 'GB',
                  team2_reg_name: 'GB'
                }
              }
            }
          }
        }
      }
    }
  }
}