getCompetitions

The command retrieves a list of sports competitions from the betting provider. It allows for highly specific filtering by sport, region, live status, and user favorites. This command is essential for populating competition selectors, navigation menus, or specific league landing pages in the Sportsbook and Casino views

Documentation

Try it now

Request parameters:

Name	Description	Type	Values	Default

competitionLimit	Restricts the number of competition records returned	number	-	-
isFavorite	If set to true, filters the competitions to only return those marked as favorites by the user	boolean	true / false	-
isLive	Filters for competitions that currently have active "Live" games. If false or omitted, it defaults to Pre-match and upcoming modes	boolean	true / false	-
includeRegion	When true, the response will include region metadata associated with each competition	boolean	true / false	-
searchCompetitionName	This parameter allows for dynamic filtering of results based on the competition's display name	string	-	-
regionId	Is used to narrow down the competition list to a specific geographical area or country	number	-	-
excludeCompetitionIds	An array to exclude specific IDs, used to fetch a targeted set of competitions	array	-	-
includeCompetitionIds	An array to include specific IDs, used to fetch a targeted set of competitions	array	-	-
isEsport	Filters for Electronic Sports categories only.	boolean	true / false	-
isCloudAvailable	Filtering by cloud sports	boolean	true / false	-
isOlympicAvailable	Filtering by olympic sports	boolean	true / false	-
isBetBuilderAvailable	A toggle to filter the subscription for games that support the Bet Builder feature (allowing users to combine multiple markets from the same game into a single wager)	boolean	true / false	-
isInternalBetBuilderAvailable	Feature toggles that instruct the stream to include or exclude complex same-game-parlay (Internal Bet Builder) pricing configurations and data structures.	boolean	true / false	-
language	Used for competition name searching	string	-	-
sportAlias	Contains sport alias value	string	-	-
regionAlias	Contains region alias value	string	-	-

Call example:
JavaScriptReact Hook

getCompetitions({
  limit: 10,
  isFavorite: true,
  onlyLiveGames: true
})

Response examples:
SuccessError

{
  result: {
    data: {
      competitions: {
        sport: {
          alias: 'Soccer'
        },
        region: {
          alias: 'England'
        },
        id: 538,
        name: 'Premier League',
        order: 1
      }
    }
  }
}

Response parameters:

Name	Description	Type	Values

competitions	This object contains the primary attributes of the competition	object
└─ id	The unique system identifier for the competition	number	-
└─ name	The official display name of the competition	string	-
└─ order	The display priority of the competition	number	-
└─ sport	The sport object identifies the top-level category to which the competition belongs	object
└─ alias	A unique, constant, and non-localized string identifier	string	"Soccer", "Tennis", etc.
└─ region	The region object provides the geographical or organizational "territory" of the competition	object
└─ alias	A unique string identifier for the region or country	string	"Spain", "Armenia", etc.