cfb.js
Version:
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_
213 lines (176 loc) • 11.6 kB
Markdown
# 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](https://github.com/swagger-api/swagger-codegen) project:
- API version: 4.3.2
- Package version: 4.3.2
- Build package: io.swagger.codegen.languages.JavascriptClientCodegen
## Installation
### For [Node.js](https://nodejs.org/)
#### npm
To publish the library as a [npm](https://www.npmjs.com/),
please follow the procedure in ["Publishing npm packages"](https://docs.npmjs.com/getting-started/publishing-npm-packages).
Then install it via:
```shell
npm install cfb.js --save
```
### For browser
The library also works in the browser environment via npm and [browserify](http://browserify.org/). 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):
```shell
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:
```javascript
module: {
rules: [
{
parser: {
amd: false
}
}
]
}
```
## Getting Started
Please follow the [installation](#installation) instruction and execute the following JS code:
```javascript
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**](docs/BettingApi.md#getLines) | **GET** /lines | Betting lines
*cfb.CoachesApi* | [**getCoaches**](docs/CoachesApi.md#getCoaches) | **GET** /coaches | Coaching records and history
*cfb.ConferencesApi* | [**getConferences**](docs/ConferencesApi.md#getConferences) | **GET** /conferences | Conferences
*cfb.DraftApi* | [**getDraftPicks**](docs/DraftApi.md#getDraftPicks) | **GET** /draft/picks | List of NFL Draft picks
*cfb.DraftApi* | [**getNFLPositions**](docs/DraftApi.md#getNFLPositions) | **GET** /draft/positions | List of NFL positions
*cfb.DraftApi* | [**getNFLTeams**](docs/DraftApi.md#getNFLTeams) | **GET** /draft/teams | List of NFL teams
*cfb.DrivesApi* | [**getDrives**](docs/DrivesApi.md#getDrives) | **GET** /drives | Drive data and results
*cfb.GamesApi* | [**getAdvancedBoxScore**](docs/GamesApi.md#getAdvancedBoxScore) | **GET** /game/box/advanced | Advanced box scores
*cfb.GamesApi* | [**getCalendar**](docs/GamesApi.md#getCalendar) | **GET** /calendar | Season calendar
*cfb.GamesApi* | [**getGameMedia**](docs/GamesApi.md#getGameMedia) | **GET** /games/media | Game media information and schedules
*cfb.GamesApi* | [**getGameWeather**](docs/GamesApi.md#getGameWeather) | **GET** /games/weather | Game weather information (Patreon only)
*cfb.GamesApi* | [**getGames**](docs/GamesApi.md#getGames) | **GET** /games | Games and results
*cfb.GamesApi* | [**getPlayerGameStats**](docs/GamesApi.md#getPlayerGameStats) | **GET** /games/players | Player game stats
*cfb.GamesApi* | [**getScoreboard**](docs/GamesApi.md#getScoreboard) | **GET** /scoreboard | Live game results (Patreon only)
*cfb.GamesApi* | [**getTeamGameStats**](docs/GamesApi.md#getTeamGameStats) | **GET** /games/teams | Team game stats
*cfb.GamesApi* | [**getTeamRecords**](docs/GamesApi.md#getTeamRecords) | **GET** /records | Team records
*cfb.MetricsApi* | [**getGamePPA**](docs/MetricsApi.md#getGamePPA) | **GET** /ppa/games | Team Predicated Points Added (PPA/EPA) by game
*cfb.MetricsApi* | [**getPlayerGamePPA**](docs/MetricsApi.md#getPlayerGamePPA) | **GET** /ppa/players/games | Player Predicated Points Added (PPA/EPA) broken down by game
*cfb.MetricsApi* | [**getPlayerSeasonPPA**](docs/MetricsApi.md#getPlayerSeasonPPA) | **GET** /ppa/players/season | Player Predicated Points Added (PPA/EPA) broken down by season
*cfb.MetricsApi* | [**getPredictedPoints**](docs/MetricsApi.md#getPredictedPoints) | **GET** /ppa/predicted | Predicted Points (i.e. Expected Points or EP)
*cfb.MetricsApi* | [**getPregameWinProbabilities**](docs/MetricsApi.md#getPregameWinProbabilities) | **GET** /metrics/wp/pregame | Pregame win probability data
*cfb.MetricsApi* | [**getTeamPPA**](docs/MetricsApi.md#getTeamPPA) | **GET** /ppa/teams | Predicted Points Added (PPA/EPA) data by team
*cfb.MetricsApi* | [**getWinProbabilityData**](docs/MetricsApi.md#getWinProbabilityData) | **GET** /metrics/wp | Win probability chart data
*cfb.PlayersApi* | [**getPlayerSeasonStats**](docs/PlayersApi.md#getPlayerSeasonStats) | **GET** /stats/player/season | Player stats by season
*cfb.PlayersApi* | [**getPlayerUsage**](docs/PlayersApi.md#getPlayerUsage) | **GET** /player/usage | Player usage metrics broken down by season
*cfb.PlayersApi* | [**getReturningProduction**](docs/PlayersApi.md#getReturningProduction) | **GET** /player/returning | Team returning production metrics
*cfb.PlayersApi* | [**getTransferPortal**](docs/PlayersApi.md#getTransferPortal) | **GET** /player/portal | Transfer portal by season
*cfb.PlayersApi* | [**playerSearch**](docs/PlayersApi.md#playerSearch) | **GET** /player/search | Search for player information
*cfb.PlaysApi* | [**getLivePlays**](docs/PlaysApi.md#getLivePlays) | **GET** /live/plays | Live metrics and PBP (Patreon only)
*cfb.PlaysApi* | [**getPlayStatTypes**](docs/PlaysApi.md#getPlayStatTypes) | **GET** /play/stat/types | Types of player play stats
*cfb.PlaysApi* | [**getPlayStats**](docs/PlaysApi.md#getPlayStats) | **GET** /play/stats | Play stats by play
*cfb.PlaysApi* | [**getPlayTypes**](docs/PlaysApi.md#getPlayTypes) | **GET** /play/types | Play types
*cfb.PlaysApi* | [**getPlays**](docs/PlaysApi.md#getPlays) | **GET** /plays | Play by play data
*cfb.RankingsApi* | [**getRankings**](docs/RankingsApi.md#getRankings) | **GET** /rankings | Historical polls and rankings
*cfb.RatingsApi* | [**getConferenceSPRatings**](docs/RatingsApi.md#getConferenceSPRatings) | **GET** /ratings/sp/conferences | Historical SP+ ratings by conference
*cfb.RatingsApi* | [**getEloRatings**](docs/RatingsApi.md#getEloRatings) | **GET** /ratings/elo | Historical Elo ratings
*cfb.RatingsApi* | [**getSPRatings**](docs/RatingsApi.md#getSPRatings) | **GET** /ratings/sp | Historical SP+ ratings
*cfb.RatingsApi* | [**getSRSRatings**](docs/RatingsApi.md#getSRSRatings) | **GET** /ratings/srs | Historical SRS ratings
*cfb.RecruitingApi* | [**getRecruitingGroups**](docs/RecruitingApi.md#getRecruitingGroups) | **GET** /recruiting/groups | Recruit position group ratings
*cfb.RecruitingApi* | [**getRecruitingPlayers**](docs/RecruitingApi.md#getRecruitingPlayers) | **GET** /recruiting/players | Player recruiting ratings and rankings
*cfb.RecruitingApi* | [**getRecruitingTeams**](docs/RecruitingApi.md#getRecruitingTeams) | **GET** /recruiting/teams | Team recruiting rankings and ratings
*cfb.StatsApi* | [**getAdvancedTeamGameStats**](docs/StatsApi.md#getAdvancedTeamGameStats) | **GET** /stats/game/advanced | Advanced team metrics by game
*cfb.StatsApi* | [**getAdvancedTeamSeasonStats**](docs/StatsApi.md#getAdvancedTeamSeasonStats) | **GET** /stats/season/advanced | Advanced team metrics by season
*cfb.StatsApi* | [**getStatCategories**](docs/StatsApi.md#getStatCategories) | **GET** /stats/categories | Team stat categories
*cfb.StatsApi* | [**getTeamSeasonStats**](docs/StatsApi.md#getTeamSeasonStats) | **GET** /stats/season | Team statistics by season
*cfb.TeamsApi* | [**getFbsTeams**](docs/TeamsApi.md#getFbsTeams) | **GET** /teams/fbs | FBS team list
*cfb.TeamsApi* | [**getRoster**](docs/TeamsApi.md#getRoster) | **GET** /roster | Team rosters
*cfb.TeamsApi* | [**getTalent**](docs/TeamsApi.md#getTalent) | **GET** /talent | Team talent composite rankings
*cfb.TeamsApi* | [**getTeamMatchup**](docs/TeamsApi.md#getTeamMatchup) | **GET** /teams/matchup | Team matchup history
*cfb.TeamsApi* | [**getTeams**](docs/TeamsApi.md#getTeams) | **GET** /teams | Team information
*cfb.VenuesApi* | [**getVenues**](docs/VenuesApi.md#getVenues) | **GET** /venues | Arena and venue information
## Documentation for Models
- [cfb.AdvancedGameStat](docs/AdvancedGameStat.md)
- [cfb.AdvancedSeasonStat](docs/AdvancedSeasonStat.md)
- [cfb.BoxScore](docs/BoxScore.md)
- [cfb.Coach](docs/Coach.md)
- [cfb.Conference](docs/Conference.md)
- [cfb.ConferenceSPRating](docs/ConferenceSPRating.md)
- [cfb.DraftPick](docs/DraftPick.md)
- [cfb.DraftPosition](docs/DraftPosition.md)
- [cfb.DraftTeam](docs/DraftTeam.md)
- [cfb.Drive](docs/Drive.md)
- [cfb.Game](docs/Game.md)
- [cfb.GameLines](docs/GameLines.md)
- [cfb.GameMedia](docs/GameMedia.md)
- [cfb.GamePPA](docs/GamePPA.md)
- [cfb.GameWeather](docs/GameWeather.md)
- [cfb.LivePlayByPlay](docs/LivePlayByPlay.md)
- [cfb.Play](docs/Play.md)
- [cfb.PlayStat](docs/PlayStat.md)
- [cfb.PlayStatType](docs/PlayStatType.md)
- [cfb.PlayType](docs/PlayType.md)
- [cfb.PlayWP](docs/PlayWP.md)
- [cfb.Player](docs/Player.md)
- [cfb.PlayerGame](docs/PlayerGame.md)
- [cfb.PlayerGamePPA](docs/PlayerGamePPA.md)
- [cfb.PlayerSearchResult](docs/PlayerSearchResult.md)
- [cfb.PlayerSeasonPPA](docs/PlayerSeasonPPA.md)
- [cfb.PlayerSeasonStat](docs/PlayerSeasonStat.md)
- [cfb.PlayerUsage](docs/PlayerUsage.md)
- [cfb.PortalPlayer](docs/PortalPlayer.md)
- [cfb.PositionGroupRecruitingRating](docs/PositionGroupRecruitingRating.md)
- [cfb.PredictedPoints](docs/PredictedPoints.md)
- [cfb.PregameWP](docs/PregameWP.md)
- [cfb.RankingWeek](docs/RankingWeek.md)
- [cfb.Recruit](docs/Recruit.md)
- [cfb.ReturningProduction](docs/ReturningProduction.md)
- [cfb.ScoreboardGame](docs/ScoreboardGame.md)
- [cfb.Team](docs/Team.md)
- [cfb.TeamEloRating](docs/TeamEloRating.md)
- [cfb.TeamGame](docs/TeamGame.md)
- [cfb.TeamMatchup](docs/TeamMatchup.md)
- [cfb.TeamPPA](docs/TeamPPA.md)
- [cfb.TeamRecord](docs/TeamRecord.md)
- [cfb.TeamRecruitingRank](docs/TeamRecruitingRank.md)
- [cfb.TeamSPRating](docs/TeamSPRating.md)
- [cfb.TeamSRSRating](docs/TeamSRSRating.md)
- [cfb.TeamSeason](docs/TeamSeason.md)
- [cfb.TeamSeasonStat](docs/TeamSeasonStat.md)
- [cfb.TeamTalent](docs/TeamTalent.md)
- [cfb.Venue](docs/Venue.md)
- [cfb.Week](docs/Week.md)
## Documentation for Authorization
### ApiKeyAuth
- **Type**: API key
- **API key parameter name**: Authorization
- **Location**: HTTP header