/
v3.0.11Get access

subscribeToSportsOnly

This API initiates a real-time subscription to a high-level data stream focused exclusively on sport categories. It is designed to populate sports navigation menus or sidebars with current available sports, often including dynamic counts of active games.

Request parameters:

NameDescriptionTypeValuesDefault
hours
Filters events occurring within the next specified number of hours.number--
limit
Restricts the number of sport entities returned in the response.number--
isLive
If true, only sports with currently active "In-Play" games are returned.booleantrue / false-
gameIds
An array of specific game numeric IDs to filter the sports data scope.array--
timeZone
Specifies the time zone for date/time calculations of associated events.number--
isEsport
Filters for Electronic Sports categories only.booleantrue / false-
lessThan
Filters based on values (timestamp).number--
greaterThan
Filters based on values (timestamp).number--
timePeriod
A predefined time range filterstring"all", "future", "today", "tomorrow"-
sportAlias
Filters for a specific sport by its string identifier (e.g., "Soccer").string--
marketTypes
Filters sports based on the availability of specific market categories.array--
lessThanEqual
Inclusive range filter (timestamp)number--
greaterThanEqual
Inclusive range filter (timestamp)number--
withoutOutright
If true, excludes "Outright/Winner" markets from countsbooleantrue / false-
includeGameCount
If true, the response includes the number of games currently available for each sport.booleantrue / false-
isCloudAvailable
Filters for sports with cloud-streaming support.booleantrue / false-
promoted
Highlights or prioritizes featured sports.booleantrue / falsefalse
marketDisplayKeys
Specifies which market keys should be included for top-level display.array["TOTALS", "WINNER", "Winner", "HANDICAP", "OUTRIGHT", "LAST" "GOAL", "FIRST" "GOAL", "CORRECT" "SCORE", "DOUBLE" "CHANCE", "HALFTIME"/"FULLTIME"]-
isOlympicAvailable
Filters for sports categorized under Olympic events.booleantrue / false-
isBetBuilderAvailable
Filters for sports that support the Bet Builder feature.booleantrue / false-

Call example:

subscribeToSportsOnly({
  isLive: true
})

Response examples:

{
  sport: {
    '1': {
      id: 1,
      name: 'Futebol',
      alias: 'Soccer',
      order: 3,
      type: 2
    },
    '2': {
      id: 2,
      name: 'Hóquei no gelo',
      alias: 'IceHockey',
      order: 11,
      type: 2
    },
    '3': {
      id: 3,
      name: 'Basquete',
      alias: 'Basketball',
      order: 7,
      type: 2
    },
    '4': {
      id: 4,
      name: 'Tênis',
      alias: 'Tennis',
      order: 9,
      type: 2
    },
    '5': {
      id: 5,
      name: 'Vôlei',
      alias: 'Volleyball',
      order: 10,
      type: 2
    },
    '11': {
      id: 11,
      name: 'Beisebol',
      alias: 'Baseball',
      order: 18,
      type: 2
    },
    '19': {
      id: 19,
      name: 'Críquete',
      alias: 'Cricket',
      order: 153,
      type: 2
    },
    '29': {
      id: 29,
      name: 'Handebol',
      alias: 'Handball',
      order: 16,
      type: 2
    },
    '41': {
      id: 41,
      name: 'Tênis de Mesa',
      alias: 'TableTennis',
      order: 26,
      type: 2
    }
  }
}