NFL Widgets

## Overview

Sportradar offers a vast array of customizable NFL widgets, with in-depth statistics.

> Click here for our NFL Widget Showcase. >The Widget Showcase provides an interactive display of all widgets available. Each widget can be viewed in Desktop, Tablet, and Mobile widths, and with or without a border. >Click the three-barred icon to view an individual widget in a new window. Click the carrot icon to view integration code samples, and copy to your clipboard.

Please check out our NFL product demonstration below for an overview of every possible configuration.

NFL Widget Showcase

Reference the left sidebar or below table for a direct link to each individual widget, which includes product descriptions, parameter specifications, and live clickable samples.

### NFL Widgets by Type

Widget Type	Widget Name
Headers	Linescore Player Header Player Header Small Scoreboard	Score Score Small Score Nano	Team Header Team Header Small Team Score Small
Game	Boxscore Coaches Booth Field Position Game Leaders General Penalties Game Probabilities	General Summary Live Game Tracker Play by Play Points Per Game Points Per Game Opponent	Projected Total Points Strength of Schedule Strength of Victory Turnover Calculator Weather
Team	Team Depth Chart Team Leaders	Team Recent Games	Team Roster
Season	Schedule and Results Matchup	Special Teams Standings	Standings Slim Top Players
Betting	Bet Percentage Tracking Betting Score Future Odds Future Odds Table	Money Percentage Tracking Odds Odds Comparison	Pregame Betting Statistics Player Comparison Win Probability
Carousel	Live Game Carousel Players Carousel	Standings Carousel	Top Players Carousel
Player	Player Career Stats	Player Game Logs	Player Statistics
League	Score Ticker	Season Scores
Stats	Player Seasonal Statistics	Team Seasonal Statistics
Other	Articles News	Injuries	Team Selector

## Articles us.common.nfl.articlesList displays a list of editorial articles for the NFL. > To see a full-sized version of this widget, click here.

Parameters

Name	Type	Argument	Default	Description
providerId	number	required		Provider ID
seasonId	number	required		Season ID (Year)
matchId	string	optional		Match ID
playerId	string	optional		Player ID
numItems	number	optional		Max number of items allowed in the list.
editorialSeasonType	string	optional	'league'	Either 'league' or 'matches'.
editorialMatchType	string	optional	'previews'	Either 'previews' or 'recaps'.
border	boolean	optional		If true enables a border around the widget.
onItemClick	function	optional		Callback that is invoked when a user selects an article. Two arguments are given, type (a string) and parameters (an object). When type is 'article', parameters will contain an articleId of the clicked article, which can then e.g. be used with the News widget.

Examples

HTML/Declarative

JS/Programmatic

JS/Example of using Event Handler

Return to top ## Bet Percentage Tracking us.betting.match.nfl.betPercentageTrackingSlim displays a small bet tracking graph for a given game, with selections for bet percentage (Spread, Moneyline, Total). > For the widget to render you must provide a valid matchId or nflMatchId. All other properties are optional. To see a full-sized version of this widget, click here.

Parameters

Name	Type	Description
props	object	properties
		Name	Type	Argument	Default	Description
		matchId	number	required		Match ID
		type	string	optional	'moneyline'	Betting percentage type to display. Options are: moneyline, spread, total.
		hideDropdown	boolean	optional		If true hides the dropdown and displays the type title.
		border	boolean	optional	'true'	If false hides a border around the widget.
		onItemClick	function	optional		Function/event handler. Emits uniqueTeamId on team click or touch.

Examples

HTML/Declarative

JS/Programmatic

JS/Example of using Event Handlers

Return to top ## Betting Score us.betting.match.nfl.score displays a small scoreboard with odds from a given NFL game. > For the widget to render you must provide a valid matchId. All other properties are optional. To see a full-sized version of this widget, click here.

Parameters

Name	Type	Description
props	object	properties
		Name	Type	Argument	Default	Description
		matchId	number	required		Match ID (Also accepts fishnet match IDs.)
		showDate	boolean	optional	'true'	If true displays the scheduled date.
		showBroadcastNetwork	boolean	optional	'true'	If true displays broadcast network info.
		showVenueInfo	boolean	optional	'true'	If true displays venue info.
		disableMatchClick	boolean	optional		If true disables onItemClick handler for the game.
		disableTeamClick	boolean	optional		If true disables onItemClick handler for teams.
		border	boolean	optional	'true'	If false hides a border around the widget.
		onItemClick	function	optional		Function/event handler. Emits uniqueTeamId on team click or touch and matchId on widget click or touch.

Examples

HTML/Declarative

JS/Programmatic

JS/Example of using Event Handlers

Return to top ## Betting Player Comparison us.betting.match.nfl.playerComparison compares statistics of two players of the same position among a variety of timeframes (Provided Game, Last 5 Games, Season, or Career). > For the widget to render you must provide a valid matchId. All other properties are optional. To see a full-sized version of this widget, click here.

Parameters

Name	Type	Description
props	object	properties
		Name	Type	Argument	Default	Description
		matchId	number	required		Match ID
		type	string	optional		Selects stats type dropdown. Valid options are match, matchup, last5, season, or career.
		positions	string	optional		Selects position dropdown. Valid options are QB, RB, WR, TE, DL, LB, DB, K, P, KR, or PR.
		awayPlayerId	number	optional		Player ID from away team.
		homePlayerId	number	optional		Player ID from home team.
		hasPlayed	boolean	optional		If true only actually played games are considered for last matchup and last 5 meetings.
		disableScore	boolean	optional		If true disables the Setting Score header.
		border	boolean	optional	'true'	If false hides a border around the widget.
		onItemClick	function	optional		Function/event handler. Emits uniqueTeamId on team click or touch and matchId on widget click or touch.

Examples

HTML/Declarative

JS/Programmatic

JS/Example of using Event Handlers

Return to top ## Boxscore us.match.nfl.boxScore provides a structured summary of team totals and player statistics for a given game. > For the widget to render you must provide a valid matchId. To see a full-sized version of this widget, click here.

Parameters

Name	Type	Description
props	object	properties
		Name	Type	Argument	Description
		matchId	number	required	Match ID
		disableWidgetHeader	boolean	optional	Hides header (season info).
		homeStats	string	optional	Selects stats type for the home team. Valid values are team or players.
		awayStats	string	optional	Selects stats type for the away team. Valid values are team or players.
		enableTeamTabs	boolean	optional	If true the widget displays tabs instead of a dropdown for mobile breakpoint, making apparent which teams are competing.
		border	boolean	optional	If true enables a border around the widget.
		onItemClick	function	optional	Function/event handler. Emits teamId and playerId when a player is clicked (target: player), and teamId and page when a dropdown selection has been made (target: team).

Examples

HTML/Declarative

JS/Example of using Event Handler

.

Return to top ## Coaches Booth us.match.nfl.coachesBooth provides in-depth team statistics for a given game. > For the widget to render you must provide a valid matchId. All other properties are optional. To see a full-sized version of this widget, click here.

Parameters

Name	Type	Argument	Default	Description
matchId	number	required		Match ID
disableWidgetHeader	boolean	optional	false	When set to true hides the widget header.
disableMatchHeader	boolean	optional	false	When set to true hides the match header.
collapseGameInformation	boolean	optional	true	When set to false opens the game information section
useTeamColors	boolean	optional	null	Valid values are: null(Uses your settings. If you are configured to use team colors, then the theme can be overridden with the teamColorsTheme parameter.), true(team colors will be used, as specified with the teamColorsTheme parameter. If your configuration does not specify a team colors theme, then team colors will not be used.), or false(team colors will not be used).
teamColorsTheme	string	optional	null	When set (and not disabled by useTeamColors), specifies the name of the formula to calculate team colors (e.g. mono-team-colors-light).
activeSide	string	optional	home	For small sizes only. Shows home or away team.
enableTeamSelect	boolean	optional	false	When set to true enables team selection. Interactive areas are: team name and logo in a match header and team logos in the statistics sub-headers. TeamId is emitted on click or touch.
border	boolean	optional		If true draws a border around the widget.

Examples

HTML/Declarative

JS/Programmatic

Return to top ## Field Position us.match.nfl.fieldPosition provides the average starting field position, net starting field position and net special teams return yards for a given game. > For the widget to render you must provide a valid matchId. All other properties are optional. To see a full-sized version of this widget, click here.

Parameters

Name	Type	Argument	Default	Description
matchId	number	required		Match ID
disableWidgetHeader	boolean	optional	false	When set to true hides the widget header.
disableMatchHeader	boolean	optional	false	When set to true hides the match header.
collapseGameInformation	boolean	optional	true	When set to false opens the game information section
useTeamColors	boolean	optional	null	Valid values are: null(Uses your settings. If you are configured to use team colors, then the theme can be overridden with the teamColorsTheme parameter.), true(team colors will be used, as specified with the teamColorsTheme parameter. If your configuration does not specify a team colors theme, then team colors will not be used.), or false(team colors will not be used).
teamColorsTheme	string	optional	null	When set (and not disabled by useTeamColors), specifies the name of the formula to calculate team colors (e.g. mono-team-colors-light).
enableTeamSelect	boolean	optional	false	When set to true enables team selection. Interactive areas are: team name and logo in a match header and team logos in the statistics sub-headers. TeamId is emitted on click or touch.
border	boolean	optional		If true draws a border around the widget.

Examples

HTML/Declarative

JS/Programmatic

Return to top ## Future Odds us.betting.season.futureOdds provides future odds for a variety of outrights. > For the widget to render you must provide a valid uniqueTournamentId. All other properties are optional. To see a full-sized version of this widget, click here.

Parameters

Name	Type	Description
props	object	properties
		Name	Type	Argument	Default	Description
		uniqueTournamentId	number	required		Unique Tournament ID
		outrightId	number	optional		Outright ID
		competitorsLimit	number	optional	'5'	Sets the competitor limit per outright.
		oddsTypeOverride	string	optional		Overrides the default oddsType. Valid values are: us (money line), eu (decimal) and uk (fractional).
		sanitizeOdds	boolean	optional	true	If true filters out indeterminate odds.
		addWordOddsToOutrightNaming	boolean	optional		If true includes the word "ODDS" in the title of each outright.
		disableDropdown	boolean	optional		If true disables the dropdown and displays the title of the outright.
		displayGrid	boolean	optional		If true displays all available outrights as a grid. outrightId prop and dropdown are disabled.
		enableTeamColors	boolean	optional		Team colors switch.
		border	boolean	optional		If true draws a border around the widget.
		onItemClick	function	optional		Function/event handler. Emits uniqueTeamId on team click or touch and matchId on widget click or touch.

Examples

HTML/Declarative

JS/Programmatic

JS/Example of using Event Handler

