cfbd 5.24.2 → 5.25.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/cfbd-5.25.0.tgz +0 -0
- package/dist/sdk.gen.d.ts +21 -1
- package/dist/sdk.gen.js +42 -2
- package/dist/types.gen.d.ts +330 -0
- package/package.json +1 -1
- package/src/sdk.gen.ts +51 -1
- package/src/types.gen.ts +357 -0
- package/cfbd-5.24.2.tgz +0 -0
package/cfbd-5.25.0.tgz
ADDED
|
Binary file
|
package/dist/sdk.gen.d.ts
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import { type OptionsLegacyParser } from '@hey-api/client-fetch';
|
|
2
|
-
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, 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, 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';
|
|
2
|
+
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, 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';
|
|
3
3
|
export declare const client: import("@hey-api/client-fetch").Client<Request, Response, unknown, import("@hey-api/client-fetch").RequestOptions<boolean, string>>;
|
|
4
4
|
/**
|
|
5
5
|
* Returns opponent-adjusted team statistics by season.
|
|
@@ -183,6 +183,26 @@ export declare const getReturningProduction: <ThrowOnError extends boolean = fal
|
|
|
183
183
|
* Returns transfer portal entries for a season.
|
|
184
184
|
*/
|
|
185
185
|
export declare const getTransferPortal: <ThrowOnError extends boolean = false>(options: OptionsLegacyParser<GetTransferPortalData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetTransferPortalResponse, unknown, ThrowOnError>;
|
|
186
|
+
/**
|
|
187
|
+
* Returns enriched pass attempts.
|
|
188
|
+
*/
|
|
189
|
+
export declare const getPassingPlays: <ThrowOnError extends boolean = false>(options: OptionsLegacyParser<GetPassingPlaysData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetPassingPlaysResponse, unknown, ThrowOnError>;
|
|
190
|
+
/**
|
|
191
|
+
* Returns passer production by season.
|
|
192
|
+
*/
|
|
193
|
+
export declare const getPlayerPassingBySeason: <ThrowOnError extends boolean = false>(options?: OptionsLegacyParser<GetPlayerPassingBySeasonData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetPlayerPassingBySeasonResponse, unknown, ThrowOnError>;
|
|
194
|
+
/**
|
|
195
|
+
* Returns passer production by game.
|
|
196
|
+
*/
|
|
197
|
+
export declare const getPlayerPassingByGame: <ThrowOnError extends boolean = false>(options: OptionsLegacyParser<GetPlayerPassingByGameData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetPlayerPassingByGameResponse, unknown, ThrowOnError>;
|
|
198
|
+
/**
|
|
199
|
+
* Returns team passing production by season.
|
|
200
|
+
*/
|
|
201
|
+
export declare const getTeamPassingBySeason: <ThrowOnError extends boolean = false>(options?: OptionsLegacyParser<GetTeamPassingBySeasonData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetTeamPassingBySeasonResponse, unknown, ThrowOnError>;
|
|
202
|
+
/**
|
|
203
|
+
* Returns team passing production by game.
|
|
204
|
+
*/
|
|
205
|
+
export declare const getTeamPassingByGame: <ThrowOnError extends boolean = false>(options: OptionsLegacyParser<GetTeamPassingByGameData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetTeamPassingByGameResponse, unknown, ThrowOnError>;
|
|
186
206
|
/**
|
|
187
207
|
* Returns predicted points values by down and distance.
|
|
188
208
|
*/
|
package/dist/sdk.gen.js
CHANGED
|
@@ -12,8 +12,8 @@ var __assign = (this && this.__assign) || function () {
|
|
|
12
12
|
return __assign.apply(this, arguments);
|
|
13
13
|
};
|
|
14
14
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
15
|
-
exports.
|
|
16
|
-
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 = void 0;
|
|
15
|
+
exports.getTeamPassingBySeason = exports.getPlayerPassingByGame = exports.getPlayerPassingBySeason = exports.getPassingPlays = 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.getExpandedSrs = exports.getSrs = exports.getConferenceSp = exports.getSp = exports.getCore = 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.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;
|
|
16
|
+
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 = void 0;
|
|
17
17
|
var client_fetch_1 = require("@hey-api/client-fetch");
|
|
18
18
|
exports.client = (0, client_fetch_1.createClient)((0, client_fetch_1.createConfig)({ baseUrl: 'https://api.collegefootballdata.com' }));
|
|
19
19
|
/**
|
|
@@ -378,6 +378,46 @@ var getTransferPortal = function (options) {
|
|
|
378
378
|
return ((_a = options === null || options === void 0 ? void 0 : options.client) !== null && _a !== void 0 ? _a : exports.client).get(__assign(__assign({}, options), { url: '/player/portal' }));
|
|
379
379
|
};
|
|
380
380
|
exports.getTransferPortal = getTransferPortal;
|
|
381
|
+
/**
|
|
382
|
+
* Returns enriched pass attempts.
|
|
383
|
+
*/
|
|
384
|
+
var getPassingPlays = function (options) {
|
|
385
|
+
var _a;
|
|
386
|
+
return ((_a = options === null || options === void 0 ? void 0 : options.client) !== null && _a !== void 0 ? _a : exports.client).get(__assign(__assign({}, options), { url: '/passing/plays' }));
|
|
387
|
+
};
|
|
388
|
+
exports.getPassingPlays = getPassingPlays;
|
|
389
|
+
/**
|
|
390
|
+
* Returns passer production by season.
|
|
391
|
+
*/
|
|
392
|
+
var getPlayerPassingBySeason = function (options) {
|
|
393
|
+
var _a;
|
|
394
|
+
return ((_a = options === null || options === void 0 ? void 0 : options.client) !== null && _a !== void 0 ? _a : exports.client).get(__assign(__assign({}, options), { url: '/passing/players/season' }));
|
|
395
|
+
};
|
|
396
|
+
exports.getPlayerPassingBySeason = getPlayerPassingBySeason;
|
|
397
|
+
/**
|
|
398
|
+
* Returns passer production by game.
|
|
399
|
+
*/
|
|
400
|
+
var getPlayerPassingByGame = function (options) {
|
|
401
|
+
var _a;
|
|
402
|
+
return ((_a = options === null || options === void 0 ? void 0 : options.client) !== null && _a !== void 0 ? _a : exports.client).get(__assign(__assign({}, options), { url: '/passing/players/games' }));
|
|
403
|
+
};
|
|
404
|
+
exports.getPlayerPassingByGame = getPlayerPassingByGame;
|
|
405
|
+
/**
|
|
406
|
+
* Returns team passing production by season.
|
|
407
|
+
*/
|
|
408
|
+
var getTeamPassingBySeason = function (options) {
|
|
409
|
+
var _a;
|
|
410
|
+
return ((_a = options === null || options === void 0 ? void 0 : options.client) !== null && _a !== void 0 ? _a : exports.client).get(__assign(__assign({}, options), { url: '/passing/teams/season' }));
|
|
411
|
+
};
|
|
412
|
+
exports.getTeamPassingBySeason = getTeamPassingBySeason;
|
|
413
|
+
/**
|
|
414
|
+
* Returns team passing production by game.
|
|
415
|
+
*/
|
|
416
|
+
var getTeamPassingByGame = function (options) {
|
|
417
|
+
var _a;
|
|
418
|
+
return ((_a = options === null || options === void 0 ? void 0 : options.client) !== null && _a !== void 0 ? _a : exports.client).get(__assign(__assign({}, options), { url: '/passing/teams/games' }));
|
|
419
|
+
};
|
|
420
|
+
exports.getTeamPassingByGame = getTeamPassingByGame;
|
|
381
421
|
/**
|
|
382
422
|
* Returns predicted points values by down and distance.
|
|
383
423
|
*/
|
package/dist/types.gen.d.ts
CHANGED
|
@@ -900,6 +900,78 @@ export type MatchupGame = {
|
|
|
900
900
|
winner: (string) | null;
|
|
901
901
|
};
|
|
902
902
|
export type MediaType = 'tv' | 'radio' | 'web' | 'ppv' | 'mobile';
|
|
903
|
+
export type PassDepth = 'short' | 'deep';
|
|
904
|
+
export type PassDirection = 'left' | 'middle' | 'right';
|
|
905
|
+
export type PassingPlay = {
|
|
906
|
+
gameId: number;
|
|
907
|
+
playId: string;
|
|
908
|
+
driveId: string;
|
|
909
|
+
season: number;
|
|
910
|
+
week: number;
|
|
911
|
+
seasonType: SeasonType;
|
|
912
|
+
offenseId: number;
|
|
913
|
+
offense: string;
|
|
914
|
+
offenseConference: (string) | null;
|
|
915
|
+
defenseId: number;
|
|
916
|
+
defense: string;
|
|
917
|
+
defenseConference: (string) | null;
|
|
918
|
+
period: number;
|
|
919
|
+
clock: PassingPlayClock;
|
|
920
|
+
down: number;
|
|
921
|
+
distance: number;
|
|
922
|
+
playText: (string) | null;
|
|
923
|
+
passerId: (string) | null;
|
|
924
|
+
passer: (string) | null;
|
|
925
|
+
targetId: (string) | null;
|
|
926
|
+
target: (string) | null;
|
|
927
|
+
outcome: PassOutcome;
|
|
928
|
+
airYards: (number) | null;
|
|
929
|
+
passDepth: ((PassDepth) | null);
|
|
930
|
+
passDirection: ((PassDirection) | null);
|
|
931
|
+
passLocation: ((PassLocation) | null);
|
|
932
|
+
totalYards: (number) | null;
|
|
933
|
+
yardsAfterCatch: (number) | null;
|
|
934
|
+
startYardline: number;
|
|
935
|
+
startYardsToGoal: number;
|
|
936
|
+
targetYardsToGoal: (number) | null;
|
|
937
|
+
isSpike: boolean;
|
|
938
|
+
isThrowaway: boolean;
|
|
939
|
+
isIntentionalGrounding: boolean;
|
|
940
|
+
parseStatus: PassParseStatus;
|
|
941
|
+
};
|
|
942
|
+
export type PassingPlayClock = {
|
|
943
|
+
minutes: number;
|
|
944
|
+
seconds: number;
|
|
945
|
+
};
|
|
946
|
+
export type PassingProduction = {
|
|
947
|
+
attempts: number;
|
|
948
|
+
completions: number;
|
|
949
|
+
incompletions: number;
|
|
950
|
+
interceptions: number;
|
|
951
|
+
completionRate: (number) | null;
|
|
952
|
+
/**
|
|
953
|
+
* Number of attempts with non-null air yards, including zero-yard values.
|
|
954
|
+
*/
|
|
955
|
+
airYardsAttemptsAvailable: number;
|
|
956
|
+
totalAirYards: (number) | null;
|
|
957
|
+
averageDepthOfTarget: (number) | null;
|
|
958
|
+
/**
|
|
959
|
+
* Number of attempts with non-null total yards, including zero-yard
|
|
960
|
+
* incompletions and interceptions.
|
|
961
|
+
*/
|
|
962
|
+
totalYardsAttemptsAvailable: number;
|
|
963
|
+
totalYards: (number) | null;
|
|
964
|
+
/**
|
|
965
|
+
* Number of completed attempts with valid total yards and air yards to
|
|
966
|
+
* calculate yards after catch, including zero-yard values.
|
|
967
|
+
*/
|
|
968
|
+
yardsAfterCatchAttemptsAvailable: number;
|
|
969
|
+
totalYardsAfterCatch: (number) | null;
|
|
970
|
+
averageYardsAfterCatch: (number) | null;
|
|
971
|
+
};
|
|
972
|
+
export type PassLocation = 'short left' | 'short middle' | 'short right' | 'deep left' | 'deep middle' | 'deep right';
|
|
973
|
+
export type PassOutcome = 'completion' | 'incompletion' | 'interception';
|
|
974
|
+
export type PassParseStatus = 'complete' | 'partial' | 'invalid';
|
|
903
975
|
export type Play = {
|
|
904
976
|
id: string;
|
|
905
977
|
driveId: string;
|
|
@@ -973,6 +1045,72 @@ export type PlayerGameUsage = {
|
|
|
973
1045
|
team: string;
|
|
974
1046
|
position: string;
|
|
975
1047
|
};
|
|
1048
|
+
export type PlayerPassingGame = {
|
|
1049
|
+
attempts: number;
|
|
1050
|
+
completions: number;
|
|
1051
|
+
incompletions: number;
|
|
1052
|
+
interceptions: number;
|
|
1053
|
+
completionRate: (number) | null;
|
|
1054
|
+
/**
|
|
1055
|
+
* Number of attempts with non-null air yards, including zero-yard values.
|
|
1056
|
+
*/
|
|
1057
|
+
airYardsAttemptsAvailable: number;
|
|
1058
|
+
totalAirYards: (number) | null;
|
|
1059
|
+
averageDepthOfTarget: (number) | null;
|
|
1060
|
+
/**
|
|
1061
|
+
* Number of attempts with non-null total yards, including zero-yard
|
|
1062
|
+
* incompletions and interceptions.
|
|
1063
|
+
*/
|
|
1064
|
+
totalYardsAttemptsAvailable: number;
|
|
1065
|
+
totalYards: (number) | null;
|
|
1066
|
+
/**
|
|
1067
|
+
* Number of completed attempts with valid total yards and air yards to
|
|
1068
|
+
* calculate yards after catch, including zero-yard values.
|
|
1069
|
+
*/
|
|
1070
|
+
yardsAfterCatchAttemptsAvailable: number;
|
|
1071
|
+
totalYardsAfterCatch: (number) | null;
|
|
1072
|
+
averageYardsAfterCatch: (number) | null;
|
|
1073
|
+
gameId: number;
|
|
1074
|
+
season: number;
|
|
1075
|
+
week: number;
|
|
1076
|
+
seasonType: SeasonType;
|
|
1077
|
+
playerId: string;
|
|
1078
|
+
player: string;
|
|
1079
|
+
team: string;
|
|
1080
|
+
conference: (string) | null;
|
|
1081
|
+
opponent: string;
|
|
1082
|
+
};
|
|
1083
|
+
export type PlayerPassingSeason = {
|
|
1084
|
+
attempts: number;
|
|
1085
|
+
completions: number;
|
|
1086
|
+
incompletions: number;
|
|
1087
|
+
interceptions: number;
|
|
1088
|
+
completionRate: (number) | null;
|
|
1089
|
+
/**
|
|
1090
|
+
* Number of attempts with non-null air yards, including zero-yard values.
|
|
1091
|
+
*/
|
|
1092
|
+
airYardsAttemptsAvailable: number;
|
|
1093
|
+
totalAirYards: (number) | null;
|
|
1094
|
+
averageDepthOfTarget: (number) | null;
|
|
1095
|
+
/**
|
|
1096
|
+
* Number of attempts with non-null total yards, including zero-yard
|
|
1097
|
+
* incompletions and interceptions.
|
|
1098
|
+
*/
|
|
1099
|
+
totalYardsAttemptsAvailable: number;
|
|
1100
|
+
totalYards: (number) | null;
|
|
1101
|
+
/**
|
|
1102
|
+
* Number of completed attempts with valid total yards and air yards to
|
|
1103
|
+
* calculate yards after catch, including zero-yard values.
|
|
1104
|
+
*/
|
|
1105
|
+
yardsAfterCatchAttemptsAvailable: number;
|
|
1106
|
+
totalYardsAfterCatch: (number) | null;
|
|
1107
|
+
averageYardsAfterCatch: (number) | null;
|
|
1108
|
+
season: number;
|
|
1109
|
+
playerId: string;
|
|
1110
|
+
player: string;
|
|
1111
|
+
team: string;
|
|
1112
|
+
conference: (string) | null;
|
|
1113
|
+
};
|
|
976
1114
|
export type PlayerPPA = {
|
|
977
1115
|
player: string;
|
|
978
1116
|
team: string;
|
|
@@ -1575,6 +1713,24 @@ export type TeamHavoc = {
|
|
|
1575
1713
|
frontSeven: number;
|
|
1576
1714
|
db: number;
|
|
1577
1715
|
};
|
|
1716
|
+
export type TeamPassingGame = {
|
|
1717
|
+
gameId: number;
|
|
1718
|
+
season: number;
|
|
1719
|
+
week: number;
|
|
1720
|
+
seasonType: SeasonType;
|
|
1721
|
+
team: string;
|
|
1722
|
+
conference: (string) | null;
|
|
1723
|
+
opponent: string;
|
|
1724
|
+
offense: PassingProduction;
|
|
1725
|
+
defense: PassingProduction;
|
|
1726
|
+
};
|
|
1727
|
+
export type TeamPassingSeason = {
|
|
1728
|
+
season: number;
|
|
1729
|
+
team: string;
|
|
1730
|
+
conference: (string) | null;
|
|
1731
|
+
offense: PassingProduction;
|
|
1732
|
+
defense: PassingProduction;
|
|
1733
|
+
};
|
|
1578
1734
|
export type TeamPPA = {
|
|
1579
1735
|
team: string;
|
|
1580
1736
|
plays: number;
|
|
@@ -2712,6 +2868,180 @@ export type GetTransferPortalData = {
|
|
|
2712
2868
|
};
|
|
2713
2869
|
export type GetTransferPortalResponse = (Array<PlayerTransfer>);
|
|
2714
2870
|
export type GetTransferPortalError = unknown;
|
|
2871
|
+
export type GetPassingPlaysData = {
|
|
2872
|
+
query: {
|
|
2873
|
+
/**
|
|
2874
|
+
* Division classification. Defaults to `fbs`.
|
|
2875
|
+
*/
|
|
2876
|
+
classification?: DivisionClassification;
|
|
2877
|
+
/**
|
|
2878
|
+
* Conference name or abbreviation on either side of the pass.
|
|
2879
|
+
*/
|
|
2880
|
+
conference?: string;
|
|
2881
|
+
/**
|
|
2882
|
+
* Defensive team name.
|
|
2883
|
+
*/
|
|
2884
|
+
defense?: string;
|
|
2885
|
+
/**
|
|
2886
|
+
* Game ID.
|
|
2887
|
+
*/
|
|
2888
|
+
gameId?: number;
|
|
2889
|
+
/**
|
|
2890
|
+
* Offensive team name.
|
|
2891
|
+
*/
|
|
2892
|
+
offense?: string;
|
|
2893
|
+
/**
|
|
2894
|
+
* Pass outcome.
|
|
2895
|
+
*/
|
|
2896
|
+
outcome?: PassOutcome;
|
|
2897
|
+
/**
|
|
2898
|
+
* Passer athlete ID.
|
|
2899
|
+
*/
|
|
2900
|
+
passerId?: string;
|
|
2901
|
+
/**
|
|
2902
|
+
* Season type.
|
|
2903
|
+
*/
|
|
2904
|
+
seasonType?: SeasonType;
|
|
2905
|
+
/**
|
|
2906
|
+
* Intended target athlete ID.
|
|
2907
|
+
*/
|
|
2908
|
+
targetId?: string;
|
|
2909
|
+
/**
|
|
2910
|
+
* Team name on either side of the pass. Either team or week is required.
|
|
2911
|
+
*/
|
|
2912
|
+
team?: string;
|
|
2913
|
+
/**
|
|
2914
|
+
* Week number. Either team or week is required.
|
|
2915
|
+
*/
|
|
2916
|
+
week?: number;
|
|
2917
|
+
/**
|
|
2918
|
+
* Season year.
|
|
2919
|
+
*/
|
|
2920
|
+
year: number;
|
|
2921
|
+
};
|
|
2922
|
+
};
|
|
2923
|
+
export type GetPassingPlaysResponse = (Array<PassingPlay>);
|
|
2924
|
+
export type GetPassingPlaysError = unknown;
|
|
2925
|
+
export type GetPlayerPassingBySeasonData = {
|
|
2926
|
+
query?: {
|
|
2927
|
+
/**
|
|
2928
|
+
* Division classification. Defaults to `fbs`.
|
|
2929
|
+
*/
|
|
2930
|
+
classification?: DivisionClassification;
|
|
2931
|
+
/**
|
|
2932
|
+
* Conference name or abbreviation.
|
|
2933
|
+
*/
|
|
2934
|
+
conference?: string;
|
|
2935
|
+
/**
|
|
2936
|
+
* Passer athlete ID. Required unless year is specified.
|
|
2937
|
+
*/
|
|
2938
|
+
passerId?: string;
|
|
2939
|
+
/**
|
|
2940
|
+
* Season type.
|
|
2941
|
+
*/
|
|
2942
|
+
seasonType?: SeasonType;
|
|
2943
|
+
/**
|
|
2944
|
+
* Team name.
|
|
2945
|
+
*/
|
|
2946
|
+
team?: string;
|
|
2947
|
+
/**
|
|
2948
|
+
* Season year. Required unless passerId is specified.
|
|
2949
|
+
*/
|
|
2950
|
+
year?: number;
|
|
2951
|
+
};
|
|
2952
|
+
};
|
|
2953
|
+
export type GetPlayerPassingBySeasonResponse = (Array<PlayerPassingSeason>);
|
|
2954
|
+
export type GetPlayerPassingBySeasonError = unknown;
|
|
2955
|
+
export type GetPlayerPassingByGameData = {
|
|
2956
|
+
query: {
|
|
2957
|
+
/**
|
|
2958
|
+
* Division classification. Defaults to `fbs`.
|
|
2959
|
+
*/
|
|
2960
|
+
classification?: DivisionClassification;
|
|
2961
|
+
/**
|
|
2962
|
+
* Conference name or abbreviation.
|
|
2963
|
+
*/
|
|
2964
|
+
conference?: string;
|
|
2965
|
+
/**
|
|
2966
|
+
* Passer athlete ID. Either passerId, team, or week is required.
|
|
2967
|
+
*/
|
|
2968
|
+
passerId?: string;
|
|
2969
|
+
/**
|
|
2970
|
+
* Season type.
|
|
2971
|
+
*/
|
|
2972
|
+
seasonType?: SeasonType;
|
|
2973
|
+
/**
|
|
2974
|
+
* Team name. Either passerId, team, or week is required.
|
|
2975
|
+
*/
|
|
2976
|
+
team?: string;
|
|
2977
|
+
/**
|
|
2978
|
+
* Week number. Either passerId, team, or week is required.
|
|
2979
|
+
*/
|
|
2980
|
+
week?: number;
|
|
2981
|
+
/**
|
|
2982
|
+
* Season year. Required.
|
|
2983
|
+
*/
|
|
2984
|
+
year: number;
|
|
2985
|
+
};
|
|
2986
|
+
};
|
|
2987
|
+
export type GetPlayerPassingByGameResponse = (Array<PlayerPassingGame>);
|
|
2988
|
+
export type GetPlayerPassingByGameError = unknown;
|
|
2989
|
+
export type GetTeamPassingBySeasonData = {
|
|
2990
|
+
query?: {
|
|
2991
|
+
/**
|
|
2992
|
+
* Division classification. Defaults to `fbs`.
|
|
2993
|
+
*/
|
|
2994
|
+
classification?: DivisionClassification;
|
|
2995
|
+
/**
|
|
2996
|
+
* Conference name or abbreviation.
|
|
2997
|
+
*/
|
|
2998
|
+
conference?: string;
|
|
2999
|
+
/**
|
|
3000
|
+
* Season type.
|
|
3001
|
+
*/
|
|
3002
|
+
seasonType?: SeasonType;
|
|
3003
|
+
/**
|
|
3004
|
+
* Team name. Required unless year is specified.
|
|
3005
|
+
*/
|
|
3006
|
+
team?: string;
|
|
3007
|
+
/**
|
|
3008
|
+
* Season year. Required unless team is specified.
|
|
3009
|
+
*/
|
|
3010
|
+
year?: number;
|
|
3011
|
+
};
|
|
3012
|
+
};
|
|
3013
|
+
export type GetTeamPassingBySeasonResponse = (Array<TeamPassingSeason>);
|
|
3014
|
+
export type GetTeamPassingBySeasonError = unknown;
|
|
3015
|
+
export type GetTeamPassingByGameData = {
|
|
3016
|
+
query: {
|
|
3017
|
+
/**
|
|
3018
|
+
* Division classification. Defaults to `fbs`.
|
|
3019
|
+
*/
|
|
3020
|
+
classification?: DivisionClassification;
|
|
3021
|
+
/**
|
|
3022
|
+
* Conference name or abbreviation.
|
|
3023
|
+
*/
|
|
3024
|
+
conference?: string;
|
|
3025
|
+
/**
|
|
3026
|
+
* Season type.
|
|
3027
|
+
*/
|
|
3028
|
+
seasonType?: SeasonType;
|
|
3029
|
+
/**
|
|
3030
|
+
* Team name. Either team or week is required.
|
|
3031
|
+
*/
|
|
3032
|
+
team?: string;
|
|
3033
|
+
/**
|
|
3034
|
+
* Week number. Either team or week is required.
|
|
3035
|
+
*/
|
|
3036
|
+
week?: number;
|
|
3037
|
+
/**
|
|
3038
|
+
* Season year. Required.
|
|
3039
|
+
*/
|
|
3040
|
+
year: number;
|
|
3041
|
+
};
|
|
3042
|
+
};
|
|
3043
|
+
export type GetTeamPassingByGameResponse = (Array<TeamPassingGame>);
|
|
3044
|
+
export type GetTeamPassingByGameError = unknown;
|
|
2715
3045
|
export type GetPredictedPointsData = {
|
|
2716
3046
|
query: {
|
|
2717
3047
|
/**
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "cfbd",
|
|
3
|
-
"version": "5.
|
|
3
|
+
"version": "5.25.0",
|
|
4
4
|
"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.",
|
|
5
5
|
"repository": {
|
|
6
6
|
"type": "git",
|
package/src/sdk.gen.ts
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
// This file is auto-generated by @hey-api/openapi-ts
|
|
2
2
|
|
|
3
3
|
import { createClient, createConfig, type OptionsLegacyParser } from '@hey-api/client-fetch';
|
|
4
|
-
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, 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, 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';
|
|
4
|
+
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, 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';
|
|
5
5
|
|
|
6
6
|
export const client = createClient(createConfig({ baseUrl: 'https://api.collegefootballdata.com' }));
|
|
7
7
|
|
|
@@ -457,6 +457,56 @@ export const getTransferPortal = <ThrowOnError extends boolean = false>(options:
|
|
|
457
457
|
});
|
|
458
458
|
};
|
|
459
459
|
|
|
460
|
+
/**
|
|
461
|
+
* Returns enriched pass attempts.
|
|
462
|
+
*/
|
|
463
|
+
export const getPassingPlays = <ThrowOnError extends boolean = false>(options: OptionsLegacyParser<GetPassingPlaysData, ThrowOnError>) => {
|
|
464
|
+
return (options?.client ?? client).get<GetPassingPlaysResponse, GetPassingPlaysError, ThrowOnError>({
|
|
465
|
+
...options,
|
|
466
|
+
url: '/passing/plays'
|
|
467
|
+
});
|
|
468
|
+
};
|
|
469
|
+
|
|
470
|
+
/**
|
|
471
|
+
* Returns passer production by season.
|
|
472
|
+
*/
|
|
473
|
+
export const getPlayerPassingBySeason = <ThrowOnError extends boolean = false>(options?: OptionsLegacyParser<GetPlayerPassingBySeasonData, ThrowOnError>) => {
|
|
474
|
+
return (options?.client ?? client).get<GetPlayerPassingBySeasonResponse, GetPlayerPassingBySeasonError, ThrowOnError>({
|
|
475
|
+
...options,
|
|
476
|
+
url: '/passing/players/season'
|
|
477
|
+
});
|
|
478
|
+
};
|
|
479
|
+
|
|
480
|
+
/**
|
|
481
|
+
* Returns passer production by game.
|
|
482
|
+
*/
|
|
483
|
+
export const getPlayerPassingByGame = <ThrowOnError extends boolean = false>(options: OptionsLegacyParser<GetPlayerPassingByGameData, ThrowOnError>) => {
|
|
484
|
+
return (options?.client ?? client).get<GetPlayerPassingByGameResponse, GetPlayerPassingByGameError, ThrowOnError>({
|
|
485
|
+
...options,
|
|
486
|
+
url: '/passing/players/games'
|
|
487
|
+
});
|
|
488
|
+
};
|
|
489
|
+
|
|
490
|
+
/**
|
|
491
|
+
* Returns team passing production by season.
|
|
492
|
+
*/
|
|
493
|
+
export const getTeamPassingBySeason = <ThrowOnError extends boolean = false>(options?: OptionsLegacyParser<GetTeamPassingBySeasonData, ThrowOnError>) => {
|
|
494
|
+
return (options?.client ?? client).get<GetTeamPassingBySeasonResponse, GetTeamPassingBySeasonError, ThrowOnError>({
|
|
495
|
+
...options,
|
|
496
|
+
url: '/passing/teams/season'
|
|
497
|
+
});
|
|
498
|
+
};
|
|
499
|
+
|
|
500
|
+
/**
|
|
501
|
+
* Returns team passing production by game.
|
|
502
|
+
*/
|
|
503
|
+
export const getTeamPassingByGame = <ThrowOnError extends boolean = false>(options: OptionsLegacyParser<GetTeamPassingByGameData, ThrowOnError>) => {
|
|
504
|
+
return (options?.client ?? client).get<GetTeamPassingByGameResponse, GetTeamPassingByGameError, ThrowOnError>({
|
|
505
|
+
...options,
|
|
506
|
+
url: '/passing/teams/games'
|
|
507
|
+
});
|
|
508
|
+
};
|
|
509
|
+
|
|
460
510
|
/**
|
|
461
511
|
* Returns predicted points values by down and distance.
|
|
462
512
|
*/
|
package/src/types.gen.ts
CHANGED
|
@@ -970,6 +970,86 @@ export type MatchupGame = {
|
|
|
970
970
|
|
|
971
971
|
export type MediaType = 'tv' | 'radio' | 'web' | 'ppv' | 'mobile';
|
|
972
972
|
|
|
973
|
+
export type PassDepth = 'short' | 'deep';
|
|
974
|
+
|
|
975
|
+
export type PassDirection = 'left' | 'middle' | 'right';
|
|
976
|
+
|
|
977
|
+
export type PassingPlay = {
|
|
978
|
+
gameId: number;
|
|
979
|
+
playId: string;
|
|
980
|
+
driveId: string;
|
|
981
|
+
season: number;
|
|
982
|
+
week: number;
|
|
983
|
+
seasonType: SeasonType;
|
|
984
|
+
offenseId: number;
|
|
985
|
+
offense: string;
|
|
986
|
+
offenseConference: (string) | null;
|
|
987
|
+
defenseId: number;
|
|
988
|
+
defense: string;
|
|
989
|
+
defenseConference: (string) | null;
|
|
990
|
+
period: number;
|
|
991
|
+
clock: PassingPlayClock;
|
|
992
|
+
down: number;
|
|
993
|
+
distance: number;
|
|
994
|
+
playText: (string) | null;
|
|
995
|
+
passerId: (string) | null;
|
|
996
|
+
passer: (string) | null;
|
|
997
|
+
targetId: (string) | null;
|
|
998
|
+
target: (string) | null;
|
|
999
|
+
outcome: PassOutcome;
|
|
1000
|
+
airYards: (number) | null;
|
|
1001
|
+
passDepth: ((PassDepth) | null);
|
|
1002
|
+
passDirection: ((PassDirection) | null);
|
|
1003
|
+
passLocation: ((PassLocation) | null);
|
|
1004
|
+
totalYards: (number) | null;
|
|
1005
|
+
yardsAfterCatch: (number) | null;
|
|
1006
|
+
startYardline: number;
|
|
1007
|
+
startYardsToGoal: number;
|
|
1008
|
+
targetYardsToGoal: (number) | null;
|
|
1009
|
+
isSpike: boolean;
|
|
1010
|
+
isThrowaway: boolean;
|
|
1011
|
+
isIntentionalGrounding: boolean;
|
|
1012
|
+
parseStatus: PassParseStatus;
|
|
1013
|
+
};
|
|
1014
|
+
|
|
1015
|
+
export type PassingPlayClock = {
|
|
1016
|
+
minutes: number;
|
|
1017
|
+
seconds: number;
|
|
1018
|
+
};
|
|
1019
|
+
|
|
1020
|
+
export type PassingProduction = {
|
|
1021
|
+
attempts: number;
|
|
1022
|
+
completions: number;
|
|
1023
|
+
incompletions: number;
|
|
1024
|
+
interceptions: number;
|
|
1025
|
+
completionRate: (number) | null;
|
|
1026
|
+
/**
|
|
1027
|
+
* Number of attempts with non-null air yards, including zero-yard values.
|
|
1028
|
+
*/
|
|
1029
|
+
airYardsAttemptsAvailable: number;
|
|
1030
|
+
totalAirYards: (number) | null;
|
|
1031
|
+
averageDepthOfTarget: (number) | null;
|
|
1032
|
+
/**
|
|
1033
|
+
* Number of attempts with non-null total yards, including zero-yard
|
|
1034
|
+
* incompletions and interceptions.
|
|
1035
|
+
*/
|
|
1036
|
+
totalYardsAttemptsAvailable: number;
|
|
1037
|
+
totalYards: (number) | null;
|
|
1038
|
+
/**
|
|
1039
|
+
* Number of completed attempts with valid total yards and air yards to
|
|
1040
|
+
* calculate yards after catch, including zero-yard values.
|
|
1041
|
+
*/
|
|
1042
|
+
yardsAfterCatchAttemptsAvailable: number;
|
|
1043
|
+
totalYardsAfterCatch: (number) | null;
|
|
1044
|
+
averageYardsAfterCatch: (number) | null;
|
|
1045
|
+
};
|
|
1046
|
+
|
|
1047
|
+
export type PassLocation = 'short left' | 'short middle' | 'short right' | 'deep left' | 'deep middle' | 'deep right';
|
|
1048
|
+
|
|
1049
|
+
export type PassOutcome = 'completion' | 'incompletion' | 'interception';
|
|
1050
|
+
|
|
1051
|
+
export type PassParseStatus = 'complete' | 'partial' | 'invalid';
|
|
1052
|
+
|
|
973
1053
|
export type Play = {
|
|
974
1054
|
id: string;
|
|
975
1055
|
driveId: string;
|
|
@@ -1047,6 +1127,74 @@ export type PlayerGameUsage = {
|
|
|
1047
1127
|
position: string;
|
|
1048
1128
|
};
|
|
1049
1129
|
|
|
1130
|
+
export type PlayerPassingGame = {
|
|
1131
|
+
attempts: number;
|
|
1132
|
+
completions: number;
|
|
1133
|
+
incompletions: number;
|
|
1134
|
+
interceptions: number;
|
|
1135
|
+
completionRate: (number) | null;
|
|
1136
|
+
/**
|
|
1137
|
+
* Number of attempts with non-null air yards, including zero-yard values.
|
|
1138
|
+
*/
|
|
1139
|
+
airYardsAttemptsAvailable: number;
|
|
1140
|
+
totalAirYards: (number) | null;
|
|
1141
|
+
averageDepthOfTarget: (number) | null;
|
|
1142
|
+
/**
|
|
1143
|
+
* Number of attempts with non-null total yards, including zero-yard
|
|
1144
|
+
* incompletions and interceptions.
|
|
1145
|
+
*/
|
|
1146
|
+
totalYardsAttemptsAvailable: number;
|
|
1147
|
+
totalYards: (number) | null;
|
|
1148
|
+
/**
|
|
1149
|
+
* Number of completed attempts with valid total yards and air yards to
|
|
1150
|
+
* calculate yards after catch, including zero-yard values.
|
|
1151
|
+
*/
|
|
1152
|
+
yardsAfterCatchAttemptsAvailable: number;
|
|
1153
|
+
totalYardsAfterCatch: (number) | null;
|
|
1154
|
+
averageYardsAfterCatch: (number) | null;
|
|
1155
|
+
gameId: number;
|
|
1156
|
+
season: number;
|
|
1157
|
+
week: number;
|
|
1158
|
+
seasonType: SeasonType;
|
|
1159
|
+
playerId: string;
|
|
1160
|
+
player: string;
|
|
1161
|
+
team: string;
|
|
1162
|
+
conference: (string) | null;
|
|
1163
|
+
opponent: string;
|
|
1164
|
+
};
|
|
1165
|
+
|
|
1166
|
+
export type PlayerPassingSeason = {
|
|
1167
|
+
attempts: number;
|
|
1168
|
+
completions: number;
|
|
1169
|
+
incompletions: number;
|
|
1170
|
+
interceptions: number;
|
|
1171
|
+
completionRate: (number) | null;
|
|
1172
|
+
/**
|
|
1173
|
+
* Number of attempts with non-null air yards, including zero-yard values.
|
|
1174
|
+
*/
|
|
1175
|
+
airYardsAttemptsAvailable: number;
|
|
1176
|
+
totalAirYards: (number) | null;
|
|
1177
|
+
averageDepthOfTarget: (number) | null;
|
|
1178
|
+
/**
|
|
1179
|
+
* Number of attempts with non-null total yards, including zero-yard
|
|
1180
|
+
* incompletions and interceptions.
|
|
1181
|
+
*/
|
|
1182
|
+
totalYardsAttemptsAvailable: number;
|
|
1183
|
+
totalYards: (number) | null;
|
|
1184
|
+
/**
|
|
1185
|
+
* Number of completed attempts with valid total yards and air yards to
|
|
1186
|
+
* calculate yards after catch, including zero-yard values.
|
|
1187
|
+
*/
|
|
1188
|
+
yardsAfterCatchAttemptsAvailable: number;
|
|
1189
|
+
totalYardsAfterCatch: (number) | null;
|
|
1190
|
+
averageYardsAfterCatch: (number) | null;
|
|
1191
|
+
season: number;
|
|
1192
|
+
playerId: string;
|
|
1193
|
+
player: string;
|
|
1194
|
+
team: string;
|
|
1195
|
+
conference: (string) | null;
|
|
1196
|
+
};
|
|
1197
|
+
|
|
1050
1198
|
export type PlayerPPA = {
|
|
1051
1199
|
player: string;
|
|
1052
1200
|
team: string;
|
|
@@ -1709,6 +1857,26 @@ export type TeamHavoc = {
|
|
|
1709
1857
|
db: number;
|
|
1710
1858
|
};
|
|
1711
1859
|
|
|
1860
|
+
export type TeamPassingGame = {
|
|
1861
|
+
gameId: number;
|
|
1862
|
+
season: number;
|
|
1863
|
+
week: number;
|
|
1864
|
+
seasonType: SeasonType;
|
|
1865
|
+
team: string;
|
|
1866
|
+
conference: (string) | null;
|
|
1867
|
+
opponent: string;
|
|
1868
|
+
offense: PassingProduction;
|
|
1869
|
+
defense: PassingProduction;
|
|
1870
|
+
};
|
|
1871
|
+
|
|
1872
|
+
export type TeamPassingSeason = {
|
|
1873
|
+
season: number;
|
|
1874
|
+
team: string;
|
|
1875
|
+
conference: (string) | null;
|
|
1876
|
+
offense: PassingProduction;
|
|
1877
|
+
defense: PassingProduction;
|
|
1878
|
+
};
|
|
1879
|
+
|
|
1712
1880
|
export type TeamPPA = {
|
|
1713
1881
|
team: string;
|
|
1714
1882
|
plays: number;
|
|
@@ -2999,6 +3167,195 @@ export type GetTransferPortalResponse = (Array<PlayerTransfer>);
|
|
|
2999
3167
|
|
|
3000
3168
|
export type GetTransferPortalError = unknown;
|
|
3001
3169
|
|
|
3170
|
+
export type GetPassingPlaysData = {
|
|
3171
|
+
query: {
|
|
3172
|
+
/**
|
|
3173
|
+
* Division classification. Defaults to `fbs`.
|
|
3174
|
+
*/
|
|
3175
|
+
classification?: DivisionClassification;
|
|
3176
|
+
/**
|
|
3177
|
+
* Conference name or abbreviation on either side of the pass.
|
|
3178
|
+
*/
|
|
3179
|
+
conference?: string;
|
|
3180
|
+
/**
|
|
3181
|
+
* Defensive team name.
|
|
3182
|
+
*/
|
|
3183
|
+
defense?: string;
|
|
3184
|
+
/**
|
|
3185
|
+
* Game ID.
|
|
3186
|
+
*/
|
|
3187
|
+
gameId?: number;
|
|
3188
|
+
/**
|
|
3189
|
+
* Offensive team name.
|
|
3190
|
+
*/
|
|
3191
|
+
offense?: string;
|
|
3192
|
+
/**
|
|
3193
|
+
* Pass outcome.
|
|
3194
|
+
*/
|
|
3195
|
+
outcome?: PassOutcome;
|
|
3196
|
+
/**
|
|
3197
|
+
* Passer athlete ID.
|
|
3198
|
+
*/
|
|
3199
|
+
passerId?: string;
|
|
3200
|
+
/**
|
|
3201
|
+
* Season type.
|
|
3202
|
+
*/
|
|
3203
|
+
seasonType?: SeasonType;
|
|
3204
|
+
/**
|
|
3205
|
+
* Intended target athlete ID.
|
|
3206
|
+
*/
|
|
3207
|
+
targetId?: string;
|
|
3208
|
+
/**
|
|
3209
|
+
* Team name on either side of the pass. Either team or week is required.
|
|
3210
|
+
*/
|
|
3211
|
+
team?: string;
|
|
3212
|
+
/**
|
|
3213
|
+
* Week number. Either team or week is required.
|
|
3214
|
+
*/
|
|
3215
|
+
week?: number;
|
|
3216
|
+
/**
|
|
3217
|
+
* Season year.
|
|
3218
|
+
*/
|
|
3219
|
+
year: number;
|
|
3220
|
+
};
|
|
3221
|
+
};
|
|
3222
|
+
|
|
3223
|
+
export type GetPassingPlaysResponse = (Array<PassingPlay>);
|
|
3224
|
+
|
|
3225
|
+
export type GetPassingPlaysError = unknown;
|
|
3226
|
+
|
|
3227
|
+
export type GetPlayerPassingBySeasonData = {
|
|
3228
|
+
query?: {
|
|
3229
|
+
/**
|
|
3230
|
+
* Division classification. Defaults to `fbs`.
|
|
3231
|
+
*/
|
|
3232
|
+
classification?: DivisionClassification;
|
|
3233
|
+
/**
|
|
3234
|
+
* Conference name or abbreviation.
|
|
3235
|
+
*/
|
|
3236
|
+
conference?: string;
|
|
3237
|
+
/**
|
|
3238
|
+
* Passer athlete ID. Required unless year is specified.
|
|
3239
|
+
*/
|
|
3240
|
+
passerId?: string;
|
|
3241
|
+
/**
|
|
3242
|
+
* Season type.
|
|
3243
|
+
*/
|
|
3244
|
+
seasonType?: SeasonType;
|
|
3245
|
+
/**
|
|
3246
|
+
* Team name.
|
|
3247
|
+
*/
|
|
3248
|
+
team?: string;
|
|
3249
|
+
/**
|
|
3250
|
+
* Season year. Required unless passerId is specified.
|
|
3251
|
+
*/
|
|
3252
|
+
year?: number;
|
|
3253
|
+
};
|
|
3254
|
+
};
|
|
3255
|
+
|
|
3256
|
+
export type GetPlayerPassingBySeasonResponse = (Array<PlayerPassingSeason>);
|
|
3257
|
+
|
|
3258
|
+
export type GetPlayerPassingBySeasonError = unknown;
|
|
3259
|
+
|
|
3260
|
+
export type GetPlayerPassingByGameData = {
|
|
3261
|
+
query: {
|
|
3262
|
+
/**
|
|
3263
|
+
* Division classification. Defaults to `fbs`.
|
|
3264
|
+
*/
|
|
3265
|
+
classification?: DivisionClassification;
|
|
3266
|
+
/**
|
|
3267
|
+
* Conference name or abbreviation.
|
|
3268
|
+
*/
|
|
3269
|
+
conference?: string;
|
|
3270
|
+
/**
|
|
3271
|
+
* Passer athlete ID. Either passerId, team, or week is required.
|
|
3272
|
+
*/
|
|
3273
|
+
passerId?: string;
|
|
3274
|
+
/**
|
|
3275
|
+
* Season type.
|
|
3276
|
+
*/
|
|
3277
|
+
seasonType?: SeasonType;
|
|
3278
|
+
/**
|
|
3279
|
+
* Team name. Either passerId, team, or week is required.
|
|
3280
|
+
*/
|
|
3281
|
+
team?: string;
|
|
3282
|
+
/**
|
|
3283
|
+
* Week number. Either passerId, team, or week is required.
|
|
3284
|
+
*/
|
|
3285
|
+
week?: number;
|
|
3286
|
+
/**
|
|
3287
|
+
* Season year. Required.
|
|
3288
|
+
*/
|
|
3289
|
+
year: number;
|
|
3290
|
+
};
|
|
3291
|
+
};
|
|
3292
|
+
|
|
3293
|
+
export type GetPlayerPassingByGameResponse = (Array<PlayerPassingGame>);
|
|
3294
|
+
|
|
3295
|
+
export type GetPlayerPassingByGameError = unknown;
|
|
3296
|
+
|
|
3297
|
+
export type GetTeamPassingBySeasonData = {
|
|
3298
|
+
query?: {
|
|
3299
|
+
/**
|
|
3300
|
+
* Division classification. Defaults to `fbs`.
|
|
3301
|
+
*/
|
|
3302
|
+
classification?: DivisionClassification;
|
|
3303
|
+
/**
|
|
3304
|
+
* Conference name or abbreviation.
|
|
3305
|
+
*/
|
|
3306
|
+
conference?: string;
|
|
3307
|
+
/**
|
|
3308
|
+
* Season type.
|
|
3309
|
+
*/
|
|
3310
|
+
seasonType?: SeasonType;
|
|
3311
|
+
/**
|
|
3312
|
+
* Team name. Required unless year is specified.
|
|
3313
|
+
*/
|
|
3314
|
+
team?: string;
|
|
3315
|
+
/**
|
|
3316
|
+
* Season year. Required unless team is specified.
|
|
3317
|
+
*/
|
|
3318
|
+
year?: number;
|
|
3319
|
+
};
|
|
3320
|
+
};
|
|
3321
|
+
|
|
3322
|
+
export type GetTeamPassingBySeasonResponse = (Array<TeamPassingSeason>);
|
|
3323
|
+
|
|
3324
|
+
export type GetTeamPassingBySeasonError = unknown;
|
|
3325
|
+
|
|
3326
|
+
export type GetTeamPassingByGameData = {
|
|
3327
|
+
query: {
|
|
3328
|
+
/**
|
|
3329
|
+
* Division classification. Defaults to `fbs`.
|
|
3330
|
+
*/
|
|
3331
|
+
classification?: DivisionClassification;
|
|
3332
|
+
/**
|
|
3333
|
+
* Conference name or abbreviation.
|
|
3334
|
+
*/
|
|
3335
|
+
conference?: string;
|
|
3336
|
+
/**
|
|
3337
|
+
* Season type.
|
|
3338
|
+
*/
|
|
3339
|
+
seasonType?: SeasonType;
|
|
3340
|
+
/**
|
|
3341
|
+
* Team name. Either team or week is required.
|
|
3342
|
+
*/
|
|
3343
|
+
team?: string;
|
|
3344
|
+
/**
|
|
3345
|
+
* Week number. Either team or week is required.
|
|
3346
|
+
*/
|
|
3347
|
+
week?: number;
|
|
3348
|
+
/**
|
|
3349
|
+
* Season year. Required.
|
|
3350
|
+
*/
|
|
3351
|
+
year: number;
|
|
3352
|
+
};
|
|
3353
|
+
};
|
|
3354
|
+
|
|
3355
|
+
export type GetTeamPassingByGameResponse = (Array<TeamPassingGame>);
|
|
3356
|
+
|
|
3357
|
+
export type GetTeamPassingByGameError = unknown;
|
|
3358
|
+
|
|
3002
3359
|
export type GetPredictedPointsData = {
|
|
3003
3360
|
query: {
|
|
3004
3361
|
/**
|
package/cfbd-5.24.2.tgz
DELETED
|
Binary file
|