cfb.js v4.3.2

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

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