Return to top ## Future Odds Table us.betting.season.futureOddsTable provides an outright odds table with specific bookmakers, as well as a consensus average betting line. > For the widget to render you must provide a valid uniqueTournamentId. All other properties are optional. To see a full-sized version of this widget, click here.

Parameters

Name	Type	Argument	Default	Description
uniqueTournamentId	number	required		Unique Tournament ID
outrightId	number	optional		Outright ID
competitorId	number	optional		Competitor ID
filter	string	optional		Determines the entity by which outrights are grouped and filtered. It reflects the values in the dropdown. Valid values are: futures, competitors and competitorTypes.
oddsTypeOverride	string	optional		Overrides the default oddsType. Valid values are: us (money line), eu (decimal) and uk (fractional).
sanitizeOdds	boolean	optional	true	If true filters out indeterminate odds.
addWordOddsToOutrightNaming	boolean	optional		If true includes the word "ODDS" in the title of each outright.
disableAvgColumn	boolean	optional		If true hides the average column in the table.
disableHeader	boolean	optional		If true hides the header.
disableTournamentDropdown	boolean	optional		If true hides the tournament dropdown.
disableFeatureDropdown	boolean	optional		If true disables the feature dropdown. Applicable to the futures layout.
disableCompetitorTypeDropdown	boolean	optional		If true disables the competitor type dropdown. Applicable to the competitors and competitorsType layout.
disableCompetitorDropdown	boolean	optional		If true disables the competitor dropdown. Applicable to the competitors layout.
disableSorting	boolean	optional		If true disables the table sorting. Single-row tables have sorting turned off by default.
enableTeamColors	boolean	optional		Enables team colors.
border	boolean	optional		If true draws a border around the widget.
onItemClick	function	optional		Function/event handler. Emits uniqueTeamId on team click or touch and matchId on widget click or touch.

Examples

HTML/Declarative

JS/Programmatic

JS/Example of using Event Handler

Return to top ## Game Leaders us.match.nfl.leaders provides a moving carousel of team leaders for a given game. Categories include passing yards, rushing yards, receiving yards, touchdowns, and interceptions. > For the widget to render you must provide a valid matchId. All other properties are optional. To see a full-sized version of this widget, click here.

Parameters

Name	Type	Description
props	object	properties
		Name	Type	Argument	Default	Description
		matchId	number	required		Match ID
		autoplay	boolean	optional	'true'	If false stops carousel autoplay.
		autoplaySpeed	number	optional	3000	Carousel autoplay speed in ms.
		enableTeamSelect	boolean	optional		If true enables team select event handler.
		enablePlayerSelect	boolean	optional		If true enables player select handler.
		border	boolean	optional		If true enables a border around the widget.
		onItemClick	function	optional		Function/event handler. Emits teamId and/or playerId on click or touch dependant on the enableTeamSelect and enablePlayerSelect props.

Examples

HTML/Declarative

JS/Programmatic

JS/Programmatic

Return to top ## Game Penalties us.match.nfl.penalties provides a breakdown of each team's penalties and penalty yardage for a given game. > For the widget to render you must provide a valid matchId. To see a full-sized version of this widget, click here.

Parameters

Name	Type	Argument	Default	Description
matchId	string	required		Match ID
disableWidgetHeader	boolean	optional	false	When set to true hides the widget header.
disableMatchHeader	boolean	optional	false	When set to true hides the match header.
collapseGameInformation	boolean	optional	true	When set to false opens the game information section
useTeamColors	boolean	optional	null	Valid values are: null(Uses your settings. If you are configured to use team colors, then the theme can be overridden with the teamColorsTheme parameter.), true(team colors will be used, as specified with the teamColorsTheme parameter. If your configuration does not specify a team colors theme, then team colors will not be used.), or false(team colors will not be used).
teamColorsTheme	string	optional	null	When set (and not disabled by useTeamColors), specifies the name of the formula to calculate team colors (e.g. mono-team-colors-light).
enableTeamSelect	boolean	optional	false	When set to true enables team selection. Interactive areas are: team name and logo in a match header and team logos in the statistics sub-headers. TeamId is emitted on click or touch.
border	boolean	optional		If true draws a border around the widget.

Examples

HTML/Declarative

JS/Programmatic

Return to top ## Game Probabilities us.match.nfl.probabilities provides a variety of probabilities for a given game, including chance to win, projected point totals, and projected margin of victory. > For the widget to render you must provide a valid matchId. All other properties are optional. To see a full-sized version of this widget, click here.

Parameters

Name	Type	Argument	Default	Description
matchId	string	required		Match ID
disableWidgetHeader	boolean	optional	false	When set to true hides the widget header.
disableMatchHeader	boolean	optional	false	When set to true hides the match header.
collapseGameInformation	boolean	optional	true	When set to false opens the game information section
useTeamColors	boolean	optional	null	Valid values are: null(Uses your settings. If you are configured to use team colors, then the theme can be overridden with the teamColorsTheme parameter.), true(team colors will be used, as specified with the teamColorsTheme parameter. If your configuration does not specify a team colors theme, then team colors will not be used.), or false(team colors will not be used).
teamColorsTheme	string	optional	null	When set (and not disabled by useTeamColors), specifies the name of the formula to calculate team colors (e.g. mono-team-colors-light).
enableTeamSelect	boolean	optional	false	When set to true enables team selection. Interactive areas are: team name and logo in a match header and team logos in the statistics sub-headers. TeamId is emitted on click or touch.
border	boolean	optional		If true draws a border around the widget.

Examples

HTML/Declarative

JS/Programmatic

Return to top ## Game Summary us.match.nfl.summary provides key information for a given game, including scoring info, weather, team statistics, and team leaders. > For the widget to render you must provide a valid matchId. All other properties are optional. To see a full-sized version of this widget, click here.

Parameters

Name	Type	Argument	Default	Description
matchId	string	required		Match ID
disableWidgetHeader	boolean	optional	false	When set to true hides the widget header.
disableMatchHeader	boolean	optional	false	When set to true hides the match header.
collapseGameInformation	boolean	optional	true	When set to false opens the game information section
useTeamColors	boolean	optional	null	Valid values are: null(Uses your settings. If you are configured to use team colors, then the theme can be overridden with the teamColorsTheme parameter.), true(team colors will be used, as specified with the teamColorsTheme parameter. If your configuration does not specify a team colors theme, then team colors will not be used.), or false(team colors will not be used).
teamColorsTheme	string	optional	null	When set (and not disabled by useTeamColors), specifies the name of the formula to calculate team colors (e.g. mono-team-colors-light).
enableTeamSelect	boolean	optional	false	When set to true enables team selection. Interactive areas are: team name and logo in a match header, rows in the scoring table of the match header, team logo in the section headers, and player names and images in the Leaders section. TeamId is emitted on click or touch.
enablePlayerSelect	boolean	optional	false	When set to true enables player selection. Interactive areas are: player names and images in the Leaders section. PlayerId is emitted on click or touch..
onItemClick	function	optional		Function/event handler. By default all widget click target areas are disabled. enableTeamSelect enables team targets and enablePlayerSelect enables player targets.
border	boolean	optional		If true draws a border around the widget.

Examples

HTML/Declarative

JS/Programmatic

Examples of onItemClick targets and emitted props

"team",{"teamId":"sd:team:82cf9565-6eb9-4f01-bdbd-5aa0d472fcd9","matchId":"sd:match:ee83c78d-f7eb-46fc-a851-e5e3b2a82f44","seasonId":2020,"seasonType":"REG","week":10,"awayTeamId":"sd:team:82cf9565-6eb9-4f01-bdbd-5aa0d472fcd9","homeTeamId":"sd:team:d26a1ca5-722d-4274-8f97-c92e49c96315","awayTeamUid":"4421","homeTeamUid":"367364"} "player",{"playerId":"sd:player:5812204c-6dae-4450-8011-99e0f72864ac","teamId":"sd:team:d26a1ca5-722d-4274-8f97-c92e49c96315","matchId":"sd:match:ee83c78d-f7eb-46fc-a851-e5e3b2a82f44","seasonId":2020,"seasonType":"REG","week":10,"awayTeamId":"sd:team:82cf9565-6eb9-4f01-bdbd-5aa0d472fcd9","homeTeamId":"sd:team:d26a1ca5-722d-4274-8f97-c92e49c96315","awayTeamUid":"4421","homeTeamUid":"367364"} Return to top ## Linescore us.match.nfl.linescore provides a score summary per quarter for a given game, including the current situation for a live game. > For the widget to render you must provide a valid matchId. To see a full-sized version of this widget, click here.

Parameters

Name	Type	Description
props	object	properties
		Name	Type	Argument	Description
		matchId	number	required	Match ID
		border	boolean	optional	If true enables a border around the widget.
		onItemClick	function	optional	Function/event handler. Emits uniqueTeamId on click or touch.

Examples

HTML/Declarative

JS/Programmatic

Return to top ## Live Game Carousel us.match.nfl.liveMatchCarousel displays a scrolling carousel of live or upcoming NFL games. > To see a full-sized version of this widget, click here.

Parameters

Name	Type	Description
props	object	properties
		Name	Type	Argument	Default	Description
		tournaments	string	optional	''	Tournaments to display in a comma-separated string. Valid options are regular, preseason, probowl or an empty value (all tournaments). More than one can be included.
		limit	number	optional	10	Max number of games shown.
		autoplay	boolean	optional	'true'	If false stops carousel autoplay.
		autoplaySpeed	number	optional	5000	Carousel autoplay speed in ms.
		showDate	boolean	optional		If true displays date alongside game time.
		useGlobalMatchIds	boolean	optional	'false'	Use global match IDs (number) in onMatchesSet and onItemClick when true, otherwise use US match IDs (string).
		border	boolean	optional		If true enables a border around the widget.
		onMatchesSet	function	optional		Function/event handler. Emits matchIds array on team click or touch.
		onItemClick	function	optional		Function/click handler. Emits target and data on click or touch.

Examples

HTML/Declarative

JS/Programmatic

>

JS/Example of using Event Handlers

JS/Example of using Click Handlers

Return to top ## Live Game Tracker us.match.lmt provides live scoring, statistics, and win probabilities for a given game. > For the widget to render you must provide a valid matchId. To see a full-sized version of this widget, click here.

Parameters

Name	Type	Description
props	object	properties
		Name	Type	Argument	Description
		matchId	number	required		Match ID

Examples

HTML/Declarative

JS/Programmatic

Return to top ## Money Percentage Tracking us.betting.match.nfl.moneyPercentageTrackingSlim displays a small money tracking graph for a given game, with selections for money percentage (Spread, Moneyline, Total). > For the widget to render you must provide a valid matchId or nflMatchId. All other properties are optional. To see a full-sized version of this widget, click here.

Parameters

