MLB Widgets
Sportradar offers a vast array of customizable MLB widgets, with in-depth statistics.
> Click here for our MLB 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 MLB product demonstration below for an overview of every possible configuration.
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.
### MLB Widgets by Type ## Articles us.common.articlesList displays a list of editorial articles. > To see a full-sized version of this widget, click here.Parameters
Name | Type | Description | ||||
---|---|---|---|---|---|---|
props |
object | properties | ||||
Name | Type | Argument | Default | Description | ||
providerId |
number | optional | Provider ID. 2 for Associated Press, 3 for Associated Press Premium. |
|||
seasonId |
number | optional | Season ID | |||
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 Slim
us.betting.match.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
. 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.mlb.score displays a small scoreboard with odds from a given MLB 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 | |||
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 diplays venue info. |
||
disableMatchClick |
boolean | optional | If true disables onItemClick handler for the match. |
|||
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
## Boxscore
us.match.mlb.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 | ||
disableHittersSorting |
boolean | optional | If true disables sorting feature in hitters tables. |
||
disablePitchersSorting |
boolean | optional | If true disables sorting feature in pitchers tables. |
||
disableHeader |
boolean | optional | If true hides the header. |
||
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 playerId on player cell click or touch. |
Examples
HTML/Declarative
JS/Programmatic
JS/Example of using Event Handler
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 List
us.common.MatchList displays a daily list of past, present and future games. Scores are automatically updated in real-time during live games.
>
This widget uses local storage for persisting end-user selection (date, live, show/hide odds). The widget displays date/time in the end user's 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 |
number | optional | Match ID | |||
dayOffset |
number | optional | 0 | Day offset from the current date. Default value is 0 (current date). |
||
sportId |
number | optional | 1 | Sport ID. 1 (Soccer), 2 (Basketball), 3 (Baseball), 4 (Ice Hockey), 9 (Golf), 16 (American Football). |
||
isLive |
boolean | optional | false | Displays only live games when set to true . |
||
showOdds |
boolean | optional | false | When set to true includes odds data for each game. |
||
disableOdds |
boolean | optional | false | When set to true disables the odds button in the right corner. |
||
onItemClick |
function | optional | Function/Event handler, emits matchId on click or touch. |
|||
filterUtIds |
string | optional | Comma-separated unique tournament IDs. When set, only games within specified unique tournaments will be listed. | |||
filterRcIds |
string | optional | Comma-separated real category IDs. When set, only games within specified real categories will be listed. | |||
favoriteTournaments |
string | optional | Comma-separated unique tournament IDs. When set, tournaments with a specified unique ID will be added to the top of the games list. | |||
oddsDeeplinkLabels |
object | optional | An object of deeplinking labels. | |||
deeplinkParams |
object | optional | An object of deeplinking parameters. |
Examples
HTML/Declarative
JS/Programmatic
JS/Example of using Event Handler
Return to top
## Game Tracker
us.match.mlb.gameTracker provides a live visualization of real-time action, including: current pitcher and batter, pitch speed and type, pitch count, on-deck batter, and an event timeline for the current inning.
>
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 | ||
disableHeader |
boolean | optional | If true hides the header. |
||
disablePitchTrackerAndCountHeader |
boolean | optional | If true removes the "pitch tracker" and "count" headers. |
||
border |
boolean | If true enables a border around the widget. |
Examples
HTML/Declarative
JS/Programmatic
.
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 | |||
showDate |
boolean | optional | If true displays the scheduled date beside the time (pre-game only). |
|||
isCollapsed |
boolean | optional | 'true' | If false expands all collapsible content. |
||
showOdds |
boolean | optional | 'true' | If false hides odds (pre-game only). |
||
disableHeader |
boolean | optional | false | If true hides the widget header. |
||
disableGameInfo |
boolean | optional | false | If true hides collapsible game information. |
||
disableGameInfoXSmall |
boolean | optional | false | If true hides collapsible game information on X-Small responsive breakpoint. |
||
disableAttendance |
boolean | optional | false | If true hides attendance content. |
||
disableTeamClick |
boolean | optional | false | If true disable onItemClick handler for teams. |
||
disablePlayerClick |
boolean | optional | false | If true disable onItemClick handler for players (i.e. team leaders under game information). |
||
enableMatchClick |
boolean | optional | false | If true the whole widget triggers match target event on onItemClick; all other targets get disabled. |
||
preMatchLinks |
string | optional | Comma separated string of link keys for pre-game. Can be: undefined , default , preview , boxscore , gametracker , recap , lineups , and matchstats . Entering default is the same as entering preview . |
|||
liveMatchLinks |
string | optional | Comma separated string of link keys for pre-game. Can be: undefined , default , preview , boxscore , gametracker , recap , lineups , and matchstats . Entering default is the same as entering boxscore, gametracker . |
|||
postMatchLinks |
string | optional | Comma separated string of link keys for pre-game. Can be: undefined , default , preview , boxscore , gametracker , recap , lineups , and matchstats . Entering default is the same as entering boxscore, recap . |
|||
border |
boolean | optional | If true enables a border around the widget. |
|||
onItemClick |
function | optional | Function/event handler. By default, the widget has two click targeting areas: team and player . The player targets appear in the Game Information section depending on match status. With preMatchLinks , liveMatchLinks , and/or postMatchLinks set the Score widget can get additional targets: preview , boxscore , gametracker , recap , lineups , and matchstats links. When enableMatchClick is set to 'true' the whole Score widget becomes a match target and all other targets gets disabled. All targets emit the following match props on click or touch: matchId , sportId , realCategoryId , seasonId , tournamentId , uniqueTournamentId , awayTeamUid , homeTeamUid , or matchStatus . Team target adds uniqueTeamId , player target adds playerId . Valid matchStatus values are: pre , live , or post . |
Examples
HTML/Declarative
JS/Programmatic
JS/Example of using Event Handlers
Examples of onItemClick targets and emitted props
"team",{"matchId":23361061,"seasonId":77361,"tournamentId":36,"uniqueTournamentId":8,"realCategoryId":32,"sportId":1,"awayTeamUid":2836,"homeTeamUid":2831,"matchStatus":"post","uniqueTeamId":2836}
"player",{"matchId":27543026,"matchStatus":"pre","playerId":36476,"seasonId":78917,"tournamentId":10560,"uniqueTournamentId":234,"realCategoryId":37,"sportId":4,"awayTeamUid":3703,"homeTeamUid":3677}
"box_score",{"matchId":23361061,"seasonId":77361,"tournamentId":36,"uniqueTournamentId":8,"realCategoryId":32,"sportId":1,"awayTeamUid":2836,"homeTeamUid":2831,"matchStatus":"post"}
"match",{"matchId":27543026,"seasonId":78917,"tournamentId":10560,"uniqueTournamentId":234,"realCategoryId":37,"sportId":4,"awayTeamUid":3703,"homeTeamUid":3677,"matchStatus":"pre"}
Return to top
## Game Scoreboard
us.match.scoreboard features the current score, the teams represented by name and logo, the status of a game, and other key game related information.
>
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 | |||
showOdds |
boolean | optional | 'true' | If false hides odds (pre-game only). |
||
showWinsDrawsLosses |
boolean | optional | 'true' | If false hides WDL information (pre-game only). |
||
showMatchTitle |
boolean | optional | 'true' | If false hides the match title (playoffs only). |
||
border |
boolean | optional | If true enables 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
## Linescore
us.match.mlb.linescore provides an inning by inning linescore 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 | ||
border |
boolean | optional | If true enables a border around the widget. |
||
onItemClick |
function | optiona> | Function/event handler. Emits uniqueTeamId on click or touch. |
Examples
HTML/Declarative
JS/Programmatic
Return to top
## Lineups
us.match.mlb.lineups provides a visualization for starting lineups in a given game, including fielding positions and starting pitchers.
>
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 | ||
hideTeamNames |
boolean | optional | If true hides team names above fields. |
||
border |
boolean | optional | If true enables a border around the widget. |
||
onItemClick |
function | optional | Function/event handler. Emits playerId on player list item click or touch. |
Examples
HTML/Declarative
JS/Programmatic
JS/Example of using Event Handlers
Return to top
## Live Game Carousel
us.match.mlb.liveMatchCarousel displays a scrolling carousel of live or upcoming MLB 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 , springtraining , allstar 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. |
|||
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 | Default | Description | ||
matchId |
number | required | Match ID |
Examples
HTML/Declarative
JS/Programmatic
Return to top
## Money Percentage Tracking
us.betting.match.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
. 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.News displays full news articles, with the capability to filter by season, game, and player.
>
- To display player news, the parameters
playerId
,seasonId
andproviderId
must be set. - To display game news, the parameters
matchId
,providerId
andtype
must be set. - To display season news, the parameters
seasonId
andproviderId
must be set.
Parameters
Name | Type | Description | ||||
---|---|---|---|---|---|---|
props |
object | properties | ||||
Name | Type | 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. |
|||
border |
boolean | optional | If true enables a border around the widget. |
Examples
HTML/Declarative
JS/Programmatic
Return to top
## Odds
us.match.odds provides odds for a given game (upcoming and live only).
>
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 . In NHL the spread stands for puckline. |
||
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.oddsComparison provides daily bookmaker odds for all games in a given season/tournament.
>
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 | |
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 . In MLB, spread stands for runline. |
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 date. Supports 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 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.mlb.playByPlay displays a running timeline of every batter outcome and lineup change for a given MLB 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 | |||
lastInning |
boolean | optional | If true displays last inning only. |
|||
disableHeader |
boolean | optional | If true hides the header. |
|||
border |
boolean | optional | If true enables a border around the widget. |
Examples
HTML/Declarative
JS/Programmatic
Return to top
## Player Career Stats
us.player.mlb.CareerStats displays the career stats of a given MLB 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 |
number | optional | Player ID | |
seasonDefaultSortDirection |
string | optional | 'asc' | Sets initial season column sort direction. Valid options are: asc / desc . |
hitterColumns |
string | optional | Comma separated string of hitter table statistics column keys. Used for picking fewer columns and different order. Valid options are: gp , gs , pa , ab , r , h , 2b , 3b , hr , rbi , bb , k , sb , cs , ba , obp , iso , babip , bbk , goao , xbh , abhr . A table of definitions is included below. |
|
pitcherColumns |
string | optional | Comma separated string of pitcher table statistics column keys. Used for picking fewer columns and different order. Valid options are: gp , gs , w , l , era , sv , svo , ip , h , r , er , hra , bb , k , oba , whip , k9 , kbb , goao , qs , cg , sho , hld . A table of definitions is included below. |
|
border |
boolean | optional | When set to true the table is displayed with a border. |
Option | Description |
---|---|
gp |
Games Played |
gs |
Games Started |
pa |
Plate Appearances |
ab |
At Bats |
r |
Runs |
h |
Hits |
2b |
Doubles |
3b |
Triples |
hr |
Home Runs |
rbi |
Runs Batted In |
bb |
Walks |
k |
Strikeouts |
sb |
Stolen Bases |
cs |
Caught Stealing |
ba |
Batting Average |
obp |
On Base Percentage |
slg |
Slugging Percentage |
ops |
On-Base + Slugging Percentage |
iso |
Isolated Power |
babip |
Batting Average on Balls in Play |
bbk |
Strikeout-to-Walk Ratio |
gofo |
Ground Out/Fly Out Ratio |
goao |
Ground Out/Air Out Ratio |
xbh |
Extra-base Hits |
abhr |
At Bats per Home Run |
Option | Description |
---|---|
gp |
Games Played |
gs |
Games Started |
w |
Wins |
l |
Losses |
era |
Earned Run Average |
sv |
Saves/td> |
svo |
Save Opportunities |
ip |
Innings Pitched |
h |
Hits Allowed |
r |
Runs Allowed |
er |
Earned Runs |
hra |
Home Runs Allowed |
bb |
Walks |
k |
Strikeouts |
oba |
Opponents' Batting Average |
whip |
Walks + Hits Per Inning Pitched |
k9 |
Strikeouts per Nine Innings |
kbb |
Strikeout-to-Walk Ratio |
goao |
Ground Ball/Fly Ball Ratio |
qs |
Quality Starts |
cg |
Complete Games |
sho |
Shutouts |
hld |
Holds |
Examples
HTML/Declarative
JS/Programmatic
Return to top
## Player Comparison
us.betting.match.mlb.playerComparison compares statistics of two players of the same position (Starting Pitcher, Relief Pitcher, Hitter) 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 SP , RP , or AH . |
|||
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
## Player Game Logs
us.player.gameLogs shows per game statistics for a given player in a season.
>
For the widget to render you must provide a valid playerId
and seasonId
.
To see a full-sized version of this widget, click here.
Parameters
Name | Type | Description | ||||
---|---|---|---|---|---|---|
props |
object | properties | ||||
Name | Type | Argument | Description | |||
playerId |
number | required | Player ID | |||
seasonId |
number | required | Season ID | |||
seasonType |
string | optional | Season Type: regular / playoffs |
|||
uniqueTournamentId |
number | optional | If seasonId is not provided, uniqueTournamentId can be used to get the current active season in that tournament. |
|||
sortIdx |
string | 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.header provides biographical information and current seasonal stats for a given player.
>
For the widget to render you must provide a valid playerId
. 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 |
number | required | Player ID | |||
seasonId |
number | optional | active season | Season ID | ||
type |
string | optional | 'main' | Season Type. Valid values are: main , auto , and playoffs . |
||
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 Header Small
us.player.headerSmall provides basic player information, including headshot, number, and position.
>
For the widget to render you must provide a valid playerId
. 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 |
number | required | Player ID | |||
seasonId |
number | optional | active season | Season 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
JS/Example of using Event Handler
Return to top
## Player Seasonal Statistics
us.season.mlb.playersStats displays seasonal statistics for MLB 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 | Argument | Default | Description |
seasonId |
number | optional | Season ID | |
seasonType |
string | optional | 'regular' | Season type: regular / playoffs |
category |
string | optional | 'hitting' | Statistics mode: hitting / pitching |
conference |
string | optional | Conference filter: al / nl |
|
uniqueTeamId |
number | optional | Unique team ID filter. | |
qualifiesAsLeagueLeader |
boolean | optional | true | When set to true enables statistical minimums to qualify a player for inclusion in a statistical category. |
disableTitle |
boolean | optional | When set to true hides the widget title. |
|
hideFilters |
boolean | optional | When set to true hides all filters / dropdown. |
|
hittingColumns |
string | optional | Comma separated string of hitting table statistics column keys. Used for picking fewer columns and different order. Valid options are t , p , gp , gs , pa , ab , r , h , 2b , 3b , hr , rbi , bb , k , sb , cs , ba , obp , slg , ops , iso , babip , bbk , goao , xbh , abhr . |
|
pitchingColumns |
string | optional | Comma separated string of pitching table statistics column keys. Used for picking fewer columns and different order. Valid options are t , p , gp , gs , w , l , era , sv , svo , ip , h , r , er , hra , bb , k , oba , whip , k9 , kbb , goao , qs , cg , sho , hld . |
|
hittingSortIdx |
string | optional | Overrides hitting table default sort statistics column index. 1, 2, 3... | |
pitchingSortIdx |
string | optional | Overrides pitching table default sort statistics column index. 1, 2, 3... | |
pageLength |
number | optional | 50 | Number of players displayed per page. |
border |
boolean | optional | When set to true the table is displayed with a border. |
|
onItemClick |
function | optional | Function/event handler. Emits playerId , uniqueTeamId , seasonId , uniqueTournamentId on table row click or touch. |
Option | Description |
---|---|
t |
Team |
p |
Position |
gp |
Games Played |
pa |
Plate Appearances |
r |
Runs |
ab |
At Bats |
r |
Runs |
h |
Hits |
2b |
Doubles |
3b |
Triples |
hr |
Home Runs |
rbi |
Runs Batted In |
bb |
Walks |
k |
Strikeouts |
sb |
Stolen Bases |
cs |
Caught Stealing |
ba |
Batting Average |
obp |
On Base Percentage |
slg |
Slugging Percentage |
ops |
On Base + Slugging Percentage |
iso |
Isolate Power |
babip |
Batting Average on Balls in Play |
bbk |
Walk-to-Strikeout Ratio |
gofo |
Ground Out/Fly Out Ration |
goao |
Ground Out/Air Out Ratio |
xbh |
Extra Base Hits |
abhr |
At Bats per Home Run |
Option | Description |
---|---|
t |
Team |
p |
Position |
gp |
Games Played |
gs |
Games Started |
w |
Wins |
l |
Losses |
era |
Earned Run Average |
sv |
Saves/td> |
svo |
Save Opportunities |
ip |
Innings Pitched |
h |
Hits Allowed |
r |
Runs Allowed |
er |
Earned Runs |
hra |
Home Runs Allowed |
bb |
Walks |
k |
Strikeouts |
oba |
Opponents' Batting Average |
whip |
Walks + Hits Per Inning Pitched |
k9 |
Strikeouts per Nine Innings |
kbb |
Strikeout-to-Walk Ratio |
gofo |
Ground Out/Fly Out Ratio |
goao |
Ground Out/Air Out Ratio |
qs |
Quality Starts |
cg |
Complete Games |
sho |
Shutouts |
hld |
Holds |
Examples
HTML/Declarative
JS/Programmatic
JS/Example of using Event Handler
Return to top
## Player Stats Graphic
us.season.mlb.playerStatsGraphic visualizes seasonal statistics for a given player, including a breakdown of the last 5 games played.
>
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 | Default | Description | ||
playerId |
number | required | Player ID | |||
seasonId |
number | required | Season ID | |||
seasonType |
string | optional | 'regular' | Selected season type: regular or playoffs . |
||
disableDropdown |
boolean | optional | If true hides the team dropdown. |
|||
qualifiesAsLeagueLeader |
boolean | optional | 'true' | If true enables statistical minimums to qualify a player for inclusion in a statistical category. |
||
border |
boolean | optional | If true enables a border around the widget. |
Examples
HTML/Declarative
JS/Programmatic
Return to top
## Playoffs
us.season.mlb.playoffs displays a full playoff bracket, including results for each series.
>
This widget will display the playoff bracket for the active season by default.
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 | ||
disableSeasonSelector |
boolean | optional | Hides the season selector. | ||
onItemClick |
function | optional | Function/event handler. Emits uniqueTeamId on click or touch. |
||
border |
boolean | optional | If true enables a border around the widget. |
Examples
HTML/Declarative
JS/Programmatic
JS/Example of using Event Handler
Return to top
## Pregame Betting Statistics
us.betting.match.mlb.pregameBettingStatistics displays betting statistics of a given MLB game.
>
For the widget to render you must provide a valid matchId
. All other properties are optional. This widget is not supported for the All-Star game or Spring Training games.
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 | |||
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
## Score
us.match.mlb.score is a variant of the smaller scoreboard with links. It features 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.
To see a full-sized version of this widget, click here.
Parameters
Name | Type | Argument | Default | Description |
matchId |
number | required | '' | Match ID |
showDate |
boolean | optional | If true shows the scheduled date beside the time (pre-game only). |
|
isCollapsed |
boolean | optional | 'true' | If false collapses collapsible content (i.e. game information). |
showOdds |
boolean | optional | 'true' | If false hides odds (pre-game only). |
disableHeader |
boolean | optional | If true hides the header. |
|
disableGameInfo |
boolean | optional | If true hides collapsible content (i.e. game information). |
|
disableGameInfoXSmall |
function | optional | If true hides collapsible content (i.e. game information) on X-Small responsive breakpoint (<321px). |
|
disableAttendance |
boolean | optional | If true hides attendance content. |
|
disableTeamClick |
boolean | optional | If true disables onItemClick handler for teams. |
|
disablePlayerClick |
boolean | optional | If true disables onItemClick handler for players (i.e. team leaders under game information). |
|
enableMatchClick |
boolean | optional | If true the whole widget triggers match target event on onItemClick. All other targets are disabled. |
|
preMatchLinks |
string | optional | Comma separated string of link keys for pre-game. Can be undefined , default , preview , boxscore , gametracker , recap , lineups , matchstats . 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 , recap , lineups , matchstats . 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 , recap , lineups , matchstats . Entering default is the same as entering 'boxscore, recap' . |
|
border |
boolean | optional | If false hides a border around the widget. |
|
onItemClick |
function | optional | Function/event handler. More info below. |
team
and player
.
The player
targets appear in the Game information section depending on the match status. With preMatchLinks
, liveMatchLinks
and/or postMatchLinks
enabled, the Score widget can get additional targets: preview
, boxscore
, gametracker
, recap
, lineups
, and matchstats
.
When enableMatchClick
is set to true the whole Score widget becomes a match target and all other targets are disabled.
All targets emit the following match props on click or touch: matchId
, sportId
, realCategoryId
, seasonId
, tournamentId
, uniqueTournamentId
, awayTeamUid
, homeTeamUid
, matchStatus
.
Team target adds uniqueTeamId
; player target adds playerId
.
Valid matchStatus
values are: pre
, live
, post
.
Examples | ||||
---|---|---|---|---|
team:{"matchId":29760630,"matchStatus":"post","uniqueTeamId":3634, "seasonId":79507,"tournamentId":25,"uniqueTournamentId":109,"realCategoryId":16, "sportId":3,"awayTeamUid":3638,"homeTeamUid":3634}, | ||||
player:{"matchId":25328014,"matchStatus":"post","uniqueTeamId":5930, "playerId":842773,"seasonId":79507,"tournamentId":25,"uniqueTournamentId":109, "realCategoryId":16,"sportId":3,"awayTeamUid":5930,"homeTeamUid":3635}, | ||||
recap: {"matchId":25328014,"seasonId":79507,"tournamentId":25, "uniqueTournamentId":109,"realCategoryId":16,"sportId":3,"awayTeamUid":5930, "homeTeamUid":3635,"matchStatus":"post"}, | ||||
match: {"matchId":25328014,"seasonId":79507,"tournamentId":25, "uniqueTournamentId":109,"realCategoryId":16,"sportId":3,"awayTeamUid":5930, "homeTeamUid":3635,"matchStatus":"post"}. |
Examples
HTML/Declarative
JS/Programmatic
JS/Example of using Event Handlers
Return to top
## Scoreboard
us.match.mlb.scoreboard provides the current score of a given game, an inning-by-inning linescore, and other top-level game information.
>
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 | |||
showOdds |
boolean | optional | 'true' | If false hides odds (pre-game only). |
||
showTeamRecord |
boolean | optional | 'true' | If false hides team record information (pre-game only). |
||
showMatchTitle |
boolean | optional | 'true' | If false hides match title (playoffs only). |
||
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
## Score Nano
us.match.mlb.scorenano is a condensed version of the scoreboard widget. It provides the current score and status of a given MLB 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 | |||
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. |
matchId
, sportId
, realCategoryId
, seasonId
, tournamentId
, uniqueTournamentId
, awayTeamUid
, homeTeamUid
, matchStatus
.
Valid matchStatus values are: pre
, live
, post
.
For example: | ||||
---|---|---|---|---|
match: {"matchId":25328014,"seasonId":79507,"tournamentId":25, "uniqueTournamentId":109,"realCategoryId":16,"sportId":3,"awayTeamUid":5930, "homeTeamUid":3635,"matchStatus":"pre"}; |
Examples
HTML/Declarative
JS/Programmatic
JS/Example of using Event Handlers
Return to top
## Score Small
us.match.mlb.ScoreSmall is a smaller version of the scoreboard widget. It provides the current score and status of a given MLB 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 | |||
showDate |
boolean | optional | If true displays the scheduled date besides time (pre-game only). |
|||
showOdds |
boolean | optional | 'true' | If false hides odds (pre-game only). |
||
border |
boolean | optional | 'true' | If false hides a border around the widget. |
||
onItemClick |
function | optional | Function/event handler. Emits matchId , seasonId , tournamentId , uniqueTournamentId on click or touch. |
Examples
HTML/Declarative
JS/Programmatic
JS/Example of using Event Handlers
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
WithoutmatchId
, 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
IfmatchId
, 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.injuries displays all current 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 | Season ID | |||
teamUid |
number | optional | Team Unique Id | |||
showSeasonYearTitle |
boolean | optional | 'false' | When set to true adds season year to the header title. |
||
disableHeader |
boolean | optional | 'false' | When set to true disables header with the team selection dropdown. |
||
disableDropdown |
boolean | optional | 'false' | When set to true disables the team dropdown in the header. |
||
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 Pitcher Comparison
us.season.mlb.PitcherComparison compares the seasonal statistics of two MLB pitchers.
>
For the widget to render you must provide:
seasonId
,playerId1
, andplayerId2
ormatchId
Parameters
Name | Type | Description | ||||
---|---|---|---|---|---|---|
props |
object | properties | ||||
Name | Type | Argument | Default | Description | ||
matchId |
number | optional | Match ID | |||
seasonId |
number | required | Season ID | |||
playerId1 |
number | optional | Player ID 1. | |||
playerId2 |
number | optional | Player ID 2. | |||
type |
string | optional | 'regular' | Selected season type. Can be regular or playoffs . |
||
border |
boolean | optional | If true enables a border around the widget. |
Examples
HTML/Declarative
JS/Programmatic
Return to top
## Season Players Carousel
us.season.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 |
number or string | required | Player ID or a comma separated list of player IDs. | |||
seasonId |
number | required | Season ID | |||
uniqueTournamentId |
number | optional | If seasonId is not provided, uniqueTournamentId can be used to get the current active season in that tournament. |
|||
seasonType |
string | optional | 'regular' | Season Type. Valid options are: regular and playoffs . |
||
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 Playoff Rounds
us.season.playoffRounds displays all playoff games for a selected season, with clickable dropdowns to select by round and league.
>
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 | Season ID | |||
selectedRound |
number | optional | '1' | The playoff round to display. | ||
conference |
string | optional | 'western' | The selected conference. Valid options are: western or eastern . |
||
disableRoundsDropdown |
boolean | optional | If true disables the rounds dropdown. |
|||
disableConferenceDropdown |
boolean | optional | If true disables the conference dropdown. |
|||
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
## Season Scores
us.season.scores displays scoreboard information broken down by a day or a round (according to local time).
>
For the widget to render you must provide a valid uniqueTournamentId
or seasonId
. All other properties are optional.
Important to note when using this widget:
- The combination of properties matters.
seasonId
has priority overuniqueTournamentId
.uniqueTournamentId
alone denotes the nearest play day / round of the active season to a current day or a current round.- If
seasonId
is entered the unique tournament is derived from that season, not the input foruniqueTournamentId
. seasonId
alone denotes the nearest play day / round of the season to a current day or a current round. For older seasons it is always the last play day/last round of the season.numFutureDays
extends the scores list into the future (i.e. numFutureDays are shown); defaults to 2; this only works in the middle of the season.selectedDate
andselectedIdx
enables selection of a particular day or round.tableroundId
andcuproundId
enables selection of a particular round by precise table/cup round id (advanced use). These options work for all seasons.- "round by round" is a property of a tournament; by default all "round by round" tournaments are broken down by round, unless
isRoundByRound
is set tofalse
; then they are broken down by day. - The widget will automatically flip to the next day (when broken down by a day during auto-selecting mode), unless
dayFlipUTCHours
ordayFlipHoursBefore
are set. - A Score widget is used to render a single game. Scope of the displayed information depends on the sport and/or unique tournament. Score widgets feature links for navigating to other widgets/content.
- Clickable items are teams, players (i.e. team leaders) and links.
seasonId
, selectedData
and numFutureDays
to 5. If a tournament is 'round by round' you can also set isRoundByRound
to false
.
To see a full-sized version of this widget, click here.
Parameters
Name | Type | Argument | Default | Description |
seasonId |
number | Season ID | ||
uniqueTournamentId |
number | Unique Tournament ID | ||
numFutureDays |
number | optional | 2 | Extends the scores list into the future. |
selectedDate |
string | optional | Selected date in YYYY-MM-DD format. | |
selectedIdx |
number | optional | Selects particular day/round. | |
isRoundByRound |
boolean | optional | 'true' | If false it forces breaking down by day even if the tournament is typically 'round by round'. However, true breaks down by round only 'round by round' tournaments. |
tableroundId |
number | optional | Matches round by particular table round id. | |
cuproundId |
number | optional | Matches round by particular cup round id. | |
dayFlipUTCHours |
number (integer between 0 and 23.) | optional | 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. An integer between 0 and 23. dayFlipUTCHours has priority over dayFlipHoursBefore . |
|
dayFlipHoursBefore |
number (integer between 0 and 23.) | optional | Forces flipping to current day's games a specific number of hours before scheduled time of the first match, but not before 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. An integer between 0 and 23. | |
showOdds |
boolean | optional | 'true' | If false odds for all pre-gamees visualizations are hidden. |
disableGameHeader |
boolean | optional | If true hides the game header. |
|
disableDateSwitcher |
boolean | optional | If true hides the date/round switcher control. |
|
dropdownReverese |
boolean | optional | If true reverses switcher items when in round/dropdown mode. |
|
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). |
preMatchLinks |
string | optional | Comma separated string of link keys for pre-game. Valid options are: undefined , default , preview , boxscore , gametracker , recap , lineups , and matchstats . 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 , lineups , matchstats . 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 , lineups , matchstats . Entering default is the same as entering 'boxscore, recap '. |
|
border |
boolean | optional | If true enables a border around the widget. |
|
onItemClick |
function | optional | Function/event handler. By default, the widget has two click target areas: team and player . The player targets appear in Game the information section depending on match status. With preMatchLinks , liveMatchLinks and/or postMatchLinks set the Score widget can get additional targets: preview , boxscore , gametracker , recap , lineups , matchstats links. All targets emit the following match props on click or touch: matchId , sportId , realCategoryId , seasonId , tournamentId , uniqueTournamentId , awayTeamUid , homeTeamUid , matchStatus . Team target adds uniqueTeamId , player target adds playerId . Valid matchStatus values are: pre , live , post . |
Examples
HTML/Declarative
JS/Programmatic
JS/Programmatic using Event Handlers
Examples of onItemClick targets and emitted props
"team",{"matchId":23361061,"seasonId":77361,"tournamentId":36,"uniqueTournamentId":8,"realCategoryId":32,"sportId":1,"awayTeamUid":2836,"homeTeamUid":2831,"matchStatus":"post","uniqueTeamId":2836}
"player",{"matchId":27543026,"matchStatus":"pre","playerId":36476,"seasonId":78917,"tournamentId":10560,"uniqueTournamentId":234,"realCategoryId":37,"sportId":4,"awayTeamUid":3703,"homeTeamUid":3677}
"box_score",{"matchId":23361061,"seasonId":77361,"tournamentId":36,"uniqueTournamentId":8,"realCategoryId":32,"sportId":1,"awayTeamUid":2836,"homeTeamUid":2831,"matchStatus":"post"}
Return to top
## Standings
us.season.mlb.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 | ||
organizationType |
string | optional | 'conference' | Separates/filters the teams in standings into groups. Possible options: conference , division , wildCard . |
||
border |
boolean | optional | If true enables a border around the widget. |
|||
showSeasonSelector |
boolean | optional | 'true' | If false hides season dropdown. |
||
onItemClick |
function | optional | Function/event handler. Emits uniqueTeamId on click or touch. |
|||
columns |
string | optional | Which columns to display: w, l, pct, gb, l10, streak, diff, home, away, wcgb. All by default. |
Examples
HTML/Declarative
JS/Programmatic
JS/Example of using Event Handler
.
Parameters
Name | Type | Description | ||||
---|---|---|---|---|---|---|
props |
object | properties | ||||
Name | Type | Argument | Default | Description | ||
seasonId |
number | optional | active season | Season ID | ||
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.mlb.standingsSlim is a lightweight version of the standings table.
>
By default, the widget renders the active standings for the American League.
To see a full-sized version of this widget, click here.
Parameters
Name | Type | Argument | Default | Description |
seasonId |
number | optional | active season | Season ID |
division |
string | optional | 'AmericanLeague' | Selects division. Valid options: AmericanLeague , AmericanLeagueEast , AmericanLeagueCentral , AmericanLeagueWest , NationalLeague , NationalLeagueEast , NationalLeagueCentral , NationalLeagueWest .
|
uniqueTeamId |
number | optional | Unique Team ID. Denotes division. | |
border |
boolean | optional | If true enables a border around the widget. |
|
disableHeader |
boolean | optional | If true hides the widget header. |
|
enableDropdown |
boolean | optional | If true enables division dropdown selector. Unless uniqueTeamId is set. |
|
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
## Team Depth Chart
us.team.mlb.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 |
number | required | Team ID | |||
disableHeader |
boolean | optional | When set to true hides header. |
|||
category |
boolean | optional | When set to true enables a border around the widget. |
|||
onItemClick |
function | optional | Function/event handler. Emits playerId on table row click or touch. |
Examples
HTML/Declarative
JS/Programmatic
JS/Programmatic
.
Parameters
Name | Type | Description | |||
---|---|---|---|---|---|
props |
object | properties | |||
Name | Type | Argument | Description | ||
seasonId |
number | optional | Season ID | ||
teamUid |
number | optional | Unique Team ID | ||
disableHeader |
boolean | optional | When set to true hides header. |
||
disableSettings |
boolean | optional | When set to true completely hides setting controls. |
||
disableMonthSelector |
boolean | optional | When set to true hides only month control. |
||
border |
boolean | optional | When set to true the table is displayed with border. |
Examples
HTML/Declarative
JS/Programmatic
Return to top
## Team Header
us.team.header provides the team record and standing for a given team and season.
>
For the widget to render you must provide a valid teamUid
and seasonId
.
To see a full-sized version of this widget, click here.
Parameters
Name | Type | Description | ||||
---|---|---|---|---|---|---|
props |
object | properties | ||||
Name | Type | Argument | Description | |||
teamUid |
number | required | Unique Team ID | |||
seasonId |
number | required | Season ID | |||
leagueType |
string | optional | Select league standings to display. Valid options are: full , 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 uniqueTournamentId on click or touch. |
Examples
HTML/Declarative
JS/Programmatic
JS/Example of using Event Handler
Return to top
## Team Header Small
us.team.headerSmall provides the team record and standing for a given team and season.
>
For the widget to render you must provide a valid teamUid
and seasonId
.
To see a full-sized version of this widget, click here.
Parameters
Name | Type | Description | ||||
---|---|---|---|---|---|---|
props |
object | properties | ||||
Name | Type | Argument | Description | |||
teamUid |
number | required | Unique Team ID | |||
seasonId |
number | required | Season ID | |||
leagueType |
string | optional | Select league standings to display. Valid options are: full , 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 uniqueTournamentId on click or touch. |
Examples
HTML/Declarative
JS/Programmatic
JS/Example of using Event Handler
Return to top
## Team Leaders
us.season.mlb.teamLeaders displays pitching and hitting leaders for a provided team.
>
For the widget to render you must provide a valid uniqueTeamId
and seasonId
.
To see a full-sized version of this widget, click here.
Parameters
Name | Type | Argument | Default | Description |
uniqueTeamId |
number | required | Unique Team ID | |
seasonId |
number | required | Season ID | |
seasonType |
string | optional | 'regular' | Season type. Valid options are: regular or playoffs . |
qualifiesAsLeagueLeader |
boolean | optional | true | If true enables statistical minimums to qualify a player for inclusion in a statistical category. |
disableHeader |
boolean | optional | true | If false displays widget header. |
disableTeamTag |
boolean | optional | If true hides the header team tag. |
|
disableHeaderDetails |
boolean | optional | If true hides the header season details. |
|
hideTitle |
boolean | optional | If true hides widget title. |
|
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.mlb.recentGames displays upcoming and/or past games of a selected team.
>
For the widget to render you must provide a valid teamUid
.
To see a full-sized version of this widget, click here.
Parameters
Name | Type | Description | ||||
---|---|---|---|---|---|---|
props |
object | properties | ||||
Name | Type | Argument | Default | Description | ||
teamUid |
number | Unique Team ID | ||||
pastGames |
number | optional | 20 | 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. |
||
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. |
|||
disableHeader |
boolean | optional | If true hides the widget header. |
|||
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":25327580,"seasonId":79507,"tournamentId":25,"uniqueTournamentId":109,"realCategoryId":16,"sportId":3,"awayTeamUid":3654,"homeTeamUid":3646,"matchStatus":"post"}
Return to top
## Team Roster
us.season.mlb.teamRoster visualizes a complete team roster for a given season.
>
For the widget to render you must provide a valid teamUid
and seasonId
.
To see a full-sized version of this widget, click here.
Parameters
Name | Type | Description | ||||
---|---|---|---|---|---|---|
props |
object | properties | ||||
Name | Type | Argument | Description | |||
teamUid |
number | required | Unique Team ID | |||
seasonId |
number | required | Season 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
.
teamUid
.
To see a full-sized version of this widget, click here.
Parameters
Name | Type | Description | ||||
---|---|---|---|---|---|---|
props |
object | properties | ||||
Name | Type | Argument | Default | Description | ||
teamUid |
number | required | Unique Team ID | |||
seasonId |
number | optional | Season ID | |||
sortDirection |
string | optional | asc | Changes groups and games sort direction. Valid options are: asc and desc . |
||
disableHeader |
boolean | optional | If true disables the entire header section and displays all groups and games. |
|||
disableTeamDropdown |
boolean | optional | If true omits team dropdown. Team can still be set by "teamUid" props. |
|||
disableGroupDropdown |
boolean | optional | If true omits group dropdown and displays all groups and games. |
|||
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 on 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
Examples of onItemClick targets and emitted props
match:{"matchId":25325490,"seasonId":79507,"tournamentId":25,"uniqueTournamentId":109,"realCategoryId":16,"sportId":3,"awayTeamUid":3653,"homeTeamUid":3654,"matchStatus":"post"}
Return to top
## Team Score Small
us.team.mlb.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 |
number | required | Match ID | |||
uniqueTeamId |
number | optional | Unique 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 | Click event handler. |
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
## Transactions
us.common.Transactions displays transactions by season, team, or player.
>
To see a full-sized version of this widget, click here.
To display recent transactions, you must use a valid uniqueTournamentId
, and recent
must be set to 'true'.
To display seasonal transactions, either the uniqueTournamentId
or the seasonId
parameter must be set. If only uniqueTournamentId
is provided, the current season is displayed.
To display team transactions, use the parameter uniqueTeamId
. If seasonId
is set, the team transactions of the given season are displayed. If only uniqueTeamId
is provided, the most recent team transactions are displayed.
To display a player's transactions, use the parameter playerId
.
Parameters
Name | Type | Description | ||||
---|---|---|---|---|---|---|
props |
object | properties | ||||
Name | Type | Argument | Description | |||
uniqueTournamentId |
number | optional | Unique tournament ID | |||
recent |
boolean | optional | When set to true displays the recent transactions in a season. |
|||
seasonId |
number | optional | Season ID | |||
uniqueTeamId |
number | optional | Unique team ID | |||
playerId |
number | optional | Player ID | |||
border |
boolean | optional | When set to true draws a border around the widget. |
|||
pageSize |
number | optional | Enables table pagination and defines the number of rows per page. | |||
pageIndex |
number | optional | Sets the 0-based index of the table page to display. Default is 0. |
Examples
HTML/Declarative
JS/Programmatic
Return to top
## Team Seasonal Statistics
us.season.mlb.teamsStats displays a sortable team statistics table for all teams in a given season.
>
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 | Description | ||||
---|---|---|---|---|---|---|
props |
object | properties | ||||
Name | Type | Argument | Default | Description | ||
seasonId |
number | optional | active season | Season ID | ||
seasonType |
string | optional | 'regular' | Season type: regular / playoffs . |
||
category |
string | optional | 'hitting' | Category: hitting / pitching . |
||
conference |
string | optional | Conference filder: al / nl . |
|||
border |
boolean | optional | When set to true the table is displayed with a border. |
|||
disableTitle |
boolean | optional | When set to true hides the widget title. |
|||
hideFilters |
boolean | optional | When set to true hides all filters / dropdown. |
|||
hittingColumns |
string | optional | Comma separated string of hitting table statistics column keys. Used for picking fewer columns and different order. Valid options are: ab , r , h , 2b , 3b , hr , rbi , bb , k , tb , sb , cs , ba , obp , slg , ops , iso , babip , bbk , goao , xbh , abhr . |
|||
pitchingColumns |
string | optional | Comma separated string of pitching table statistics column keys. Used for picking picking fewer columns and different order. Valid options are: w , l , era , sv , svo , ip , h , r , er , hra , bb , k , oba , whip , k9 , kbb , go , ao , qs , cg , sho . |
|||
onItemClick |
function | optional | Function/event handler. Emits uniqueTeamId , seasonId , uniqueTournamentId on table row click or touch. |
Option | Description |
---|---|
ab |
At Bats |
r |
Runs |
h |
Hits |
2b |
Doubles |
3b |
Triples |
hr |
Home Runs |
rbi |
Runs Batted In |
bb |
Walks |
k |
Strikeouts |
tb |
Total Bases |
sb |
Stolen Bases |
cs |
Caught Stealing |
ba |
Batting Average |
obp |
On Base Percentage |
slg |
Slugging Percentage |
ops |
On-Base + Slugging Percentage |
iso |
Isolated Power |
babip |
Batting Average on Balls in Play |
bbk |
Strikeout-to-Walk Ratio |
gofo |
Ground Out/Fly Out Ratio |
goao |
Ground Out/Air Out Ratio |
xbh |
Extra-base Hits |
abhr |
At Bats per Home Run |
Option | Description |
---|---|
w |
Wins |
l |
Losses |
era |
Earned Run Average |
sv |
Saves/td> |
svo |
Save Opportunities |
ip |
Innings Pitched |
h |
Hits Allowed |
r |
Runs Allowed |
er |
Earned Runs |
hra |
Home Runs Allowed |
bb |
Walks |
k |
Strikeouts |
oba |
Opponents' Batting Average |
whip |
Walks + Hits Per Inning Pitched |
k9 |
Strikeouts per Nine Innings |
go |
Groundouts |
fo |
Flyouts |
kbb |
Strikeout-to-Walk Ratio |
goao |
Ground Out/Fly Out Ratio |
qs |
Quality Starts |
cg |
Complete Games |
sho |
Shutouts |
Examples
HTML/Declarative
JS/Programmatic
JS/Programmatic
Return to top
## Team Stats Dash
us.team.mlb.statsDash displays quick pitching and hitting stats for a given team.
>
For the widget to render you must provide a valid uniqueTeamId
.
To see a full-sized version of this widget, click here.
Parameters
Name | Type | Description | ||||
---|---|---|---|---|---|---|
props |
object | properties | ||||
Name | Type | Argument | Default | Description | ||
uniqueTeamId |
number | required | Unique Team ID | |||
seasonId |
number | optional | Active season | Season ID | ||
seasonType |
string | optional | 'regular' | Season type. Valid options are: regular and playoffs . |
||
category |
string | optional | 'pitching' | Stat type. Valid options are: hitting and pitching . |
||
disableHeader |
boolean | optional | If true hides the header. |
|||
showSeasonYearTitle |
boolean | optional | If true displays season year with header title. |
|||
border |
boolean | optional | If true enables a border around the widget. |
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
Return to top
## Team Stats Graphic
us.season.mlb.teamStatsGraphic provides top-level team seasonal statistics for pitching and hitting, with a dropdown for team selection.
>
For the widget to render you must provide a valid seasonId
.
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 | Season ID | |||
teamUid |
number | optional | Team ID | |||
seasonType |
string | optional | 'regular' | Selected season type. Valid options: regular or playoffs . |
||
disableDropdown |
boolean | optional | If true hides the team dropdown. |
|||
border |
boolean | optional | If true enables a border around the widget. |
|||
onItemClick |
function | optional | Function/event handler. Emits uniqueTeamId on team dropdown change. |
Examples
HTML/Declarative
JS/Programmatic
JS/Example of using Event Handler
Return to top
## Top Players
us.season.mlb.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
Name | Type | Argument | Default | Description |
seasonId |
number | required | Season ID | |
seasonType |
string | optional | 'regular' | Season type. Valid options are: regular or playoffs . |
conference |
string | optional | 'all' | Selected conference. Can be al , nl , all . |
statType |
string | optional | 'hitting_runs_batted_in' | Selected Stat. See below for valid options. |
disableDropdown |
boolean | optional | 'points' | If true hides dropdown. |
disableHeader |
boolean | optional | If true hides the widget header. |
|
showTitle |
boolean | optional | If true turns dropdown to title. |
|
hidePlayers |
boolean | optional | If true hides player images. |
|
playersLimit |
number | optional | 5 | Limits list length. |
qualifiesAsLeagueLeader |
boolean | optional | 'true' | If true enables statistical minimums to qualify a player for inclusion in a statistical category. |
border |
boolean | optional | If true enables a border around the widget. |
|
onItemClick |
function | optional | Function/event handler. Emits playerId on click or touch. |
Option | Description |
---|---|
hitting_runs_batted_in |
Runs Batted In |
hitting_batting_average |
Batting Average |
hitting_slugging_percentage |
Slugging Percentage |
hitting_on_base_percentage |
On Base Percentage |
hitting_on_base_percentage_plus_slugging |
OPS (On Base + Slugging Percentage) |
hitting_hits |
Hits |
hitting_doubles |
Doubles |
hitting_triples |
Triples |
hitting_home_runs |
Home Runs |
hitting_at_bats |
At Bats |
hitting_batting_average_on_balls_in_play |
Batting Average on Balls in Play |
hitting_isolated_power |
Isolated Power |
hitting_walks_per_strikeout |
Walks Per Strikeout (Hitter) |
hitting_at_bats_per_homerun |
At Bats Per Home Run |
hitting_stolen_bases |
Stolen Bases |
hitting_caught_stealing |
Caught Stealing |
hitting_plate_appearances |
Plate Appearances |
hitting_ground_out_to_fly_out_ratio |
Groundout to Fly Out Ratio (Hitter) |
hitting_ground_out_to_air_out_ratio |
Groundout to Air Out Ratio (Hitter) |
pitching_overall_earned_run_average |
ERA (Earned Run Average) |
pitching_overall_wins |
Wins |
pitching_overall_losses |
Losses |
pitching_overall_outs_pitched |
Outs |
pitching_overall_saves |
Saves |
pitching_overall_walks_plus_hits_per_innings_pitched |
WHIP (Walks + Hits Per Inning Pitched) |
pitching_overall_total_strikeouts |
Strikeouts |
pitching_overall_walks |
Walks |
pitching_overall_strikeouts_per_walk |
Strikeouts to Walk Ratio |
pitching_overall_complete_games |
Complete Games |
pitching_overall_shutouts |
Shutouts |
pitching_overall_quality_starts |
Quality Starts |
pitching_overall_holds |
Holds |
pitching_overall_opponents_batting_average |
Opponent Batting Average |
pitching_overall_ground_out_to_fly_out_ratio |
Groundout to Fly Out Ratio (Pitcher) |
pitching_overall_ground_out_to_air_out_ratio |
Groundout to Air Out Ratio (Pitcher) |
pitching_overall_games_started |
Games Started |
Examples
HTML/Declarative
JS/Programmatic
JS/Example of using Event Handler
Return to top
## Top Players Carousel
us.season.mlb.topPlayersCarousel displays a moving top 5 leaderboard for a variety of MLB 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 | |||
statString |
string | optional | String with stat keys. See below for valid options. | |||
seasonType |
string | optional | 'regular' | Season type. Valid options are: regular or playoffs . |
||
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. |
Option | Description |
---|---|
rbi |
Runs Batted In |
ba |
Batting Average |
slg |
Slugging Percentage |
obp |
On Base Percentage |
xbs |
Extra Base Hits |
h |
Hits |
2b |
Doubles |
3b |
Triples |
hr |
Home Runs |
ab |
At Bats |
babip |
Batting Average on Balls in Play |
iso |
Isolated Power |
bbk |
Walks Per Strikeout (Hitter) |
abhr |
At Bats Per Home Run |
sb |
Stolen Bases |
cs |
Caught Stealing |
pa |
Plate Appearances |
hgofo |
Groundout to Fly Out Ratio (Hitter) |
hgoao |
Groundout to Air Out Ratio (Hitter) |
era |
ERA (Earned Run Average) |
w |
Wins |
l |
Losses |
ip |
Outs (Innings Pitched) |
sv |
Saves |
whip |
WHIP (Walks + Hits Per Inning Pitched) |
k |
Strikeouts |
bb |
Walks |
kbb |
Strikeouts to Walk Ratio |
cg |
Complete Games |
sho |
Shutouts |
qs |
Quality Starts |
hld |
Holds |
oba |
Opponent Batting Average |
pgofo |
Groundout to Fly Out Ratio (Pitcher) |
pgoao |
Groundout to Air Out Ratio (Pitcher) |
gs |
Games Started |
Examples
HTML/Declarative
JS/Programmatic
Return to top
## Top Teams
us.season.mlb.topTeams provides a team leaderboard for a selected statistic and season.
>
For the widget to render you must provide a valid seasonId
.
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 | Season ID | |||
seasonType |
string | optional | 'regular' | Season type. Valid options are: regular or playoffs . |
||
conference |
string | optional | 'all' | Selected conference. Can be al , nl or undefined (i.e. all). |
||
statType |
string | optional | 'points' | Selected Stat. See below for valid options. | ||
disableDropdown |
boolean | optional | If true hides dropdown. |
|||
teamsLimit |
number | optional | 5 | Limits list length. | ||
border |
boolean | optional | If true enables a border around the widget. |
|||
onItemClick |
function | optional | Function/event handler. Emits event on team row click or touch. |
Option | Description |
---|---|
hitting_at_bats_per_homerun |
At Bats per Home Run (Hitting) |
hitting_batting_average |
Batting Average |
hitting_doubles |
Doubles |
hitting_extra_base_hits |
Extra Base Hits |
hitting_hits |
Hits |
hitting_home_runs |
Home Runs |
hitting_isolated_power |
Isolated Power |
hitting_on_base_percentage |
On Base Percentage |
hitting_on_base_percentage_plus_slugging |
OPS (On Base + Slugging Percentage) |
hitting_runs_batted_in |
Runs Batted In |
hitting_slugging_percentage |
Slugging Percentage |
hitting_triples |
Triples |
hitting_walks_per_strikeout |
Strikeout to Walk Ratio (Hitter) |
hitting_ground_out_to_fly_out_ratio |
Groundout to Fly Out Ratio (Hitter) |
hitting_ground_out_to_air_out_ratio |
Groundout to Air Out Ratio (Hitter) |
pitching_overall_complete_games |
Complete Games |
pitching_overall_earned_run_average |
ERA (Earned Run Average) |
pitching_overall_opponents_batting_average |
Opponent Batting Average |
pitching_overall_quality_starts |
Quality Starts |
pitching_overall_shutouts |
Shutouts |
pitching_overall_strikeouts_per_9_innings |
Strikeouts Per 9 Innings |
pitching_overall_strikeouts_per_walk |
Strikeout to Walk Ratio (Pitcher) |
pitching_overall_total_strikeouts |
Strikeouts |
pitching_overall_walks |
Walks |
pitching_overall_walks_plus_hits_per_innings_pitched |
WHIP (Walks + Hits Per Innings Pitched) |
pitching_overall_ground_out_to_fly_out_ratio |
Groundout to Fly Out Ratio (Pitcher) |
pitching_overall_ground_out_to_air_out_ratio |
Groundout to Air Out Ratio (Pitcher) |
Examples
HTML/Declarative
JS/Programmatic
JS/Example of using Event Handler
Return to top
## Venue Header
us.common.VenueHeader displays the venue name for a given game, including the team logo and other relevant venue properties.
>
For the widget to render you must provide a valid matchId
or stadiumId
. 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 | string | required | Match ID | |||
stadiumId |
number | optional | Venue ID | |||
border |
boolean | optional | When set to 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 | Default | Description | ||
matchId |
number | required | Match ID | |||
border |
boolean | optional | 'true' | If true enables a border around the widget. |
Examples
HTML/Declarative
JS/Programmatic
Return to top
Docs Navigation
- Documentation
- Football (American Football)
- Football (Soccer)
- Australian Rules Football
- Baseball
- Basketball
- NBA v8
- NBA v7
- NBA v5
- NBA v4
- WNBA v8
- WNBA v7
- WNBA v4
- WNBA v3
- NBA G League v8
- NBA G League v7
- NBA G League v5
- NCAA Men's Basketball v8
- NCAA Men's Basketball v7
- NCAA Men's Basketball v4
- NCAA Men's Basketball v3
- NCAA Women's Basketball v8
- NCAA Women's Basketball v7
- NCAA Women's Basketball v3
- Global Basketball v2
- Global Basketball v1
- NBA Historical v1
- Combat Sports
- Cricket
- Editorial Content
- Golf
- Handball
- Hockey
- Images
- Insights
- Insights User Interface
- NBA Insights v1
- NHL Insights v1
- MLB Insights v1
- NFL Insights v1
- MLB Betting Splits v2
- MLB Betting Splits v1
- NBA Betting Splits v2
- NBA Betting Splits v1
- NCAAFB Betting Splits v2
- NCAAFB Betting Splits v1
- NCAAMB Betting Splits v2
- NCAAMB Betting Splits v1
- NFL Betting Splits v2
- NFL Betting Splits v1
- NHL Betting Splits v2
- NHL Betting Splits v1
- Soccer Betting Splits v2
- Soccer Betting Splits v1
- Odds
- Racing
- Rugby
- Tennis
- Widgets
- Baseline Sports Coverage
- Badminton v2
- Badminton v1
- Bandy v2
- Bandy v1
- Beach Soccer v2
- Beach Soccer v1
- Curling v2
- Curling v1
- Cycling v2
- Darts v2
- Darts v1
- Field Hockey v2
- Field Hockey v1
- Floorball v2
- Floorball v1
- Futsal v2
- Futsal v1
- Pesapallo v2
- Pesapallo v1
- Snooker v2
- Snooker v1
- Squash v2
- Squash v1
- Table Tennis v2
- Volleyball (Beach) v2
- Volleyball (Beach) v1
- Volleyball (Indoor) v2
- Volleyball (Indoor) v1
- Waterpolo v2
- Waterpolo v1
- Winter Sports v1