/
v3.0.11Get access

subscribeToGamesWithRegion

This API function establishes a real-time subscription to track match data filtered by its geographic region and position in the sports hierarchy.

Request parameters:

Name
DescriptionTypeValuesDefault
gameId
An optional parameter used when you want to isolate the stream to a single, specific match ID within that region.number--
favorite
it means this boolean flag is used to filter or sort the data stream based on whether the entire league/tournament (represented by the competitionId) is bookmarked or favorited by the user, rather than an individual match.booleantrue / false-
gameType
Typically filters matches based on their live status.string"sport", "live", "willBeLiveSoon"-
sportAlias
Identifies the broad sports category.string--
regionAlias
Filters events by their physical country or tournament territory.string--
competitionId
Filter to narrow the scope down to a specific league or cup within that region.number--

Parameters marked with must be included in the request

Call example:

subscribeToGamesWithRegion({
  sportAlias: 'Soccer',
  regionAlias: 'England',
  competitionId: 4679,
  gameType: 'willBeLiveSoon',
  favorite: false
})

Response examples:

{
  region: {
    '2570001': {
      id: 2570001,
      name: 'England',
      alias: 'England',
      competition: {
        '4679': {
          id: 4679,
          name: 'FA Cup - Women',
          order: 1075,
          game: {
            '29881588': {
              id: 29881588,
              start_ts: 1780236000,
              team1_name: 'Brighton and Hove Albion WFC (Wom)',
              team2_name: 'Manchester City LFC (Wom)',
              sport_alias: 'Soccer'
            }
          }
        }
      }
    }
  }
}