Wondering what’s next for npm?Check out our public roadmap! »

    cbb-npm

    1.0.7 • Public • Published

    cbb-npm

    Support for the following data from ESPN's college basketball endpoints:

    • play-by-play (including shot location data when available)
    • scores
    • schedule
    • standings
    • rankings

    Support for the following data from ESPN's endpoints and recruiting data from 247Sports:

    • play-by-play (including shot location data when available)
    • scores
    • schedule
    • standings
    • rankings (not available for WNBA/NBA)

    Recruiting data from 247Sports available for:

    • men's college basketball
    • college football

    The following sports are available from ESPN:

    • College Basketball
    • Women's College Basketball
    • WNBA
    • NBA
    • 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'

    Installation

    npm install cbb-npm

    Usage

    const sdv = require('cbb-npm');

    Examples

    Men's College Basketball

    Examples

    CBB Games

    const gameId = 401260281;
    
    // get detailed play-by-play data for a game
    const result = await sdv.cbbGames.getPlayByPlay(gameId);
    
    // get box score
    const result = await sdv.cbbGames.getBoxScore(gameId);
    
    // get game all game data
    const summary = await sdv.cbbGames.getSummary(gameId);
    
    // get all game pickcenter data
    const picks = await sdv.cbbGames.getPicks(gameId);

    CBB Scores

    const inputs = {
        year: 2021,
        month: 02,
        day: 15
    };
    const result = await sdv.cbbScoreboard.getScoreboard(inputs);

    CBB Schedules

    const inputs = {
        groups: 50, // all Div-I games
        year: 2020,
        month: 12,
        day: 02
    };
    
    const result = await sdv.cbbSchedule.getSchedule(inputs);

    CBB Conferences

    const results = await sdv.cbbScoreboard.getConferences();

    CBB Teams

    // get list of teams
    const result = await sdv.cbbTeams.getTeamList();
    
    // get individual team data
    const teamId = 52;
    const result = await sdv.cbbTeams.getTeamInfo(teamId);
    
    // get team roster data
    const result = await sdv.cbbTeams.getTeamPlayers(teamId);

    CBB Rankings

    // get rankings
    const inputs = {
        year: 2020,
        week: 19
    };
    
    const result = await sdv.cbbRankings.getRankings(inputs);

    CBB Standings

    // get standings
    const inputs = {
        year: 2020
    };
    
    const result = await sdv.cbbStandings.getStandings(inputs);

    CBB Recruiting

    // get recruiting data from 247Composite
    // get player rankings
    const result = await sdv.cbbRecruiting.getPlayerRankings({
                        year: 2016
                    });
    
    const result = await sdv.cbbRecruiting.getPlayerRankings({
                        year: 2021,
                        position: "C"
                    });
    
    const result = await sdv.cbbRecruiting.getPlayerRankings({
                        year: 2020,
                        group: "JuniorCollege"
                    });
    
    // get school rankings
    const result = await sdv.cbbRecruiting.getSchoolRankings(2021);
    
    // get a school's commit list
    const result = await sdv.cbbRecruiting.getSchoolCommits('floridastate', 2020);

    Women's College Basketball

    Examples

    WBB Games

    const gameId = 401260281;
    
    // get detailed play-by-play data for a game
    const result = await sdv.wbbGames.getPlayByPlay(gameId);
    
    // get box score
    const result = await sdv.wbbGames.getBoxScore(gameId);
    
    // get game all game data
    const summary = await sdv.wbbGames.getSummary(gameId);

    WBB Scores

    const inputs = {
        year: 2021,
        month: 02,
        day: 15
    };
    const result = await sdv.wbbScoreboard.getScoreboard(inputs);

    WBB Schedules

    const inputs = {
        groups: 50, // all Div-I games
        year: 2020,
        month: 12,
        day: 02
    };
    
    const result = await sdv.wbbSchedule.getSchedule(inputs);

    WBB Conferences

    const results = await sdv.wbbScoreboard.getConferences();

    WBB Teams

    // get list of teams
    const result = await sdv.wbbTeams.getTeamList();
    
    // get individual team data
    const teamId = 52;
    const result = await sdv.wbbTeams.getTeamInfo(teamId);
    
    // get team roster data
    const result = await sdv.wbbTeams.getTeamPlayers(teamId);

    WBB Rankings

    // get rankings
    const inputs = {
        year: 2020,
        week: 19
    };
    
    const result = await sdv.wbbRankings.getRankings(inputs);

    WBB Standings

    // get standings
    const inputs = {
        year: 2020
    };
    
    const result = await sdv.wbbStandings.getStandings(inputs);

    NCAA Data

    Examples

    NCAA Scoreboard

    // acceptable sport names:
    // ['football' ,'basketball-men', 'basketball-women',
    //  'soccer-men','soccer-women','fieldhockey',
    //  'volleyball-women','beach-volleyball',
    //  'icehockey-men','icehockey-women',
    //  'baseball',  'volleyball-men',
    //  'lacrosse-men', 'lacrosse-women']
    // get ncaa scoreboard data for sport from above list
    // (default: 'basketball-men')
    const result = await sdv.ncaaScoreboard.getNcaaScoreboard(
        sport = 'basketball-men', division = 'd1', year = 2020, month = 02, day = 15
    )

    NCAA Games

    // NCAA game information for a given game id
    const result = await sdv.ncaaGame.getNcaaInfo(5764053);
    
    // NCAA box score for a given game id
    const result = await sdv.ncaaGame.getNcaaBoxScore(5764053);
    
    // NCAA play-by-play for a given game id
    const result = await sdv.ncaaGame.getNcaaPlayByPlay(5764053);
    
    // NCAA game team stats for a given game (appears to only exist for football)
    const result = await sdv.ncaaGame.getNcaaTeamStats(5772253);
    
    // NCAA game scoring summary for a given game (appears to only exist for football)
    const result = await sdv.ncaaGame.getNcaaScoringSummary(5772253);

    NBA

    Examples

    NBA Games

    const gameId = 401283399;
    
    // get detailed play-by-play data for a game
    const result = await sdv.nbaGames.getPlayByPlay(gameId);
    
    // get box score
    const result = await sdv.nbaGames.getBoxScore(gameId);
    
    // get game all game data
    const summary = await sdv.nbaGames.getSummary(gameId);
    
    // get all game pickcenter data
    const picks = await sdv.nbaGames.getPicks(gameId);

    NBA Scores

    const inputs = {
        year: 2021,
        month: 02,
        day: 15
    };
    const result = await sdv.nbaScoreboard.getScoreboard(inputs);

    NBA Schedules

    const inputs = {
        groups: 46, // nba group code
        year: 2020,
        month: 12,
        day: 02
    };
    
    const result = await sdv.nbaSchedule.getSchedule(inputs);

    NBA Conferences

    const results = await sdv.nbaScoreboard.getConferences();

    NBA Teams

    // get list of teams
    const result = await sdv.nbaTeams.getTeamList();
    
    // get individual team data
    const teamId = 16;
    const result = await sdv.nbaTeams.getTeamInfo(teamId);
    
    // get team roster data
    const result = await sdv.nbaTeams.getTeamPlayers(teamId);

    NBA Standings

    // get standings
    const inputs = {
        year: 2020
    };
    
    const result = await sdv.nbaStandings.getStandings(inputs);

    WNBA

    Examples

    WNBA Games

    const gameId = 401244185;
    
    // get detailed play-by-play data for a game
    const result = await sdv.wnbaGames.getPlayByPlay(gameId);
    
    // get box score
    const result = await sdv.wnbaGames.getBoxScore(gameId);
    
    // get game all game data
    const summary = await sdv.wnbaGames.getSummary(gameId);

    WNBA Scores

    const inputs = {
        year: 2021,
        month: 02,
        day: 15
    };
    const result = await sdv.wnbaScoreboard.getScoreboard(inputs);

    WNBA Schedules

    const inputs = {
        groups: 59, // wnba group code
        year: 2020,
        month: 12,
        day: 02
    };
    
    const result = await sdv.wnbaSchedule.getSchedule(inputs);

    WNBA Conferences

    const results = await sdv.wnbaScoreboard.getConferences();

    WNBA Teams

    // get list of teams
    const result = await sdv.wnbaTeams.getTeamList();
    
    // get individual team data
    const teamId = 14;
    const result = await sdv.wnbaTeams.getTeamInfo(teamId);
    
    // get team roster data
    const result = await sdv.wnbaTeams.getTeamPlayers(teamId);

    WNBA Standings

    // get standings
    const inputs = {
        year: 2020
    };
    
    const result = await sdv.wnbaStandings.getStandings(inputs);

    NFL

    Examples

    NFL Games

    const gameId = 401220403;
    
    // get detailed play-by-play data for a game
    const result = await sdv.nflGames.getPlayByPlay(gameId);
    
    // get box score
    const box = await sdv.nflGames.getBoxScore(gameId);
    
    // get all game data
    const summary = await sdv.nflGames.getSummary(gameId);
    
    // get all game pickcenter data
    const picks = await sdv.nflGames.getPicks(gameId);

    NFL Scores

    const inputs = {
        year: 2021,
        month: 02,
        day: 07
    };
    const result = await sdv.nflScoreboard.getScoreboard(inputs);

    NFL Schedules

    const inputs = {
        groups: 20, // nfl group code
        year: 2021,
        month: 02,
        day: 07
    };
    
    const result = await sdv.nflSchedule.getSchedule(inputs);

    NFL Conferences

    const results = await sdv.nflScoreboard.getConferences();

    NFL Teams

    // get list of teams
    const result = await sdv.nflTeams.getTeamList();
    
    // get individual team data
    const teamId = 27;
    const result = await sdv.nflTeams.getTeamInfo(teamId);
    
    // get team roster data
    const result = await sdv.nflTeams.getTeamPlayers(teamId);

    NFL Standings

    // get standings
    const inputs = {
        year: 2020
    };
    
    const result = await sdv.nflStandings.getStandings(inputs);

    College Football

    Examples

    CFB Games

    const gameId = 401256194;
    
    // get detailed play-by-play data for a game
    const result = await sdv.cfbGames.getPlayByPlay(gameId);
    
    // get box score
    const result = await sdv.cfbGames.getBoxScore(gameId);
    
    // get game all game data
    const summary = await sdv.cfbGames.getSummary(gameId);
    
    // get all game pickcenter data
    const picks = await sdv.cfbGames.getPicks(gameId);

    CFB Scores

    const inputs = {
        year: 2021,
        month: 12,
        day: 15
    };
    const result = await sdv.cfbScoreboard.getScoreboard(inputs);

    CFB Schedules

    const inputs = {
        groups: 80, // all Div-I games
        year: 2020,
        month: 12,
        day: 02
    };
    
    const result = await sdv.cfbSchedule.getSchedule(inputs);

    CFB Conferences

    const results = await sdv.cfbScoreboard.getConferences();

    CFB Teams

    // get list of teams
    const result = await sdv.cfbTeams.getTeamList();
    
    // get individual team data
    const teamId = 52;
    const result = await sdv.cfbTeams.getTeamInfo(teamId);
    
    // get team roster data
    const result = await sdv.cfbTeams.getTeamPlayers(teamId);

    CFB Rankings

    // get rankings
    const inputs = {
        year: 2020,
        week: 12
    };
    
    const result = await sdv.cfbRankings.getRankings(inputs);

    CFB Standings

    // get standings
    const inputs = {
        year: 2020
    };
    
    const result = await sdv.cfbStandings.getStandings(inputs);

    CFB Recruiting

    // get recruiting data from 247Composite
    // get player rankings
    const result = await sdv.cfbRecruiting.getPlayerRankings({
                        year: 2016
                    });
    
    const result = await sdv.cfbRecruiting.getPlayerRankings({
                        year: 2021,
                        position: "DT"
                    });
    
    const result = await sdv.cfbRecruiting.getPlayerRankings({
                        year: 2020,
                        group: "JuniorCollege"
                    });
    
    // get school rankings
    const result = await sdv.cfbRecruiting.getSchoolRankings(2021);
    
    // get a school's commit list
    const result = await sdv.cfbRecruiting.getSchoolCommits('floridastate', 2020);

    Install

    npm i cbb-npm

    DownloadsWeekly Downloads

    2

    Version

    1.0.7

    License

    MIT

    Unpacked Size

    89.3 kB

    Total Files

    47

    Last publish

    Collaborators

    • avatar