cfb.js

cfb - JavaScript client for cfb.js This is an API for accessing all sorts of college football data. Please note that API keys should be supplied with "Bearer " prepended (e.g. "Bearer your_key"). API keys can be acquired from the CollegeFootballData.com website. This SDK is automatically generated by the Swagger Codegen project:

• API version: 4.3.2
• Package version: 4.3.2
• Build package: io.swagger.codegen.languages.JavascriptClientCodegen

Installation

For Node.js

npm

To publish the library as a npm, please follow the procedure in "Publishing npm packages".

Then install it via:

npm install cfb.js --save

For browser

The library also works in the browser environment via npm and browserify. After following the above steps with Node.js and installing browserify with npm install -g browserify, perform the following (assuming main.js is your entry file, that's to say your javascript file where you actually use this library):

browserify main.js > bundle.js

Then include bundle.js in the HTML pages.

Webpack Configuration

Using Webpack you may encounter the following error: "Module not found: Error: Cannot resolve module", most certainly you should disable AMD loader. Add/merge the following section to your webpack config:

module: {
  rules: [
    {
      parser: {
        amd: false
      }
    }
  ]
}

Getting Started

Please follow the installation instruction and execute the following JS code:

var cfb = require('cfb.js');

var defaultClient = cfb.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "Bearer YOUR_API_KEY";

var api = new cfb.BettingApi()

var opts = { 
  'gameId': 56, // {Number} Game id filter
  'year': 56, // {Number} Year/season filter for games
  'week': 56, // {Number} Week filter
  'seasonType': "regular", // {String} Season type filter (regular or postseason)
  'team': "team_example", // {String} Team
  'home': "home_example", // {String} Home team filter
  'away': "away_example", // {String} Away team filter
  'conference': "conference_example" // {String} Conference abbreviation filter
};
api.getLines(opts).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

Documentation for API Endpoints

All URIs are relative to https://api.collegefootballdata.com

Class | Method | HTTP request | Description ------------ | ------------- | ------------- | ------------- cfb.BettingApi | getLines | GET /lines | Betting lines cfb.CoachesApi | getCoaches | GET /coaches | Coaching records and history cfb.ConferencesApi | getConferences | GET /conferences | Conferences cfb.DraftApi | getDraftPicks | GET /draft/picks | List of NFL Draft picks cfb.DraftApi | getNFLPositions | GET /draft/positions | List of NFL positions cfb.DraftApi | getNFLTeams | GET /draft/teams | List of NFL teams cfb.DrivesApi | getDrives | GET /drives | Drive data and results cfb.GamesApi | getAdvancedBoxScore | GET /game/box/advanced | Advanced box scores cfb.GamesApi | getCalendar | GET /calendar | Season calendar cfb.GamesApi | getGameMedia | GET /games/media | Game media information and schedules cfb.GamesApi | getGameWeather | GET /games/weather | Game weather information (Patreon only) cfb.GamesApi | getGames | GET /games | Games and results cfb.GamesApi | getPlayerGameStats | GET /games/players | Player game stats cfb.GamesApi | getScoreboard | GET /scoreboard | Live game results (Patreon only) cfb.GamesApi | getTeamGameStats | GET /games/teams | Team game stats cfb.GamesApi | getTeamRecords | GET /records | Team records cfb.MetricsApi | getGamePPA | GET /ppa/games | Team Predicated Points Added (PPA/EPA) by game cfb.MetricsApi | getPlayerGamePPA | GET /ppa/players/games | Player Predicated Points Added (PPA/EPA) broken down by game cfb.MetricsApi | getPlayerSeasonPPA | GET /ppa/players/season | Player Predicated Points Added (PPA/EPA) broken down by season cfb.MetricsApi | getPredictedPoints | GET /ppa/predicted | Predicted Points (i.e. Expected Points or EP) cfb.MetricsApi | getPregameWinProbabilities | GET /metrics/wp/pregame | Pregame win probability data cfb.MetricsApi | getTeamPPA | GET /ppa/teams | Predicted Points Added (PPA/EPA) data by team cfb.MetricsApi | getWinProbabilityData | GET /metrics/wp | Win probability chart data cfb.PlayersApi | getPlayerSeasonStats | GET /stats/player/season | Player stats by season cfb.PlayersApi | getPlayerUsage | GET /player/usage | Player usage metrics broken down by season cfb.PlayersApi | getReturningProduction | GET /player/returning | Team returning production metrics cfb.PlayersApi | getTransferPortal | GET /player/portal | Transfer portal by season cfb.PlayersApi | playerSearch | GET /player/search | Search for player information cfb.PlaysApi | getLivePlays | GET /live/plays | Live metrics and PBP (Patreon only) cfb.PlaysApi | getPlayStatTypes | GET /play/stat/types | Types of player play stats cfb.PlaysApi | getPlayStats | GET /play/stats | Play stats by play cfb.PlaysApi | getPlayTypes | GET /play/types | Play types cfb.PlaysApi | getPlays | GET /plays | Play by play data cfb.RankingsApi | getRankings | GET /rankings | Historical polls and rankings cfb.RatingsApi | getConferenceSPRatings | GET /ratings/sp/conferences | Historical SP+ ratings by conference cfb.RatingsApi | getEloRatings | GET /ratings/elo | Historical Elo ratings cfb.RatingsApi | getSPRatings | GET /ratings/sp | Historical SP+ ratings cfb.RatingsApi | getSRSRatings | GET /ratings/srs | Historical SRS ratings cfb.RecruitingApi | getRecruitingGroups | GET /recruiting/groups | Recruit position group ratings cfb.RecruitingApi | getRecruitingPlayers | GET /recruiting/players | Player recruiting ratings and rankings cfb.RecruitingApi | getRecruitingTeams | GET /recruiting/teams | Team recruiting rankings and ratings cfb.StatsApi | getAdvancedTeamGameStats | GET /stats/game/advanced | Advanced team metrics by game cfb.StatsApi | getAdvancedTeamSeasonStats | GET /stats/season/advanced | Advanced team metrics by season cfb.StatsApi | getStatCategories | GET /stats/categories | Team stat categories cfb.StatsApi | getTeamSeasonStats | GET /stats/season | Team statistics by season cfb.TeamsApi | getFbsTeams | GET /teams/fbs | FBS team list cfb.TeamsApi | getRoster | GET /roster | Team rosters cfb.TeamsApi | getTalent | GET /talent | Team talent composite rankings cfb.TeamsApi | getTeamMatchup | GET /teams/matchup | Team matchup history cfb.TeamsApi | getTeams | GET /teams | Team information cfb.VenuesApi | getVenues | GET /venues | Arena and venue information

Documentation for Models

• cfb.AdvancedGameStat
• cfb.AdvancedSeasonStat
• cfb.BoxScore
• cfb.Coach
• cfb.Conference
• cfb.ConferenceSPRating
• cfb.DraftPick
• cfb.DraftPosition
• cfb.DraftTeam
• cfb.Drive
• cfb.Game
• cfb.GameLines
• cfb.GameMedia
• cfb.GamePPA
• cfb.GameWeather
• cfb.LivePlayByPlay
• cfb.Play
• cfb.PlayStat
• cfb.PlayStatType
• cfb.PlayType
• cfb.PlayWP
• cfb.Player
• cfb.PlayerGame
• cfb.PlayerGamePPA
• cfb.PlayerSearchResult
• cfb.PlayerSeasonPPA
• cfb.PlayerSeasonStat
• cfb.PlayerUsage
• cfb.PortalPlayer
• cfb.PositionGroupRecruitingRating
• cfb.PredictedPoints
• cfb.PregameWP
• cfb.RankingWeek
• cfb.Recruit
• cfb.ReturningProduction
• cfb.ScoreboardGame
• cfb.Team
• cfb.TeamEloRating
• cfb.TeamGame
• cfb.TeamMatchup
• cfb.TeamPPA
• cfb.TeamRecord
• cfb.TeamRecruitingRank
• cfb.TeamSPRating
• cfb.TeamSRSRating
• cfb.TeamSeason
• cfb.TeamSeasonStat
• cfb.TeamTalent
• cfb.Venue
• cfb.Week

Documentation for Authorization

ApiKeyAuth

• Type: API key
• API key parameter name: Authorization
• Location: HTTP header