cfbd 5.29.0 → 5.30.0

package/dist/sdk.gen.d.ts

@@ -1,5 +1,5 @@
 import { type OptionsLegacyParser } from '@hey-api/client-fetch';
-import type { GetAdjustedTeamSeasonStatsData, GetAdjustedTeamSeasonStatsResponse, GetAdjustedPlayerPassingStatsData, GetAdjustedPlayerPassingStatsResponse, GetAdjustedPlayerRushingStatsData, GetAdjustedPlayerRushingStatsResponse, GetKickerPaarData, GetKickerPaarResponse, GetTeamsData, GetTeamsResponse, GetFbsTeamsData, GetFbsTeamsResponse, GetMatchupData, GetTeamsAtsData, GetTeamsAtsResponse, GetRosterData, GetRosterResponse, GetConferencesData, GetConferencesResponse, GetTeamConferenceChangesData, GetTeamConferenceChangesResponse, GetTeamConferenceAffiliationsData, GetTeamConferenceAffiliationsResponse, GetTalentData, GetTalentResponse, GetVenuesResponse, GetPlayerSeasonStatsData, GetPlayerSeasonStatsResponse, GetPlayerSeasonSuccessRatesData, GetPlayerSeasonSuccessRatesResponse, GetPlayerGameSuccessRatesData, GetPlayerGameSuccessRatesResponse, GetTeamStatsData, GetTeamStatsResponse, GetCategoriesResponse, GetAdvancedSeasonStatsData, GetAdvancedSeasonStatsResponse, GetAdvancedGameStatsData, GetAdvancedGameStatsResponse, GetGameHavocStatsData, GetGameHavocStatsResponse, GetRushingPlaysData, GetRushingPlaysResponse, GetPlayerRushingBySeasonData, GetPlayerRushingBySeasonResponse, GetPlayerRushingByGameData, GetPlayerRushingByGameResponse, GetTeamRushingBySeasonData, GetTeamRushingBySeasonResponse, GetTeamRushingByGameData, GetTeamRushingByGameResponse, GetRecruitsData, GetRecruitsResponse, GetTeamRecruitingRankingsData, GetTeamRecruitingRankingsResponse, GetAggregatedTeamRecruitingRatingsData, GetAggregatedTeamRecruitingRatingsResponse, GetCoreData, GetCoreResponse, GetSpData, GetSpResponse, GetConferenceSpData, GetConferenceSpResponse, GetSrsData, GetSrsResponse, GetExpandedSrsData, GetExpandedSrsResponse, GetEloData, GetEloResponse, GetFpiData, GetFpiResponse, GetRankingsData, GetRankingsError, GetRankingsResponse, GetPlaysData, GetPlaysResponse, GetPlayTypesResponse, GetPlayStatsData, GetPlayStatsResponse, GetPlayStatTypesResponse, GetCfpPlayoffData, GetCfpPlayoffError, GetCfpParticipantsData, GetCfpParticipantsError, GetCfpParticipantsResponse, GetCfpGamesData, GetCfpGamesError, GetCfpGamesResponse, SearchPlayersData, SearchPlayersResponse, GetPlayerUsageData, GetPlayerUsageResponse, GetPlayerSeasonOverviewData, GetReturningProductionData, GetReturningProductionResponse, GetTransferPortalData, GetTransferPortalResponse, GetPassingPlaysData, GetPassingPlaysResponse, GetPlayerPassingBySeasonData, GetPlayerPassingBySeasonResponse, GetPlayerPassingByGameData, GetPlayerPassingByGameResponse, GetTeamPassingBySeasonData, GetTeamPassingBySeasonResponse, GetTeamPassingByGameData, GetTeamPassingByGameResponse, GetPredictedPointsData, GetPredictedPointsResponse, GetPredictedPointsAddedByTeamData, GetPredictedPointsAddedByTeamResponse, GetPredictedPointsAddedByGameData, GetPredictedPointsAddedByGameResponse, GetPredictedPointsAddedByPlayerGameData, GetPredictedPointsAddedByPlayerGameResponse, GetPredictedPointsAddedByPlayerSeasonData, GetPredictedPointsAddedByPlayerSeasonResponse, GetWinProbabilityData, GetWinProbabilityResponse, GetPregameWinProbabilitiesData, GetPregameWinProbabilitiesResponse, GetFieldGoalExpectedPointsResponse, GetLivePlaysData, GetLinesData, GetLinesResponse, GetUserInfoResponse, GetUsageData, GetUsageResponse, GetGamesData, GetGamesError, GetGamesResponse, GetGameTeamStatsData, GetGameTeamStatsResponse, GetGamePlayerStatsData, GetGamePlayerStatsResponse, GetMediaData, GetMediaResponse, GetWeatherData, GetWeatherResponse, GetRecordsData, GetRecordsResponse, GetCalendarData, GetCalendarResponse, GetScoreboardData, GetScoreboardResponse, GetDrivesData, GetDrivesResponse, GetDraftTeamsResponse, GetDraftPositionsResponse, GetDraftPicksData, GetDraftPicksResponse, GetCoachesData, GetCoachesResponse, GetCoachProfileData, GetCoachProfileError, GetCoachSeasonsData, GetCoachSeasonsError, GetCoachSeasonsResponse, GetCoachTenuresData, GetCoachTenuresError, GetCoachTenuresResponse, GetAdvancedBoxScoreData } from './types.gen';
+import type { GetAdjustedTeamSeasonStatsData, GetAdjustedTeamSeasonStatsResponse, GetAdjustedPlayerPassingStatsData, GetAdjustedPlayerPassingStatsResponse, GetAdjustedPlayerRushingStatsData, GetAdjustedPlayerRushingStatsResponse, GetKickerPaarData, GetKickerPaarResponse, GetTeamSeasonOverviewData, GetTeamSeasonOverviewError, GetTeamsData, GetTeamsResponse, GetFbsTeamsData, GetFbsTeamsResponse, GetMatchupData, GetTeamsAtsData, GetTeamsAtsResponse, GetRosterData, GetRosterResponse, GetConferencesData, GetConferencesResponse, GetTeamConferenceChangesData, GetTeamConferenceChangesResponse, GetTeamConferenceAffiliationsData, GetTeamConferenceAffiliationsResponse, GetTalentData, GetTalentResponse, GetVenuesResponse, GetPlayerSeasonStatsData, GetPlayerSeasonStatsResponse, GetPlayerSeasonSuccessRatesData, GetPlayerSeasonSuccessRatesResponse, GetPlayerGameSuccessRatesData, GetPlayerGameSuccessRatesResponse, GetTeamStatsData, GetTeamStatsResponse, GetCategoriesResponse, GetAdvancedSeasonStatsData, GetAdvancedSeasonStatsResponse, GetAdvancedGameStatsData, GetAdvancedGameStatsResponse, GetGameHavocStatsData, GetGameHavocStatsResponse, GetRushingPlaysData, GetRushingPlaysResponse, GetPlayerRushingBySeasonData, GetPlayerRushingBySeasonResponse, GetPlayerRushingByGameData, GetPlayerRushingByGameResponse, GetTeamRushingBySeasonData, GetTeamRushingBySeasonResponse, GetTeamRushingByGameData, GetTeamRushingByGameResponse, GetRecruitsData, GetRecruitsResponse, GetTeamRecruitingRankingsData, GetTeamRecruitingRankingsResponse, GetAggregatedTeamRecruitingRatingsData, GetAggregatedTeamRecruitingRatingsResponse, GetCoreData, GetCoreResponse, GetSpData, GetSpResponse, GetConferenceSpData, GetConferenceSpResponse, GetSrsData, GetSrsResponse, GetExpandedSrsData, GetExpandedSrsResponse, GetEloData, GetEloResponse, GetFpiData, GetFpiResponse, GetRankingsData, GetRankingsError, GetRankingsResponse, GetPlaysData, GetPlaysResponse, GetPlayTypesResponse, GetPlayStatsData, GetPlayStatsResponse, GetPlayStatTypesResponse, GetCfpPlayoffData, GetCfpPlayoffError, GetCfpParticipantsData, GetCfpParticipantsError, GetCfpParticipantsResponse, GetCfpGamesData, GetCfpGamesError, GetCfpGamesResponse, SearchPlayersData, SearchPlayersResponse, GetPlayerUsageData, GetPlayerUsageResponse, GetPlayerSeasonOverviewData, GetReturningProductionData, GetReturningProductionResponse, GetTransferPortalData, GetTransferPortalResponse, GetPassingPlaysData, GetPassingPlaysResponse, GetPlayerPassingBySeasonData, GetPlayerPassingBySeasonResponse, GetPlayerPassingByGameData, GetPlayerPassingByGameResponse, GetTeamPassingBySeasonData, GetTeamPassingBySeasonResponse, GetTeamPassingByGameData, GetTeamPassingByGameResponse, GetPredictedPointsData, GetPredictedPointsResponse, GetPredictedPointsAddedByTeamData, GetPredictedPointsAddedByTeamResponse, GetPredictedPointsAddedByGameData, GetPredictedPointsAddedByGameResponse, GetPredictedPointsAddedByPlayerGameData, GetPredictedPointsAddedByPlayerGameResponse, GetPredictedPointsAddedByPlayerSeasonData, GetPredictedPointsAddedByPlayerSeasonResponse, GetWinProbabilityData, GetWinProbabilityResponse, GetPregameWinProbabilitiesData, GetPregameWinProbabilitiesResponse, GetFieldGoalExpectedPointsResponse, GetLivePlaysData, GetLinesData, GetLinesResponse, GetUserInfoResponse, GetUsageData, GetUsageResponse, GetGamesData, GetGamesError, GetGamesResponse, GetGameTeamStatsData, GetGameTeamStatsResponse, GetGamePlayerStatsData, GetGamePlayerStatsResponse, GetMediaData, GetMediaResponse, GetWeatherData, GetWeatherResponse, GetRecordsData, GetRecordsResponse, GetCalendarData, GetCalendarResponse, GetScoreboardData, GetScoreboardResponse, GetDrivesData, GetDrivesResponse, GetDraftTeamsResponse, GetDraftPositionsResponse, GetDraftPicksData, GetDraftPicksResponse, GetCoachesData, GetCoachesResponse, GetCoachProfileData, GetCoachProfileError, GetCoachSeasonsData, GetCoachSeasonsError, GetCoachSeasonsResponse, GetCoachTenuresData, GetCoachTenuresError, GetCoachTenuresResponse, GetAdvancedBoxScoreData } from './types.gen';
 export declare const client: import("@hey-api/client-fetch").Client<Request, Response, unknown, import("@hey-api/client-fetch").RequestOptions<boolean, string>>;
 /**
  * Returns opponent-adjusted team statistics by season.
@@ -17,6 +17,10 @@ export declare const getAdjustedPlayerRushingStats: <ThrowOnError extends boolea
  * Returns Points Added Above Replacement (PAAR) ratings for kickers.
  */
 export declare const getKickerPaar: <ThrowOnError extends boolean = false>(options?: OptionsLegacyParser<GetKickerPaarData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetKickerPaarResponse, unknown, ThrowOnError>;
+/**
+ * Returns a stored full-season team overview, including postseason and garbage time.
+ */
+export declare const getTeamSeasonOverview: <ThrowOnError extends boolean = false>(options: OptionsLegacyParser<GetTeamSeasonOverviewData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<import("./types.gen").TeamSeasonOverview, GetTeamSeasonOverviewError, ThrowOnError>;
 /**
  * Returns team information and conference affiliations.
  */

package/dist/sdk.gen.js

@@ -12,8 +12,8 @@ var __assign = (this && this.__assign) || function () {
     return __assign.apply(this, arguments);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getReturningProduction = exports.getPlayerSeasonOverview = exports.getPlayerUsage = exports.searchPlayers = exports.getCfpGames = exports.getCfpParticipants = exports.getCfpPlayoff = exports.getPlayStatTypes = exports.getPlayStats = exports.getPlayTypes = exports.getPlays = exports.getRankings = exports.getFpi = exports.getElo = exports.getExpandedSrs = exports.getSrs = exports.getConferenceSp = exports.getSp = exports.getCore = exports.getAggregatedTeamRecruitingRatings = exports.getTeamRecruitingRankings = exports.getRecruits = exports.getTeamRushingByGame = exports.getTeamRushingBySeason = exports.getPlayerRushingByGame = exports.getPlayerRushingBySeason = exports.getRushingPlays = exports.getGameHavocStats = exports.getAdvancedGameStats = exports.getAdvancedSeasonStats = exports.getCategories = exports.getTeamStats = exports.getPlayerGameSuccessRates = exports.getPlayerSeasonSuccessRates = exports.getPlayerSeasonStats = exports.getVenues = exports.getTalent = exports.getTeamConferenceAffiliations = exports.getTeamConferenceChanges = exports.getConferences = exports.getRoster = exports.getTeamsAts = exports.getMatchup = exports.getFbsTeams = exports.getTeams = exports.getKickerPaar = exports.getAdjustedPlayerRushingStats = exports.getAdjustedPlayerPassingStats = exports.getAdjustedTeamSeasonStats = exports.client = void 0;
-exports.getAdvancedBoxScore = exports.getCoachTenures = exports.getCoachSeasons = exports.getCoachProfile = exports.getCoaches = exports.getDraftPicks = exports.getDraftPositions = exports.getDraftTeams = exports.getDrives = exports.getScoreboard = exports.getCalendar = exports.getRecords = exports.getWeather = exports.getMedia = exports.getGamePlayerStats = exports.getGameTeamStats = exports.getGames = exports.getUsage = exports.getUserInfo = exports.getLines = exports.getLivePlays = exports.getFieldGoalExpectedPoints = exports.getPregameWinProbabilities = exports.getWinProbability = exports.getPredictedPointsAddedByPlayerSeason = exports.getPredictedPointsAddedByPlayerGame = exports.getPredictedPointsAddedByGame = exports.getPredictedPointsAddedByTeam = exports.getPredictedPoints = exports.getTeamPassingByGame = exports.getTeamPassingBySeason = exports.getPlayerPassingByGame = exports.getPlayerPassingBySeason = exports.getPassingPlays = exports.getTransferPortal = void 0;
+exports.getPlayerSeasonOverview = exports.getPlayerUsage = exports.searchPlayers = exports.getCfpGames = exports.getCfpParticipants = exports.getCfpPlayoff = exports.getPlayStatTypes = exports.getPlayStats = exports.getPlayTypes = exports.getPlays = exports.getRankings = exports.getFpi = exports.getElo = exports.getExpandedSrs = exports.getSrs = exports.getConferenceSp = exports.getSp = exports.getCore = exports.getAggregatedTeamRecruitingRatings = exports.getTeamRecruitingRankings = exports.getRecruits = exports.getTeamRushingByGame = exports.getTeamRushingBySeason = exports.getPlayerRushingByGame = exports.getPlayerRushingBySeason = exports.getRushingPlays = exports.getGameHavocStats = exports.getAdvancedGameStats = exports.getAdvancedSeasonStats = exports.getCategories = exports.getTeamStats = exports.getPlayerGameSuccessRates = exports.getPlayerSeasonSuccessRates = exports.getPlayerSeasonStats = exports.getVenues = exports.getTalent = exports.getTeamConferenceAffiliations = exports.getTeamConferenceChanges = exports.getConferences = exports.getRoster = exports.getTeamsAts = exports.getMatchup = exports.getFbsTeams = exports.getTeams = exports.getTeamSeasonOverview = exports.getKickerPaar = exports.getAdjustedPlayerRushingStats = exports.getAdjustedPlayerPassingStats = exports.getAdjustedTeamSeasonStats = exports.client = void 0;
+exports.getAdvancedBoxScore = exports.getCoachTenures = exports.getCoachSeasons = exports.getCoachProfile = exports.getCoaches = exports.getDraftPicks = exports.getDraftPositions = exports.getDraftTeams = exports.getDrives = exports.getScoreboard = exports.getCalendar = exports.getRecords = exports.getWeather = exports.getMedia = exports.getGamePlayerStats = exports.getGameTeamStats = exports.getGames = exports.getUsage = exports.getUserInfo = exports.getLines = exports.getLivePlays = exports.getFieldGoalExpectedPoints = exports.getPregameWinProbabilities = exports.getWinProbability = exports.getPredictedPointsAddedByPlayerSeason = exports.getPredictedPointsAddedByPlayerGame = exports.getPredictedPointsAddedByGame = exports.getPredictedPointsAddedByTeam = exports.getPredictedPoints = exports.getTeamPassingByGame = exports.getTeamPassingBySeason = exports.getPlayerPassingByGame = exports.getPlayerPassingBySeason = exports.getPassingPlays = exports.getTransferPortal = exports.getReturningProduction = void 0;
 var client_fetch_1 = require("@hey-api/client-fetch");
 exports.client = (0, client_fetch_1.createClient)((0, client_fetch_1.createConfig)({ baseUrl: 'https://api.collegefootballdata.com' }));
 /**
@@ -48,6 +48,14 @@ var getKickerPaar = function (options) {
     return ((_a = options === null || options === void 0 ? void 0 : options.client) !== null && _a !== void 0 ? _a : exports.client).get(__assign(__assign({}, options), { url: '/wepa/players/kicking' }));
 };
 exports.getKickerPaar = getKickerPaar;
+/**
+ * Returns a stored full-season team overview, including postseason and garbage time.
+ */
+var getTeamSeasonOverview = function (options) {
+    var _a;
+    return ((_a = options === null || options === void 0 ? void 0 : options.client) !== null && _a !== void 0 ? _a : exports.client).get(__assign(__assign({}, options), { url: '/teams/season/overview' }));
+};
+exports.getTeamSeasonOverview = getTeamSeasonOverview;
 /**
  * Returns team information and conference affiliations.
  */

package/dist/types.gen.d.ts

@@ -2225,6 +2225,210 @@ export type TeamScoringOpportunities = {
     points: number;
     pointsPerOpportunity: number;
 };
+export type TeamSeasonAdvancedStats = {
+    season: number;
+    team: string;
+    conference: string;
+    offense: {
+        passingPlays: {
+            explosiveness: (number) | null;
+            successRate: number;
+            totalPPA: number;
+            ppa: number;
+            rate: number;
+        };
+        rushingPlays: {
+            explosiveness: (number) | null;
+            successRate: number;
+            totalPPA: number;
+            ppa: number;
+            rate: number;
+        };
+        passingDowns: {
+            explosiveness: (number) | null;
+            successRate: number;
+            ppa: number;
+            rate: number;
+        };
+        standardDowns: {
+            explosiveness: (number) | null;
+            successRate: number;
+            ppa: number;
+            rate: number;
+        };
+        havoc: {
+            db: (number) | null;
+            frontSeven: (number) | null;
+            total: (number) | null;
+        };
+        fieldPosition: {
+            averagePredictedPoints: (number) | null;
+            averageStart: (number) | null;
+        };
+        pointsPerOpportunity: number;
+        totalOpportunies: number;
+        openFieldYardsTotal: number;
+        openFieldYards: number;
+        secondLevelYardsTotal: number;
+        secondLevelYards: number;
+        lineYardsTotal: number;
+        lineYards: number;
+        stuffRate: number;
+        powerSuccess: (number) | null;
+        explosiveness: (number) | null;
+        successRate: number;
+        totalPPA: number;
+        ppa: number;
+        drives: number;
+        plays: number;
+    };
+    defense: {
+        passingPlays: {
+            explosiveness: (number) | null;
+            successRate: number;
+            totalPPA: number;
+            ppa: number;
+            rate: number;
+        };
+        rushingPlays: {
+            explosiveness: (number) | null;
+            successRate: number;
+            totalPPA: number;
+            ppa: number;
+            rate: number;
+        };
+        passingDowns: {
+            explosiveness: (number) | null;
+            successRate: number;
+            totalPPA: number;
+            ppa: number;
+            rate: number;
+        };
+        standardDowns: {
+            explosiveness: (number) | null;
+            successRate: number;
+            ppa: number;
+            rate: number;
+        };
+        havoc: {
+            db: (number) | null;
+            frontSeven: (number) | null;
+            total: (number) | null;
+        };
+        fieldPosition: {
+            averagePredictedPoints: (number) | null;
+            averageStart: (number) | null;
+        };
+        pointsPerOpportunity: number;
+        totalOpportunies: number;
+        openFieldYardsTotal: number;
+        openFieldYards: number;
+        secondLevelYardsTotal: number;
+        secondLevelYards: number;
+        lineYardsTotal: number;
+        lineYards: number;
+        stuffRate: number;
+        powerSuccess: (number) | null;
+        explosiveness: (number) | null;
+        successRate: number;
+        totalPPA: number;
+        ppa: number;
+        drives: number;
+        plays: number;
+    };
+};
+export type TeamSeasonOverview = {
+    advanced: TeamSeasonAdvancedStats;
+    players: {
+        usage: Array<TeamSeasonPlayerUsage>;
+        ppa: Array<TeamSeasonPlayerPpa>;
+    };
+    passing: ((TeamPassingSeason) | null);
+    rushing: ((TeamRushingSeason) | null);
+    /**
+     * Completed games for the requested season, including postseason.
+     */
+    record: {
+        ties: number;
+        losses: number;
+        wins: number;
+        games: number;
+    };
+    /**
+     * Current available ratings for the requested season; unavailable systems are null.
+     */
+    ratings: {
+        sp: {
+            specialTeams: TeamSeasonRankedRating;
+            defense: TeamSeasonRankedRating;
+            offense: TeamSeasonRankedRating;
+            overall: TeamSeasonRankedRating;
+        } | null;
+        srs: ((TeamSeasonRankedRating) | null);
+        /**
+         * Latest available postgame Elo from a completed game in this season.
+         */
+        elo: (number) | null;
+        core: {
+            defense: TeamSeasonRankedRating;
+            offense: TeamSeasonRankedRating;
+            overall: TeamSeasonRankedRating;
+        } | null;
+        /**
+         * FPI efficiencies (higher is better for all four), not the FPI points rating.
+         */
+        fpi: {
+            specialTeams: TeamSeasonRankedRating;
+            defense: TeamSeasonRankedRating;
+            offense: TeamSeasonRankedRating;
+            overall: TeamSeasonRankedRating;
+        } | null;
+    };
+    season: number;
+    teamId: number;
+    team: string;
+};
+export type TeamSeasonOverviewError = {
+    message: string;
+};
+export type TeamSeasonPlayerPpa = {
+    season: number;
+    id: string;
+    name: (string) | null;
+    position: (string) | null;
+    team: string;
+    conference: string;
+    averagePPA: TeamSeasonPlayerPpaValues;
+    totalPPA: TeamSeasonPlayerPpaValues;
+};
+export type TeamSeasonPlayerPpaValues = {
+    all: (number) | null;
+    pass: (number) | null;
+    rush: (number) | null;
+    firstDown: (number) | null;
+    secondDown: (number) | null;
+    thirdDown: (number) | null;
+    standardDowns: (number) | null;
+    passingDowns: (number) | null;
+};
+export type TeamSeasonPlayerUsage = {
+    season: number;
+    id: string;
+    name: (string) | null;
+    position: (string) | null;
+    team: string;
+    conference: string;
+    usage: {
+        passingDowns: (number) | null;
+        standardDowns: (number) | null;
+        thirdDown: (number) | null;
+        secondDown: (number) | null;
+        firstDown: (number) | null;
+        rush: (number) | null;
+        pass: (number) | null;
+        overall: (number) | null;
+    };
+};
 export type TeamSeasonPredictedPointsAdded = {
     season: number;
     conference: string;
@@ -2256,6 +2460,16 @@ export type TeamSeasonPredictedPointsAdded = {
         overall: number;
     };
 };
+export type TeamSeasonRankedRating = {
+    /**
+     * Rating/efficiency rounded to two decimal places.
+     */
+    rating: (number) | null;
+    /**
+     * Competition rank within the requested season and division, using unrounded values.
+     */
+    rank: (number) | null;
+};
 export type TeamSP = {
     year: number;
     team: string;
@@ -2465,6 +2679,22 @@ export type GetKickerPaarData = {
 };
 export type GetKickerPaarResponse = (Array<KickerPAAR>);
 export type GetKickerPaarError = unknown;
+export type GetTeamSeasonOverviewData = {
+    query: {
+        /**
+         * Team name.
+         */
+        team: string;
+        /**
+         * Season year.
+         */
+        year: number;
+    };
+};
+export type GetTeamSeasonOverviewResponse = (TeamSeasonOverview);
+export type GetTeamSeasonOverviewError = ({
+    message: string;
+} | TeamSeasonOverviewError);
 export type GetTeamsData = {
     query?: {
         /**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "cfbd",
-  "version": "5.29.0",
+  "version": "5.30.0",
   "description": "This API is in limited Beta for Patreon subscribers. It may have bugs and is subject to changes. API keys can be acquired from the CollegeFootballData.com website.",
   "repository": {
     "type": "git",

package/src/sdk.gen.ts

@@ -1,7 +1,7 @@
 // This file is auto-generated by @hey-api/openapi-ts
 
 import { createClient, createConfig, type OptionsLegacyParser } from '@hey-api/client-fetch';
-import type { GetAdjustedTeamSeasonStatsData, GetAdjustedTeamSeasonStatsError, GetAdjustedTeamSeasonStatsResponse, GetAdjustedPlayerPassingStatsData, GetAdjustedPlayerPassingStatsError, GetAdjustedPlayerPassingStatsResponse, GetAdjustedPlayerRushingStatsData, GetAdjustedPlayerRushingStatsError, GetAdjustedPlayerRushingStatsResponse, GetKickerPaarData, GetKickerPaarError, GetKickerPaarResponse, GetTeamsData, GetTeamsError, GetTeamsResponse, GetFbsTeamsData, GetFbsTeamsError, GetFbsTeamsResponse, GetMatchupData, GetMatchupError, GetMatchupResponse, GetTeamsAtsData, GetTeamsAtsError, GetTeamsAtsResponse, GetRosterData, GetRosterError, GetRosterResponse, GetConferencesData, GetConferencesError, GetConferencesResponse, GetTeamConferenceChangesData, GetTeamConferenceChangesError, GetTeamConferenceChangesResponse, GetTeamConferenceAffiliationsData, GetTeamConferenceAffiliationsError, GetTeamConferenceAffiliationsResponse, GetTalentData, GetTalentError, GetTalentResponse, GetVenuesError, GetVenuesResponse, GetPlayerSeasonStatsData, GetPlayerSeasonStatsError, GetPlayerSeasonStatsResponse, GetPlayerSeasonSuccessRatesData, GetPlayerSeasonSuccessRatesError, GetPlayerSeasonSuccessRatesResponse, GetPlayerGameSuccessRatesData, GetPlayerGameSuccessRatesError, GetPlayerGameSuccessRatesResponse, GetTeamStatsData, GetTeamStatsError, GetTeamStatsResponse, GetCategoriesError, GetCategoriesResponse, GetAdvancedSeasonStatsData, GetAdvancedSeasonStatsError, GetAdvancedSeasonStatsResponse, GetAdvancedGameStatsData, GetAdvancedGameStatsError, GetAdvancedGameStatsResponse, GetGameHavocStatsData, GetGameHavocStatsError, GetGameHavocStatsResponse, GetRushingPlaysData, GetRushingPlaysError, GetRushingPlaysResponse, GetPlayerRushingBySeasonData, GetPlayerRushingBySeasonError, GetPlayerRushingBySeasonResponse, GetPlayerRushingByGameData, GetPlayerRushingByGameError, GetPlayerRushingByGameResponse, GetTeamRushingBySeasonData, GetTeamRushingBySeasonError, GetTeamRushingBySeasonResponse, GetTeamRushingByGameData, GetTeamRushingByGameError, GetTeamRushingByGameResponse, GetRecruitsData, GetRecruitsError, GetRecruitsResponse, GetTeamRecruitingRankingsData, GetTeamRecruitingRankingsError, GetTeamRecruitingRankingsResponse, GetAggregatedTeamRecruitingRatingsData, GetAggregatedTeamRecruitingRatingsError, GetAggregatedTeamRecruitingRatingsResponse, GetCoreData, GetCoreError, GetCoreResponse, GetSpData, GetSpError, GetSpResponse, GetConferenceSpData, GetConferenceSpError, GetConferenceSpResponse, GetSrsData, GetSrsError, GetSrsResponse, GetExpandedSrsData, GetExpandedSrsError, GetExpandedSrsResponse, GetEloData, GetEloError, GetEloResponse, GetFpiData, GetFpiError, GetFpiResponse, GetRankingsData, GetRankingsError, GetRankingsResponse, GetPlaysData, GetPlaysError, GetPlaysResponse, GetPlayTypesError, GetPlayTypesResponse, GetPlayStatsData, GetPlayStatsError, GetPlayStatsResponse, GetPlayStatTypesError, GetPlayStatTypesResponse, GetCfpPlayoffData, GetCfpPlayoffError, GetCfpPlayoffResponse, GetCfpParticipantsData, GetCfpParticipantsError, GetCfpParticipantsResponse, GetCfpGamesData, GetCfpGamesError, GetCfpGamesResponse, SearchPlayersData, SearchPlayersError, SearchPlayersResponse, GetPlayerUsageData, GetPlayerUsageError, GetPlayerUsageResponse, GetPlayerSeasonOverviewData, GetPlayerSeasonOverviewError, GetPlayerSeasonOverviewResponse, GetReturningProductionData, GetReturningProductionError, GetReturningProductionResponse, GetTransferPortalData, GetTransferPortalError, GetTransferPortalResponse, GetPassingPlaysData, GetPassingPlaysError, GetPassingPlaysResponse, GetPlayerPassingBySeasonData, GetPlayerPassingBySeasonError, GetPlayerPassingBySeasonResponse, GetPlayerPassingByGameData, GetPlayerPassingByGameError, GetPlayerPassingByGameResponse, GetTeamPassingBySeasonData, GetTeamPassingBySeasonError, GetTeamPassingBySeasonResponse, GetTeamPassingByGameData, GetTeamPassingByGameError, GetTeamPassingByGameResponse, GetPredictedPointsData, GetPredictedPointsError, GetPredictedPointsResponse, GetPredictedPointsAddedByTeamData, GetPredictedPointsAddedByTeamError, GetPredictedPointsAddedByTeamResponse, GetPredictedPointsAddedByGameData, GetPredictedPointsAddedByGameError, GetPredictedPointsAddedByGameResponse, GetPredictedPointsAddedByPlayerGameData, GetPredictedPointsAddedByPlayerGameError, GetPredictedPointsAddedByPlayerGameResponse, GetPredictedPointsAddedByPlayerSeasonData, GetPredictedPointsAddedByPlayerSeasonError, GetPredictedPointsAddedByPlayerSeasonResponse, GetWinProbabilityData, GetWinProbabilityError, GetWinProbabilityResponse, GetPregameWinProbabilitiesData, GetPregameWinProbabilitiesError, GetPregameWinProbabilitiesResponse, GetFieldGoalExpectedPointsError, GetFieldGoalExpectedPointsResponse, GetLivePlaysData, GetLivePlaysError, GetLivePlaysResponse, GetLinesData, GetLinesError, GetLinesResponse, GetUserInfoError, GetUserInfoResponse, GetUsageData, GetUsageError, GetUsageResponse, GetGamesData, GetGamesError, GetGamesResponse, GetGameTeamStatsData, GetGameTeamStatsError, GetGameTeamStatsResponse, GetGamePlayerStatsData, GetGamePlayerStatsError, GetGamePlayerStatsResponse, GetMediaData, GetMediaError, GetMediaResponse, GetWeatherData, GetWeatherError, GetWeatherResponse, GetRecordsData, GetRecordsError, GetRecordsResponse, GetCalendarData, GetCalendarError, GetCalendarResponse, GetScoreboardData, GetScoreboardError, GetScoreboardResponse, GetDrivesData, GetDrivesError, GetDrivesResponse, GetDraftTeamsError, GetDraftTeamsResponse, GetDraftPositionsError, GetDraftPositionsResponse, GetDraftPicksData, GetDraftPicksError, GetDraftPicksResponse, GetCoachesData, GetCoachesError, GetCoachesResponse, GetCoachProfileData, GetCoachProfileError, GetCoachProfileResponse, GetCoachSeasonsData, GetCoachSeasonsError, GetCoachSeasonsResponse, GetCoachTenuresData, GetCoachTenuresError, GetCoachTenuresResponse, GetAdvancedBoxScoreData, GetAdvancedBoxScoreError, GetAdvancedBoxScoreResponse } from './types.gen';
+import type { GetAdjustedTeamSeasonStatsData, GetAdjustedTeamSeasonStatsError, GetAdjustedTeamSeasonStatsResponse, GetAdjustedPlayerPassingStatsData, GetAdjustedPlayerPassingStatsError, GetAdjustedPlayerPassingStatsResponse, GetAdjustedPlayerRushingStatsData, GetAdjustedPlayerRushingStatsError, GetAdjustedPlayerRushingStatsResponse, GetKickerPaarData, GetKickerPaarError, GetKickerPaarResponse, GetTeamSeasonOverviewData, GetTeamSeasonOverviewError, GetTeamSeasonOverviewResponse, GetTeamsData, GetTeamsError, GetTeamsResponse, GetFbsTeamsData, GetFbsTeamsError, GetFbsTeamsResponse, GetMatchupData, GetMatchupError, GetMatchupResponse, GetTeamsAtsData, GetTeamsAtsError, GetTeamsAtsResponse, GetRosterData, GetRosterError, GetRosterResponse, GetConferencesData, GetConferencesError, GetConferencesResponse, GetTeamConferenceChangesData, GetTeamConferenceChangesError, GetTeamConferenceChangesResponse, GetTeamConferenceAffiliationsData, GetTeamConferenceAffiliationsError, GetTeamConferenceAffiliationsResponse, GetTalentData, GetTalentError, GetTalentResponse, GetVenuesError, GetVenuesResponse, GetPlayerSeasonStatsData, GetPlayerSeasonStatsError, GetPlayerSeasonStatsResponse, GetPlayerSeasonSuccessRatesData, GetPlayerSeasonSuccessRatesError, GetPlayerSeasonSuccessRatesResponse, GetPlayerGameSuccessRatesData, GetPlayerGameSuccessRatesError, GetPlayerGameSuccessRatesResponse, GetTeamStatsData, GetTeamStatsError, GetTeamStatsResponse, GetCategoriesError, GetCategoriesResponse, GetAdvancedSeasonStatsData, GetAdvancedSeasonStatsError, GetAdvancedSeasonStatsResponse, GetAdvancedGameStatsData, GetAdvancedGameStatsError, GetAdvancedGameStatsResponse, GetGameHavocStatsData, GetGameHavocStatsError, GetGameHavocStatsResponse, GetRushingPlaysData, GetRushingPlaysError, GetRushingPlaysResponse, GetPlayerRushingBySeasonData, GetPlayerRushingBySeasonError, GetPlayerRushingBySeasonResponse, GetPlayerRushingByGameData, GetPlayerRushingByGameError, GetPlayerRushingByGameResponse, GetTeamRushingBySeasonData, GetTeamRushingBySeasonError, GetTeamRushingBySeasonResponse, GetTeamRushingByGameData, GetTeamRushingByGameError, GetTeamRushingByGameResponse, GetRecruitsData, GetRecruitsError, GetRecruitsResponse, GetTeamRecruitingRankingsData, GetTeamRecruitingRankingsError, GetTeamRecruitingRankingsResponse, GetAggregatedTeamRecruitingRatingsData, GetAggregatedTeamRecruitingRatingsError, GetAggregatedTeamRecruitingRatingsResponse, GetCoreData, GetCoreError, GetCoreResponse, GetSpData, GetSpError, GetSpResponse, GetConferenceSpData, GetConferenceSpError, GetConferenceSpResponse, GetSrsData, GetSrsError, GetSrsResponse, GetExpandedSrsData, GetExpandedSrsError, GetExpandedSrsResponse, GetEloData, GetEloError, GetEloResponse, GetFpiData, GetFpiError, GetFpiResponse, GetRankingsData, GetRankingsError, GetRankingsResponse, GetPlaysData, GetPlaysError, GetPlaysResponse, GetPlayTypesError, GetPlayTypesResponse, GetPlayStatsData, GetPlayStatsError, GetPlayStatsResponse, GetPlayStatTypesError, GetPlayStatTypesResponse, GetCfpPlayoffData, GetCfpPlayoffError, GetCfpPlayoffResponse, GetCfpParticipantsData, GetCfpParticipantsError, GetCfpParticipantsResponse, GetCfpGamesData, GetCfpGamesError, GetCfpGamesResponse, SearchPlayersData, SearchPlayersError, SearchPlayersResponse, GetPlayerUsageData, GetPlayerUsageError, GetPlayerUsageResponse, GetPlayerSeasonOverviewData, GetPlayerSeasonOverviewError, GetPlayerSeasonOverviewResponse, GetReturningProductionData, GetReturningProductionError, GetReturningProductionResponse, GetTransferPortalData, GetTransferPortalError, GetTransferPortalResponse, GetPassingPlaysData, GetPassingPlaysError, GetPassingPlaysResponse, GetPlayerPassingBySeasonData, GetPlayerPassingBySeasonError, GetPlayerPassingBySeasonResponse, GetPlayerPassingByGameData, GetPlayerPassingByGameError, GetPlayerPassingByGameResponse, GetTeamPassingBySeasonData, GetTeamPassingBySeasonError, GetTeamPassingBySeasonResponse, GetTeamPassingByGameData, GetTeamPassingByGameError, GetTeamPassingByGameResponse, GetPredictedPointsData, GetPredictedPointsError, GetPredictedPointsResponse, GetPredictedPointsAddedByTeamData, GetPredictedPointsAddedByTeamError, GetPredictedPointsAddedByTeamResponse, GetPredictedPointsAddedByGameData, GetPredictedPointsAddedByGameError, GetPredictedPointsAddedByGameResponse, GetPredictedPointsAddedByPlayerGameData, GetPredictedPointsAddedByPlayerGameError, GetPredictedPointsAddedByPlayerGameResponse, GetPredictedPointsAddedByPlayerSeasonData, GetPredictedPointsAddedByPlayerSeasonError, GetPredictedPointsAddedByPlayerSeasonResponse, GetWinProbabilityData, GetWinProbabilityError, GetWinProbabilityResponse, GetPregameWinProbabilitiesData, GetPregameWinProbabilitiesError, GetPregameWinProbabilitiesResponse, GetFieldGoalExpectedPointsError, GetFieldGoalExpectedPointsResponse, GetLivePlaysData, GetLivePlaysError, GetLivePlaysResponse, GetLinesData, GetLinesError, GetLinesResponse, GetUserInfoError, GetUserInfoResponse, GetUsageData, GetUsageError, GetUsageResponse, GetGamesData, GetGamesError, GetGamesResponse, GetGameTeamStatsData, GetGameTeamStatsError, GetGameTeamStatsResponse, GetGamePlayerStatsData, GetGamePlayerStatsError, GetGamePlayerStatsResponse, GetMediaData, GetMediaError, GetMediaResponse, GetWeatherData, GetWeatherError, GetWeatherResponse, GetRecordsData, GetRecordsError, GetRecordsResponse, GetCalendarData, GetCalendarError, GetCalendarResponse, GetScoreboardData, GetScoreboardError, GetScoreboardResponse, GetDrivesData, GetDrivesError, GetDrivesResponse, GetDraftTeamsError, GetDraftTeamsResponse, GetDraftPositionsError, GetDraftPositionsResponse, GetDraftPicksData, GetDraftPicksError, GetDraftPicksResponse, GetCoachesData, GetCoachesError, GetCoachesResponse, GetCoachProfileData, GetCoachProfileError, GetCoachProfileResponse, GetCoachSeasonsData, GetCoachSeasonsError, GetCoachSeasonsResponse, GetCoachTenuresData, GetCoachTenuresError, GetCoachTenuresResponse, GetAdvancedBoxScoreData, GetAdvancedBoxScoreError, GetAdvancedBoxScoreResponse } from './types.gen';
 
 export const client = createClient(createConfig({ baseUrl: 'https://api.collegefootballdata.com' }));
 
@@ -45,6 +45,16 @@ export const getKickerPaar = <ThrowOnError extends boolean = false>(options?: Op
     });
 };
 
+/**
+ * Returns a stored full-season team overview, including postseason and garbage time.
+ */
+export const getTeamSeasonOverview = <ThrowOnError extends boolean = false>(options: OptionsLegacyParser<GetTeamSeasonOverviewData, ThrowOnError>) => {
+    return (options?.client ?? client).get<GetTeamSeasonOverviewResponse, GetTeamSeasonOverviewError, ThrowOnError>({
+        ...options,
+        url: '/teams/season/overview'
+    });
+};
+
 /**
  * Returns team information and conference affiliations.
  */

package/src/types.gen.ts

@@ -2390,6 +2390,216 @@ export type TeamScoringOpportunities = {
     pointsPerOpportunity: number;
 };
 
+export type TeamSeasonAdvancedStats = {
+    season: number;
+    team: string;
+    conference: string;
+    offense: {
+        passingPlays: {
+            explosiveness: (number) | null;
+            successRate: number;
+            totalPPA: number;
+            ppa: number;
+            rate: number;
+        };
+        rushingPlays: {
+            explosiveness: (number) | null;
+            successRate: number;
+            totalPPA: number;
+            ppa: number;
+            rate: number;
+        };
+        passingDowns: {
+            explosiveness: (number) | null;
+            successRate: number;
+            ppa: number;
+            rate: number;
+        };
+        standardDowns: {
+            explosiveness: (number) | null;
+            successRate: number;
+            ppa: number;
+            rate: number;
+        };
+        havoc: {
+            db: (number) | null;
+            frontSeven: (number) | null;
+            total: (number) | null;
+        };
+        fieldPosition: {
+            averagePredictedPoints: (number) | null;
+            averageStart: (number) | null;
+        };
+        pointsPerOpportunity: number;
+        totalOpportunies: number;
+        openFieldYardsTotal: number;
+        openFieldYards: number;
+        secondLevelYardsTotal: number;
+        secondLevelYards: number;
+        lineYardsTotal: number;
+        lineYards: number;
+        stuffRate: number;
+        powerSuccess: (number) | null;
+        explosiveness: (number) | null;
+        successRate: number;
+        totalPPA: number;
+        ppa: number;
+        drives: number;
+        plays: number;
+    };
+    defense: {
+        passingPlays: {
+            explosiveness: (number) | null;
+            successRate: number;
+            totalPPA: number;
+            ppa: number;
+            rate: number;
+        };
+        rushingPlays: {
+            explosiveness: (number) | null;
+            successRate: number;
+            totalPPA: number;
+            ppa: number;
+            rate: number;
+        };
+        passingDowns: {
+            explosiveness: (number) | null;
+            successRate: number;
+            totalPPA: number;
+            ppa: number;
+            rate: number;
+        };
+        standardDowns: {
+            explosiveness: (number) | null;
+            successRate: number;
+            ppa: number;
+            rate: number;
+        };
+        havoc: {
+            db: (number) | null;
+            frontSeven: (number) | null;
+            total: (number) | null;
+        };
+        fieldPosition: {
+            averagePredictedPoints: (number) | null;
+            averageStart: (number) | null;
+        };
+        pointsPerOpportunity: number;
+        totalOpportunies: number;
+        openFieldYardsTotal: number;
+        openFieldYards: number;
+        secondLevelYardsTotal: number;
+        secondLevelYards: number;
+        lineYardsTotal: number;
+        lineYards: number;
+        stuffRate: number;
+        powerSuccess: (number) | null;
+        explosiveness: (number) | null;
+        successRate: number;
+        totalPPA: number;
+        ppa: number;
+        drives: number;
+        plays: number;
+    };
+};
+
+export type TeamSeasonOverview = {
+    advanced: TeamSeasonAdvancedStats;
+    players: {
+        usage: Array<TeamSeasonPlayerUsage>;
+        ppa: Array<TeamSeasonPlayerPpa>;
+    };
+    passing: ((TeamPassingSeason) | null);
+    rushing: ((TeamRushingSeason) | null);
+    /**
+     * Completed games for the requested season, including postseason.
+     */
+    record: {
+        ties: number;
+        losses: number;
+        wins: number;
+        games: number;
+    };
+    /**
+     * Current available ratings for the requested season; unavailable systems are null.
+     */
+    ratings: {
+        sp: {
+            specialTeams: TeamSeasonRankedRating;
+            defense: TeamSeasonRankedRating;
+            offense: TeamSeasonRankedRating;
+            overall: TeamSeasonRankedRating;
+        } | null;
+        srs: ((TeamSeasonRankedRating) | null);
+        /**
+         * Latest available postgame Elo from a completed game in this season.
+         */
+        elo: (number) | null;
+        core: {
+            defense: TeamSeasonRankedRating;
+            offense: TeamSeasonRankedRating;
+            overall: TeamSeasonRankedRating;
+        } | null;
+        /**
+         * FPI efficiencies (higher is better for all four), not the FPI points rating.
+         */
+        fpi: {
+            specialTeams: TeamSeasonRankedRating;
+            defense: TeamSeasonRankedRating;
+            offense: TeamSeasonRankedRating;
+            overall: TeamSeasonRankedRating;
+        } | null;
+    };
+    season: number;
+    teamId: number;
+    team: string;
+};
+
+export type TeamSeasonOverviewError = {
+    message: string;
+};
+
+export type TeamSeasonPlayerPpa = {
+    season: number;
+    id: string;
+    name: (string) | null;
+    position: (string) | null;
+    team: string;
+    conference: string;
+    averagePPA: TeamSeasonPlayerPpaValues;
+    totalPPA: TeamSeasonPlayerPpaValues;
+};
+
+export type TeamSeasonPlayerPpaValues = {
+    all: (number) | null;
+    pass: (number) | null;
+    rush: (number) | null;
+    firstDown: (number) | null;
+    secondDown: (number) | null;
+    thirdDown: (number) | null;
+    standardDowns: (number) | null;
+    passingDowns: (number) | null;
+};
+
+export type TeamSeasonPlayerUsage = {
+    season: number;
+    id: string;
+    name: (string) | null;
+    position: (string) | null;
+    team: string;
+    conference: string;
+    usage: {
+        passingDowns: (number) | null;
+        standardDowns: (number) | null;
+        thirdDown: (number) | null;
+        secondDown: (number) | null;
+        firstDown: (number) | null;
+        rush: (number) | null;
+        pass: (number) | null;
+        overall: (number) | null;
+    };
+};
+
 export type TeamSeasonPredictedPointsAdded = {
     season: number;
     conference: string;
@@ -2422,6 +2632,17 @@ export type TeamSeasonPredictedPointsAdded = {
     };
 };
 
+export type TeamSeasonRankedRating = {
+    /**
+     * Rating/efficiency rounded to two decimal places.
+     */
+    rating: (number) | null;
+    /**
+     * Competition rank within the requested season and division, using unrounded values.
+     */
+    rank: (number) | null;
+};
+
 export type TeamSP = {
     year: number;
     team: string;
@@ -2658,6 +2879,25 @@ export type GetKickerPaarResponse = (Array<KickerPAAR>);
 
 export type GetKickerPaarError = unknown;
 
+export type GetTeamSeasonOverviewData = {
+    query: {
+        /**
+         * Team name.
+         */
+        team: string;
+        /**
+         * Season year.
+         */
+        year: number;
+    };
+};
+
+export type GetTeamSeasonOverviewResponse = (TeamSeasonOverview);
+
+export type GetTeamSeasonOverviewError = ({
+    message: string;
+} | TeamSeasonOverviewError);
+
 export type GetTeamsData = {
     query?: {
         /**