Name	Type	Description
props	object	properties
		Name	Type	Argument	Default	Description
		matchId	number	required		Match ID
		type	string	optional	'moneyline'	Betting percentage type to display. Options are: moneyline, spread, total.
		hideDropdown	boolean	optional		If true hides the dropdown and displays the type title.
		border	boolean	optional	'true'	If false hides a border around the widget.
		onItemClick	function	optional		Function/event handler. Emits uniqueTeamId on team click or touch.

Examples

HTML/Declarative

JS/Programmatic

JS/Example of using Event Handlers

Return to top ## News us.common.nfl.news displays full NFL news articles, with the capability to filter by season, game, and player. >

• To display player news, the parameters playerId, seasonId and providerId must be set.
• To display game news, the parameters matchId, providerId and type must be set.
• To display season news, the parameters seasonId and providerId must be set.

To see a full-sized version of this widget, click here.

Parameters

Name	Type	Description
props	object	properties
		Name	Type	Default	Description
		seasonId	number	optional	Season ID
		matchId	string	optional	Match ID
		playerId	string	optional	Player ID
		articleId	string	optional	Article ID
		limit	number	optional	Maximum number of articles to display.
		type	string	optional	Type of content. Valid types: previews, recaps, or contents.
		providerId	number	optional	ID of the news provider. 2 for Associated Press, 3 for Associated Press Premium.

Examples

HTML/Declarative

JS/Programmatic

Return to top ## Odds us.match.odds provides odds for a given game. > For the widget to render you must provide a valid matchId. All other properties are optional. To see a full-sized version of this widget, click here.

Parameters

Name	Type	Description
props	object	properties
		Name	Type	Argument	Default	Description
		matchId	number	required		Match ID
		oddsType	string	optional	'spread'	Odds Type Filter. Choose between: spread, moneyLine, or overunder.
		type	string	optional	'mixed'	Determines height of the odds markets' buttons. Valid values are: mixed, line, and block.
		disableHeader	boolean	optional	false	If true hides the widget header.
		border	boolean	optional		If true enables a border around the widget.

Examples

HTML/Declarative

JS/Programmatic

Return to top ## Odds Comparison us.betting.season.nfl.oddsComparison is a compiled table of bookmaker odds. It displays pre-game and live odds based on the game's status and odds type. > To see a full-sized version of this widget, click here.

Parameters

Name	Type	Argument	Default	Description
matchStatus	string	optional	'pre'	Match Status Filter. You can choose between pre or live.
oddsType	string	optional	'spread'	Odds type filter. Choose between: spread, moneyLine, or overunder.
bookmakers	string	optional		Comma separated string for selected bookmakers. Options are: draftkings, fanduel, mgm, williamhillnewjersey, caesarsnewjersey, caesarspennsylvania, sugarhousenj, bet365newjersey, and pointsbet.
selectedDate	string	optional		Selects particular NFL week which contains selectedDate. Format: YYYY-MM-DD.
onItemClick	function	optional		Function/event handler. Emits matchId and other props on table row click or touch.
border	boolean	optional		If true draws a border around the widget.
enableLimit	boolean	optional	'true'	If true enables a 5 game limit on the table. If more games are available, a "more" button appears and after clicking it, 5 more games can be seen.
disableOddsColor	boolean	optional		If true disables odds colors on live games.
disableOddsHighlighting	boolean	optional		If true disables highlighting for odds changes.
disableHeader	boolean	optional		If true disables the season info header.
enableDeeplink	boolean			If true bookmaker column headings become clickable, opening the corresponding bookmaker's website in a new browser tab.

Examples

HTML/Declarative

JS/Programmatic

JS/Example of using Event Handler

Return to top ## Play by Play us.match.nfl.playByPlay displays a running timeline of every drive in a given game, as well as an interactive field display. > For the widget to render you must provide a valid matchId. To see a full-sized version of this widget, click here.

Parameters

Name	Type	Argument	Default	Description
matchId	string	required		Match ID
disableWidgetHeader	boolean	optional	false	When set to true hides the widget header.
disableMatchHeader	boolean	optional	false	When set to true hides the match header.
collapseGameInformation	boolean	optional	true	When set to false opens the game information section
disableInnerScrolling	boolean	optional		When set to true the inner fixed-height drives scroll area is disabled. The widget displays full height.
listOrder	string	optional		The order of quarters, drives, and plays in the list. Valid values are: 'default' - during a live game quarters, drives, and plays are listed in a descending order, otherwise in an ascending order; 'desc' lists quarters, drives, and plays in a descending order; 'descq' lists quarters in a descending order, and drives and plays in an ascending order; 'asc' lists quarters, drives, and plays in an ascending order.
selectedQuarter	number	optional	null	The number of the quarter, when selecting a play with the triplet selectedQuarter, selectedDrive, selectedPlay. Can be one of 1, 2, 3, 4, or 5 (overtime). Defaults to the last quarter played.
selectedDrive	number	optional	null	The number of the drive, when selecting a play with the triplet selectedQuarter, selectedDrive, selectedPlay. Numbering starts at 1. Defaults to the last drive played.
selectedPlay	number	optional	null	The number of the play, when selecting a play with the triplet selectedQuarter, selectedDrive, selectedPlay. Numbering starts at 1. Defaults to the last play played.
filterQuarter	number	optional	null	When set, displays only drives of the specified quarter. Can be one of: null, 1, 2, 3, 4, 5 (overtime). Null represents no restriction.
filterDrive	number	optional	null	Can be one of: null, scoring, team. When scoring, displays only scoring drives. When team, displays only drives where the team set with filterDriveTeamId is in possession. Null represents no restriction.
filterDriveTeamId	number	optional	null	Sets the team ID to use when filterDrive is team.
useTeamColors	boolean	optional	null	Valid values are: null(Uses your settings. If you are configured to use team colors, then the theme can be overridden with the teamColorsTheme parameter.), true(team colors will be used, as specified with the teamColorsTheme parameter. If your configuration does not specify a team colors theme, then team colors will not be used.), or false(team colors will not be used).
teamColorsTheme	string	optional	null	When set (and not disabled by useTeamColors), specifies the name of the formula to calculate team colors (e.g. mono-team-colors-light).
enableTeamSelect	boolean	optional	false	When set to true enables team selection. Interactive areas are: team name and logo in a match header and team logos in the statistics sub-headers. TeamId is emitted on click or touch.

Examples

HTML/Declarative

JS/Programmatic

Return to top ## Player Career Stats us.player.nfl.CareerStats displays the career stats of a given NFL player. > For the widget to render you must provide a valid playerId. To see a full-sized version of this widget, click here.

Parameters

Name	Type	Argument	Default	Description
playerId	string	required		Player ID
seasonType	string	optional		Season Type: regular or playoffs.
seasonDefaultSortDirection	string	'asc'		Sets initial season column sort direction. Valid options are asc and desc
disableSeasonTypeDropdown	boolean	optional		When set to true omits the season type dropdown.
displayAccumulatedStatsCategoriesOnly	boolean	optional	true	When set to true individual tables are displayed only if a player has accumulated stats for a given category.
border	boolean	optional		When set to true the table is displayed with a border.

Columns Option Descriptions

Examples

HTML/Declarative

JS/Programmatic

Return to top ## Player Game Logs us.player.nfl.gameLogs shows game-by-game statistics for a given player in a season. > For the widget to render you must provide a valid playerId. To see a full-sized version of this widget, click here.

Parameters

Name	Type	Description
props	object	properties
		Name	Type	Argument	Description
		playerId	string	required	Player ID
		seasonId	number	optional	Season ID. If not provided, the current season is used.
		seasonType	string	optional	Season Type: regular / playoffs
		sortIdx	number	optional	Overrides table default sort column index. 1, 2, 3..; Usually used with sortDirection.
		sortDirection	string	optional	Overrides table default sort direction. Valid options are asc and desc. Usually used with sortIdx.
		enableLimit	boolean	optional	Switches into limited mode. If there are more than 10 games, it shows only 10 games with an option to extend the games view. Games are sorted from newest on.
		border	boolean	optional	If true enables a border around the widget.
		onItemClick	boolean		Function/event handler. Emits matchId and other props on table row click or touch.

Examples

HTML/Declarative

JS/Programmatic

JS/Example of using Event Handler

Example of onItemClick targets and emitted props

match: {"matchId":"sd:match:f0e1490c-e9c3-479d-b937-cb2e3930b29b","seasonId":2021,"awayTeamId":"sd:team:e6aa13a4-0055-48a9-bc41-be28dc106929","homeTeamId":"sd:team:4254d319-1bc7-4f81-b4ab-b5e6f3402b69"} Return to top ## Player Header us.player.nfl.header provides biographical information and current seasonal stats for a given player. > For the widget to render you must provide a valid playerId and seasonId. All other properties are optional. To see a full-sized version of this widget, click here.

Parameters

Name	Type	Description
props	object	properties
		Name	Type	Argument	Description
		playerId	string	required	Player ID
		seasonId	number	required	Season ID
		seasonType	string	optional	Season Type. Valid values are: pre, reg, and pst.
		hidePlayerImg	boolean	optional	Hides player image.
		border	boolean	optional	If true enables a border around the widget.
		onItemClick	function	optional	Function/event handler. Emits TeamId and uniqueTeamId on team logo click or touch.

Examples

HTML/Declarative

JS/Programmatic

JS/Example of using Event Handler

Return to top ## Player Header Small us.player.nfl.headerSmall provides basic player information, including headshot, number, and position. > For the widget to render you must provide a valid playerId and seasonId. All other properties are optional. To see a full-sized version of this widget, click here.

Parameters

Name	Type	Description
props	object	properties
		Name	Type	Argument	Description
		playerId	string	required	Player ID
		seasonId	number	required	Season ID
		seasonType	string	optional	Season Type. Valid values are: pre, reg, and pst.
		border	boolean	optional	If true enables a border around the widget.
		onItemClick	function	optional	Function/event handler. Emits uniqueTeamId on click or touch.

Examples

HTML/Declarative

JS/Programmatic

JS/Example of using Event Handler

Return to top ## Player Seasonal Statistics us.season.nfl.playersStats displays seasonal statistics for NFL players. > All properties are optional. By default, the widget provides player statistics for the active season. To see a full-sized version of this widget, click here.

Parameters

Name	Type	Description
props	object	properties
		Name	Type	Argument	Default	Description
		seasonId	number	optional		Season ID (Year or Fishnet ID)
		seasonType	number	optional	'regular'	Season type: regular / playoffs
		category	string	optional	'passing'	Statistics mode: passing, rushing, receiving, defense, kicking, punting, returns.
		conference	string	optional	'all'	Conference filter: all, afc, or nfc.
		teamId	number	optional		Team ID with or without 'sd:team:' prefix. When teamId is entered team dropdown is hidden.
		qualifiesAsLeagueLeader	boolean	optional	true	When set to true enables statistical minimums to qualify a player for inclusion in a statistical category.

