**Installation****Documentation****Breaking Changes**Follow the [SportsDataverse](https://twitter.com/SportsDataverse) on Twitter and star this repo **Our Authors****Citations****Overview of Services****API Reference**cfb.getPlayByPlay(id) ⇒cfb.getBoxScore(id) ⇒cfb.getSummary(id) ⇒cfb.getPicks(id) ⇒cfb.getPlayerRankings(year, page, group, state) ⇒cfb.getSchoolRankings(year, page) ⇒cfb.getSchoolCommits(year, school) ⇒cfb.getRankings(year, week) ⇒cfb.getSchedule(year, month, day, group, seasontype) ⇒cfb.getScoreboard(year, month, day, group, seasontype, limit) ⇒cfb.getConferences(year, group) ⇒cfb.getStandings(year, group) ⇒cfb.getTeamList(group) ⇒cfb.getTeamInfo(id) ⇒cfb.getTeamPlayers(id)mbb.getPlayByPlay(id) ⇒mbb.getBoxScore(id) ⇒mbb.getSummary(id) ⇒mbb.getPicks(id) ⇒mbb.getRankings(year, week) ⇒mbb.getPlayerRankings(year, page, group) ⇒mbb.getSchoolRankings(year, page) ⇒mbb.getSchoolCommits(year, school) ⇒mbb.getSchedule(year, month, day, group, seasontype) ⇒mbb.getScoreboard(year, month, day, group, seasontype, limit) ⇒mbb.getConferences(year, group) ⇒mbb.getStandings(year, group) ⇒mbb.getTeamList(group) ⇒mbb.getTeamInfo(id) ⇒mbb.getTeamPlayers(id) ⇒nba.getPlayByPlay(id) ⇒nba.getBoxScore(id) ⇒nba.getSummary(id) ⇒nba.getPicks(id) ⇒nba.getSchedule(year, month, day) ⇒nba.getScoreboard(year, month, day, limit) ⇒nba.getStandings(year, group) ⇒nba.getTeamList() ⇒nba.getTeamInfo(id) ⇒nba.getTeamPlayers(id) ⇒ncaa.getRedirectUrl(url) ⇒ncaa.getInfo(game) ⇒ncaa.getBoxScore(game) ⇒ncaa.getPlayByPlay(game) ⇒ncaa.getTeamStats(game) ⇒ncaa.getScoringSummary(game) ⇒ncaa.getScoreboard(sport, division, year, month, day) ⇒ncaa.getSports() ⇒ncaa.getSeasons(sport) ⇒ncaa.getDivisions(sport, season) ⇒ncaa.getSportDivisionData(sport, season, division, rankingPeriod, type, gameHigh, category) ⇒ncaa.getPlayerData(sport, season, division, rankingPeriod, gameHigh, category) ⇒ncaa.getTeamData(sport, season, division, rankingPeriod, gameHigh, category) ⇒nfl.getPlayByPlay(id) ⇒nfl.getBoxScore(id) ⇒nfl.getSummary(id) ⇒nfl.getPicks(id) ⇒nfl.getSchedule(year, month, day) ⇒nfl.getScoreboard(year, month, day, limit) ⇒nfl.getStandings(year, group) ⇒nfl.getTeamList()nfl.getTeamInfo(id) ⇒nfl.getTeamPlayers(id) ⇒nhl.getPlayByPlay(id) ⇒nhl.getBoxScore(id) ⇒nhl.getSummary(id) ⇒nhl.getPicks(id) ⇒nhl.getSchedule(year, month, day) ⇒nhl.getScoreboard(year, month, day, limit) ⇒nhl.getStandings(year, group) ⇒nhl.getTeamList()nhl.getTeamInfo(id) ⇒nhl.getTeamPlayers(id) ⇒wbb.getPlayByPlay(id) ⇒wbb.getBoxScore(id) ⇒wbb.getSummary(id) ⇒wbb.getRankings(year, week) ⇒wbb.getSchedule(year, month, day, group, seasontype, limit) ⇒wbb.getScoreboard(year, month, day, group, seasontype, limit) ⇒wbb.getConferences(year, group) ⇒wbb.getStandings(year, group) ⇒wbb.getTeamList(group) ⇒wbb.getTeamInfo(id) ⇒wbb.getTeamPlayers(id) ⇒wnba.getPlayByPlay(id) ⇒wnba.getBoxScore(id) ⇒wnba.getSummary(id) ⇒wnba.getSchedule(year, month, day) ⇒wnba.getScoreboard(year, month, day, limit) ⇒wnba.getStandings(year, group) ⇒wnba.getTeamList() ⇒wnba.getTeamInfo(id) ⇒wnba.getTeamPlayers(id) ⇒

The {sportsdataverse} Node.js Module

Saiem Gilani•Mar 12, 2021

38 min read•7552 words

sportsdataverse

Installation

npm install sportsdataverse

Documentation

For more information on the package and function reference, please see the sportsdataverse node.js documentation website

Follow the SportsDataverse on Twitter and star this repo

Citations

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}
}

