CfbGPT
CfbGPT · GPT 작업
College Football Data API
API for accessing college football data
GET /stats/categoriesTeam stat categoriesStat category list
GET /stats/game/advancedAdvanced team metrics by gameAdvanced team game stats
GET /stats/season/advancedAdvanced team metrics by seasonAdvanced team season stats
GET /stats/seasonTeam statistics by seasonTeam season stats
GET /draft/picksList of NFL Draft picksList of NFL Draft picks
GET /draft/positionsList of NFL positionsList of NFL positions
GET /draft/teamsList of NFL teamsList of NFL teams
GET /metrics/wp/pregamePregame win probability dataPregame win probabilities
GET /ppa/players/seasonPlayer Predicated Points Added (PPA/EPA) broken down by seasonPredicted Points Added (PPA) by player season
GET /metrics/wpWin probability chart dataWin probability data
GET /ppa/players/gamesPlayer Predicated Points Added (PPA/EPA) broken down by gamePredicted Points Added (PPA) by player game
GET /ppa/gamesTeam Predicated Points Added (PPA/EPA) by gamePredicted Points Added (PPA) by game
GET /ppa/teamsPredicted Points Added (PPA/EPA) data by teamPredicted Points Added (PPA)
GET /ppa/predictedPredicted Points (i.e. Expected Points or EP)Predicted Points
GET /ratings/fpiHistorical FPI ratingsFPI rating data
GET /ratings/eloHistorical Elo ratingsElo rating data
GET /ratings/sp/conferencesHistorical SP+ ratings by conferenceGet average SP+ historical rating data by conference
GET /ratings/spHistorical SP+ ratingsSP+ rating data
GET /ratings/srsHistorical SRS ratingsSRS rating data (requires either a year or team specified)
GET /recruiting/teamsTeam recruiting rankings and ratingsTeam recruiting rankings
GET /recruiting/groupsRecruit position group ratingsGets a list of aggregated statistics by team and position grouping
GET /recruiting/playersPlayer recruiting ratings and rankingsGet player recruiting rankings and data. Requires either a year or team to be specified.
GET /linesBetting linesClosing betting lines
GET /player/portalTransfer portal by seasonTransfer portal by season
GET /stats/player/seasonPlayer stats by seasonSeason player stats
GET /player/usagePlayer usage metrics broken down by seasonPlayer usage metrics by season
GET /player/returningTeam returning production metricsReturning production metrics
GET /player/searchSearch for player informationSearch for players
GET /rankingsHistorical polls and rankingsPoll rankings
GET /venuesArena and venue informationVenues
GET /coachesCoaching records and historyCoaching history
GET /teams/matchupTeam matchup historyMatchup history
GET /rosterTeam rostersRoster data
GET /teams/fbsFBS team listInformation on major division teams
GET /talentTeam talent composite rankingsTeam talent composite
GET /teamsTeam informationGet team information
GET /conferencesConferencesGet conference list
GET /drivesDrive data and resultsGet game drives
GET /play/stat/typesTypes of player play statsType of play stats
GET /play/typesPlay typesTypes of plays
GET /play/statsPlay stats by playGets player stats associated by play (limit 1000)
GET /playsPlay by play dataGet play data and results
GET /live/playsLive metrics and PBP (Patreon only)Get live metrics and PBP
GET /game/box/advancedAdvanced box scoresGet advanced box score data
GET /games/teamsTeam game statsTeam stats broken down by game
GET /games/playersPlayer game statsPlayer stats broken down by game
GET /games/weatherGame weather information (Patreon only)Weather information for the hour of kickoff
GET /calendarSeason calendarGet calendar of weeks by season
GET /games/mediaGame media information and schedulesGame media information (TV, radio, etc)
GET /scoreboardLive game results (Patreon only)Get live game results
GET /recordsTeam recordsGet team records by year
GET /gamesGames and resultsGet game results
원본 API 스키마
{
"openapi": "3.0.0",
"info": {
"title": "College Football Data API",
"description": "API for accessing college football data",
"version": "4.5.1"
},
"servers": [
{
"url": "https://api.collegefootballdata.com"
}
],
"paths": {
"/stats/categories": {
"get": {
"operationId": "team_stat_categories",
"summary": "Team stat categories",
"description": "Stat category list",
"responses": {
"200": {
"description": "successful operation"
},
"400": {
"description": "error"
}
}
}
},
"/stats/game/advanced": {
"get": {
"operationId": "advanced_team_metrics_by_game",
"summary": "Advanced team metrics by game",
"description": "Advanced team game stats",
"responses": {
"200": {
"description": "successful operation"
},
"400": {
"description": "error"
}
},
"parameters": [
{
"name": "year",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "week",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "team",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "opponent",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "excludeGarbageTime",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "seasonType",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
]
}
},
"/stats/season/advanced": {
"get": {
"operationId": "advanced_team_metrics_by_season",
"summary": "Advanced team metrics by season",
"description": "Advanced team season stats",
"responses": {
"200": {
"description": "successful operation"
},
"400": {
"description": "error"
}
},
"parameters": [
{
"name": "year",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "team",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "excludeGarbageTime",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "startWeek",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "endWeek",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
]
}
},
"/stats/season": {
"get": {
"operationId": "team_statistics_by_season",
"summary": "Team statistics by season",
"description": "Team season stats",
"responses": {
"200": {
"description": "successful operation"
},
"400": {
"description": "error"
}
},
"parameters": [
{
"name": "year",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "team",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "conference",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "startWeek",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "endWeek",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
]
}
},
"/draft/picks": {
"get": {
"operationId": "list_of_nfl_draft_picks",
"summary": "List of NFL Draft picks",
"description": "List of NFL Draft picks",
"responses": {
"200": {
"description": "successful operation"
},
"400": {
"description": "error"
}
},
"parameters": [
{
"name": "year",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "nflTeam",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "college",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "conference",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "position",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
]
}
},
"/draft/positions": {
"get": {
"operationId": "list_of_nfl_positions",
"summary": "List of NFL positions",
"description": "List of NFL positions",
"responses": {
"200": {
"description": "successful operation"
},
"400": {
"description": "error"
}
}
}
},
"/draft/teams": {
"get": {
"operationId": "list_of_nfl_teams",
"summary": "List of NFL teams",
"description": "List of NFL teams",
"responses": {
"200": {
"description": "successful operation"
},
"400": {
"description": "error"
}
}
}
},
"/metrics/wp/pregame": {
"get": {
"operationId": "pregame_win_probability_data",
"summary": "Pregame win probability data",
"description": "Pregame win probabilities",
"responses": {
"200": {
"description": "successful operation"
},
"400": {
"description": "error"
}
},
"parameters": [
{
"name": "year",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "week",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "team",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "seasonType",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
]
}
},
"/ppa/players/season": {
"get": {
"operationId": "player_predicated_points_added_ppa_epa_broken_down_by_season",
"summary": "Player Predicated Points Added (PPA/EPA) broken down by season",
"description": "Predicted Points Added (PPA) by player season",
"responses": {
"200": {
"description": "successful operation"
},
"400": {
"description": "error"
}
},
"parameters": [
{
"name": "year",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "team",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "conference",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "position",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "playerId",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "threshold",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "excludeGarbageTime",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
]
}
},
"/metrics/wp": {
"get": {
"operationId": "win_probability_chart_data",
"summary": "Win probability chart data",
"description": "Win probability data",
"responses": {
"200": {
"description": "successful operation"
},
"400": {
"description": "error"
}
},
"parameters": [
{
"name": "gameId",
"in": "query",
"required": true,
"schema": {
"type": "string"
}
}
]
}
},
"/ppa/players/games": {
"get": {
"operationId": "player_predicated_points_added_ppa_epa_broken_down_by_game",
"summary": "Player Predicated Points Added (PPA/EPA) broken down by game",
"description": "Predicted Points Added (PPA) by player game",
"responses": {
"200": {
"description": "successful operation"
},
"400": {
"description": "error"
}
},
"parameters": [
{
"name": "year",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "week",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "team",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "position",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "playerId",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "threshold",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "excludeGarbageTime",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "seasonType",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
]
}
},
"/ppa/games": {
"get": {
"operationId": "team_predicated_points_added_ppa_epa_by_game",
"summary": "Team Predicated Points Added (PPA/EPA) by game",
"description": "Predicted Points Added (PPA) by game",
"responses": {
"200": {
"description": "successful operation"
},
"400": {
"description": "error"
}
},
"parameters": [
{
"name": "year",
"in": "query",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "week",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "team",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "conference",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "excludeGarbageTime",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "seasonType",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
]
}
},
"/ppa/teams": {
"get": {
"operationId": "predicted_points_added_ppa_epa_data_by_team",
"summary": "Predicted Points Added (PPA/EPA) data by team",
"description": "Predicted Points Added (PPA)",
"responses": {
"200": {
"description": "successful operation"
},
"400": {
"description": "error"
}
},
"parameters": [
{
"name": "year",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "team",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "conference",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "excludeGarbageTime",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
]
}
},
"/ppa/predicted": {
"get": {
"operationId": "predicted_points_expected_points_ep",
"summary": "Predicted Points (i.e. Expected Points or EP)",
"description": "Predicted Points",
"responses": {
"200": {
"description": "successful operation"
},
"400": {
"description": "error"
}
},
"parameters": [
{
"name": "down",
"in": "query",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "distance",
"in": "query",
"required": true,
"schema": {
"type": "string"
}
}
]
}
},
"/ratings/fpi": {
"get": {
"operationId": "historical_fpi_ratings",
"summary": "Historical FPI ratings",
"description": "FPI rating data",
"responses": {
"200": {
"description": "successful operation"
},
"400": {
"description": "error"
}
},
"parameters": [
{
"name": "year",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "team",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "conference",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
]
}
},
"/ratings/elo": {
"get": {
"operationId": "historical_elo_ratings",
"summary": "Historical Elo ratings",
"description": "Elo rating data",
"responses": {
"200": {
"description": "successful operation"
},
"400": {
"description": "error"
}
},
"parameters": [
{
"name": "year",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "week",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "seasonType",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "team",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "conference",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
]
}
},
"/ratings/sp/conferences": {
"get": {
"operationId": "historical_spplus_ratings_by_conference",
"summary": "Historical SP+ ratings by conference",
"description": "Get average SP+ historical rating data by conference",
"responses": {
"200": {
"description": "successful operation"
},
"400": {
"description": "error"
}
},
"parameters": [
{
"name": "year",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "conference",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
]
}
},
"/ratings/sp": {
"get": {
"operationId": "historical_spplus_ratings",
"summary": "Historical SP+ ratings",
"description": "SP+ rating data",
"responses": {
"200": {
"description": "successful operation"
},
"400": {
"description": "error"
}
},
"parameters": [
{
"name": "year",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "team",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
]
}
},
"/ratings/srs": {
"get": {
"operationId": "historical_srs_ratings",
"summary": "Historical SRS ratings",
"description": "SRS rating data (requires either a year or team specified)",
"responses": {
"200": {
"description": "successful operation"
},
"400": {
"description": "error"
}
},
"parameters": [
{
"name": "year",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "team",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "conference",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
]
}
},
"/recruiting/teams": {
"get": {
"operationId": "team_recruiting_rankings_and_ratings",
"summary": "Team recruiting rankings and ratings",
"description": "Team recruiting rankings",
"responses": {
"200": {
"description": "successful operation"
},
"400": {
"description": "error"
}
},
"parameters": [
{
"name": "year",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "team",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
]
}
},
"/recruiting/groups": {
"get": {
"operationId": "recruit_position_group_ratings",
"summary": "Recruit position group ratings",
"description": "Gets a list of aggregated statistics by team and position grouping",
"responses": {
"200": {
"description": "successful operation"
},
"400": {
"description": "error"
}
},
"parameters": [
{
"name": "startYear",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "endYear",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "team",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "conference",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
]
}
},
"/recruiting/players": {
"get": {
"operationId": "player_recruiting_ratings_and_rankings",
"summary": "Player recruiting ratings and rankings",
"description": "Get player recruiting rankings and data. Requires either a year or team to be specified.",
"responses": {
"200": {
"description": "successful operation"
},
"400": {
"description": "error"
}
},
"parameters": [
{
"name": "year",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "classification",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "position",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "state",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "team",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
]
}
},
"/lines": {
"get": {
"operationId": "betting_lines",
"summary": "Betting lines",
"description": "Closing betting lines",
"responses": {
"200": {
"description": "successful operation"
},
"400": {
"description": "error"
}
},
"parameters": [
{
"name": "gameId",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "year",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "week",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "seasonType",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "team",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "home",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "away",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "conference",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
]
}
},
"/player/portal": {
"get": {
"operationId": "transfer_portal_by_season",
"summary": "Transfer portal by season",
"description": "Transfer portal by season",
"responses": {
"200": {
"description": "successful operation"
},
"400": {
"description": "error"
}
},
"parameters": [
{
"name": "year",
"in": "query",
"required": true,
"schema": {
"type": "string"
}
}
]
}
},
"/stats/player/season": {
"get": {
"operationId": "player_stats_by_season",
"summary": "Player stats by season",
"description": "Season player stats",
"responses": {
"200": {
"description": "successful operation"
},
"400": {
"description": "error"
}
},
"parameters": [
{
"name": "year",
"in": "query",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "team",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "conference",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "startWeek",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "endWeek",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "seasonType",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "category",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
]
}
},
"/player/usage": {
"get": {
"operationId": "player_usage_metrics_broken_down_by_season",
"summary": "Player usage metrics broken down by season",
"description": "Player usage metrics by season",
"responses": {
"200": {
"description": "successful operation"
},
"400": {
"description": "error"
}
},
"parameters": [
{
"name": "year",
"in": "query",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "team",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "conference",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "position",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "playerId",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "excludeGarbageTime",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
]
}
},
"/player/returning": {
"get": {
"operationId": "team_returning_production_metrics",
"summary": "Team returning production metrics",
"description": "Returning production metrics",
"responses": {
"200": {
"description": "successful operation"
},
"400": {
"description": "error"
}
},
"parameters": [
{
"name": "year",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "team",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "conference",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
]
}
},
"/player/search": {
"get": {
"operationId": "search_for_player_information",
"summary": "Search for player information",
"description": "Search for players",
"responses": {
"200": {
"description": "successful operation"
},
"400": {
"description": "error"
}
},
"parameters": [
{
"name": "searchTerm",
"in": "query",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "position",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "team",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "year",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
]
}
},
"/rankings": {
"get": {
"operationId": "historical_polls_and_rankings",
"summary": "Historical polls and rankings",
"description": "Poll rankings",
"responses": {
"200": {
"description": "successful operation"
},
"400": {
"description": "error"
}
},
"parameters": [
{
"name": "year",
"in": "query",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "week",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "seasonType",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
]
}
},
"/venues": {
"get": {
"operationId": "arena_and_venue_information",
"summary": "Arena and venue information",
"description": "Venues",
"responses": {
"200": {
"description": "successful operation"
},
"400": {
"description": "error"
}
}
}
},
"/coaches": {
"get": {
"operationId": "coaching_records_and_history",
"summary": "Coaching records and history",
"description": "Coaching history",
"responses": {
"200": {
"description": "successful operation"
},
"400": {
"description": "error"
}
},
"parameters": [
{
"name": "firstName",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "lastName",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "team",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "year",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "minYear",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "maxYear",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
]
}
},
"/teams/matchup": {
"get": {
"operationId": "team_matchup_history",
"summary": "Team matchup history",
"description": "Matchup history",
"responses": {
"200": {
"description": "successful operation"
},
"400": {
"description": "error"
}
},
"parameters": [
{
"name": "team1",
"in": "query",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "team2",
"in": "query",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "minYear",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "maxYear",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
]
}
},
"/roster": {
"get": {
"operationId": "team_rosters",
"summary": "Team rosters",
"description": "Roster data",
"responses": {
"200": {
"description": "successful operation"
},
"400": {
"description": "error"
}
},
"parameters": [
{
"name": "team",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "year",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
]
}
},
"/teams/fbs": {
"get": {
"operationId": "fbs_team_list",
"summary": "FBS team list",
"description": "Information on major division teams",
"responses": {
"200": {
"description": "successful operation"
},
"400": {
"description": "error"
}
},
"parameters": [
{
"name": "year",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
]
}
},
"/talent": {
"get": {
"operationId": "team_talent_composite_rankings",
"summary": "Team talent composite rankings",
"description": "Team talent composite",
"responses": {
"200": {
"description": "successful operation"
},
"400": {
"description": "error"
}
},
"parameters": [
{
"name": "year",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
]
}
},
"/teams": {
"get": {
"operationId": "team_information",
"summary": "Team information",
"description": "Get team information",
"responses": {
"200": {
"description": "successful operation"
},
"400": {
"description": "error"
}
},
"parameters": [
{
"name": "conference",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
]
}
},
"/conferences": {
"get": {
"operationId": "conferences",
"summary": "Conferences",
"description": "Get conference list",
"responses": {
"200": {
"description": "successful operation"
},
"400": {
"description": "error"
}
}
}
},
"/drives": {
"get": {
"operationId": "drive_data_and_results",
"summary": "Drive data and results",
"description": "Get game drives",
"responses": {
"200": {
"description": "successful operation"
},
"400": {
"description": "error"
}
},
"parameters": [
{
"name": "seasonType",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "year",
"in": "query",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "week",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "team",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "offense",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "defense",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "conference",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "offenseConference",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "defenseConference",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "classification",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
]
}
},
"/play/stat/types": {
"get": {
"operationId": "types_of_player_play_stats",
"summary": "Types of player play stats",
"description": "Type of play stats",
"responses": {
"200": {
"description": "successful operation"
},
"400": {
"description": "error"
}
}
}
},
"/play/types": {
"get": {
"operationId": "play_types",
"summary": "Play types",
"description": "Types of plays",
"responses": {
"200": {
"description": "successful operation"
},
"400": {
"description": "error"
}
}
}
},
"/play/stats": {
"get": {
"operationId": "play_stats_by_play",
"summary": "Play stats by play",
"description": "Gets player stats associated by play (limit 1000)",
"responses": {
"200": {
"description": "successful operation"
},
"400": {
"description": "error"
}
},
"parameters": [
{
"name": "year",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "week",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "team",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "gameId",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "athleteId",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "statTypeId",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "seasonType",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "conference",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
]
}
},
"/plays": {
"get": {
"operationId": "play_by_play_data",
"summary": "Play by play data",
"description": "Get play data and results",
"responses": {
"200": {
"description": "successful operation"
},
"400": {
"description": "error"
}
},
"parameters": [
{
"name": "seasonType",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "year",
"in": "query",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "week",
"in": "query",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "team",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "offense",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "defense",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "conference",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "offenseConference",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "defenseConference",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "playType",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "classification",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
]
}
},
"/live/plays": {
"get": {
"operationId": "live_metrics_and_pbp_patreon_only",
"summary": "Live metrics and PBP (Patreon only)",
"description": "Get live metrics and PBP",
"responses": {
"200": {
"description": "successful operation"
},
"400": {
"description": "error"
}
},
"parameters": [
{
"name": "id",
"in": "query",
"required": true,
"schema": {
"type": "string"
}
}
]
}
},
"/game/box/advanced": {
"get": {
"operationId": "advanced_box_scores",
"summary": "Advanced box scores",
"description": "Get advanced box score data",
"responses": {
"200": {
"description": "successful operation"
},
"400": {
"description": "error"
}
},
"parameters": [
{
"name": "gameId",
"in": "query",
"required": true,
"schema": {
"type": "string"
}
}
]
}
},
"/games/teams": {
"get": {
"operationId": "team_game_stats",
"summary": "Team game stats",
"description": "Team stats broken down by game",
"responses": {
"200": {
"description": "successful operation"
},
"400": {
"description": "error"
}
},
"parameters": [
{
"name": "year",
"in": "query",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "week",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "seasonType",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "team",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "conference",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "gameId",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "classification",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
]
}
},
"/games/players": {
"get": {
"operationId": "player_game_stats",
"summary": "Player game stats",
"description": "Player stats broken down by game",
"responses": {
"200": {
"description": "successful operation"
},
"400": {
"description": "error"
}
},
"parameters": [
{
"name": "year",
"in": "query",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "week",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "seasonType",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "team",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "conference",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "category",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "gameId",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
]
}
},
"/games/weather": {
"get": {
"operationId": "game_weather_information_patreon_only",
"summary": "Game weather information (Patreon only)",
"description": "Weather information for the hour of kickoff",
"responses": {
"200": {
"description": "successful operation"
},
"400": {
"description": "error"
}
},
"parameters": [
{
"name": "gameId",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "year",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "week",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "seasonType",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "team",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "conference",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "classification",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
]
}
},
"/calendar": {
"get": {
"operationId": "season_calendar",
"summary": "Season calendar",
"description": "Get calendar of weeks by season",
"responses": {
"200": {
"description": "successful operation"
},
"400": {
"description": "error"
}
},
"parameters": [
{
"name": "year",
"in": "query",
"required": true,
"schema": {
"type": "string"
}
}
]
}
},
"/games/media": {
"get": {
"operationId": "game_media_information_and_schedules",
"summary": "Game media information and schedules",
"description": "Game media information (TV, radio, etc)",
"responses": {
"200": {
"description": "successful operation"
},
"400": {
"description": "error"
}
},
"parameters": [
{
"name": "year",
"in": "query",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "week",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "seasonType",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "team",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "conference",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "mediaType",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "classification",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
]
}
},
"/scoreboard": {
"get": {
"operationId": "live_game_results_patreon_only",
"summary": "Live game results (Patreon only)",
"description": "Get live game results",
"responses": {
"200": {
"description": "successful operation"
},
"400": {
"description": "error"
}
},
"parameters": [
{
"name": "classification",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "conference",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
]
}
},
"/records": {
"get": {
"operationId": "team_records",
"summary": "Team records",
"description": "Get team records by year",
"responses": {
"200": {
"description": "successful operation"
},
"400": {
"description": "error"
}
},
"parameters": [
{
"name": "year",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "team",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "conference",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
]
}
},
"/games": {
"get": {
"operationId": "games_and_results",
"summary": "Games and results",
"description": "Get game results",
"responses": {
"200": {
"description": "successful operation"
},
"400": {
"description": "error"
}
},
"parameters": [
{
"name": "year",
"in": "query",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "week",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "seasonType",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "team",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "home",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "away",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "conference",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "division",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "id",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
]
}
}
},
"components": {
"securitySchemes": {
"ApiKeyAuth": {
"type": "apiKey",
"in": "header",
"name": "Authorization"
}
},
"schemas": {}
}
}