/
v3.0.11Get access

subscribeToUpcomingCompetitionsWithSport

This API establishes a real-time subscription to a filtered stream of sports data. It is designed to populate sports navigation menus and tournament pickers, ensuring that the UI only displays regions and leagues that currently have upcoming events. Structure will include sport -> region -> competition.

Request parameters:

Name
DescriptionTypeValuesDefault
hours
The look-ahead window (e.g., 2 for events starting within 2 hours).number--
timeZone
The user's timezone (e.g., -4) to calculate start times correctly.string--
timePeriod
A predefined duration category.string"all", "future", "today", "tomorrow"-
sportAlias
The alias for the sport.string--
regionLimit
Limits the number of countries/regions returned per sport.number--
isCloudAvailable
Internal flag for events with cloud-based featurebooleantrue / false-
competitionLimit
Limits the number of competition returned per region.number--
isOlympicAvailable
Filter to include or exclude Olympic-specific event data.booleantrue / false-
isBetBuilderAvailable
If true, only returns matches that support builder betsbooleantrue / false-

Parameters marked with must be included in the request

Call example:

subscribeToUpcomingCompetitionsWithSport({
  sportAlias: 'Nascar'
})

Response examples:

{
  sport: {
    '33': {
      id: 33,
      region: {
        '50033': {
          alias: 'North America',
          order: 1,
          name: 'North America',
          id: 50033,
          competition: {
            '15534': {
              id: 19883,
              name: 'Australian Open - Women. Outright',
              order: 3329,
              group: 'Grand Slam Women',
              groups: {
                '23': 'Outright',
                '27': 'International Spain',
                '52': 'Grand Slam Women'
              }
            }
          }
        }
      }
    }
  }
}