Overview of Services

Support for the following data from ESPN's endpoints:

play-by-play (including shot location data when available)
scores
schedule
standings
rankings (not available for professional sports)

Recruiting data from 247Sports available for:

men's college basketball
college football

The following sports are available from ESPN:

Men's College Basketball
Women's College Basketball
College Football
WNBA
NBA
NFL
NHL
All team sports on the NCAA website:
- 'football'
- 'basketball-men'
- 'basketball-women'
- 'soccer-men'
- 'soccer-women'
- 'fieldhockey'
- 'volleyball-women'
- 'icehockey-men'
- 'icehockey-women'
- 'baseball'
- 'beach-volleyball'
- 'lacrosse-men'
- 'lacrosse-women'
- 'volleyball-men'

API Reference

Operations for College Football.

Kind: global namespace

cfb : object
- .getPlayByPlay(id) ⇒
- .getBoxScore(id) ⇒
- .getSummary(id) ⇒
- .getPicks(id) ⇒
- .getPlayerRankings(year, page, group, state) ⇒
- .getSchoolRankings(year, page) ⇒
- .getSchoolCommits(year, school) ⇒
- .getRankings(year, week) ⇒
- .getSchedule(year, month, day, group, seasontype) ⇒
- .getScoreboard(year, month, day, group, seasontype, limit) ⇒
- .getConferences(year, group) ⇒
- .getStandings(year, group) ⇒
- .getTeamList(group) ⇒
- .getTeamInfo(id) ⇒
- .getTeamPlayers(id)

cfb.getPlayByPlay(id) ⇒

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);

cfb.getBoxScore(id) ⇒

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);

cfb.getSummary(id) ⇒

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);

cfb.getPicks(id) ⇒

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);

cfb.getPlayerRankings(year, page, group, state) ⇒

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});

cfb.getSchoolRankings(year, page) ⇒

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});

cfb.getSchoolCommits(year, school) ⇒

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});

cfb.getRankings(year, week) ⇒

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)

cfb.getSchedule(year, month, day, group, seasontype) ⇒

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)

cfb.getScoreboard(year, month, day, group, seasontype, limit) ⇒

Gets the College Football scoreboard data for a specified date if available.

Kind: static method of cfb Returns: json

Example

const result = await sdv.cfb.getScoreboard(
year = 2019, month = 11, day = 16, group=80
)

cfb.getConferences(year, group) ⇒

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);

cfb.getStandings(year, group) ⇒

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);

cfb.getTeamList(group) ⇒

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);

cfb.getTeamInfo(id) ⇒

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);

cfb.getTeamPlayers(id)

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

mbb : object
- .getPlayByPlay(id) ⇒
- .getBoxScore(id) ⇒
- .getSummary(id) ⇒
- .getPicks(id) ⇒
- .getRankings(year, week) ⇒
- .getPlayerRankings(year, page, group) ⇒
- .getSchoolRankings(year, page) ⇒
- .getSchoolCommits(year, school) ⇒
- .getSchedule(year, month, day, group, seasontype) ⇒
- .getScoreboard(year, month, day, group, seasontype, limit) ⇒
- .getConferences(year, group) ⇒
- .getStandings(year, group) ⇒
- .getTeamList(group) ⇒
- .getTeamInfo(id) ⇒
- .getTeamPlayers(id) ⇒

mbb.getPlayByPlay(id) ⇒

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);

mbb.getBoxScore(id) ⇒

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);

mbb.getSummary(id) ⇒

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);

mbb.getPicks(id) ⇒

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);

mbb.getRankings(year, week) ⇒

Gets the Men's College Basketball rankings data for a specified year and week if available.

Kind: static method of mbb Returns: json

| Param | Type | Description | | --- | --- | --- | | year | * | Year (YYYY) | | week | * | Week |

Example

const result = await sdv.mbb.getRankings(
year = 2020, week = 15
)

mbb.getPlayerRankings(year, page, group) ⇒

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

Example

const result = await sdv.mbb.getPlayerRankings({year: 2016});

