npm install sportsdataverse
For more information on the package and function reference, please see the sportsdataverse node.js documentation website
To cite the sportsdataverse
Node.js package in publications, use:
BibTex Citation
@misc{gilani_2021_sportsdataverse_js,
author = {Gilani, Saiem},
title = {sportsdataverse-js: The SportsDataverse's Node.js Package for Sports Data.},
url = {https://js.sportsdataverse.org},
year = {2021}
}
Support for the following data from ESPN's endpoints:
Recruiting data from 247Sports available for:
The following sports are available from ESPN:
Operations for College Football.
Kind: global namespace
object
Gets the College Football game play-by-play data for a specified game.
Kind: static method of cfb
Returns: json
Param | Type | Description |
---|---|---|
id | number |
Game id. |
Example
const result = await sdv.cfb.getPlayByPlay(401256194);
Gets the College Football game box score data for a specified game.
Kind: static method of cfb
Returns: json
Param | Type | Description |
---|---|---|
id | number |
Game id. |
Example
const result = await sdv.cfb.getBoxScore(401256194);
Gets the College Football game summary data for a specified game.
Kind: static method of cfb
Returns: json
Param | Type | Description |
---|---|---|
id | number |
Game id. |
Example
const result = await sdv.cfb.getSummary(401256194);
Gets the College Football PickCenter data for a specified game.
Kind: static method of cfb
Returns: json
Param | Type | Description |
---|---|---|
id | number |
Game id. |
Example
const result = await sdv.cfb.getPicks(401256194);
Gets the College Football Player recruiting data for a specified year, page, position, state and institution type if available.
Kind: static method of cfb
Returns: json
Param | Type | Description |
---|---|---|
year | * |
Year (YYYY) |
page | number |
Page (50 per page) |
group | "HighSchool" | "JuniorCollege" | "PrepSchool" |
Institution Type |
state | string |
State of recruit |
Example
const result = await sdv.cfb.getPlayerRankings({year: 2016});
Gets the College Football School recruiting data for a specified year and page if available.
Kind: static method of cfb
Returns: json
Param | Type | Description |
---|---|---|
year | * |
Year (YYYY) |
page | number |
Page (50 per page) |
Example
const result = await sdv.cfb.getSchoolRankings({year: 2016});
Gets the College Football School commitment data for a specified school and year.
Kind: static method of cfb
Returns: json
Param | Type | Description |
---|---|---|
year | * |
Year (YYYY) |
school | string |
School |
Example
const result = await sdv.cfb.getSchoolCommits({school: 'Florida State', year: 2021});
Gets the CFB rankings data for a specified year and week if available.
Kind: static method of cfb
Returns: json
Param | Type | Description |
---|---|---|
year | * |
Year (YYYY) |
week | * |
Week |
Example
const result = await sdv.cfb.getRankings(year = 2020, week = 4)
Gets the College Football schedule data for a specified date if available.
Kind: static method of cfb
Returns: json
Param | Type | Description |
---|---|---|
year | * |
Year (YYYY) |
month | * |
Month (MM) |
day | * |
Day (DD) |
group | number |
Group is 80 for FBS, 81 for FCS |
seasontype | number |
Pre-Season: 1, Regular Season: 2, Postseason: 3, Off-season: 4 |
Example
const result = await sdv.cfb.getSchedule(year = 2019, month = 11, day = 16, group=80)
Gets the College Football scoreboard data for a specified date if available.
Kind: static method of cfb
Returns: json
Param | Type | Description |
---|---|---|
year | * |
Year (YYYY) |
month | * |
Month (MM) |
day | * |
Day (DD) |
group | number |
Group is 80 for FBS, 81 for FCS |
seasontype | number |
Pre-Season: 1, Regular Season: 2, Postseason: 3, Off-season: 4 |
limit | number |
Limit on the number of results @default 300 |
Example
const result = await sdv.cfb.getScoreboard(
year = 2019, month = 11, day = 16, group=80
)
Gets the list of all College Football conferences and their identification info for ESPN.
Kind: static method of cfb
Returns: json
Param | Type | Description |
---|---|---|
year | number |
Season |
group | number |
Group is 80 for FBS, 81 for FCS |
Example
const yr = 2021;
const result = await sdv.cfb.getConferences(year = yr, group = 80);
Gets the team standings for College Football.
Kind: static method of cfb
Returns: json
Param | Type | Description |
---|---|---|
year | number |
Season |
group | number |
Group is 80 for FBS, 81 for FCS |
Example
const yr = 2020;
const result = await sdv.cfb.getStandings(year = yr);
Gets the list of all College Football teams their identification info for ESPN.
Kind: static method of cfb
Returns: json
Param | Type | Description |
---|---|---|
group | number |
Group is 80 for FBS, 81 for FCS |
Example
const result = await sdv.cfb.getTeamList(group=80);
Gets the team info for a specific College Football team.
Kind: static method of cfb
Returns: json
Param | Type | Description |
---|---|---|
id | number |
Team Id |
Example
const teamId = 52;
const result = await sdv.cfb.getTeamInfo(teamId);
Gets the team roster information for a specific College Football team.
Kind: static method of cfb
Param | Type | Description |
---|---|---|
id | number |
Team Id |
Example
const teamId = 52;
const result = await sdv.cfb.getTeamPlayers(teamId);
Operations for Men's College Basketball.
Kind: global namespace
object
Gets the Men's College Basketball game play-by-play data for a specified game.
Kind: static method of mbb
Returns: json
Param | Type | Description |
---|---|---|
id | number |
Game id. |
Example
const result = await sdv.mbb.getPlayByPlay(401260281);
Gets the Men's College Basketball game box score data for a specified game.
Kind: static method of mbb
Returns: json
Param | Type | Description |
---|---|---|
id | number |
Game id. |
Example
const result = await sdv.mbb.getBoxScore(401260281);
Gets the Men's College Basketball game summary data for a specified game.
Kind: static method of mbb
Returns: json
Param | Type | Description |
---|---|---|
id | number |
Game id. |
Example
const result = await sdv.mbb.getSummary(401260281);
Gets the Men's College Basketball game PickCenter data for a specified game.
Kind: static method of mbb
Returns: json
Param | Type | Description |
---|---|---|
id | number |
Game id. |
Example
const result = await sdv.mbb.getPicks(401260281);
Gets the Men's College Basketball Player recruiting data for a specified year, page, position and institution type if available.
Kind: static method of mbb
Returns: json
Param | Type | Description |
---|---|---|
year | * |
Year (YYYY) |
page | number |
Page (50 per page) |
group | "HighSchool" | "JuniorCollege" | "PrepSchool" |
Institution Type |
Example
const result = await sdv.mbb.getPlayerRankings({year: 2016});
Gets the Men's College Basketball School recruiting data for a specified year, page, position and institution type if available.
Kind: static method of mbb
Returns: json
Param | Type | Description |
---|---|---|
year | * |
Year (YYYY) |
page | number |
Page (50 per page) |
Example
const result = await sdv.mbb.getSchoolRankings({year: 2016});
Gets the Men's College Basketball School commitment data for a specified school and year.
Kind: static method of mbb
Returns: json
Param | Type | Description |
---|---|---|
year | * |
Year (YYYY) |
school | string |
School |
Example
const result = await sdv.mbb.getSchoolCommits({school: 'Clemson', year: 2016});
Gets the Men's College Basketball schedule data for a specified date if available.
Kind: static method of mbb
Returns: json
Param | Type | Description |
---|---|---|
year | * |
Year (YYYY) |
month | * |
Month (MM) |
day | * |
Day (DD) |
group | number |
Group is 50 for Division-I, 51 for Division-II, 52 for Division-III |
seasontype | number |
Pre-Season: 1, Regular Season: 2, Postseason: 3, Off-season: 4 |
Example
const result = await sdv.mbb.getSchedule(
year = 2021, month = 02, day = 15, group=50
)
Gets the Men's College Basketball scoreboard data for a specified date if available.
Kind: static method of mbb
Returns: json
Param | Type | Description |
---|---|---|
year | * |
Year (YYYY) |
month | * |
Month (MM) |
day | * |
Day (DD) |
group | number |
Group is 50 for Division-I, 51 for Division-II, 52 for Division-III |
seasontype | number |
Pre-Season: 1, Regular Season: 2, Postseason: 3, Off-season: 4 |
limit | number |
Limit on the number of results @default 300 |
Example
const result = await sdv.mbb.getScoreboard(
year = 2021, month = 02, day = 15, group=50
)
Gets the Men's College Basketball Conferences.
Kind: static method of mbb
Returns: json
Param | Type | Description |
---|---|---|
year | number |
Season |
group | number |
Group is 50 for Division-I, 51 for Division-II, 52 for Division-III |
Example
const yr = 2021;
const result = await sdv.mbb.getConferences(year = yr, group = 50);
Gets the team standings for Men's College Basketball.
Kind: static method of mbb
Returns: json
Param | Type | Description |
---|---|---|
year | number |
Season |
group | number |
Group is 50 for Division-I, 51 for Division-II, 52 for Division-III, see wbb.getConferences() for more info |
Example
const yr = 2020;
const result = await sdv.mbb.getStandings(year = yr);
Gets the list of all College Football teams their identification info for ESPN.
Kind: static method of mbb
Returns: json
Param | Type | Description |
---|---|---|
group | number |
Group is 50 for Division-I, 51 for Division-II, 52 for Division-III |
Example
const result = await sdv.mbb.getTeamList(group=50);
Gets the team info for a specific College Basketball team.
Kind: static method of mbb
Returns: json
Param | Type | Description |
---|---|---|
id | number |
Team Id |
Example
const teamId = 52;
const result = await sdv.mbb.getTeamInfo(teamId);
Gets the team roster information for a specific Men's College Basketball team.
Kind: static method of mbb
Returns: json
Param | Type | Description |
---|---|---|
id | number |
Team Id |
Example
const teamId = 52;
const result = await sdv.mbb.getTeamPlayers(teamId);
Operations for MLB.
Kind: global namespace
object
Gets the MLB game play-by-play data for a specified game.
Kind: static method of mlb
Returns: json
Param | Type | Description |
---|---|---|
id | number |
Game id. |
Example
const result = await sdv.mlb.getPlayByPlay(401472105);
Gets the MLB game box score data for a specified game.
Kind: static method of mlb
Returns: json
Param | Type | Description |
---|---|---|
id | number |
Game id. |
Example
const result = await sdv.mlb.getBoxScore(401472105);
Gets the MLB game summary data for a specified game.
Kind: static method of mlb
Returns: json
Param | Type | Description |
---|---|---|
id | number |
Game id. |
Example
const result = await sdv.mlb.getSummary(401472105);
Gets the MLB game PickCenter data for a specified game.
Kind: static method of mlb
Returns: json
Param | Type | Description |
---|---|---|
id | number |
Game id. |
Example
const result = await sdv.mlb.getPicks(401472105);
Gets the MLB schedule data for a specified date if available.
Kind: static method of mlb
Returns: json
Param | Type | Description |
---|---|---|
year | * |
Year (YYYY) |
month | * |
Month (MM) |
day | * |
Day (DD) |
Example
const result = await sdv.mlb.getSchedule(
year = 2016, month = 04, day = 15
)
Gets the MLB scoreboard data for a specified date if available.
Kind: static method of mlb
Returns: json
Param | Type | Description |
---|---|---|
year | * |
Year (YYYY) |
month | * |
Month (MM) |
day | * |
Day (DD) |
limit | number |
Limit on the number of results @default 300 |
Example
const result = await sdv.mlb.getScoreboard(
year = 2019, month = 11, day = 16
)
Gets the team standings for the MLB.
Kind: static method of mlb
Returns: json
Param | Type | Description |
---|---|---|
year | number |
Season |
group | string |
acceptable group names: 'league','conference','division' |
Example
const yr = 2016;
const result = await sdv.mlb.getStandings(year = yr);
Gets the list of all MLB teams their identification info for ESPN.
Kind: static method of mlb
Returns: json
Example
const result = await sdv.mlb.getTeamList();
Gets the team info for a specific MLB team.
Kind: static method of mlb
Returns: json
Param | Type | Description |
---|---|---|
id | number |
Team Id |
Example
const teamId = 16;
const result = await sdv.mlb.getTeamInfo(teamId);
Gets the team roster information for a specific MLB team.
Kind: static method of mlb
Returns: json
Param | Type | Description |
---|---|---|
id | number |
Team Id |
Example
const teamId = 16;
const result = await sdv.mlb.getTeamPlayers(teamId);
Operations for NBA.
Kind: global namespace
object
Gets the NBA game play-by-play data for a specified game.
Kind: static method of nba
Returns: json
Param | Type | Description |
---|---|---|
id | number |
Game id. |
Example
const result = await sdv.nba.getPlayByPlay(401283399);
Gets the NBA game box score data for a specified game.
Kind: static method of nba
Returns: json
Param | Type | Description |
---|---|---|
id | number |
Game id. |
Example
const result = await sdv.nba.getBoxScore(401283399);
Gets the NBA game summary data for a specified game.
Kind: static method of nba
Returns: json
Param | Type | Description |
---|---|---|
id | number |
Game id. |
Example
const result = await sdv.nba.getSummary(401283399);
Gets the NBA game PickCenter data for a specified game.
Kind: static method of nba
Returns: json
Param | Type | Description |
---|---|---|
id | number |
Game id. |
Example
const result = await sdv.nba.getPicks(401283399);
Gets the NBA schedule data for a specified date if available.
Kind: static method of nba
Returns: json
Param | Type | Description |
---|---|---|
year | * |
Year (YYYY) |
month | * |
Month (MM) |
day | * |
Day (DD) |
Example
const result = await sdv.nba.getSchedule(
year = 2016, month = 04, day = 15
)
Gets the NBA scoreboard data for a specified date if available.
Kind: static method of nba
Returns: json
Param | Type | Description |
---|---|---|
year | * |
Year (YYYY) |
month | * |
Month (MM) |
day | * |
Day (DD) |
limit | number |
Limit on the number of results @default 300 |
Example
const result = await sdv.nba.getScoreboard(
year = 2019, month = 11, day = 16
)
Gets the team standings for the NBA.
Kind: static method of nba
Returns: json
Param | Type | Description |
---|---|---|
year | number |
Season |
group | string |
acceptable group names: 'league','conference','division' |
Example
const yr = 2016;
const result = await sdv.nba.getStandings(year = yr);
Gets the list of all NBA teams their identification info for ESPN.
Kind: static method of nba
Returns: json
Example
const result = await sdv.nba.getTeamList();
Gets the team info for a specific NBA team.
Kind: static method of nba
Returns: json
Param | Type | Description |
---|---|---|
id | number |
Team Id |
Example
const teamId = 16;
const result = await sdv.nba.getTeamInfo(teamId);
Gets the team roster information for a specific NBA team.
Kind: static method of nba
Returns: json
Param | Type | Description |
---|---|---|
id | number |
Team Id |
Example
const teamId = 16;
const result = await sdv.nba.getTeamPlayers(teamId);
Operations for NCAA Sports.
Kind: global namespace
object
Gets the gameId for older games whose url redirects to the current url pattern using the game url fragment (relative to https://ncaa.com) pulled from ncaaScoreboard
Kind: static method of ncaa
Returns: json
Param | Type | Description |
---|---|---|
url | string |
Game url as pulled from ncaaScoreboard.getNcaaScoreboard. |
Example
const result = await sdv.ncaaScoreboard.getNcaaScoreboard(
sport = 'basketball-men', division = 'd3', year = 2019, month = 02, day = 15
)
const urlGame = result["games"][16]["game"]["url"]
const gameId = await sdv.ncaa.getRedirectUrl(url=urlGame);
Gets the gameInfo data for a specified game.
Kind: static method of ncaa
Returns: json
Param | Type | Description |
---|---|---|
game | number |
Game id. |
Example
const result = await sdv.ncaa.getInfo(5764053);
Gets the box score data for a specified game if available.
Kind: static method of ncaa
Returns: json
Param | Type | Description |
---|---|---|
game | number |
Game id. |
Example
const result = await sdv.ncaa.getBoxScore(5764053);
Gets the play-by-play data for a specified game if available.
Kind: static method of ncaa
Returns: json
Param | Type | Description |
---|---|---|
game | number |
Game id. |
Example
const result = await sdv.ncaa.getPlayByPlay(5764053);
Gets the scoreboard data for a specified date and team sport if available.
Kind: static method of ncaa
Returns: json
Param | Type | Description |
---|---|---|
sport | string |
Sport name. Acceptable values: 'football','basketball-men', 'basketball-women', 'baseball', 'softball', 'soccer-men','soccer-women', 'fieldhockey', 'icehockey-men','icehockey-women', 'lacrosse-men','lacrosse-women', 'beach-volleyball', 'volleyball-women', 'volleyball-men' |
division | string |
Division of teams desired. Acceptable values: Football - ['fbs','fcs','d2','d3'] All others - ['d1','d2','d3'] |
year | * |
Year (YYYY) |
month | * |
Month (MM) |
day | * |
Day (DD) |
Example
const result = await sdv.ncaa.getScoreboard(
sport = 'basketball-men', division = 'd3', year = 2019, month = 02, day = 15
)
Retrieves the set of sports and their abbreviations.
Kind: static method of ncaa
Returns: json
Example
const result = sdv.ncaa.getSports();
Retrieves the seasons for the selected sport.
Kind: static method of ncaa
Returns: json
Param | Type | Description |
---|---|---|
sport | string |
Sport abbreviation. Acceptable values: 'MBA' = Baseball, 'MBB' = Men's basketball, 'MFB' = Men's Football, 'MIH' = Men's Ice-hockey, 'MLA' = Men's Lacrosse', 'MSO' = Men's Soccer, 'MTE' = Men's Tennis, 'MVB' = Men's Volleyball, 'MWP' = Men's Water Polo, 'WBB' = Women's Basketball, 'WBW' = Women's Bowling, 'WFH' = Field Hockey, 'WIH' = Women's Ice-Hockey, 'WLA' = Women's Lacrosse, 'WSB' = Women's Softball, 'WSO' = Women's Soccer, 'WSV' = Women's Beach Volleyball, 'WTE' = Women's Tennis, 'WVB' = Women's Volleyball, 'WWP' = Women's Water Polo |
Example
const result = sdv.ncaa.getSeasons(sport='MBB');
Retrieves the Divisions for the selected sport and season.
Kind: static method of ncaa
Returns: json
Param | Type | Description |
---|---|---|
sport | string |
Sport abbreviation. Acceptable values: 'MBA' = Baseball, 'MBB' = Men's basketball, 'MFB' = Men's Football, 'MIH' = Men's Ice-hockey, 'MLA' = Men's Lacrosse', 'MSO' = Men's Soccer, 'MTE' = Men's Tennis, 'MVB' = Men's Volleyball, 'MWP' = Men's Water Polo, 'WBB' = Women's Basketball, 'WBW' = Women's Bowling, 'WFH' = Field Hockey, 'WIH' = Women's Ice-Hockey, 'WLA' = Women's Lacrosse, 'WSB' = Women's Softball, 'WSO' = Women's Soccer, 'WSV' = Women's Beach Volleyball, 'WTE' = Women's Tennis, 'WVB' = Women's Volleyball, 'WWP' = Women's Water Polo |
season | string |
Season for sport |
Example
const result = sdv.ncaa.getDivisions(sport='MBB', season='2017');
Request the data from the NCAA Stats website.
Kind: static method of ncaa
Returns: json
Param | Description |
---|---|
sport | Sport abbreviation. Acceptable values: 'MBA' = Baseball, 'MBB' = Men's basketball, 'MFB' = Men's Football, 'MIH' = Men's Ice-hockey, 'MLA' = Men's Lacrosse', 'MSO' = Men's Soccer, 'MTE' = Men's Tennis, 'MVB' = Men's Volleyball, 'MWP' = Men's Water Polo, 'WBB' = Women's Basketball, 'WBW' = Women's Bowling, 'WFH' = Field Hockey, 'WIH' = Women's Ice-Hockey, 'WLA' = Women's Lacrosse, 'WSB' = Women's Softball, 'WSO' = Women's Soccer, 'WSV' = Women's Beach Volleyball, 'WTE' = Women's Tennis, 'WVB' = Women's Volleyball, 'WWP' = Women's Water Polo |
season | Season of query, value for 2016-2017 season would be 2017. |
division | Division, for college football: 11 for FBS, 12 for FCS, otherwise 1 for Division-I, 2 for Division-II, 3 for Division-III. |
rankingPeriod | Integer value indicating the ranking period, options can be found from using the @function ncaa.getSportDivisionData function. |
type | Individual or Team type of statistics |
gameHigh | logical, indicating whether the statistic desired is of the game-high variety |
category | Value for the stat category, can also be found using the @function ncaa.getSportDivisionData |
Example
const sportDivisionData = sdv.ncaa.getSportDivisionData(sport='MFB',season='2016',division=12,type='team',gameHigh=true);
Get the Player Data from the NCAA Stats website.
Kind: static method of ncaa
Returns: json
Param | Type | Description |
---|---|---|
sport | Sport abbreviation. Acceptable values: 'MBA' = Baseball, 'MBB' = Men's basketball, 'MFB' = Men's Football, 'MIH' = Men's Ice-hockey, 'MLA' = Men's Lacrosse', 'MSO' = Men's Soccer, 'MTE' = Men's Tennis, 'MVB' = Men's Volleyball, 'MWP' = Men's Water Polo, 'WBB' = Women's Basketball, 'WBW' = Women's Bowling, 'WFH' = Field Hockey, 'WIH' = Women's Ice-Hockey, 'WLA' = Women's Lacrosse, 'WSB' = Women's Softball, 'WSO' = Women's Soccer, 'WSV' = Women's Beach Volleyball, 'WTE' = Women's Tennis, 'WVB' = Women's Volleyball, 'WWP' = Women's Water Polo | |
season | Season of query, value for 2016-2017 season would be 2017. | |
division | Division, for college football: 11 for FBS, 12 for FCS, otherwise 1 for Division-I, 2 for Division-II, 3 for Division-III. | |
rankingPeriod | Integer value indicating the ranking period, options can be found from using the @function ncaa.getSportDivisionData function. | |
gameHigh | 'Y' | 'N' |
logical, indicating whether the statistic desired is of the game-high variety |
category | Value for the stat category, can also be found using the @function ncaa.getSportDivisionData |
Example
const players = await sdv.ncaa.getPlayerData(sport = 'MFB', year = '2017', division = '11',rankingPeriod = '52', gameHigh='N', category = '20')
Get the Team Data from the NCAA Stats website.
Kind: static method of ncaa
Returns: json
Param | Type | Description |
---|---|---|
sport | Sport abbreviation. Acceptable values: 'MBA' = Baseball, 'MBB' = Men's basketball, 'MFB' = Men's Football, 'MIH' = Men's Ice-hockey, 'MLA' = Men's Lacrosse', 'MSO' = Men's Soccer, 'MTE' = Men's Tennis, 'MVB' = Men's Volleyball, 'MWP' = Men's Water Polo, 'WBB' = Women's Basketball, 'WBW' = Women's Bowling, 'WFH' = Field Hockey, 'WIH' = Women's Ice-Hockey, 'WLA' = Women's Lacrosse, 'WSB' = Women's Softball, 'WSO' = Women's Soccer, 'WSV' = Women's Beach Volleyball, 'WTE' = Women's Tennis, 'WVB' = Women's Volleyball, 'WWP' = Women's Water Polo | |
season | Season of query, value for 2016-2017 season would be 2017. | |
division | Division, for college football: 11 for FBS, 12 for FCS, otherwise 1 for Division-I, 2 for Division-II, 3 for Division-III. | |
rankingPeriod | Integer value indicating the ranking period, options can be found from using the @function ncaaSports.getSportDivisionData function. | |
gameHigh | 'Y' | 'N' |
logical, indicating whether the statistic desired is of the game-high variety |
category | Value for the stat category, can also be found using the @function ncaaSports.getSportDivisionData |
Example
const teams = await sdv.ncaa.getTeamData(sport = 'MFB', year = '2017', division = '11', rankingPeriod = '52', gameHigh='N', category = '20')
Operations for NFL.
Kind: global namespace
object
Gets the NFL game play-by-play data for a specified game.
Kind: static method of nfl
Returns: json
Param | Type | Description |
---|---|---|
id | number |
Game id. |
Example
const result = await sdv.nfl.getPlayByPlay(401220403);
Gets the NFL game box score data for a specified game.
Kind: static method of nfl
Returns: json
Param | Type | Description |
---|---|---|
id | number |
Game id. |
Example
const result = await sdv.nfl.getBoxScore(401220403);
Gets the NFL game summary data for a specified game.
Kind: static method of nfl
Returns: json
Param | Type | Description |
---|---|---|
id | number |
Game id. |
Example
const result = await sdv.nfl.getSummary(401220403);
Gets the NFL PickCenter data for a specified game.
Kind: static method of nfl
Returns: json
Param | Type | Description |
---|---|---|
id | number |
Game id. |
Example
const result = await sdv.nfl.getPicks(401220403);
Gets the NFL schedule data for a specified date if available.
Kind: static method of nfl
Returns: json
Param | Type | Description |
---|---|---|
year | * |
Year (YYYY) |
month | * |
Month (MM) |
day | * |
Day (DD) |
Example
const result = await sdv.nfl.getSchedule(
year = 2019, month = 11, day = 17
)
Gets the NFL Weekly Schedule data for a specified season type.
Kind: static method of nfl
Returns: json
Param | Type | Description |
---|---|---|
week | * |
Week (1-17) Default is 1 |
year | * |
Year (YYYY) Default is current year |
seasonType | * |
Season Type (1 = Preseason, 2 = Regular Season, 3 = Postseason) Default is 2 |
Example
const result = await sdv.nfl.getWeeklySchedule(
week = 1, year = 2023, seasonType = 2
)
Gets the NFL scoreboard data for a specified date if available.
Kind: static method of nfl
Returns: json
Param | Type | Description |
---|---|---|
year | * |
Year (YYYY) |
month | * |
Month (MM) |
day | * |
Day (DD) |
limit | number |
Limit on the number of results @default 300 |
Example
const result = await sdv.nfl.getScoreboard(
year = 2019, month = 11, day = 17
)
Gets the team standings for the NFL.
Kind: static method of nfl
Returns: json
Param | Type | Description |
---|---|---|
year | number |
Season |
group | string |
acceptable group names: 'league','conference','division' |
Example
const yr = 2021;
const result = await sdv.nfl.getStandings(year = yr);
Gets the list of all NFL teams their identification info for ESPN.
Kind: static method of nfl
Example
const result = await sdv.nfl.getTeamList();
Gets the team info for a specific NFL team.
Kind: static method of nfl
Returns: json
Param | Type | Description |
---|---|---|
id | number |
Team Id |
Example
const teamId = 16;
const result = await sdv.nfl.getTeamInfo(teamId);
Gets the team roster information for a specific NFL team.
Kind: static method of nfl
Returns: json
Param | Type | Description |
---|---|---|
id | number |
Team Id |
Example
const teamId = 16;
const result = await sdv.nfl.getTeamPlayers(teamId);
Operations for NHL.
Kind: global namespace
object
Gets the NHL game play-by-play data for a specified game.
Kind: static method of nhl
Returns: json
Param | Type | Description |
---|---|---|
id | number |
Game id. |
Example
const result = await sdv.nhl.getPlayByPlay(401272446);
Gets the NHL game box score data for a specified game.
Kind: static method of nhl
Returns: json
Param | Type | Description |
---|---|---|
id | number |
Game id. |
Example
const result = await sdv.nhl.getBoxScore(401272446);
Gets the NHL game summary data for a specified game.
Kind: static method of nhl
Returns: json
Param | Type | Description |
---|---|---|
id | number |
Game id. |
Example
const result = await sdv.nhl.getSummary(401272446);
Gets the NHL PickCenter data for a specified game.
Kind: static method of nhl
Returns: json
Param | Type | Description |
---|---|---|
id | number |
Game id. |
Example
const result = await sdv.nhl.getPicks(401272446);
Gets the NHL schedule data for a specified date if available.
Kind: static method of nhl
Returns: json
Param | Type | Description |
---|---|---|
year | * |
Year (YYYY) |
month | * |
Month (MM) |
day | * |
Day (DD) |
Example
const result = await sdv.nhl.getSchedule(
year = 2019, month = 11, day = 17
)
Gets the NHL scoreboard data for a specified date if available.
Kind: static method of nhl
Returns: json
Param | Type | Description |
---|---|---|
year | * |
Year (YYYY) |
month | * |
Month (MM) |
day | * |
Day (DD) |
limit | number |
Limit on the number of results @default 300 |
Example
const result = await sdv.nhl.getScoreboard(
year = 2019, month = 11, day = 16
)
Gets the team standings for the NHL.
Kind: static method of nhl
Returns: json
Param | Type | Description |
---|---|---|
year | number |
Season |
group | string |
acceptable group names: 'league','conference','division' |
Example
const yr = 2016;
const result = await sdv.nhl.getStandings(year = yr);
Gets the list of all NHL teams their identification info for ESPN.
Kind: static method of nhl
Example
const result = await sdv.nhl.getTeamList();
Gets the team info for a specific NHL team.
Kind: static method of nhl
Returns: json
Param | Type | Description |
---|---|---|
id | number |
Team Id |
Example
const teamId = 16;
const result = await sdv.nhl.getTeamInfo(teamId);
Gets the team roster information for a specific NHL team.
Kind: static method of nhl
Returns: json
Param | Type | Description |
---|---|---|
id | number |
Team Id |
Example
const teamId = 16;
const result = await sdv.nhl.getTeamPlayers(teamId);
ERROR, Cannot find namespace. Operations for WBB.
Kind: global namespace
object
Gets the Women's College Basketball game play-by-play data for a specified game.
Kind: static method of wbb
Returns: json
Param | Type | Description |
---|---|---|
id | number |
Game id. |
Example
const result = await sdv.wbb.getPlayByPlay(401260565);
Gets the Women's College Basketball game box score data for a specified game.
Kind: static method of wbb
Returns: json
Param | Type | Description |
---|---|---|
id | number |
Game id. |
Example
const result = await sdv.wbb.getBoxScore(401260565);
Gets the Women's College Basketball game summary data for a specified game.
Kind: static method of wbb
Returns: json
Param | Type | Description |
---|---|---|
id | number |
Game id. |
Example
const result = await sdv.wbb.getSummary(401260565);
Gets the Women's College Basketball schedule data for a specified date if available.
Kind: static method of wbb
Returns: json
Param | Type | Description |
---|---|---|
year | * |
Year (YYYY) |
month | * |
Month (MM) |
day | * |
Day (DD) |
group | number |
Group is 50 for Division-I, 51 for Division-II, 52 for Division-III |
seasontype | number |
Pre-Season: 1, Regular Season: 2, Postseason: 3, Off-season: 4 |
limit | number |
Limit on the number of results @default 300 |
Example
const result = await sdv.wbb.getSchedule(
year = 2021, month = 02, day = 15, group=50
)
Gets the Women's College Basketball scoreboard data for a specified date if available.
Kind: static method of wbb
Returns: json
Param | Type | Description |
---|---|---|
year | * |
Year (YYYY) |
month | * |
Month (MM) |
day | * |
Day (DD) |
group | number |
Group is 50 for Division-I, 51 for Division-II, 52 for Division-III |
seasontype | number |
Pre-Season: 1, Regular Season: 2, Postseason: 3, Off-season: 4 |
limit | number |
Limit on the number of results @default 300 |
Example
const result = await sdv.wbb.getScoreboard(
year = 2019, month = 02, day = 15, group=50
)
Gets the list of all Women's College Basketball conferences and their identification info for ESPN.
Kind: static method of wbb
Returns: json
Param | Type | Description |
---|---|---|
year | number |
Season |
group | number |
Group is 50 for Division-I, 51 for Division-II, 52 for Division-III |
Example
const yr = 2021;
const result = await sdv.wbb.getConferences(year = yr, group = 50);
Gets the team standings for Women's College Basketball.
Kind: static method of wbb
Returns: json
Param | Type | Description |
---|---|---|
year | number |
Season |
group | number |
Group is 50 for Division-I, 51 for Division-II, 52 for Division-III, see wbb.getConferences() for more info |
Example
const yr = 2020;
const result = await sdv.wbb.getStandings(year = yr);
Gets the list of all Women's College Basketball teams their identification info for ESPN.
Kind: static method of wbb
Returns: json
Param | Type | Description |
---|---|---|
group | number |
Group is 50 for Division I, 51 for Division II, 52 for Division III |
Example
get list of teams
const result = await sdv.wbb.getTeamList(group=50);
Gets the team info for a specific WBB team.
Kind: static method of wbb
Returns: json
Param | Type | Description |
---|---|---|
id | number |
Team Id |
Example
const teamId = 52;
const result = await sdv.wbb.getTeamInfo(teamId);
Gets the team roster information for a specific WBB team.
Kind: static method of wbb
Returns: json
Param | Type | Description |
---|---|---|
id | number |
Team Id |
Example
const teamId = 52;
const result = await sdv.wbb.getTeamPlayers(teamId);
Operations for WNBA.
Kind: global namespace
object
Gets the WNBA game play-by-play data for a specified game.
Kind: static method of wnba
Returns: json
Param | Type | Description |
---|---|---|
id | number |
Game id. |
Example
const result = await sdv.wnba.getPlayByPlay(401244185);
Gets the WNBA game box score data for a specified game.
Kind: static method of wnba
Returns: json
Param | Type | Description |
---|---|---|
id | number |
Game id. |
Example
const result = await sdv.wnba.getBoxScore(401244185);
Gets the WNBA game summary data for a specified game.
Kind: static method of wnba
Returns: json
Param | Type | Description |
---|---|---|
id | number |
Game id. |
Example
const result = await sdv.wnba.getSummary(401244185);
Gets the WNBA schedule data for a specified date if available.
Kind: static method of wnba
Returns: json
Param | Type | Description |
---|---|---|
year | * |
Year (YYYY) |
month | * |
Month (MM) |
day | * |
Day (DD) |
Example
const result = await sdv.wnba.getSchedule(
year = 2019, month = 07, day = 15
)
Gets the WNBA scoreboard data for a specified date if available.
Kind: static method of wnba
Returns: json
Param | Type | Description |
---|---|---|
year | * |
Year (YYYY) |
month | * |
Month (MM) |
day | * |
Day (DD) |
limit | number |
Limit on the number of results @default 300 |
Example
const result = await sdv.wnba.getScoreboard(
year = 2019, month = 07, day = 15
)
Gets the team standings for the WNBA.
Kind: static method of wnba
Returns: json
Param | Type | Description |
---|---|---|
year | number |
Season |
group | string |
acceptable group names: 'league','conference' |
Example
const yr = 2016;
const result = await sdv.wnba.getStandings(year = yr);
Gets the list of all WNBA teams their identification info for ESPN.
Kind: static method of wnba
Returns: json
Example
const result = await sdv.wnba.getTeamList();
Gets the team info for a specific WNBA team.
Kind: static method of wnba
Returns: json
Param | Type | Description |
---|---|---|
id | number |
Team Id |
Example
const teamId = 16;
const result = await sdv.wnba.getTeamInfo(teamId);
Gets the team roster information for a specific WNBA team.
Kind: static method of wnba
Returns: json
Param | Type | Description |
---|---|---|
id | number |
Team Id |
Example
const teamId = 16;
const result = await sdv.wnba.getTeamPlayers(teamId);
© 2020-21 sportsdataverse.js, developed by Saiem Gilani, part of the SportsDataverse