cfbd 5.16.0 → 5.18.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, GetConferencesResponse, GetTalentData, GetTalentResponse, GetVenuesResponse, GetPlayerSeasonStatsData, GetPlayerSeasonStatsResponse, GetPlayerSeasonSuccessRatesData, GetPlayerSeasonSuccessRatesResponse, GetPlayerGameSuccessRatesData, GetPlayerGameSuccessRatesResponse, GetTeamStatsData, GetTeamStatsResponse, GetCategoriesResponse, GetAdvancedSeasonStatsData, GetAdvancedSeasonStatsResponse, GetAdvancedGameStatsData, GetAdvancedGameStatsResponse, GetGameHavocStatsData, GetGameHavocStatsResponse, GetRecruitsData, GetRecruitsResponse, GetTeamRecruitingRankingsData, GetTeamRecruitingRankingsResponse, GetAggregatedTeamRecruitingRatingsData, GetAggregatedTeamRecruitingRatingsResponse, GetSpData, GetSpResponse, GetConferenceSpData, GetConferenceSpResponse, GetSrsData, GetSrsResponse, GetEloData, GetEloResponse, GetFpiData, GetFpiResponse, GetRankingsData, GetRankingsResponse, GetPlaysData, GetPlaysResponse, GetPlayTypesResponse, GetPlayStatsData, GetPlayStatsResponse, GetPlayStatTypesResponse, SearchPlayersData, SearchPlayersResponse, GetPlayerUsageData, GetPlayerUsageResponse, GetPlayerSeasonOverviewData, GetReturningProductionData, GetReturningProductionResponse, GetTransferPortalData, GetTransferPortalResponse, GetPredictedPointsData, GetPredictedPointsResponse, GetPredictedPointsAddedByTeamData, GetPredictedPointsAddedByTeamResponse, GetPredictedPointsAddedByGameData, GetPredictedPointsAddedByGameResponse, GetPredictedPointsAddedByPlayerGameData, GetPredictedPointsAddedByPlayerGameResponse, GetPredictedPointsAddedByPlayerSeasonData, GetPredictedPointsAddedByPlayerSeasonResponse, GetWinProbabilityData, GetWinProbabilityResponse, GetPregameWinProbabilitiesData, GetPregameWinProbabilitiesResponse, GetFieldGoalExpectedPointsResponse, GetLivePlaysData, GetLinesData, GetLinesResponse, GetUserInfoResponse, GetUsageData, GetUsageResponse, GetGamesData, GetGamesResponse, GetGameTeamStatsData, GetGameTeamStatsResponse, GetGamePlayerStatsData, GetGamePlayerStatsResponse, GetMediaData, GetMediaResponse, GetWeatherData, GetWeatherResponse, GetRecordsData, GetRecordsResponse, GetCalendarData, GetCalendarResponse, GetScoreboardData, GetScoreboardResponse, GetDrivesData, GetDrivesResponse, GetDraftTeamsResponse, GetDraftPositionsResponse, GetDraftPicksData, GetDraftPicksResponse, GetCoachesData, GetCoachesResponse, GetAdvancedBoxScoreData } from './types.gen';
+import type { GetAdjustedTeamSeasonStatsData, GetAdjustedTeamSeasonStatsResponse, GetAdjustedPlayerPassingStatsData, GetAdjustedPlayerPassingStatsResponse, GetAdjustedPlayerRushingStatsData, GetAdjustedPlayerRushingStatsResponse, GetKickerPaarData, GetKickerPaarResponse, GetTeamsData, GetTeamsResponse, GetFbsTeamsData, GetFbsTeamsResponse, GetMatchupData, GetTeamsAtsData, GetTeamsAtsResponse, GetRosterData, GetRosterResponse, GetConferencesResponse, GetTalentData, GetTalentResponse, GetVenuesResponse, GetPlayerSeasonStatsData, GetPlayerSeasonStatsResponse, GetPlayerSeasonSuccessRatesData, GetPlayerSeasonSuccessRatesResponse, GetPlayerGameSuccessRatesData, GetPlayerGameSuccessRatesResponse, GetTeamStatsData, GetTeamStatsResponse, GetCategoriesResponse, GetAdvancedSeasonStatsData, GetAdvancedSeasonStatsResponse, GetAdvancedGameStatsData, GetAdvancedGameStatsResponse, GetGameHavocStatsData, GetGameHavocStatsResponse, GetRecruitsData, GetRecruitsResponse, GetTeamRecruitingRankingsData, GetTeamRecruitingRankingsResponse, GetAggregatedTeamRecruitingRatingsData, GetAggregatedTeamRecruitingRatingsResponse, GetSpData, GetSpResponse, GetConferenceSpData, GetConferenceSpResponse, GetSrsData, GetSrsResponse, 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, 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, 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>>;
 /**
  * Retrieve opponent-adjusted team season statistics
@@ -116,7 +116,7 @@ export declare const getFpi: <ThrowOnError extends boolean = false>(options?: Op
 /**
  * Retrieves historical poll data
  */
-export declare const getRankings: <ThrowOnError extends boolean = false>(options: OptionsLegacyParser<GetRankingsData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetRankingsResponse, unknown, ThrowOnError>;
+export declare const getRankings: <ThrowOnError extends boolean = false>(options: OptionsLegacyParser<GetRankingsData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetRankingsResponse, GetRankingsError, ThrowOnError>;
 /**
  * Retrieves historical play data
  */
@@ -133,6 +133,18 @@ export declare const getPlayStats: <ThrowOnError extends boolean = false>(option
  * Retrieves available play stat types
  */
 export declare const getPlayStatTypes: <ThrowOnError extends boolean = false>(options?: OptionsLegacyParser<unknown, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetPlayStatTypesResponse, unknown, ThrowOnError>;
+/**
+ * Retrieves the complete College Football Playoff bracket for a season
+ */
+export declare const getCfpPlayoff: <ThrowOnError extends boolean = false>(options: OptionsLegacyParser<GetCfpPlayoffData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<import("./types.gen").CfpPlayoff, GetCfpPlayoffError, ThrowOnError>;
+/**
+ * Retrieves College Football Playoff participants for a season
+ */
+export declare const getCfpParticipants: <ThrowOnError extends boolean = false>(options: OptionsLegacyParser<GetCfpParticipantsData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetCfpParticipantsResponse, GetCfpParticipantsError, ThrowOnError>;
+/**
+ * Retrieves College Football Playoff matchups for a season
+ */
+export declare const getCfpGames: <ThrowOnError extends boolean = false>(options: OptionsLegacyParser<GetCfpGamesData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetCfpGamesResponse, GetCfpGamesError, ThrowOnError>;
 /**
  * Search for players (lists top 100 results)
  */
@@ -204,7 +216,7 @@ export declare const getUsage: <ThrowOnError extends boolean = false>(options?:
 /**
  * Retrieves historical game data
  */
-export declare const getGames: <ThrowOnError extends boolean = false>(options?: OptionsLegacyParser<GetGamesData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetGamesResponse, unknown, ThrowOnError>;
+export declare const getGames: <ThrowOnError extends boolean = false>(options?: OptionsLegacyParser<GetGamesData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetGamesResponse, GetGamesError, ThrowOnError>;
 /**
  * Retrieves team box score statistics
  */

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.getUserInfo = exports.getLines = exports.getLivePlays = exports.getFieldGoalExpectedPoints = exports.getPregameWinProbabilities = exports.getWinProbability = exports.getPredictedPointsAddedByPlayerSeason = exports.getPredictedPointsAddedByPlayerGame = exports.getPredictedPointsAddedByGame = exports.getPredictedPointsAddedByTeam = exports.getPredictedPoints = exports.getTransferPortal = exports.getReturningProduction = exports.getPlayerSeasonOverview = exports.getPlayerUsage = exports.searchPlayers = exports.getPlayStatTypes = exports.getPlayStats = exports.getPlayTypes = exports.getPlays = exports.getRankings = exports.getFpi = exports.getElo = exports.getSrs = exports.getConferenceSp = exports.getSp = exports.getAggregatedTeamRecruitingRatings = exports.getTeamRecruitingRankings = exports.getRecruits = exports.getGameHavocStats = exports.getAdvancedGameStats = exports.getAdvancedSeasonStats = exports.getCategories = exports.getTeamStats = exports.getPlayerGameSuccessRates = exports.getPlayerSeasonSuccessRates = exports.getPlayerSeasonStats = exports.getVenues = exports.getTalent = 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.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 = void 0;
+exports.getFieldGoalExpectedPoints = exports.getPregameWinProbabilities = exports.getWinProbability = exports.getPredictedPointsAddedByPlayerSeason = exports.getPredictedPointsAddedByPlayerGame = exports.getPredictedPointsAddedByGame = exports.getPredictedPointsAddedByTeam = exports.getPredictedPoints = exports.getTransferPortal = 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.getSrs = exports.getConferenceSp = exports.getSp = exports.getAggregatedTeamRecruitingRatings = exports.getTeamRecruitingRankings = exports.getRecruits = exports.getGameHavocStats = exports.getAdvancedGameStats = exports.getAdvancedSeasonStats = exports.getCategories = exports.getTeamStats = exports.getPlayerGameSuccessRates = exports.getPlayerSeasonSuccessRates = exports.getPlayerSeasonStats = exports.getVenues = exports.getTalent = 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.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 = 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' }));
 /**
@@ -280,6 +280,30 @@ var getPlayStatTypes = 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: '/plays/stats/types' }));
 };
 exports.getPlayStatTypes = getPlayStatTypes;
+/**
+ * Retrieves the complete College Football Playoff bracket for a season
+ */
+var getCfpPlayoff = 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: '/playoffs/cfp' }));
+};
+exports.getCfpPlayoff = getCfpPlayoff;
+/**
+ * Retrieves College Football Playoff participants for a season
+ */
+var getCfpParticipants = 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: '/playoffs/cfp/participants' }));
+};
+exports.getCfpParticipants = getCfpParticipants;
+/**
+ * Retrieves College Football Playoff matchups for a season
+ */
+var getCfpGames = 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: '/playoffs/cfp/games' }));
+};
+exports.getCfpGames = getCfpGames;
 /**
  * Search for players (lists top 100 results)
  */

