UNPKG

18.1 kBJSONView Raw
1{"openapi":"3.0.0","info":{"contact":{"email":"admin@collegefootballdata.com"},"description":"This is an API for accessing all sorts of college football data. It currently has a wide array of data ranging from play by play to player statistics to game scores and more.","title":"College Football Data","version":"1.1.1","x-apisguru-categories":["open_data"],"x-logo":{"backgroundColor":"#FFFFFF","url":"https://collegefootballdata.com/Logo.png"},"x-origin":[{"format":"swagger","url":"https://api.collegefootballdata.com/api-docs.json","version":"2.0"}],"x-providerName":"collegefootballdata.com"},"tags":[{"description":"Games scores and statistics","name":"games"},{"description":"Drive data","name":"drives"},{"description":"Play by play data","name":"plays"},{"description":"Team information","name":"teams"},{"description":"Conference information","name":"conferences"},{"description":"Information about venues","name":"venues"},{"description":"Information about coaches","name":"coaches"},{"description":"Historical poll rankings","name":"rankings"}],"paths":{"/coaches":{"get":{"description":"Coaching history","operationId":"getCoaches","parameters":[{"description":"First name filter","in":"query","name":"firstName","required":false,"schema":{"type":"string"}},{"description":"Last name filter","in":"query","name":"lastName","required":false,"schema":{"type":"string"}},{"description":"Team name filter","in":"query","name":"team","required":false,"schema":{"type":"string"}},{"description":"Year filter","in":"query","name":"year","required":false,"schema":{"type":"integer"}},{"description":"Minimum year filter (inclusive)","in":"query","name":"minYear","required":false,"schema":{"type":"integer"}},{"description":"Maximum year filter (inclusive)","in":"query","name":"maxYear","required":false,"schema":{"type":"integer"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"properties":{"first_name":{"type":"string"},"last_name":{"type":"string"},"seasons":{"items":{"$ref":"#/components/schemas/TeamSeason"},"type":"array"}},"type":"object"}}}}},"summary":"Get coach records and school history","tags":["coaches"]}},"/conferences":{"get":{"description":"Conferences","operationId":"getConferences","responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/Conference"},"type":"array"}}}}},"summary":"Get conference list","tags":["conferences"]}},"/drives":{"get":{"description":"Drive results","operationId":"getDrvies","parameters":[{"description":"Season type filter","in":"query","name":"seasonType","required":false,"schema":{"type":"string","default":"regular"}},{"description":"Year filter","in":"query","name":"year","required":true,"schema":{"type":"integer"}},{"description":"Week filter","in":"query","name":"week","required":false,"schema":{"type":"integer"}},{"description":"Team filter","in":"query","name":"team","required":false,"schema":{"type":"string"}},{"description":"Offensive team filter","in":"query","name":"offense","required":false,"schema":{"type":"string"}},{"description":"Defensive team filter","in":"query","name":"defense","required":false,"schema":{"type":"string"}},{"description":"Conference filter","in":"query","name":"conference","required":false,"schema":{"type":"string"}},{"description":"Offensive conference filter","in":"query","name":"offenseConference","required":false,"schema":{"type":"string"}},{"description":"Defensive conference filter","in":"query","name":"defenseConference","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/Drive"},"type":"array"}}}}},"summary":"Get drive information","tags":["drives"]}},"/games":{"get":{"description":"Game results","operationId":"getGames","parameters":[{"description":"Year/season filter for games","in":"query","name":"year","required":true,"schema":{"type":"integer"}},{"description":"Week filter","in":"query","name":"week","required":false,"schema":{"type":"integer"}},{"description":"Season type filter (regular or postseason)","in":"query","name":"seasonType","required":false,"schema":{"type":"string","default":"regular"}},{"description":"Team","in":"query","name":"team","required":false,"schema":{"type":"string"}},{"description":"Home team filter","in":"query","name":"home","required":false,"schema":{"type":"string"}},{"description":"Away team filter","in":"query","name":"away","required":false,"schema":{"type":"string"}},{"description":"Conference abbreviation filter","in":"query","name":"conference","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/Game"},"type":"array"}}}},"400":{"description":"error"}},"summary":"Get game information","tags":["games"]}},"/games/players":{"get":{"description":"Player game stats","operationId":"getPlayerGameStats","parameters":[{"description":"Year/season filter for games","in":"query","name":"year","required":true,"schema":{"type":"integer"}},{"description":"Week filter","in":"query","name":"week","required":false,"schema":{"type":"integer"}},{"description":"Season type filter (regular or postseason)","in":"query","name":"seasonType","required":false,"schema":{"type":"string","default":"regular"}},{"description":"Team filter","in":"query","name":"team","required":false,"schema":{"type":"string"}},{"description":"Conference abbreviation filter","in":"query","name":"conference","required":false,"schema":{"type":"string"}},{"description":"Category filter (e.g defensive)","in":"query","name":"category","required":false,"schema":{"type":"string"}},{"description":"Game id filter","in":"query","name":"gameId","required":false,"schema":{"type":"integer"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/PlayerGame"},"type":"array"}}}},"400":{"description":"error"}},"summary":"Get player statistics by game","tags":["games"]}},"/games/teams":{"get":{"description":"Team game stats","operationId":"getTeamGameStats","parameters":[{"description":"Year/season filter for games","in":"query","name":"year","required":true,"schema":{"type":"integer"}},{"description":"Week filter","in":"query","name":"week","required":false,"schema":{"type":"integer"}},{"description":"Season type filter (regular or postseason)","in":"query","name":"seasonType","required":false,"schema":{"type":"string","default":"regular"}},{"description":"Team filter","in":"query","name":"team","required":false,"schema":{"type":"string"}},{"description":"Conference abbreviation filter","in":"query","name":"conference","required":false,"schema":{"type":"string"}},{"description":"Game id filter","in":"query","name":"gameId","required":false,"schema":{"type":"integer"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/TeamGame"},"type":"array"}}}},"400":{"description":"error"}},"summary":"Get team statistics by game","tags":["games"]}},"/play/types":{"get":{"description":"Types of plays","operationId":"getPlayTypes","responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/PlayType"},"type":"array"}}}}},"summary":"Get play type list","tags":["plays"]}},"/plays":{"get":{"description":"Play results","operationId":"getPlays","parameters":[{"description":"Season type filter","in":"query","name":"seasonType","required":false,"schema":{"type":"string","default":"regular"}},{"description":"Year filter","in":"query","name":"year","required":true,"schema":{"type":"integer"}},{"description":"Week filter","in":"query","name":"week","required":true,"schema":{"type":"integer"}},{"description":"Team filter","in":"query","name":"team","required":false,"schema":{"type":"string"}},{"description":"Offensive team filter","in":"query","name":"offense","required":false,"schema":{"type":"string"}},{"description":"Defensive team filter","in":"query","name":"defense","required":false,"schema":{"type":"string"}},{"description":"Conference filter","in":"query","name":"conference","required":false,"schema":{"type":"string"}},{"description":"Offensive conference filter","in":"query","name":"offenseConference","required":false,"schema":{"type":"string"}},{"description":"Defensive conference filter","in":"query","name":"defenseConference","required":false,"schema":{"type":"string"}},{"description":"Play type filter","in":"query","name":"playType","required":false,"schema":{"type":"integer"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/Play"},"type":"array"}}}}},"summary":"Get play information","tags":["plays"]}},"/rankings":{"get":{"description":"Poll rankings","operationId":"getRankings","parameters":[{"description":"Year/season filter for games","in":"query","name":"year","required":true,"schema":{"type":"integer"}},{"description":"Week filter","in":"query","name":"week","required":false,"schema":{"type":"integer"}},{"description":"Season type filter (regular or postseason)","in":"query","name":"seasonType","required":false,"schema":{"type":"string","default":"regular"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/RankingWeek"},"type":"array"}}}},"400":{"description":"error"}},"summary":"Get historical rankings and polls","tags":["rankings"]}},"/roster":{"get":{"description":"Roster data","operationId":"getRoster","parameters":[{"description":"Team name","in":"query","name":"team","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/Player"},"type":"array"}}}},"400":{"description":"error"}},"summary":"Get team roster","tags":["teams"]}},"/talent":{"get":{"description":"Team talent composite","operationId":"getTalent","parameters":[{"description":"Year filter","in":"query","name":"year","required":false,"schema":{"type":"integer"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/TeamTalent"},"type":"array"}}}},"400":{"description":"error"}},"summary":"Get team talent rankings","tags":["teams"]}},"/teams":{"get":{"description":"Team information","operationId":"getTeams","parameters":[{"description":"Conference abbreviation filter","in":"query","name":"conference","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/Team"},"type":"array"}}}},"400":{"description":"error"}},"summary":"Get team information","tags":["teams"]}},"/teams/matchup":{"get":{"description":"Matchup history","operationId":"getTeamMatchup","parameters":[{"description":"First team","in":"query","name":"team1","required":true,"schema":{"type":"string"}},{"description":"Second team","in":"query","name":"team2","required":true,"schema":{"type":"string"}},{"description":"Minimum year","in":"query","name":"minYear","required":false,"schema":{"type":"integer"}},{"description":"Maximum year","in":"query","name":"maxYear","required":false,"schema":{"type":"integer"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/TeamMatchup"},"type":"array"}}}},"400":{"description":"error"}},"summary":"Get matchup history","tags":["teams"]}},"/venues":{"get":{"description":"Venues","operationId":"getVenues","responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/Venue"},"type":"array"}}}},"400":{"description":"error"}},"summary":"Get venue information","tags":["venues"]}}},"servers":[{"url":"https://api.collegefootballdata.com/"}],"components":{"schemas":{"Conference":{"properties":{"abbreviation":{"type":"string"},"id":{"type":"integer"},"name":{"type":"string"},"short_name":{"type":"string"}},"type":"object"},"Drive":{"properties":{"defense":{"type":"string"},"defense_conference":{"type":"string"},"drive_result":{"type":"string"},"end_period":{"type":"integer"},"end_time":{"properties":{"minutes":{"type":"integer"},"seconds":{"type":"integer"}},"type":"object"},"end_yardline":{"type":"integer"},"game_id":{"type":"integer"},"id":{"type":"integer"},"offense":{"type":"string"},"offense_conference":{"type":"string"},"plays":{"type":"integer"},"scoring":{"type":"boolean"},"start_period":{"type":"integer"},"start_time":{"properties":{"minutes":{"type":"integer"},"seconds":{"type":"integer"}},"type":"object"},"start_yardline":{"type":"integer"},"yards":{"type":"integer"}},"type":"object"},"Game":{"properties":{"attendance":{"type":"integer"},"away_conference":{"type":"string"},"away_line_scores":{"items":{"type":"integer"},"type":"array"},"away_points":{"type":"integer"},"away_team":{"type":"string"},"conference_game":{"type":"boolean"},"home_conference":{"type":"string"},"home_line_scores":{"items":{"type":"integer"},"type":"array"},"home_points":{"type":"integer"},"home_team":{"type":"string"},"id":{"type":"integer"},"neutral_site":{"type":"boolean"},"season":{"type":"integer"},"season_type":{"type":"string"},"start_date":{"type":"string"},"venue":{"type":"string"},"venue_id":{"type":"integer"},"week":{"type":"integer"}},"type":"object"},"Play":{"properties":{"clock":{"properties":{"minutes":{"type":"integer"},"seconds":{"type":"integer"}},"type":"object"},"defense":{"type":"string"},"defense_conference":{"type":"string"},"defense_points":{"type":"integer"},"distance":{"type":"integer"},"down":{"type":"integer"},"drive_id":{"type":"integer"},"id":{"type":"integer"},"offense":{"type":"string"},"offense_conference":{"type":"string"},"offense_score":{"type":"integer"},"period":{"type":"integer"},"play_text":{"type":"string"},"play_type":{"type":"string"},"yard_line":{"type":"integer"},"yards_gained":{"type":"integer"}},"type":"object"},"PlayType":{"properties":{"abbreviation":{"type":"string"},"id":{"type":"integer"},"text":{"type":"string"}},"type":"object"},"Player":{"properties":{"city":{"type":"string"},"country":{"type":"string"},"first_name":{"type":"string"},"height":{"type":"integer"},"id":{"type":"integer"},"jersey":{"type":"integer"},"last_name":{"type":"string"},"position":{"type":"string"},"state":{"type":"string"},"weight":{"type":"integer"},"year":{"type":"integer"}},"type":"object"},"PlayerGame":{"properties":{"id":{"type":"integer"},"teams":{"items":{"properties":{"categories":{"items":{"properties":{"name":{"type":"string"},"types":{"items":{"properties":{"athletes":{"items":{"properties":{"id":{"type":"integer"},"name":{"type":"string"},"stat":{"type":"string"}},"type":"object"},"type":"array"},"name":{"type":"string"}},"type":"object"},"type":"array"}},"type":"object"},"type":"array"},"homeAway":{"type":"boolean"},"points":{"type":"integer"},"school":{"properties":{"conference":{"type":"string"},"name":{"type":"string"}},"type":"object"}},"type":"object"},"type":"array"}},"type":"object"},"RankingWeek":{"properties":{"polls":{"items":{"properties":{"poll":{"type":"string"},"ranks":{"items":{"properties":{"conference":{"type":"string"},"firstPlaceVotes":{"type":"integer"},"points":{"type":"integer"},"rank":{"type":"integer"},"school":{"type":"string"}},"type":"object"},"type":"array"}},"type":"object"},"type":"array"},"season":{"type":"integer"},"seasonType":{"type":"string"},"week":{"type":"integer"}},"type":"object"},"Team":{"properties":{"abbreviation":{"type":"string"},"alt_color":{"type":"string"},"color":{"type":"string"},"conference":{"type":"string"},"division":{"type":"string"},"logos":{"items":{"type":"string"},"type":"array"},"mascot":{"type":"string"},"school":{"type":"string"}},"type":"object"},"TeamGame":{"properties":{"id":{"type":"integer"},"teams":{"items":{"properties":{"conference":{"type":"string"},"homeAway":{"type":"boolean"},"points":{"type":"integer"},"school":{"type":"string"},"stats":{"items":{"properties":{"category":{"type":"string"},"stat":{"type":"string"}},"type":"object"},"type":"array"}},"type":"object"},"type":"array"}},"type":"object"},"TeamMatchup":{"properties":{"endYear":{"type":"integer"},"games":{"items":{"properties":{"awayScore":{"type":"integer"},"awayTeam":{"type":"string"},"date":{"type":"string"},"homeScore":{"type":"integer"},"homeTeam":{"type":"string"},"neutralSite":{"type":"boolean"},"season":{"type":"integer"},"season_type":{"type":"string"},"venue":{"type":"string"},"week":{"type":"integer"},"winner":{"type":"string"}},"type":"object"},"type":"array"},"startYear":{"type":"integer"},"team1":{"type":"string"},"team1Wins":{"type":"integer"},"team2":{"type":"string"},"team2Wins":{"type":"integer"},"ties":{"type":"integer"}},"type":"object"},"TeamSeason":{"properties":{"games":{"type":"integer"},"losses":{"type":"integer"},"postseason_rank":{"description":"Final ranking in the AP poll","type":"integer"},"preseason_rank":{"description":"Rank in the AP preseason poll","type":"integer"},"school":{"type":"string"},"ties":{"type":"integer"},"wins":{"type":"integer"},"year":{"type":"string"}},"type":"object"},"TeamTalent":{"properties":{"school":{"type":"string"},"talent":{"type":"number"},"year":{"type":"integer"}},"type":"object"},"Venue":{"properties":{"capacity":{"type":"integer"},"city":{"type":"string"},"country_code":{"type":"string"},"dome":{"type":"boolean"},"elevation":{"type":"integer"},"grass":{"type":"boolean"},"id":{"type":"integer"},"location":{"properties":{"x":{"type":"number"},"y":{"type":"number"}},"type":"object"},"name":{"type":"string"},"state":{"type":"string"},"year":{"type":"integer"},"zip":{"type":"string"}},"type":"object"}}}}
\No newline at end of file