Neophobe Plebeian Mumpsimus
    Have ideas to improve npm?Join in the discussion! »

    cfb-data

    4.0.0 • Public • Published

    Update (2.0.0): Every function now returns a promise. Existing functionality should still be preserved, so it is safe to update from previous versions without making any changes.

    cfb-data

    • currently supports retrieving the following types of data:
      • detailed play-by-play
      • scores
      • standings
      • rankings
    • investigating future support for other types of data
      • team statistics
      • individual statistics

    contents

    1. install

    2. use

      a. games

      b. scores

      c. schedules

      d. conferences

      e. teams

      f. rankings

      g. standings

      h. recruiting

    3. license

    install

    npm install cfb-data

    use

    const cfb = require('cfb-data');

    games

    const gameId = 400763535;
     
    // get detailed play-by-play data for a game
    const result = await cfb.games.getPlayByPlay(gameId);
     
    // get box score
    const result = await cfb.games.getBoxScore(id);
     
    // get game all game data
    const summary = await cfb.games.getSummary(gameId);

    scores

    // get scoreboard data
    const inputs = {
        year: 2015,
        week: 5
    };
     
    const result = await cfb.scoreboard.getScoreboard(inputs);

    schedules

    const inputs = {
        groups: 80, // all FBS games
        year: 2017,
        week: 8
    };
     
    const result = await cfb.schedule.getSchedule(inputs);

    conferences

    const results = await cfb.scoreboard.getConferences();

    teams

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

    rankings

    // get rankings
    const inputs = {
        year: 2015,
        week: 10
    };
     
    const result = await cfb.rankings.getRankings(inputs);

    standings

    // get standings
    const inputs = {
        year: 2015
    };
     
    const result = await cfb.standings.getStandings(inputs);

    recruiting

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

    license

    MIT

    Install

    npm i cfb-data

    DownloadsWeekly Downloads

    0

    Version

    4.0.0

    License

    MIT

    Unpacked Size

    20.1 kB

    Total Files

    13

    Last publish

    Collaborators

    • avatar