package/dist/types.gen.d.ts

@@ -302,6 +302,20 @@ export type CalendarWeek = {
      */
     lastGameStart: string;
 };
+export type CfpPlayoff = {
+    season: number;
+    competition: PlayoffCompetition_Cfp;
+    format: string;
+    teamCount: number;
+    status: PlayoffStatus;
+    participants: Array<PlayoffParticipant>;
+    rounds: Array<PlayoffRoundRecord>;
+    champion: ((PlayoffTeam) | null);
+};
+export type CfpPlayoffNotFound = {
+    message: 'CFP playoff not found';
+};
+export type message = 'CFP playoff not found';
 export type Coach = {
     firstName: string;
     lastName: string;
@@ -478,6 +492,7 @@ export type Game = {
     excitementIndex: (number) | null;
     highlights: (string) | null;
     notes: (string) | null;
+    playoff: ((GamePlayoff) | null);
 };
 export type GameHavocStats = {
     gameId: number;
@@ -556,6 +571,16 @@ export type GamePlayerStatTypes = {
     name: string;
     athletes: Array<GamePlayerStatPlayer>;
 };
+export type GamePlayoff = {
+    competition: PlayoffCompetition;
+    format: string;
+    round: PlayoffRound;
+    roundName: string;
+    bracketSlot: string;
+    homeSeed: (number) | null;
+    awaySeed: (number) | null;
+    bowlName: (string) | null;
+};
 export type GameStatus = 'scheduled' | 'in_progress' | 'completed';
 export type GameTeamStats = {
     id: number;
@@ -815,6 +840,14 @@ export type PlayerSearchResult = {
     hometown: string;
     teamColor: string;
     teamColorSecondary: string;
+    activeStartYear: (number) | null;
+    activeEndYear: (number) | null;
+    teamStints: Array<PlayerSearchTeamStint>;
+};
+export type PlayerSearchTeamStint = {
+    team: string;
+    startYear: (number) | null;
+    endYear: (number) | null;
 };
 export type PlayerSeasonOverview = {
     season: number;
@@ -972,6 +1005,76 @@ export type PlayerWeightedEPA = {
     wepa: number;
     plays: number;
 };
+export type PlayoffAdvancement = {
+    matchupId: number;
+    bracketSlot: string;
+    position: number;
+};
+export type PlayoffBidType = 'automatic' | 'at_large';
+export type PlayoffCompetition = 'cfp';
+export type PlayoffCompetition_Cfp = 'cfp';
+export type PlayoffLinkedGame = {
+    id: number;
+    startDate: string;
+    completed: boolean;
+    homeTeam: PlayoffTeam;
+    homePoints: (number) | null;
+    awayTeam: PlayoffTeam;
+    awayPoints: (number) | null;
+    venueId: (number) | null;
+    venue: (string) | null;
+};
+export type PlayoffMatchup = {
+    id: number;
+    bracketSlot: string;
+    round: PlayoffRound;
+    roundName: string;
+    roundOrder: number;
+    matchupOrder: number;
+    startDate: (string) | null;
+    bowlName: (string) | null;
+    slots: Array<PlayoffMatchupSlot>;
+    game: ((PlayoffLinkedGame) | null);
+    advancesTo: ((PlayoffAdvancement) | null);
+};
+export type PlayoffMatchupSlot = {
+    position: number;
+    seed: (number) | null;
+    participant: ((PlayoffTeam) | null);
+    source: ((PlayoffMatchupSlotSource) | null);
+};
+export type PlayoffMatchupSlotSource = {
+    matchupId: number;
+    bracketSlot: string;
+    outcome: 'winner';
+};
+export type outcome = 'winner';
+export type PlayoffOutcome = 'active' | 'eliminated' | 'champion';
+export type PlayoffParticipant = {
+    team: PlayoffTeam;
+    committeeRank: (number) | null;
+    seed: number;
+    bidType: PlayoffBidType;
+    qualificationReason: (string) | null;
+    conferenceChampion: boolean;
+    qualifyingConference: (string) | null;
+    firstRoundBye: boolean;
+    outcome: PlayoffOutcome;
+    eliminatedRound: ((PlayoffRound) | null);
+};
+export type PlayoffRound = 'first_round' | 'quarterfinal' | 'semifinal' | 'championship';
+export type PlayoffRoundRecord = {
+    code: PlayoffRound;
+    name: string;
+    order: number;
+    matchups: Array<PlayoffMatchup>;
+};
+export type PlayoffStatus = 'scheduled' | 'selected' | 'in_progress' | 'completed';
+export type PlayoffTeam = {
+    id: number;
+    school: string;
+    conference: (string) | null;
+};
 export type PlayStat = {
     gameId: number;
     season: number;
@@ -1025,6 +1128,7 @@ export type PlayWinProbability = {
 };
 export type Poll = {
     poll: string;
+    isFinal: (boolean) | null;
     ranks: Array<PollRank>;
 };
 export type PollRank = {
@@ -1055,6 +1159,7 @@ export type PregameWinProbability = {
     spread: number;
     homeWinProbability: number;
 };
+export type RankingPoll = 'cfp';
 export type Recruit = {
     id: string;
     athleteId: (string) | null;
@@ -2037,6 +2142,18 @@ export type GetFpiResponse = (Array<TeamFPI>);
 export type GetFpiError = unknown;
 export type GetRankingsData = {
     query: {
+        /**
+         * Return the marked final CFP snapshot
+         */
+        final?: boolean;
+        /**
+         * Return the latest CFP snapshot, preferring the marked final
+         */
+        latest?: boolean;
+        /**
+         * Optional poll filter
+         */
+        poll?: RankingPoll;
         /**
          * Optional season type filter
          */
@@ -2052,7 +2169,9 @@ export type GetRankingsData = {
     };
 };
 export type GetRankingsResponse = (Array<PollWeek>);
-export type GetRankingsError = unknown;
+export type GetRankingsError = ({
+    message: string;
+});
 export type GetPlaysData = {
     query: {
         /**
@@ -2145,6 +2264,46 @@ export type GetPlayStatsResponse = (Array<PlayStat>);
 export type GetPlayStatsError = unknown;
 export type GetPlayStatTypesResponse = (Array<PlayStatType>);
 export type GetPlayStatTypesError = unknown;
+export type GetCfpPlayoffData = {
+    query: {
+        /**
+         * Required year filter
+         */
+        year: number;
+    };
+};
+export type GetCfpPlayoffResponse = (CfpPlayoff);
+export type GetCfpPlayoffError = ({
+    message: string;
+} | CfpPlayoffNotFound);
+export type GetCfpParticipantsData = {
+    query: {
+        /**
+         * Required year filter
+         */
+        year: number;
+    };
+};
+export type GetCfpParticipantsResponse = (Array<PlayoffParticipant>);
+export type GetCfpParticipantsError = ({
+    message: string;
+} | CfpPlayoffNotFound);
+export type GetCfpGamesData = {
+    query: {
+        /**
+         * Optional playoff round filter
+         */
+        round?: PlayoffRound;
+        /**
+         * Required year filter
+         */
+        year: number;
+    };
+};
+export type GetCfpGamesResponse = (Array<PlayoffMatchup>);
+export type GetCfpGamesError = ({
+    message: string;
+} | CfpPlayoffNotFound);
 export type SearchPlayersData = {
     query: {
         /**
@@ -2493,6 +2652,10 @@ export type GetGamesData = {
          * Optional division classification filter
          */
         classification?: DivisionClassification;
+        /**
+         * Optional playoff competition filter
+         */
+        competition?: PlayoffCompetition;
         /**
          * Optional conference filter
          */
@@ -2505,6 +2668,10 @@ export type GetGamesData = {
          * Game id filter to retrieve a single game
          */
         id?: number;
+        /**
+         * Optional playoff round filter; requires competition
+         */
+        round?: PlayoffRound;
         /**
          * Optional season type filter
          */
@@ -2524,7 +2691,9 @@ export type GetGamesData = {
     };
 };
 export type GetGamesResponse = (Array<Game>);
-export type GetGamesError = unknown;
+export type GetGamesError = ({
+    message: string;
+});
 export type GetGameTeamStatsData = {
     query?: {
         /**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "cfbd",
-  "version": "5.16.0",
+  "version": "5.18.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, GetConferencesError, GetConferencesResponse, 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, GetRecruitsData, GetRecruitsError, GetRecruitsResponse, GetTeamRecruitingRankingsData, GetTeamRecruitingRankingsError, GetTeamRecruitingRankingsResponse, GetAggregatedTeamRecruitingRatingsData, GetAggregatedTeamRecruitingRatingsError, GetAggregatedTeamRecruitingRatingsResponse, GetSpData, GetSpError, GetSpResponse, GetConferenceSpData, GetConferenceSpError, GetConferenceSpResponse, GetSrsData, GetSrsError, GetSrsResponse, GetEloData, GetEloError, GetEloResponse, GetFpiData, GetFpiError, GetFpiResponse, GetRankingsData, GetRankingsError, GetRankingsResponse, GetPlaysData, GetPlaysError, GetPlaysResponse, GetPlayTypesError, GetPlayTypesResponse, GetPlayStatsData, GetPlayStatsError, GetPlayStatsResponse, GetPlayStatTypesError, GetPlayStatTypesResponse, SearchPlayersData, SearchPlayersError, SearchPlayersResponse, GetPlayerUsageData, GetPlayerUsageError, GetPlayerUsageResponse, GetPlayerSeasonOverviewData, GetPlayerSeasonOverviewError, GetPlayerSeasonOverviewResponse, GetReturningProductionData, GetReturningProductionError, GetReturningProductionResponse, GetTransferPortalData, GetTransferPortalError, GetTransferPortalResponse, 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, GetAdvancedBoxScoreData, GetAdvancedBoxScoreError, GetAdvancedBoxScoreResponse } from './types.gen';
+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, GetConferencesError, GetConferencesResponse, 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, GetRecruitsData, GetRecruitsError, GetRecruitsResponse, GetTeamRecruitingRankingsData, GetTeamRecruitingRankingsError, GetTeamRecruitingRankingsResponse, GetAggregatedTeamRecruitingRatingsData, GetAggregatedTeamRecruitingRatingsError, GetAggregatedTeamRecruitingRatingsResponse, GetSpData, GetSpError, GetSpResponse, GetConferenceSpData, GetConferenceSpError, GetConferenceSpResponse, GetSrsData, GetSrsError, GetSrsResponse, 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, 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, GetAdvancedBoxScoreData, GetAdvancedBoxScoreError, GetAdvancedBoxScoreResponse } from './types.gen';
 
 export const client = createClient(createConfig({ baseUrl: 'https://api.collegefootballdata.com' }));
 
@@ -335,6 +335,36 @@ export const getPlayStatTypes = <ThrowOnError extends boolean = false>(options?:
     });
 };
 
+/**
+ * Retrieves the complete College Football Playoff bracket for a season
+ */
+export const getCfpPlayoff = <ThrowOnError extends boolean = false>(options: OptionsLegacyParser<GetCfpPlayoffData, ThrowOnError>) => {
+    return (options?.client ?? client).get<GetCfpPlayoffResponse, GetCfpPlayoffError, ThrowOnError>({
+        ...options,
+        url: '/playoffs/cfp'
+    });
+};
+
+/**
+ * Retrieves College Football Playoff participants for a season
+ */
+export const getCfpParticipants = <ThrowOnError extends boolean = false>(options: OptionsLegacyParser<GetCfpParticipantsData, ThrowOnError>) => {
+    return (options?.client ?? client).get<GetCfpParticipantsResponse, GetCfpParticipantsError, ThrowOnError>({
+        ...options,
+        url: '/playoffs/cfp/participants'
+    });
+};
+
+/**
+ * Retrieves College Football Playoff matchups for a season
+ */
+export const getCfpGames = <ThrowOnError extends boolean = false>(options: OptionsLegacyParser<GetCfpGamesData, ThrowOnError>) => {
+    return (options?.client ?? client).get<GetCfpGamesResponse, GetCfpGamesError, ThrowOnError>({
+        ...options,
+        url: '/playoffs/cfp/games'
+    });
+};
+
 /**
  * Search for players (lists top 100 results)
  */

package/src/types.gen.ts

@@ -311,6 +311,23 @@ export type CalendarWeek = {
     lastGameStart: string;
 };
 
+export type CfpPlayoff = {
+    season: number;
+    competition: PlayoffCompetition_Cfp;
+    format: string;
+    teamCount: number;
+    status: PlayoffStatus;
+    participants: Array<PlayoffParticipant>;
+    rounds: Array<PlayoffRoundRecord>;
+    champion: ((PlayoffTeam) | null);
+};
+
+export type CfpPlayoffNotFound = {
+    message: 'CFP playoff not found';
+};
+
+export type message = 'CFP playoff not found';
+
 export type Coach = {
     firstName: string;
     lastName: string;
@@ -497,6 +514,7 @@ export type Game = {
     excitementIndex: (number) | null;
     highlights: (string) | null;
     notes: (string) | null;
+    playoff: ((GamePlayoff) | null);
 };
 
 export type GameHavocStats = {
@@ -585,6 +603,17 @@ export type GamePlayerStatTypes = {
     athletes: Array<GamePlayerStatPlayer>;
 };
 
+export type GamePlayoff = {
+    competition: PlayoffCompetition;
+    format: string;
+    round: PlayoffRound;
+    roundName: string;
+    bracketSlot: string;
+    homeSeed: (number) | null;
+    awaySeed: (number) | null;
+    bowlName: (string) | null;
+};
+
 export type GameStatus = 'scheduled' | 'in_progress' | 'completed';
 
 export type GameTeamStats = {
@@ -865,6 +894,15 @@ export type PlayerSearchResult = {
     hometown: string;
     teamColor: string;
     teamColorSecondary: string;
+    activeStartYear: (number) | null;
+    activeEndYear: (number) | null;
+    teamStints: Array<PlayerSearchTeamStint>;
+};
+
+export type PlayerSearchTeamStint = {
+    team: string;
+    startYear: (number) | null;
+    endYear: (number) | null;
 };
 
 export type PlayerSeasonOverview = {
@@ -1035,6 +1073,91 @@ export type PlayerWeightedEPA = {
     plays: number;
 };
 
+export type PlayoffAdvancement = {
+    matchupId: number;
+    bracketSlot: string;
+    position: number;
+};
+
+export type PlayoffBidType = 'automatic' | 'at_large';
+
+export type PlayoffCompetition = 'cfp';
+
+export type PlayoffCompetition_Cfp = 'cfp';
+
+export type PlayoffLinkedGame = {
+    id: number;
+    startDate: string;
+    completed: boolean;
+    homeTeam: PlayoffTeam;
+    homePoints: (number) | null;
+    awayTeam: PlayoffTeam;
+    awayPoints: (number) | null;
+    venueId: (number) | null;
+    venue: (string) | null;
+};
+
+export type PlayoffMatchup = {
+    id: number;
+    bracketSlot: string;
+    round: PlayoffRound;
+    roundName: string;
+    roundOrder: number;
+    matchupOrder: number;
+    startDate: (string) | null;
+    bowlName: (string) | null;
+    slots: Array<PlayoffMatchupSlot>;
+    game: ((PlayoffLinkedGame) | null);
+    advancesTo: ((PlayoffAdvancement) | null);
+};
+
+export type PlayoffMatchupSlot = {
+    position: number;
+    seed: (number) | null;
+    participant: ((PlayoffTeam) | null);
+    source: ((PlayoffMatchupSlotSource) | null);
+};
+
+export type PlayoffMatchupSlotSource = {
+    matchupId: number;
+    bracketSlot: string;
+    outcome: 'winner';
+};
+
+export type outcome = 'winner';
+
+export type PlayoffOutcome = 'active' | 'eliminated' | 'champion';
+
+export type PlayoffParticipant = {
+    team: PlayoffTeam;
+    committeeRank: (number) | null;
+    seed: number;
+    bidType: PlayoffBidType;
+    qualificationReason: (string) | null;
+    conferenceChampion: boolean;
+    qualifyingConference: (string) | null;
+    firstRoundBye: boolean;
+    outcome: PlayoffOutcome;
+    eliminatedRound: ((PlayoffRound) | null);
+};
+
+export type PlayoffRound = 'first_round' | 'quarterfinal' | 'semifinal' | 'championship';
+
+export type PlayoffRoundRecord = {
+    code: PlayoffRound;
+    name: string;
+    order: number;
+    matchups: Array<PlayoffMatchup>;
+};
+
+export type PlayoffStatus = 'scheduled' | 'selected' | 'in_progress' | 'completed';
+
+export type PlayoffTeam = {
+    id: number;
+    school: string;
+    conference: (string) | null;
+};
+
 export type PlayStat = {
     gameId: number;
     season: number;
@@ -1092,6 +1215,7 @@ export type PlayWinProbability = {
 
 export type Poll = {
     poll: string;
+    isFinal: (boolean) | null;
     ranks: Array<PollRank>;
 };
 
@@ -1127,6 +1251,8 @@ export type PregameWinProbability = {
     homeWinProbability: number;
 };
 
+export type RankingPoll = 'cfp';
+
 export type Recruit = {
     id: string;
     athleteId: (string) | null;
@@ -2228,6 +2354,18 @@ export type GetFpiError = unknown;
 
 export type GetRankingsData = {
     query: {
+        /**
+         * Return the marked final CFP snapshot
+         */
+        final?: boolean;
+        /**
+         * Return the latest CFP snapshot, preferring the marked final
+         */
+        latest?: boolean;
+        /**
+         * Optional poll filter
+         */
+        poll?: RankingPoll;
         /**
          * Optional season type filter
          */
@@ -2245,7 +2383,9 @@ export type GetRankingsData = {
 
 export type GetRankingsResponse = (Array<PollWeek>);
 
-export type GetRankingsError = unknown;
+export type GetRankingsError = ({
+    message: string;
+});
 
 export type GetPlaysData = {
     query: {
@@ -2349,6 +2489,55 @@ export type GetPlayStatTypesResponse = (Array<PlayStatType>);
 
 export type GetPlayStatTypesError = unknown;
 
+export type GetCfpPlayoffData = {
+    query: {
+        /**
+         * Required year filter
+         */
+        year: number;
+    };
+};
+
+export type GetCfpPlayoffResponse = (CfpPlayoff);
+
+export type GetCfpPlayoffError = ({
+    message: string;
+} | CfpPlayoffNotFound);
+
+export type GetCfpParticipantsData = {
+    query: {
+        /**
+         * Required year filter
+         */
+        year: number;
+    };
+};
+
+export type GetCfpParticipantsResponse = (Array<PlayoffParticipant>);
+
+export type GetCfpParticipantsError = ({
+    message: string;
+} | CfpPlayoffNotFound);
+
+export type GetCfpGamesData = {
+    query: {
+        /**
+         * Optional playoff round filter
+         */
+        round?: PlayoffRound;
+        /**
+         * Required year filter
+         */
+        year: number;
+    };
+};
+
+export type GetCfpGamesResponse = (Array<PlayoffMatchup>);
+
+export type GetCfpGamesError = ({
+    message: string;
+} | CfpPlayoffNotFound);
+
 export type SearchPlayersData = {
     query: {
         /**
@@ -2746,6 +2935,10 @@ export type GetGamesData = {
          * Optional division classification filter
          */
         classification?: DivisionClassification;
+        /**
+         * Optional playoff competition filter
+         */
+        competition?: PlayoffCompetition;
         /**
          * Optional conference filter
          */
@@ -2758,6 +2951,10 @@ export type GetGamesData = {
          * Game id filter to retrieve a single game
          */
         id?: number;
+        /**
+         * Optional playoff round filter; requires competition
+         */
+        round?: PlayoffRound;
         /**
          * Optional season type filter
          */
@@ -2779,7 +2976,9 @@ export type GetGamesData = {
 
 export type GetGamesResponse = (Array<Game>);
 
-export type GetGamesError = unknown;
+export type GetGamesError = ({
+    message: string;
+});
 
 export type GetGameTeamStatsData = {
     query?: {