props Name	Type	Argument	Default	Description
useRadar360Qualifiers	boolean	optional		When set to true uses radar360 data as qualifiers source.
props.pageLength	number	optional	50	Number of players to display per page.
props.disableTitle	boolean	optional		When set to true hides the widget title.
props.hideFilters	boolean	optional		When set to true hides all filters/dropdowns.
props.hideFilters	boolean	optional		When set to true hides all filters/dropdowns.
props.hideFilters	boolean	optional		When set to true hides all filters/dropdowns.
props.hideFilters	boolean	optional		When set to true hides all filters/dropdowns.
props.hideFilters	boolean	optional		When set to true hides all filters/dropdowns.
props.disableCategoryDropdown	boolean	optional		When set to true hides category dropdown.
props.disableQualifiersSwitch	boolean	optional		When set to true hides qualifiers switch.
props.disableSeasonDropdown	boolean	optional		When set to true hides season dropdowns.
props.disableSeasonTypeDropdown	boolean	optional		When set to true hides season type dropdowns.
props.disableConferenceDropdown	boolean	optional		When set to true hides conference dropdowns.
props.disableTeamsDropdown	boolean	optional		When set to true hides teams dropdowns.
props.disablePositionsDropdown	boolean	optional		When set to true hides positions dropdowns.
props.border	boolean	optional		When set to true the table is displayed with border.
props.passingColumns	string	optional		Comma separated string of passing statistics column keys. Used for picking fewer columns and different order. Valid options are: team, position, passer_rat, passing_comp, passing_att, passing_cmp_pct, passing_yds, passing_tds, passing_int, passing_yds_att, passing_yds_game, catchable_pass, sacks_allowed, hurries, avg_pocket_time.
props.rushingColumns	string	optional		Comma separated string of rushing statistics column keys. Used for picking fewer columns and different order. Valid options are: team, position, rush_att, rush_yds, rush_avg, rush_td, rush_att_game, rush_yds_game, rush_first_downs, rush_stuff_pct, fumbles, fumbles_lost, rushing_td_pct, rush_yac_avg, rush_ybc_avg, rush_brk_tack.
props.receivingColumns	string	optional		Comma separated string of receiving statistics column keys. Used for picking fewer columns and different order. Valid options are team, position, targets, receptions, rec_yds, rec_tds, targets_game, rec_yds_game, yds_rec, first_down_pct, avg_yds_catch, avg_yac, rec_drop, brk_tack.
props.defenseColumns	string	optional		Comma separated string of defensive statistics column keys. Used for picking fewer columns and different order. Valid options are team, position, tot_tack, assists, def_sacks, def_sack_yds, forced_fumbles, def_tgt, passes_defended, def_int, int_td, safety, tfl, def_blitz, qbh, def_knocks, def_hurries, pressures, def_snaps.
props.kickingColumns	string	optional		Comma separated string of kicking table statistics column keys. Used for picking fewer columns and different order. Valid options are team, position, kickoffs, kickoffs_tb, kickoffs_tb_pct, kickoffs_yds, kickoff_yds_avg, fgm, fga, fg_pct, xpm, xpa, xp_pct.
props.puntingColumns	string	optional		Comma separated string of punting table statistics column keys. Used for picking fewer columns and different order. Valid options are team, position, punts, gross_punt_yds, gross_punt_avg, punts_blocked, punting_touchbacks, punt_i20, punt_long, net_punt_yds, net_punt_avg, hang.
props.returnsColumns	string	optional		Comma separated string of returns table statistics column keys. Used for picking fewer columns and different order. Valid options are team, position, punt_returns, punt_ret_yds, punt_ret_avg, punt_ret_fc, punt_ret_long, punt_ret_td, kickoff_returns, kickoff_return_yds, kickoff_return_avg, kick_return_long, kickoff_return_td.
props.passingSortIdx	string	optional		Overrides passing table default sort statistics column index. 1, 2, 3....
props.rushingSortIdx	string	optional		Overrides rushing table default sort statistics column index. 1, 2, 3....
props.receivingSortIdx	string	optional		Overrides receiving table default sort statistics column index. 1, 2, 3....
props.defenseSortIdx	string	optional		Overrides defensive table default sort statistics column index. 1, 2, 3....
props.kickingSortIdx	string	optional		Overrides kicking table default sort statistics column index. 1, 2, 3....
props.puntingSortIdx	string	optional		Overrides punting table default sort statistics column index. 1, 2, 3....
props.returnsSortIdx	string	optional		Overrides return table default sort statistics column index. 1, 2, 3....
props.onItemClick	function	optional		Function/event handler. Emits playerId, teamId, seasonId, uniqueTournamentId on table row click or touch.

Examples

HTML/Declarative

JS/Programmatic

JS/Example of using Event Handler

Return to top ## Player Statistics us.player.nfl.statistics provides seasonal statistics for a given player and season. > For the widget to render you must provide a valid playerId, seasonId, and seasonType. All other properties are optional. To see a full-sized version of this widget, click here.

Parameters

Name	Type	Description
props	object	properties
		Name	Type	Argument	Default	Description
		playerId	string	required		Player ID
		seasonId	number	required		Season ID
		seasonType	string	required		Season Type. Valid values are: pre, reg, and pst.
		disableWidgetHeader	boolean	optional	false	When set to true hides the widget header.
		enableTeamSelect	boolean	optional	false	When set to true enables team selection. Interactive areas are: team logo, player image. TeamId is emitted on click or touch.
		enablePlayerSelect	boolean	optional	false	When set to true enables player selection. Interactive areas are: player image. PlayerId is emitted on click or touch.
		border	boolean	optional		If true enables a border around the widget.
		onItemClick	function	optional		Function/event handler. Emits uniqueTeamId on click or touch.

Examples

HTML/Declarative

JS/Programmatic

Return to top ## Points Per Game us.match.nfl.pointsPerGame compares the average points per game for each team in a provided matchup. > For the widget to render you must provide a valid matchId. All other properties are optional. To see a full-sized version of this widget, click here.

Parameters

Name	Type	Description
props	object	properties
		Name	Type	Argument	Default	Description
		matchId	string	required		Match ID
		border	boolean	optional		If true enables a border around the widget.
		onItemClick	function	optional		Function/event handler. Emits teamId on click or touch.

Examples

HTML/Declarative

JS/Programmatic

JS/Programmatic

>

Return to top ## Points Per Game Opponent us.match.nfl.pointsPerGame compares the average points allowed per game for each team in a provided matchup. > For the widget to render you must provide a valid matchId. All other properties are optional. To see a full-sized version of this widget, click here.

Parameters

Name	Type	Description
props	object	properties
		Name	Type	Argument	Default	Description
		matchId	string	required		Match ID
		border	boolean	optional		If true enables a border around the widget.
		onItemClick	function	optional		Function/event handler. Emits teamId on click or touch.

Examples

HTML/Declarative

JS/Programmatic

JS/Programmatic

Return to top ## Pregame Betting Statistics us.betting.match.nfl.pregameBettingStatistics displays betting statistics of a given NFL game. > For the widget to render you must provide a valid matchId. All other properties are optional. This widget is not supported for the Pro Bowl or Preseason games. To see a full-sized version of this widget, click here.

Parameters

Name	Type	Description
props	object	properties
		Name	Type	Argument	Description
		matchId	string	required	Match ID
		disableHeader	boolean	optional	If true hides the widget header.
		border	boolean	optional	If false hides a border around the widget.
		onItemClick	function	optional	Function/event handler. Emits uniqueTeamId on team click or touch.

Examples

HTML/Declarative

JS/Programmatic

JS/Example of using Event Handlers

Return to top ## Projected Total Points us.match.nfl.projectedTotalPoints provides the projected point total for each team in a given game, displayed alongside the over/under. > For the widget to render you must provide a valid matchId. All other properties are optional. To see a full-sized version of this widget, click here.

Parameters

Name	Type	Description
props	object	properties
		Name	Type	Argument	Default	Description
		matchId	string	required		Match ID
		border	boolean	optional		If true draws a border around the widget.
		onItemClick	function	optional		Function/event handler. Emits teamId on click or touch.

Examples

HTML/Declarative

JS/Programmatic

JS/Programmatic

Return to top ## Schedule and Results us.season.nfl.scheduleAndResults displays weekly schedules and results for all NFL games. > For the widget to render you must provide a valid seasonId. All other properties are optional. To see a full-sized version of this widget, click here.

Parameters

Name	Type	Argument	Default	Description
seasonId	number	required		NFL Season ID (Year)
seasonType	string	optional		Sets the default selected season type. Valid values are: pre, reg, or pst. It must be specified together with week; either both or none must be set. If this prop is null then the season type of the currently active week of the specified seasonId will be used.
week	number	optional	null	Sets the selected week. It must be specified together with seasonType; either both or none must be set. The valid number depends on the value of seasonType. For pre, valid values are 0-4. For reg, valid values are 1-17. For pst, valid values are 1-5. If this prop is null then the currently active week of the specified seasonId will be used.
disableWidgetHeader	boolean	optional	'false'	When set to true hides the widget header.
disableOpenScoringTable	boolean	optional	false	When set to true disables the opening of the scoring table on clicks for small and medium sizes.
enableGameSelect	boolean	optional	false	Enables game selection. Interactive areas are: entire game and row. MatchId is emitted on click or touch.
enableMatchSelect	boolean	optional	false	Enables game selection. Interactive areas are: entire game and row. MatchId is emitted on click or touch.
enableTeamSelect	boolean	optional	false	Enables team selection. Interactive areas are: team name and logo in the match headers and entire rows in the scoring table of the match headers. TeamId is emitted on click or touch.
enableSeasonSelect	boolean	optional	false	Enables seasonal attributes selection. Interactive areas are: entire game and row. SeasonId, seasonType and week are emitted on click or touch.
onItemClick	function	optional		Function/event handler. Emits teamId on team click or touch, matchId on match click or touch and seasonId, seasonType and week on season change enableGameSelect
border	boolean	optional		If true draws a border around the widget.

Examples

HTML/Declarative

JS/Programmatic

JS/Example of using Event Handler

Return to top ## Score us.match.nfl.score displays the current score, the teams represented by name and logo, the game status, and other key game-related information as collapsible content. > For the widget to render you must provide a valid matchId. All other properties are optional. This widget displays date/time in your local timezone (based on operating system settings). To see a full-sized version of this widget, click here.

Parameters