mbb.getSchoolRankings(year, page) ⇒

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});

mbb.getSchoolCommits(year, school) ⇒

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});

mbb.getSchedule(year, month, day, group, seasontype) ⇒

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
)

mbb.getScoreboard(year, month, day, group, seasontype, limit) ⇒

Gets the Men's College Basketball scoreboard data for a specified date if available.

Kind: static method of mbb Returns: json

Example

const result = await sdv.mbb.getScoreboard(
year = 2021, month = 02, day = 15, group=50
)

mbb.getConferences(year, group) ⇒

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);

mbb.getStandings(year, group) ⇒

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);

mbb.getTeamList(group) ⇒

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);

mbb.getTeamInfo(id) ⇒

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);

mbb.getTeamPlayers(id) ⇒

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 NBA.

Kind: global namespace

nba : object
- .getPlayByPlay(id) ⇒
- .getBoxScore(id) ⇒
- .getSummary(id) ⇒
- .getPicks(id) ⇒
- .getSchedule(year, month, day) ⇒
- .getScoreboard(year, month, day, limit) ⇒
- .getStandings(year, group) ⇒
- .getTeamList() ⇒
- .getTeamInfo(id) ⇒
- .getTeamPlayers(id) ⇒

nba.getPlayByPlay(id) ⇒

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);

nba.getBoxScore(id) ⇒

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);

nba.getSummary(id) ⇒

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);

nba.getPicks(id) ⇒

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);

nba.getSchedule(year, month, day) ⇒

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
)

nba.getScoreboard(year, month, day, limit) ⇒

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
)

nba.getStandings(year, group) ⇒

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);

nba.getTeamList() ⇒

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();

nba.getTeamInfo(id) ⇒

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);

nba.getTeamPlayers(id) ⇒

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

ncaa : object

ncaa.getRedirectUrl(url) ⇒

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);

ncaa.getInfo(game) ⇒

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);

ncaa.getBoxScore(game) ⇒

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);

ncaa.getPlayByPlay(game) ⇒

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);

ncaa.getTeamStats(game) ⇒

Gets the team stats 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.getTeamStats(5764053);

ncaa.getScoringSummary(game) ⇒

Gets the scoring summary 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.getScoringSummary(5764053);

ncaa.getScoreboard(sport, division, year, month, day) ⇒

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
)

ncaa.getSports() ⇒

Retrieves the set of sports and their abbreviations.

Kind: static method of ncaa Returns: json Example

const result = sdv.ncaa.getSports();

ncaa.getSeasons(sport) ⇒

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');

ncaa.getDivisions(sport, season) ⇒

Retrieves the Divisions for the selected sport and season.

Kind: static method of ncaa Returns: json

Example

const result = sdv.ncaa.getDivisions(sport='MBB', season='2017');

ncaa.getSportDivisionData(sport, season, division, rankingPeriod, type, gameHigh, category) ⇒

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);

ncaa.getPlayerData(sport, season, division, rankingPeriod, gameHigh, category) ⇒

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')

ncaa.getTeamData(sport, season, division, rankingPeriod, gameHigh, category) ⇒

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

nfl : object
- .getPlayByPlay(id) ⇒
- .getBoxScore(id) ⇒
- .getSummary(id) ⇒
- .getPicks(id) ⇒
- .getSchedule(year, month, day) ⇒
- .getScoreboard(year, month, day, limit) ⇒
- .getStandings(year, group) ⇒
- .getTeamList()
- .getTeamInfo(id) ⇒
- .getTeamPlayers(id) ⇒

nfl.getPlayByPlay(id) ⇒

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);

nfl.getBoxScore(id) ⇒

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);

nfl.getSummary(id) ⇒

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);

nfl.getPicks(id) ⇒

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);

nfl.getSchedule(year, month, day) ⇒

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
)

nfl.getScoreboard(year, month, day, limit) ⇒

Gets the NFL scoreboard data for a specified date if available.

Kind: static method of nfl Returns: json

Example

const result = await sdv.nfl.getScoreboard(
year = 2019, month = 11, day = 17
)

nfl.getStandings(year, group) ⇒

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);

nfl.getTeamList()

Gets the list of all NFL teams their identification info for ESPN.

Kind: static method of nfl Example

const result = await sdv.nfl.getTeamList();

nfl.getTeamInfo(id) ⇒

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);

nfl.getTeamPlayers(id) ⇒

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

