/
v3.0.11Get access

subscribeToCompetitionsOnly

This API function establishes a real-time subscription focused strictly at the competition or league level, bypassing individual match granularities. It allows the client application to listen for structural changes, schedule modifications, or outright updates for tournaments within a specific sport and geographical region.

Request parameters:

NameDescriptionTypeValuesDefault
sportAlias
Identifies the broad sports categorystring--
regionAlias
Filters the competitions by their physical country or tournament territory.string--
isOlympicAvailable
Filters for sports categorized under Olympic events.booleantrue / false-
isBetBuilderAvailable
Filters for sports that support the Bet Builder feature.booleantrue / false-

Call example:

subscribeToCompetitionsOnly({
  regionAlias: 'Europe',
  sportAlias: 'Soccer'
})

Response examples:

{
  competition: {
    '566': {
      id: 566,
      name: 'UEFA Champions League',
      order: 1
    },
    '1857': {
      id: 1857,
      name: 'U17 European Championship',
      order: 6337
    },
    '27420': {
      id: 27420,
      name: 'UEFA Nations League. Outright',
      order: 6430
    }
  }
}