Name	Type	Description
props	object	properties
		Name	Type	Argument	Default	Description
		matchId	string	required		Match ID
		showDate	boolean	optional		Shows the date of future games.
		isCollapsed	boolean	optional	'true'	If false collapses collapsible content (i.e. game information).
		disablePitch	boolean	optional		If true hides the field/pitch.
		disableLastPlay	boolean	optional		If true hides last play info.
		disableHeader	boolean	optional		If true hides the header.
		disableGameInfo	boolean	optional		If true hides the expandable bottom section containing game details.
		disableAttendance	function	optional		If true hides attendance content.
		autoSlide	boolean	optional		Disables auto sliding of the content in the game info section.
		autoSlideSpeed	number	optional		Sets the delay of auto sliding of the content in the game info section (in milliseconds).
		enableTeamSelect	boolean	optional		If true enables team onItemClick target.
		enablePlayerSelect	boolean	optional		If true hides field/pitch player onItemClick target.
		enableMatchClick	boolean	optional		If true hides field/pitch match onItemClick target and disables all other targets.
		preMatchLinks	string	optional		Comma separated string of link keys for pre-game. Can be undefined, default, preview, boxscore, gametracker, or recap. Entering default is the same as entering 'preview'.
		liveMatchLinks	string	optional		Comma separated string of link keys for a live game. Can be undefined, default, preview, boxscore, gametracker, or recap. Entering default is the same as entering 'boxscore, gametracker'.
		postMatchLinks	string	optional		Comma separated string of link keys for post-game. Can be undefined, default, preview, boxscore, gametracker, or recap. Entering default is the same as entering 'boxscore, recap'.
		border	boolean	optional	true	If false hides a border around the widget.
		onItemClick	function	optional		Function/event handler. More info below.

By default, all widget click target areas are disabled. The enableTeamSelect enables team targets. enablePlayerSelect enables a player targets. The player targets appear in the Game Information section depending on game status. enableMatchClick enables a match target and disables all other targets. With preMatchLinks, liveMatchLinks and/or postMatchLinks set the widget gets preview, boxscore, gametracker and/or recap targets. All targets emit the following match props on click or touch: matchId, sportId, realCategoryId, seasonId, seasonType, week, awayTeamId, homeTeamId, awayTeamUid, homeTeamUid. Team target adds teamId, player target adds playerId and teamId, match target adds matchStatus, Valid matchStatus values are: pre, live, post.

Examples

"team",{"teamId":"sd:team:82cf9565-6eb9-4f01-bdbd-5aa0d472fcd9","matchId":"sd:match:ee83c78d-f7eb-46fc-a851-e5e3b2a82f44","seasonId":2020,"seasonType":"REG","week":10,"awayTeamId":"sd:team:82cf9565-6eb9-4f01-bdbd-5aa0d472fcd9","homeTeamId":"sd:team:d26a1ca5-722d-4274-8f97-c92e49c96315","awayTeamUid":"4421","homeTeamUid":"367364"} "player",{"playerId":"sd:player:5812204c-6dae-4450-8011-99e0f72864ac","teamId":"sd:team:d26a1ca5-722d-4274-8f97-c92e49c96315","matchId":"sd:match:ee83c78d-f7eb-46fc-a851-e5e3b2a82f44","seasonId":2020,"seasonType":"REG","week":10,"awayTeamId":"sd:team:82cf9565-6eb9-4f01-bdbd-5aa0d472fcd9","homeTeamId":"sd:team:d26a1ca5-722d-4274-8f97-c92e49c96315","awayTeamUid":"4421","homeTeamUid":"367364"} "box_score",{"matchId":"sd:match:ee83c78d-f7eb-46fc-a851-e5e3b2a82f44","seasonId":2020,"seasonType":"REG","week":10,"awayTeamId":"sd:team:82cf9565-6eb9-4f01-bdbd-5aa0d472fcd9","homeTeamId":"sd:team:d26a1ca5-722d-4274-8f97-c92e49c96315","awayTeamUid":"4421","homeTeamUid":"367364"} "match",{"matchId":"sd:match:ee83c78d-f7eb-46fc-a851-e5e3b2a82f44","matchStatus":"post","seasonId":2020,"sportId":16,"seasonType":"REG","week":10,"awayTeamId":"sd:team:82cf9565-6eb9-4f01-bdbd-5aa0d472fcd9","homeTeamId":"sd:team:d26a1ca5-722d-4274-8f97-c92e49c96315","awayTeamUid":"4421","homeTeamUid":"367364"}

HTML/Declarative

JS/Programmatic

JS/Example of using Event Handlers

Return to top ## Scoreboard us.match.nfl.scoreboard provides the current score of a given game, a quarter-by-quarter line score, and other top-level game information. > For the widget to render you must provide a valid matchId. All other properties are optional. This widget displays date/time in your local timezone (based on operating system settings). To see a full-sized version of this widget, click here.

Parameters

Name	Type	Description
props	object	properties
		Name	Type	Argument	Description
		matchId	string	required	Match ID
		border	boolean	optional	If true draws a border around the widget.
		onItemClick	function	optional	Function/event handler. Emits playerId, teamId, matchId on click or touch.

Examples

HTML/Declarative

JS/Programmatic

Return to top ## Score Nano us.match.nfl.scorenano is a condensed version of the scoreboard widget. It provides the current score and status of a given NFL game. > For the widget to render you must provide a valid matchId. All other properties are optional. To see a full-sized version of this widget, click here.

Parameters

Name	Type	Description
props	object	properties
		Name	Type	Argument	Default	Description
		matchId	string	required		Match ID
		border	boolean	optional		If false hides a border around the widget.
		onItemClick	function	optional		Function/event handler. Only target item is match. More info below.

onItemClick property emits various match props on click or touch, such as matchId, sportId, realCategoryId, seasonId, tournamentId, uniqueTournamentId, awayTeamUid, homeTeamUid, awayTeamId, homeTeamId, seasonType, week. Valid matchStatus values are: pre, live, post.

Examples

match: {"matchId":"sd:match:ee83c78d-f7eb-46fc-a851-e5e3b2a82f44","seasonId":2020,"tournamentId":47,"uniqueTournamentId":31,"realCategoryId":43,"sportId":16,"awayTeamUid":4421,"homeTeamUid":367364,"matchStatus":"post","seasonType":"REG","week":10,"awayTeamId":"sd:team:82cf9565-6eb9-4f01-bdbd-5aa0d472fcd9","homeTeamId":"sd:team:d26a1ca5-722d-4274-8f97-c92e49c96315"}

HTML/Declarative

JS/Programmatic

JS/Example of using Event Handlers

Return to top ## Score Small us.match.nfl.ScoreSmall is a smaller version of the scoreboard widget. It provides the current score and status of a given NFL game. > For the widget to render you must provide a valid matchId. All other properties are optional. This widget displays date/time in your local timezone (based on operating system settings). To see a full-sized version of this widget, click here.

Parameters

Name	Type	Description
props	object	properties
		Name	Type	Argument	Default	Description
		matchId	string	required		Match ID
		showDate	boolean	optional		If true shows the date of future games.
		border	boolean	optional	'true'	If true draws a border around the widget.
		onItemClick	function	optional		Function/event handler. Emits playerId, teamId, matchId on click or touch.

Examples

HTML/Declarative

JS/Programmatic

Return to top ## Score Ticker us.common.scoreTicker provides a condensed ticker of daily matchups. The user has the ability to view previous and upcoming dates, as well as all other leagues and sports currently offered. > To see a full-sized version of this widget, click here. There are two options for generating the Score Ticker widget.

Option 1

Without matchId, sport or uniqueTournamentId props being set, the widget attempts to find and auto-select sports with live games. If there are multiple sports that are live at one time, the widget follows this order of operations: NFL playoffs, NBA playoffs, NCAAF playoffs, NCAAB NCAA tournament, MLB playoffs, NHL playoffs, NFL pro bowl, NBA All-Star game, MLB All-Star game, NHL All-Star game, NFL regular season, NBA regular season, NCAAF regular season, NCAAB regular season, MLB regular season, NHL regular season, Premier League, Champions League, La Liga, Bundesliga, MLS playoffs, MLS regular season, Serie A, Ligue 1, Europa League, NCAAB NIT, NCAAB CBI, NCAAB CIT, NFL preseason, NBA preseason, MLB spring training, NHL preseason, NBA summer league. The widget picks from the allowedSports prop, if set. Otherwise, it picks from all supported sports. For soccer it further picks from the allowedUniqueTournaments prop, if set. Otherwise, it picks from all supported unique tournaments. Failing to find a live sport, and with the considerNearest prop set to true, the widget will select a sport with the soonest upcoming game. Failing to find a live sport or an upcoming game with the considerNearest prop, the widget falls back to the NFL Score Ticker for the current day. The widget automatically reselects live games, or the soonest upcoming sport, to follow status changes that occur over time. Once a user selects another sport using the sport selector, the widget will stop automatically reselecting games and sports until the widget is reloaded.

Option 2

If matchId, sport or uniqueTournamentId props are set, the widget will initialize with that sport. Auto-selecting sport is turned off in this scenario.

Parameters