nhl : object
- .getPlayByPlay(id) ⇒
- .getBoxScore(id) ⇒
- .getSummary(id) ⇒
- .getPicks(id) ⇒
- .getSchedule(year, month, day) ⇒
- .getScoreboard(year, month, day, limit) ⇒
- .getStandings(year, group) ⇒
- .getTeamList()
- .getTeamInfo(id) ⇒
- .getTeamPlayers(id) ⇒

nhl.getPlayByPlay(id) ⇒

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);

nhl.getBoxScore(id) ⇒

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);

nhl.getSummary(id) ⇒

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);

nhl.getPicks(id) ⇒

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);

nhl.getSchedule(year, month, day) ⇒

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
)

nhl.getScoreboard(year, month, day, limit) ⇒

Gets the NHL scoreboard data for a specified date if available.

Kind: static method of nhl Returns: json

Example

const result = await sdv.nhl.getScoreboard(
year = 2019, month = 11, day = 16
)

nhl.getStandings(year, group) ⇒

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);

nhl.getTeamList()

Gets the list of all NHL teams their identification info for ESPN.

Kind: static method of nhl Example

const result = await sdv.nhl.getTeamList();

nhl.getTeamInfo(id) ⇒

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);

nhl.getTeamPlayers(id) ⇒

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);

Operations for WBB.

Kind: global namespace

wbb : object
- .getPlayByPlay(id) ⇒
- .getBoxScore(id) ⇒
- .getSummary(id) ⇒
- .getRankings(year, week) ⇒
- .getSchedule(year, month, day, group, seasontype, limit) ⇒
- .getScoreboard(year, month, day, group, seasontype, limit) ⇒
- .getConferences(year, group) ⇒
- .getStandings(year, group) ⇒
- .getTeamList(group) ⇒
- .getTeamInfo(id) ⇒
- .getTeamPlayers(id) ⇒

wbb.getPlayByPlay(id) ⇒

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);

wbb.getBoxScore(id) ⇒

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);

wbb.getSummary(id) ⇒

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);

wbb.getRankings(year, week) ⇒

Gets the WBB rankings data for a specified year and week if available.

Kind: static method of wbb Returns: json

| Param | Type | Description | | --- | --- | --- | | year | * | Year (YYYY) | | week | * | Week |

Example

const result = await sdv.wbb.getRankings(
year = 2021, week = 4
)

wbb.getSchedule(year, month, day, group, seasontype, limit) ⇒

Gets the Women's College Basketball schedule data for a specified date if available.

Kind: static method of wbb Returns: json

Example

const result = await sdv.wbb.getSchedule(
year = 2021, month = 02, day = 15, group=50
)

wbb.getScoreboard(year, month, day, group, seasontype, limit) ⇒

Gets the Women's College Basketball scoreboard data for a specified date if available.

Kind: static method of wbb Returns: json

Example

const result = await sdv.wbb.getScoreboard(
year = 2019, month = 02, day = 15, group=50
)

wbb.getConferences(year, group) ⇒

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);

wbb.getStandings(year, group) ⇒

Gets the team standings for Women's College Basketball.

Kind: static method of wbb Returns: json

Example

const yr = 2020;
const result = await sdv.wbb.getStandings(year = yr);

wbb.getTeamList(group) ⇒

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);

wbb.getTeamInfo(id) ⇒

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);

wbb.getTeamPlayers(id) ⇒

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

wnba : object
- .getPlayByPlay(id) ⇒
- .getBoxScore(id) ⇒
- .getSummary(id) ⇒
- .getSchedule(year, month, day) ⇒
- .getScoreboard(year, month, day, limit) ⇒
- .getStandings(year, group) ⇒
- .getTeamList() ⇒
- .getTeamInfo(id) ⇒
- .getTeamPlayers(id) ⇒

wnba.getPlayByPlay(id) ⇒

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);

wnba.getBoxScore(id) ⇒

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);

wnba.getSummary(id) ⇒

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);

wnba.getSchedule(year, month, day) ⇒

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
)

wnba.getScoreboard(year, month, day, limit) ⇒

Gets the WNBA scoreboard data for a specified date if available.

Kind: static method of wnba Returns: json

Example

const result = await sdv.wnba.getScoreboard(
year = 2019, month = 07, day = 15
)

wnba.getStandings(year, group) ⇒

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);

wnba.getTeamList() ⇒

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();

wnba.getTeamInfo(id) ⇒

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);

wnba.getTeamPlayers(id) ⇒

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);

Table of Contents

The {sportsdataverse} Node.js Module

Follow the SportsDataverse on Twitter and star this repo

Share this post: