/
v3.0.11Get access

subscribeToUpcomingCompetitionsWithRegion

This API creates a real-time subscription for competitions and leagues, specifically filtered by a geographic region. It is used to populate "League Selectors" or "Tournament Lists" once a user has already chosen a specific sport and country.

Request parameters:

Name
DescriptionTypeValuesDefault
regionAlias
The primary filter (e.g., 'England'). This tells the API to only return data for that specific territory.string--
sportAlias
The context filter (e.g., 'soccer'). Ensures you get "Premier League" and not "England Cricket" leagues.string--
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:

subscribeToUpcomingCompetitionsWithRegion({
  sportAlias: 'Soccer',
  regionAlias: 'England'
})

Response examples:

{
  region: {
    '2570001': {
      name: 'England',
      competition: {
        '538': {
          id: 538,
          name: 'Premier League',
          order: 1
        },
        '539': {
          id: 539,
          name: 'Championship',
          order: 5
        },
        '1840': {
          id: 1840,
          name: 'FA Cup',
          order: 4
        },
        '1841': {
          id: 1841,
          name: 'FA Trophy',
          order: 1100
        },
        '1843': {
          id: 1843,
          name: 'League One',
          order: 1068
        },
        '1844': {
          id: 1844,
          name: 'League Two',
          order: 1071
        },
        '1849': {
          id: 1849,
          name: 'FA WSL',
          order: 1098
        },
        '18071': {
          id: 18071,
          name: 'Premier League. Outright',
          order: 1125
        },
        '20721': {
          id: 20721,
          name: 'Championship. Outright',
          order: 1128
        },
        '20765': {
          id: 20765,
          name: 'Premier League. Matchday Statistics',
          order: 2
        },
        '22907': {
          id: 22907,
          name: 'League One. Outright',
          order: 1129
        },
        '23109': {
          id: 23109,
          name: 'League Two. Outright',
          order: 1130
        }
      }
    }
  }
}