Name	Type	Argument	Default	Description
matchId	number	optional		Match ID. Has priority over sport.
sport	number | string	optional	nfl	A name (string) or ID (number) of the sport that will initially be displayed. Supported: soccer (1), nba (2), mlb (3), nhl (4), nfl (5), ncaaf (6), ncaab (7).
allowedSports	array | string	optional	'spread'	Array or comma-separated string of allowed sports (names or ids) to chose from sport selector or sport prop. Also denotes live/nearest sport auto-selecting feature and sport selector items order. If sport prop default is not on the list its default changes to first allowed sport. Supported: soccer (1), nba (2), mlb (3), nhl (4), nfl (5), ncaaf (6), ncaab (7). In case of one sport (with the exception of soccer - see allowedUniqueTournaments), the sport toggle ability is removed and a sport label is displayed instead of the sport selector.
uniqueTournamentId	number	optional		Unique tournament ID (Soccer). Supported: 17 (EPL), 242 (MLS), 7 (UCL), 679 (UEL), 8 (LaLiga), 23 (Serie A), 35 (BundesLiga), 34 (Ligue 1). Has no effect in combination with other supported sports.
allowedUniqueTournaments	array | string	optional		Array or comma-separated string of allowed soccer unique tournaments IDs to choose from sport selector or uniqueTournamentId prop. Also impacts live/nearest auto-selecting feature and sport selector soccer items order. Supported: 17 (EPL), 242 (MLS), 7 (UCL), 679 (UEL), 8 (LaLiga), 23 (Serie A), 35 (BundesLiga), 34 (Ligue 1). In case of only soccer and one soccer unique tournament, the sport toggle ability is removed and a selected soccer unique tournament label is displayed instead of the sport selector. If not set, all supported soccer unique tournaments are allowed.
prevDays	number	optional	1	Number of previous days to select from the date control.
nextDays	number	optional	1	Number of upcoming days to select from the date control.
flipOnEndDay	boolean	optional		Forces to flip to the next day at day's end. If a sport has games being played on consecutive days (e.g. Monday and Tuesday), the ticker will automatically flip to Tuesday's games at the end of the current day/start of the next day. If, however, a sport has games separated by a day (e.g. Monday and Wednesday), then the flipOnEndDay prop can be set to "true" and force the ticker to flip at the end of Monday/start of Tuesday. If set to "false" or left as the default option, the ticker would not flip to the next set of games until the end of Tuesday/start of Wednesday. As a rule, NFL and NCAAF are not affected by this prop's functionality. These two sports are set to flip based on weekly timers. NFL is set to flip to the next week at 5 a.m. UTC on Wednesdays, while NCAAF is set to flip to the next week at 5 a.m. UTC on Tuesdays. If there are live games from the previous week still taking place at those times, the week flip will be delayed until the conclusion of those games.
dayFlipUTCHours	number	optional		Integer between 0 and 23. Forces flipping to current day's games at a specified time based on UTC time zone, but not before start of the current day (in local time). Although the time is set according to UTC, it will effect end users according to their local time zone. Example: if the current date is 1/19/22, a value of 20 will set flipping at 12:00 for a user in PST time zone, 15:00 for EST and 21:00 for CET. However, using a value of 6 will set flipping at 0:00 PST (rather than 1/18/22 22:00 PST), 1:00 EST and 7:00 CET. dayFlipUTCHours has priority over dayFlipHoursBefore.
dayFlipHoursBefore	number	optional		Integer between 0 and 23. Forces flipping to current day's games a specific number of hours before the scheduled time of the first match, but not before the start of the current day (in local time). Example: if the first game of the day is at 7:30pm EST, a value of 7 would leave last night's games displayed until 12:30pm EST.
mergeLive	boolean	optional		Displays all live games no matter when they were originally scheduled/started. Any games that were scheduled the day before and continued past midnight will be moved to the previous day (their original displayed day) as soon as they are finished.
considerNearest	boolean	optional	true	Auto-selects the sport with the soonest game if there are currently no live games.
hasHorizontalSelectors	number	optional		Renders horizontal selectors instead of dropdowns. Typical use case: the HTML Inline Frame element.
h80	boolean	optional		Sets the widget fixed height at 80px. Typical use case: the HTML Inline Frame element.
h90	boolean	optional		Sets the widget fixed height at 90px. Typical use case: the HTML Inline Frame element.
layout	string	optional	'normal'	Sets the type of layout. Valid values are normal and compact. normal breaks the navigation and match list for mobile breakpoint (480px) in 2 lines; compact layout keeps the sport selector and match list for mobile breakpoint in one line, omitting the date selector. The Compact layout also has different paddings and widths, and uses a carrot icon instead of hamburger icon for the sport selector.
disableSportDropdown	boolean	optional		If true hides the sports dropdown/label and takes away from the user the ability to change sport/unique tournament. In the case of a disabled sport selector and unset sport and uniqueTournamentId props, the widget will operate in auto-selecting mode indefinitely.
onItemClick	function	optional		Function/event handler. Possible target items are match and us-sport. When the target is match it means a match has been clicked or touched and it emits various match values: matchId, sportId, usSport, realCategoryId, seasonId, tournamentId, uniqueTournamentId, awayTeamUid, homeTeamUid, matchStatus. When the target is us-sport it means a different sport (or a different soccer league) has been selected in the score ticker, and it emits usSport and uniqueTournamentId values. Valid matchStatus values are: pre, live, post. The usSport value is a numerical sport ID, it can contains the same IDs as the sport prop. Example below.

Examples

HTML/Declarative

JS/Programmatic

JS/Example of using Event Handlers

JS/Allowing MLS(242) soccer league and all non soccer leagues (using array notation)

JS/Allowing European soccer leagues (using comma separated string notation)

onItemClick Example

Return to top ## Season Injuries us.season.nfl.injuries displays weekly injuries for a given season, with the ability to filter by team. > For the widget to render you must provide a valid seasonId. All other properties are optional. To see a full-sized version of this widget, click here.

Parameters

Name	Type	Description
props	object	properties
		Name	Type	Argument	Default	Description
		seasonId	number	required		NFL Season ID (Year)
		seasonType	string	optional		Sets the default selected season type. If not set the widget will default to preseason. Valid values are: pre, reg, or pst.
		week	number	optional	Week 1 of seasonType	Sets the default selected week. The valid number depend on the value of seasonType. For pre, valid values are 0-4. For reg, valid values are 1-17. For pst, valid values are 1-5.
		teamId	string	optional		If set, then only injuries for the given team are displayed. Otherwise injuries for all teams are displayed.
		disableHeader	boolean	optional	'false'	When set to true disables header with the week selection dropdown.
		disableTeamHeaders	boolean	optional	'false'	When set to true disables team headers.
		border	boolean	optional		If true enables a border around the widget.
		onItemClick	function	optional		Function/event handler. Emits playerId on player row click or touch. Emits teamId and uniqueTeamId on team header click or touch.

Examples

HTML/Declarative

JS/Programmatic

JS/Example of using Event Handler

Return to top ## Season Matchup us.season.nfl.matchup displays opponent statistics for several positions (QB, RB, WR, TE) against a given team. > For the widget to render you must provide a valid seasonId. All other properties are optional. To see a full-sized version of this widget, click here.

Parameters

Name	Type	Description
props	object	properties
		Name	Type	Argument	Default	Description
		seasonId	number	required		NFL Season ID (Year)
		teamId	string	optional	null	Sets the selected team. If this is set to null the alphabetically first team of the NFC will be selected.
		position	string	optional	null	Sets the position of the opposing teams. Valid values are: quarterbacks, running_backs, wide_receivers, and tightends. If this is null, the default selection is quarterbacks.
		seasonType	string	optional	null	Sets the default selected season type. Valid values are: pre, reg, or pst. If this prop is null the season type of the currently active week of the specified seasonId will be used.
		week	number	optional	null	Sets the selected week number. The valid number depends on the value of seasonType. For pre, valid values are 0-4. For reg, valid values are 1-17. For pst, valid values are 1-5. If null, the season type of the currently active week of the specified seasonId will be used.
		disableWidgetHeader	boolean	optional	'false'	When set to true hides the widget header.
		selectedUpperTab	string	optional	null	Changes the default active tab in the first row of tabs. The valid inputs depend on the default selected position. If position is not provided the default is quarterbacks. See below for valid positions.
		selectedLowerTab	string	optional	null	Changes the default active tab in the second row of tabs. This row isn't always available depending on the selected position. If position is not provided the default is quarterbacks. See below for valid positions.
		enableTeamSelect	boolean	optional	false	Enables team selection. Interactive area is team dropdown. TeamId is emitted on changing the item in the dropdown.
		border	boolean	optional		If true draws a border around the widget.

Examples

HTML/Declarative

JS/Programmatic

Return to top ## Season Players Carousel us.season.nfl.playerscarousel provides a moving carousel of headers for provided players. > For the widget to render you must provide a valid seasonId or uniqueTournamentId and any number of playerIds. All other properties are optional. To see a full-sized version of this widget, click here.

Parameters

Name	Type	Description
props	object	properties
		Name	Type	Argument	Default	Description
		playerId	string	required		Player ID or a comma separated list of player IDs.
		seasonId	number	required		Season ID (Year)
		seasonType	string	optional		Season Type. Valid options are: pre, reg and pst.
		disableHeader	boolean	optional		If set to true disables the team header.
		border	boolean	optional		If true enables a border around the widget.

Examples

HTML/Declarative

JS/Programmatic

Return to top ## Season Scores us.season.nfl.scores displays weekly schedules and results for all NFL games. > All the properties are optional. By default, the widget will render the active season and week. To see a full-sized version of this widget, click here.

Parameters

Name	Type	Argument	Default	Description
seasonId	number	optional		Season ID (Year)
seasonType	string	optional		Season type. Valid options are: pre, reg, or pst.
week	number	optional		Week number.
firstSeasonId	number	optional	200	The oldest season year for the season dropdown to display.
disableGameHeader	boolean	optional		If true the headers of games are hidden.
disableGameInfo	boolean	optional		If true hides collapsible content (i.e. game information).
disableGameInfoXSmall	boolean	optional	'true'	If true hides collapsible content (i.e. game information) on X-Small responsive breakpoint (<321px).
disablePitchSwitch	boolean	optional		If true hides "SHOW FIELD" switch. However disablePitch prop is still operational.
disablePitch	boolean	optional		Switches pitch visualization (i.e. "SHOW FIELD") switch off. Pitch visualization is only available with live games.
autoSlide	boolean	optional	true	If false disables auto sliding of the content in the game info section.
autoSlideSpeed	number	optional	5000	Sets the delay of auto sliding of the content in the game info section (in milliseconds).
preMatchLinks	string	optional		Comma separated string of link keys for pre-game. Can be undefined, default, preview, boxscore, gametracker, recap. Entering default is the same as entering 'preview'.
liveMatchLinks	string	optional		Comma separated string of link keys for live-match. Can be undefined, default, preview, boxscore, gametracker, recap. Entering default is the same as entering 'boxscore, gametracker'.
postMatchLinks	string	optional		Comma separated string of link keys for post-match. Can be undefined, default, preview, boxscore, gametracker, recap. Entering default is the same as entering 'boxscore, recap'.
enableTeamSelect	boolean	optional		Enables on team click or touch.
enablePlayerSelect	boolean	optional		Enables on player (i.e. game leaders) click or touch.
max3InARow	boolean	optional		If true displays a maximum of 3 games in a row.
border	boolean	optional		If true draws a border around the widget.
onItemClick	function	optional		Function/event handler. More info below.

By default, all widget click target areas are disabled. The enableTeamSelect enables team targets. enablePlayerSelect enables a player targets. The player targets appear in the Game Information section depending on game status. With preMatchLinks, liveMatchLinks and/or postMatchLinks set the widget gets preview, boxscore, gametracker and/or recap targets. All targets emit the following match props on click or touch: matchId, sportId, realCategoryId, seasonId, seasonType, week, awayTeamId, homeTeamId, awayTeamUid, homeTeamUid. Team target adds teamId, player target adds playerId and teamId, match target adds matchStatus, Valid matchStatus values are: pre, live, post.

Examples

"team", {"teamId":"sd:team:82cf9565-6eb9-4f01-bdbd-5aa0d472fcd9","matchId":"sd:match:ee83c78d-f7eb-46fc-a851-e5e3b2a82f44","seasonId":2020,"seasonType":"REG","week":10,"awayTeamId":"sd:team:82cf9565-6eb9-4f01-bdbd-5aa0d472fcd9","homeTeamId":"sd:team:d26a1ca5-722d-4274-8f97-c92e49c96315","awayTeamUid":"4421","homeTeamUid":"367364"} "player", {"playerId":"sd:player:5812204c-6dae-4450-8011-99e0f72864ac","teamId":"sd:team:d26a1ca5-722d-4274-8f97-c92e49c96315","matchId":"sd:match:ee83c78d-f7eb-46fc-a851-e5e3b2a82f44","seasonId":2020,"seasonType":"REG","week":10,"awayTeamId":"sd:team:82cf9565-6eb9-4f01-bdbd-5aa0d472fcd9","homeTeamId":"sd:team:d26a1ca5-722d-4274-8f97-c92e49c96315","awayTeamUid":"4421","homeTeamUid":"367364"} "box_score", {"matchId":"sd:match:ee83c78d-f7eb-46fc-a851-e5e3b2a82f44","seasonId":2020,"seasonType":"REG","week":10,"awayTeamId":"sd:team:82cf9565-6eb9-4f01-bdbd-5aa0d472fcd9","homeTeamId":"sd:team:d26a1ca5-722d-4274-8f97-c92e49c96315","awayTeamUid":"4421","homeTeamUid":"367364"}

HTML/Declarative

JS/Programmatic

JS/Example of using Event Handlers

Return to top ## Season Team Stats us.season.nfl.teamsStats displays a sortable team statistics table for all teams in a given season. Data can be filtered by season type (regular season, playoffs) and by stats categories (offense, offense - advanced, defense, defense - advanced). > All widget properties are optional. By default, the widget will provide a table for the active season. To see a full-sized version of this widget, click here.

Parameters

Name	Type	Argument	Default	Description
seasonId	number	optional	active season	Season ID (Year or Fishnet Season ID)
category	string	optional	'passing'	Statistics mode. Options: offense, offenseAdvanced, defense1, defense2, defenseAdvanced.
conference	string	optional	'all'	Filter teams by conference. Valid options are: all, afc, nfc.
seasonType	string	optional	'regular'	Season type: regular / playoffs.
border	boolean	optional		When set to true the table is displayed with a border.
pageLength	number	optional	50	Number of players to display per page.
disableTitle	boolean	optional		When set to true hides the widget title.
hideFilters	boolean	optional		When set to true hides all filters / dropdown.
offenseColumns	string	optional		Comma separated string of offensive table statistics column keys. Used for picking fewer columns and different order. Valid options are: pf, pfg, tot_yds, tot_ydsg, pass_yds, pass_ydsg, rush_yds, rush_ydsg.
offenseAdvancedColumns	string	optional		Comma separated string of advanced offensive table statistics column keys. Used for picking fewer columns and different order. Valid options are: ppd, rz_td_pct, rz_score_pct, rz_tot_drives, two_pt_conv_pct, pass_pct, rush_pct, to_diff, bppg.
defense1Columns	string	optional		Comma separated string of defensive1 table statistics column keys. Used for picking fewer columns and different order. Valid options are: pa, pag, tot_yds_allwd, tot_yds_g_allwd, def_pass_yds, def_pass_yds_g, rush_yds_allwd, def_rush_yds_g.
defense2Columns	string	optional		Comma separated string of defensive2 table statistics column keys. Used for picking fewer columns and different order. Valid options are: def_sacks, def_sacks_yds, ff, pass_def, def_int, int_yds, int_td, safety, tot_tacks, tfl, qbh.
defenseAdvancedColumns	string	optional		Comma separated string of advanced defensive table statistics column keys. Used for picking fewer columns and different order. Valid options are: def_miss_tacks, def_miss_tacks_pct, def_hurries, def_koncks, def_blitz_pct, def_third_pct.
offenseSortIdx	string	optional		Overrides offensive table default sort statistics column index. 1, 2, 3...
offenseAdvancedSortIdx	string	optional		Overrides offensive advanced table default sort statistics column index. 1, 2, 3...
defense1SortIdx	string	optional		Overrides defense1 table default sort statistics column index. 1, 2, 3...
defense2SortIdx	string	optional		Overrides defense2 table default sort statistics column index. 1, 2, 3...
defenseAdvancedSortIdx	string	optional		Overrides defense advanced table default sort statistics column index. 1, 2, 3...
onItemClick	function	optional		Function/event handler. Emits playerId, teamId, seasonId, uniqueTournamentId on table row click or touch.

Examples

HTML/Declarative

JS/Programmatic

JS/Programmatic

Return to top ## Special Teams us.season.nfl.specialTeams displays special teams statistics for each NFL team in a given season. > For the widget to render you must provide a valid seasonId. All other properties are optional. To see a full-sized version of this widget, click here.

Parameters

Name	Type	Description
props	object	properties
		Name	Type	Argument	Default	Description
		seasonId	number	required		NFL Season ID (Year)
		seasonType	string	optional	null	Sets the default selected season type. Valid values are: pre, reg, or pst. If set to null, the widget will display the active week of the specified seasonId.
		teamId	string	optional	null	Sets the selected team. If this is set to null the alphabetically first team of the NFC will be displayed.
		disableWidgetHeader	boolean	optional	'false'	When set to true hides the widget header.
		enableTeamSelect	boolean	optional	'false'	Enables team selection. Interactive areas are: team and dropdown. TeamId is emitted when the dropdown selection changes.
		border	boolean	optional		If true enables a border around the widget.

Examples

HTML/Declarative

JS/Programmatic

Return to top ## Standings us.season.nfl.standings provides detailed standings info for a given season. > By default, the widget provides the active season standings. To see a full-sized version of this widget, click here.

Parameters

Name	Type	Description
props	object	properties
		Name	Type	Argument	Default	Description
		seasonId	number	optional	active season	Season ID (Year)
		border	boolean	optional		If true enables a border around the widget.
		showSeasonYearTitle	boolean	optional		Adds season year to the title.
		showSeasonSelector	boolean	optional	true	Displays the season selector dropdown.
		transformTeamId	boolean	optional		If true onItemCLick event handler returns team id in "sd" format/origin instead of fishnet.
		columns	string	optional		Comma separated string of column keys. Used for picking fewer columns and different order. Valid options are w, l, t, pct, h, r, c, pf, pa, pd, d, sos, sov, s.
		onItemClick	function	optional		Function/event handler. Emits uniqueTeamId on table row click or touch.

Columns Option Descriptions

Option	Description
w	Wins
l	Losses
t	Ties
pct	Win Percentage
h	Home
r	Road
c	Conference
pf	Points For
pa	Points Against
pd	Point Differential
d	Division
sos	Strength of Schedule
sov	Strength of Victory
s	Streak

Examples

HTML/Declarative

JS/Programmatic

JS/Example of using Event Handler

Return to top ## Standings Carousel us.season.nfl.standingscarousel provides a moving carousel of divisional standings. > To see a full-sized version of this widget, click here.

Parameters

Name	Type	Description
props	object	properties
		Name	Type	Argument	Default	Description
		seasonId	number	optional	active season	Season ID (Year)
		disableHeader	boolean	optional	true	If set to true disables the header.
		autoplay	boolean	optional	true	If set to true the carousel will automatically switch the selected item periodically.
		autoplaySpeed	number	optional	5000	The speed for autoplay in milliseconds.
		border	boolean	optional		If true enables a border around the widget.

Examples

HTML/Declarative

JS/Programmatic

Return to top ## Standings Slim us.season.nfl.standingsSlim is a lightweight version of the standings table. > By default, the widget renders the active standings for the AFC. To see a full-sized version of this widget, click here.

Parameters

Name	Type	Description
props	object	properties
		Name	Type	Argument	Description
		seasonId	number	required	Season ID (Year)
		division	string	optional	Selects division. Valid options: afc, nfc, afc_north, afc_east, afc_west, afc_south, nfc_north, nfc_east, nfc_west, nfc_south.
		teamId	string	optional	Displays the division in which the entered team belongs.
		columns	string	optional	Comma separated string of column keys. Used for picking fewer columns and different order. Valid options are w, l, t, pct, h, r, c, pf, pa, pd, d, sos, sov, s.
		disableHeader	boolean	optional	If true hides the widget header.
		enableDropdown	boolean	optional	If true enables division dropdown selector. Unless teamId is set.
		border	boolean	optional	If true enables a border around the widget.
		onItemClick	function	optional	Function/event handler. Emits teamId on click or touch.

Columns Option Descriptions

Option	Description
w	Wins
l	Losses
t	Ties
pct	Win Percentage
h	Home
r	Road
c	Conference
pf	Points For
pa	Points Against
pd	Point Differential
d	Division
sos	Strength of Schedule
sov	Strength of Victory
s	Streak

Examples

HTML/Declarative

JS/Programmatic

JS/Example of using Event Handler

Return to top ## Strength of Schedule us.match.nfl.strengthOfSchedule provides the combined winning percentage of each teams' opponents in a given game. > For the widget to render you must provide a valid matchId. All other properties are optional. To see a full-sized version of this widget, click here.

Parameters

Name	Type	Description
props	object	properties
		Name	Type	Argument	Default	Description
		matchId	string	required		Match ID
		border	boolean	optional	'true'	If true draws a border around the widget.
		onItemClick	function	optional		Function/event handler. Emits teamId on click or touch.

Examples

HTML/Declarative

JS/Programmatic

JS/Programmatic

Return to top ## Strength of Victory us.match.nfl.strengthOfVictory provides the combined winning percentage of each teams' defeated opponents in a given game. > For the widget to render you must provide a valid matchId. All other properties are optional. To see a full-sized version of this widget, click here.

Parameters

Name	Type	Description
props	object	properties
		Name	Type	Argument	Default	Description
		matchId	string	required		Match ID
		border	boolean	optional	'true'	If true draws a border around the widget.
		onItemClick	function	optional		Function/event handler. Emits teamId on click or touch.

Examples

HTML/Declarative

JS/Programmatic

JS/Programmatic

Return to top ## Team Depth Chart us.team.nfl.depthChart visualizes a depth chart for every position on a given team. > For the widget to render you must provide a valid teamId. To see a full-sized version of this widget, click here.

Parameters

Name	Type	Description
props	object	properties
		Name	Type	Argument	Description
		teamId	string	required	Team ID
		disableDropdown	boolean	optional	When set to true disables the team selection dropdown..
		disableHeaderDetails	boolean	optional	When set to true disables the season header detail.
		onItemClick	function	optional	Function/event handler. Emits playerId on table row click or touch.

Examples

HTML/Declarative

JS/Programmatic

JS/Programmatic

Return to top ## Team Header us.team.nfl.header provides team record and standing for a given team and season. > For the widget to render you must provide a valid teamid and seasonId. To see a full-sized version of this widget, click here.

Parameters

Name	Type	Description
props	object	properties
		Name	Type	Argument	Description
		teamId	string	required	Team ID
		seasonId	number	required	Season ID (Year)
		leagueType	string	optional	Select league standings to display. Valid options are: division, conference, and all
		tiedRankIndicator	boolean	optional	If true displays a tie ranking indicator based solely on win percentage or total points (depending on the sport). It does not factor in all tiebreaking scenarios that you would otherwise see using the regular standings positions.
		border	boolean	optional	If true enables a border around the widget.
		onItemClick	function	optional	Function/event handler. Emits teamId on click or touch.

Examples

HTML/Declarative

JS/Programmatic

JS/Example of using Event Handler

Return to top ## Team Header Small us.team.nfl.headerSmall provides the team record and standing for a given team and season. > For the widget to render you must provide a valid teamId and seasonId. To see a full-sized version of this widget, click here.

Parameters

Name	Type	Description
props	object	properties
		Name	Type	Argument	Description
		teamId	string	required	Team ID
		seasonId	number	required	Season ID (Year)
		leagueType	string	optional	League type to display. Valid options are: division, conference, and all
		tiedRankIndicator	boolean	optional	If true displays a tie ranking indicator based solely on win percentage. It does not factor in all tiebreaking scenarios that you would otherwise see using the regular standings positions.
		border	boolean	optional	If true enables a border around the widget.
		onItemClick	function	optional	Function/event handler. Emits teamId on click or touch.

Examples

HTML/Declarative

JS/Programmatic

JS/Example of using Event Handler

Return to top ## Team Leaders us.season.nfl.teamLeaders displays leaders (passing, rushing, receiving, sacks, tackles, interceptions) for a provided team. > For the widget to render you must provide a valid teamId and seasonId. To see a full-sized version of this widget, click here.

Parameters

Name	Type	Description
props	object	properties
		Name	Type	Argument	Description
		teamId	number	required	Team ID
		seasonId	number	required	Season ID (Year)
		seasonType	string	optional	Season type. Valid options are: pre reg, or pst.
		disableHeader	boolean	optional	If true hides the widget header.
		disableTeamTag	boolean	optional	If true hides the header team tag.
		disableHeaderDetails	boolean	optional	If true hides the header season details.
		border	boolean	optional	If true enables a border around the widget.
		onItemClick	function	optional	Function/event handler. Emits playerId on click or touch.

Examples

HTML/Declarative

JS/Programmatic

JS/Example of using Event Handler

Return to top ## Team Recent Games us.team.nfl.recentGames displays upcoming and/or past games of a selected team. > For the widget to render you must provide a valid teamId. To see a full-sized version of this widget, click here.

Parameters

Name	Type	Argument	Default	Description
teamId	string	required		Team ID
pastGames	number	optional	10	Number of past games to display.
nextGames	number	optional	1	Number of future games to display.
currentSeason	boolean	optional	true	If true provides games of current season only.
includePreseason	boolean	optional		If true adds preseason games.
sortDirection	string	optional	desc	Changes groups and games sort direction. Valid options are: asc and desc.
disableTeamDropdown	boolean	optional		If true disables the team selection dropdown.
disableDropdown	boolean	optional		If true disables the team selection dropdown.
disableHeaderDetails	boolean	optional		If true disables the season header detail.
border	boolean	optional		If true enables a border around the widget.
onItemClick	function	optional		Function/event handler. Emits matchId, seasonId, tournamentId, uniqueTournamentId and other props on table row upon click or touch. See example below.

Examples

HTML/Declarative

Please note that in HTML prop names changes from CamelCase to hyphen-word-delimited notation, i.e. pastGames to past-games

JS/Programmatic

JS/Example of using Event Handler

Example of onItemClick targets and emitted props

match:{"matchId":"sd:match:b1ecaeac-df1f-4f1d-ab0c-157152cc5000","fishnetMatchId":"21980993","seasonId":2020,"seasonType":"REG","week":16,"awayTeamId":"sd:team:386bdbf9-9eea-4869-bb9a-274b0bc66e80","homeTeamId":"sd:team:e627eec7-bbae-4fa4-8e73-8e1d6bc5c060","awayTeamUid":"4428","homeTeamUid":"4392","matchStatus":"post"} Return to top ## Team Roster us.season.nfl.teamRoster visualizes a complete team roster. > For the widget to render you must provide a valid teamId. To see a full-sized version of this widget, click here.

Parameters

Name	Type	Description
props	object	properties
		Name	Type	Argument	Description
		teamId	string	required	Team ID
		border	boolean	optional	If true enables a border around the widget.
		onItemClick	function	optional	Function/event handler. Emits playerId on click or touch.

Examples

HTML/Declarative

JS/Programmatic

JS/Example of using Event Handler

.

Return to top ## Team Score Small us.team.nfl.scoreSmall displays the score of a given game. > For the widget to render you must provide a valid matchId. To see a full-sized version of this widget, click here.

Parameters

Name	Type	Description
props	object	properties
		Name	Type	Argument	Description
		matchId	string	required	Match ID
		teamId	string	optional	Team ID The ID must be one of the two teams that played in the provided game. If not specified, away team is selected.
		border	boolean	optional	If true enables a border around the widget.
		onItemClick	function	optional	Function/event handler. Emits matchId, teamId on item click or touch.

Examples

HTML/Declarative

JS/Programmatic

JS/Example of using Event Handler

Return to top ## Team Selector us.common.TeamSelector displays all teams from a given league. > For the widget to render you must provide a valid seasonId or uniqueTournamentId. Entering uniqueTournamentId without year renders the active season. To see a full-sized version of this widget, click here.

Parameters

Name	Type	Description
props	object	properties
		Name	Type	Argument	Description
		seasonId	number	optional	Season ID. Has priority over uniqueTournamentId.
		uniqueTournamentId	number	optional	Unique tournament ID. Valid options: 132 (NBA), 234 (NHL), 109 (MLB), 31 (NFL), 27653 (NCAAF), 648 (NCAAB), 242 (MLS), 7 (Champions League), 679 (Europa League), 17 (Premier League), 35 (Bundesliga), 8 (La Liga), 23 (Serie A), 34 (Ligue 1)
		year	number	optional	Season year (format: YYYY). Works with unique tournament ID.
		uniqueTeamId	number	optional	Unique team ID
		border	number	optional	When set to true draws a border around the widget.
		onItemClick	function	optional	OnClick callback function.

Examples

HTML/Declarative

JS/Programmatic

JS/Example of using Event Handler

Return to top

.

## Top Players us.season.nfl.topPlayers displays a top 5 leaderboard for a given season, with a dropdown to select by statistic. > For the widget to render you must provide a valid seasonId. To have specific stats for players, statType must be set. To see a full-sized version of this widget, click here.

Parameters

Description
properties
		Name	Type	Argument	Description
		seasonId	number	required	Season ID (Year)
		seasonType	string	optional	Season type. Valid options are: pre, reg, or pst.
		statType	string	optional	Selected Stat. See below for valid options.
		playersLimit	number	optional	Maximum number of players to display.
		hidePlayers	boolean	optional	Hide player images.
		disableHeader	boolean	optional	Hides the header.
		disableDropdown	boolean	optional	Hides the dropdown.
		showTitle	boolean	optional	Instead of dropdown, display the stat name in the title.

Valid options for statType:

Option	Description
passing_yards	Passing Yards
passing_touchdowns	Passing Touchdowns
pass_completions	Completion Percentage
pass_receptions	Receptions
run_after_catch	Yards After Catch
rushing_yards	Rushing Yards
rushing_touchdowns	Rushing Touchdowns
yards_per_carry	Yards Per Carry
carries	Carries
lost_fumbles	Lost Fumbles
forced_fumbles	Forced Fumbles
thrown_interceptions	Interceptions Thrown
interceptions	Interceptions
tackles_assists	Tackles
tackles	Solo Tackles
assists	Assisted Tackles
sacks	Sacks

Examples

HTML/Declarative

JS/Programmatic

Return to top ## Top Players Carousel us.season.nfl.topPlayersCarousel displays a moving top 5 leaderboard for a variety of NFL player statistics. > To have specific stats for players, statString must be set. To see a full-sized version of this widget, click here.

Parameters

Name	Type	Description
props	object	properties
		Name	Type	Argument	Default	Description
		seasonId	number	optional		Season ID (Year)
		statString	string	optional		String with stat Keys. See below for valid options.
		seasonType	string	optional	'reg'	Season type. Valid options are: pre, reg or pst.
		autoplay	boolean	optional	'true'	Carousel autoplay turned on/off.
		autoplaySpeed	number	optional	5000	Carousel autoplay speed in milliseconds.
		border	boolean	optional		If true enables a border around the widget.

Valid options for stat keys:

Option	Description
pasy	Passing Yards
past	Passing Touchdowns
pasc	Completion Percentage
pasr	Receptions
rect	Receiving Touchdowns
rac	Yards After Catch
ruy	Rushing Yards
rut	Rushing Touchdowns
ypc	Yards Per Carry
car	Carries
lf	Lost Fumbles
ff	Forced Fumbles
tint	Interceptions Thrown
int	Interceptions
taca	Tackles
tac	Solo Tackles
ast	Assisted Tackles
sac	Sacks

Examples

HTML/Declarative

JS/Programmatic

Return to top ## Turnover Calculator us.match.nfl.turnoverCalculator compares the turnovers for each team in a given game. > For the widget to render you must provide a valid matchId. To see a full-sized version of this widget, click here.

Parameters

Name	Type	Argument	Default	Description
matchId	string	required		Match ID
disableWidgetHeader	boolean	optional	false	When set to true hides the widget header.
disableMatchHeader	boolean	optional	false	When set to true hides the match header.
collapseGameInformation	boolean	optional	true	When set to false opens the game information section
selectedQuarter	number	optional	null	Displays turnovers of the specified quarter. Can be one of 1, 2, 3, 4, or 5 (overtime).
selectedTurnover	number	optional	null	0 based index setting the displayed turnover in the quarter set with selectedQuarter. If selectedQuarter is not provided the first quarter will be selected.
enableTeamSelect	boolean	optional	false	When set to true enables team selection. Interactive areas are: team name and logo in a match header and team logo under Turnover comparison. TeamId is emitted on click or touch.
border	boolean	optional		If true draws a border around the widget.

Examples

HTML/Declarative

JS/Programmatic

Return to top ## Weather us.match.nfl.weather is a smaller version of the scoreboard widget. It provides the current score and status of a given NFL game. > For the widget to render you must provide a valid matchId. To see a full-sized version of this widget, click here.

Parameters

Name	Type	Description
props	object	properties
		Name	Type	Argument	Default	Description
		matchId	string	required		Match ID
		border	boolean	optional	'true'	If true draws a border around the widget.

Examples

HTML/Declarative

JS/Programmatic

Return to top ## Win Probability us.match.winProbability displays the win probability for each team in a given game. > For the widget to render you must provide a valid matchId. All other properties are optional. To see a full-sized version of this widget, click here.

Parameters

Name	Type	Description
props	object	properties
		Name	Type	Argument	Description
		matchId	number	required	Match ID
		border	boolean	optional	If true displays a border around the widget.
		onItemClick	function	optional	Function/event handler. Emits teamId on click or touch.

Examples

HTML/Declarative

JS/Programmatic

JS/Programmatic

Return to top