cfbd 5.15.0 → 5.17.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.17.0.tgz +0 -0
- package/dist/sdk.gen.d.ts +9 -1
- package/dist/sdk.gen.js +18 -2
- package/dist/types.gen.d.ts +117 -0
- package/package.json +1 -1
- package/src/sdk.gen.ts +21 -1
- package/src/types.gen.ts +127 -0
- package/cfbd-5.15.0.tgz +0 -0
package/cfbd-5.17.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, GetConferencesResponse, GetTalentData, GetTalentResponse, GetVenuesResponse, GetPlayerSeasonStatsData, GetPlayerSeasonStatsResponse, 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';
|
|
2
|
+
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';
|
|
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
|
* Retrieve opponent-adjusted team season statistics
|
|
@@ -53,6 +53,14 @@ export declare const getVenues: <ThrowOnError extends boolean = false>(options?:
|
|
|
53
53
|
* Retrieves aggregated player statistics for a given season
|
|
54
54
|
*/
|
|
55
55
|
export declare const getPlayerSeasonStats: <ThrowOnError extends boolean = false>(options: OptionsLegacyParser<GetPlayerSeasonStatsData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetPlayerSeasonStatsResponse, unknown, ThrowOnError>;
|
|
56
|
+
/**
|
|
57
|
+
* Retrieves player passing and rushing success rates by season
|
|
58
|
+
*/
|
|
59
|
+
export declare const getPlayerSeasonSuccessRates: <ThrowOnError extends boolean = false>(options?: OptionsLegacyParser<GetPlayerSeasonSuccessRatesData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetPlayerSeasonSuccessRatesResponse, unknown, ThrowOnError>;
|
|
60
|
+
/**
|
|
61
|
+
* Retrieves player passing and rushing success rates by game
|
|
62
|
+
*/
|
|
63
|
+
export declare const getPlayerGameSuccessRates: <ThrowOnError extends boolean = false>(options: OptionsLegacyParser<GetPlayerGameSuccessRatesData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetPlayerGameSuccessRatesResponse, unknown, ThrowOnError>;
|
|
56
64
|
/**
|
|
57
65
|
* Retrieves aggregated team season statistics
|
|
58
66
|
*/
|
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.getCoaches = exports.getDraftPicks = exports.getDraftPositions = exports.getDraftTeams = exports.getDrives = exports.getScoreboard = exports.getCalendar = exports.getRecords = exports.getWeather = exports.getMedia = exports.getGamePlayerStats = exports.getGameTeamStats = void 0;
|
|
15
|
+
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;
|
|
16
|
+
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;
|
|
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
|
/**
|
|
@@ -120,6 +120,22 @@ var getPlayerSeasonStats = function (options) {
|
|
|
120
120
|
return ((_a = options === null || options === void 0 ? void 0 : options.client) !== null && _a !== void 0 ? _a : exports.client).get(__assign(__assign({}, options), { url: '/stats/player/season' }));
|
|
121
121
|
};
|
|
122
122
|
exports.getPlayerSeasonStats = getPlayerSeasonStats;
|
|
123
|
+
/**
|
|
124
|
+
* Retrieves player passing and rushing success rates by season
|
|
125
|
+
*/
|
|
126
|
+
var getPlayerSeasonSuccessRates = function (options) {
|
|
127
|
+
var _a;
|
|
128
|
+
return ((_a = options === null || options === void 0 ? void 0 : options.client) !== null && _a !== void 0 ? _a : exports.client).get(__assign(__assign({}, options), { url: '/stats/player/success' }));
|
|
129
|
+
};
|
|
130
|
+
exports.getPlayerSeasonSuccessRates = getPlayerSeasonSuccessRates;
|
|
131
|
+
/**
|
|
132
|
+
* Retrieves player passing and rushing success rates by game
|
|
133
|
+
*/
|
|
134
|
+
var getPlayerGameSuccessRates = function (options) {
|
|
135
|
+
var _a;
|
|
136
|
+
return ((_a = options === null || options === void 0 ? void 0 : options.client) !== null && _a !== void 0 ? _a : exports.client).get(__assign(__assign({}, options), { url: '/stats/player/success/game' }));
|
|
137
|
+
};
|
|
138
|
+
exports.getPlayerGameSuccessRates = getPlayerGameSuccessRates;
|
|
123
139
|
/**
|
|
124
140
|
* Retrieves aggregated team season statistics
|
|
125
141
|
*/
|
package/dist/types.gen.d.ts
CHANGED
|
@@ -765,6 +765,20 @@ export type PlayerGamePredictedPointsAdded = {
|
|
|
765
765
|
all: number;
|
|
766
766
|
};
|
|
767
767
|
};
|
|
768
|
+
export type PlayerGameSuccessRate = {
|
|
769
|
+
season: number;
|
|
770
|
+
seasonType: SeasonTypeDB;
|
|
771
|
+
week: number;
|
|
772
|
+
gameId: number;
|
|
773
|
+
id: string;
|
|
774
|
+
name: string;
|
|
775
|
+
position: string;
|
|
776
|
+
team: string;
|
|
777
|
+
conference: string;
|
|
778
|
+
opponent: string;
|
|
779
|
+
passing: PlayerSuccessRateSplit;
|
|
780
|
+
rushing: PlayerSuccessRateSplit;
|
|
781
|
+
};
|
|
768
782
|
export type PlayerGameUsage = {
|
|
769
783
|
total: number;
|
|
770
784
|
quarter1: (number) | null;
|
|
@@ -801,6 +815,14 @@ export type PlayerSearchResult = {
|
|
|
801
815
|
hometown: string;
|
|
802
816
|
teamColor: string;
|
|
803
817
|
teamColorSecondary: string;
|
|
818
|
+
activeStartYear: (number) | null;
|
|
819
|
+
activeEndYear: (number) | null;
|
|
820
|
+
teamStints: Array<PlayerSearchTeamStint>;
|
|
821
|
+
};
|
|
822
|
+
export type PlayerSearchTeamStint = {
|
|
823
|
+
team: string;
|
|
824
|
+
startYear: (number) | null;
|
|
825
|
+
endYear: (number) | null;
|
|
804
826
|
};
|
|
805
827
|
export type PlayerSeasonOverview = {
|
|
806
828
|
season: number;
|
|
@@ -883,6 +905,16 @@ export type PlayerSeasonPredictedPointsAdded = {
|
|
|
883
905
|
all: number;
|
|
884
906
|
};
|
|
885
907
|
};
|
|
908
|
+
export type PlayerSeasonSuccessRate = {
|
|
909
|
+
season: number;
|
|
910
|
+
id: string;
|
|
911
|
+
name: string;
|
|
912
|
+
position: string;
|
|
913
|
+
team: string;
|
|
914
|
+
conference: string;
|
|
915
|
+
passing: PlayerSuccessRateSplit;
|
|
916
|
+
rushing: PlayerSuccessRateSplit;
|
|
917
|
+
};
|
|
886
918
|
export type PlayerStat = {
|
|
887
919
|
season: number;
|
|
888
920
|
playerId: string;
|
|
@@ -903,6 +935,11 @@ export type PlayerStatsByQuarter = {
|
|
|
903
935
|
rushing: number;
|
|
904
936
|
passing: number;
|
|
905
937
|
};
|
|
938
|
+
export type PlayerSuccessRateSplit = {
|
|
939
|
+
plays: number;
|
|
940
|
+
successes: number;
|
|
941
|
+
successRate: (number) | null;
|
|
942
|
+
};
|
|
906
943
|
export type PlayerTransfer = {
|
|
907
944
|
season: number;
|
|
908
945
|
firstName: string;
|
|
@@ -1660,6 +1697,86 @@ export type GetPlayerSeasonStatsData = {
|
|
|
1660
1697
|
};
|
|
1661
1698
|
export type GetPlayerSeasonStatsResponse = (Array<PlayerStat>);
|
|
1662
1699
|
export type GetPlayerSeasonStatsError = unknown;
|
|
1700
|
+
export type GetPlayerSeasonSuccessRatesData = {
|
|
1701
|
+
query?: {
|
|
1702
|
+
/**
|
|
1703
|
+
* Optional conference abbreviation filter
|
|
1704
|
+
*/
|
|
1705
|
+
conference?: string;
|
|
1706
|
+
/**
|
|
1707
|
+
* Optional ending week range
|
|
1708
|
+
*/
|
|
1709
|
+
endWeek?: number;
|
|
1710
|
+
/**
|
|
1711
|
+
* Optional flag to exclude garbage time plays
|
|
1712
|
+
*/
|
|
1713
|
+
excludeGarbageTime?: boolean;
|
|
1714
|
+
/**
|
|
1715
|
+
* Player ID filter, required if year not specified
|
|
1716
|
+
*/
|
|
1717
|
+
playerId?: number;
|
|
1718
|
+
/**
|
|
1719
|
+
* Optional season type filter
|
|
1720
|
+
*/
|
|
1721
|
+
seasonType?: SeasonType;
|
|
1722
|
+
/**
|
|
1723
|
+
* Optional starting week range
|
|
1724
|
+
*/
|
|
1725
|
+
startWeek?: number;
|
|
1726
|
+
/**
|
|
1727
|
+
* Optional team filter
|
|
1728
|
+
*/
|
|
1729
|
+
team?: string;
|
|
1730
|
+
/**
|
|
1731
|
+
* Optional minimum credited passing plus rushing plays
|
|
1732
|
+
*/
|
|
1733
|
+
threshold?: number;
|
|
1734
|
+
/**
|
|
1735
|
+
* Year filter, required if playerId not specified
|
|
1736
|
+
*/
|
|
1737
|
+
year?: number;
|
|
1738
|
+
};
|
|
1739
|
+
};
|
|
1740
|
+
export type GetPlayerSeasonSuccessRatesResponse = (Array<PlayerSeasonSuccessRate>);
|
|
1741
|
+
export type GetPlayerSeasonSuccessRatesError = unknown;
|
|
1742
|
+
export type GetPlayerGameSuccessRatesData = {
|
|
1743
|
+
query: {
|
|
1744
|
+
/**
|
|
1745
|
+
* Optional conference abbreviation filter
|
|
1746
|
+
*/
|
|
1747
|
+
conference?: string;
|
|
1748
|
+
/**
|
|
1749
|
+
* Optional flag to exclude garbage time plays
|
|
1750
|
+
*/
|
|
1751
|
+
excludeGarbageTime?: boolean;
|
|
1752
|
+
/**
|
|
1753
|
+
* Optional player ID filter
|
|
1754
|
+
*/
|
|
1755
|
+
playerId?: number;
|
|
1756
|
+
/**
|
|
1757
|
+
* Optional season type filter
|
|
1758
|
+
*/
|
|
1759
|
+
seasonType?: SeasonType;
|
|
1760
|
+
/**
|
|
1761
|
+
* Optional team filter
|
|
1762
|
+
*/
|
|
1763
|
+
team?: string;
|
|
1764
|
+
/**
|
|
1765
|
+
* Optional minimum credited passing plus rushing plays
|
|
1766
|
+
*/
|
|
1767
|
+
threshold?: number;
|
|
1768
|
+
/**
|
|
1769
|
+
* Week filter, required if team and playerId not specified
|
|
1770
|
+
*/
|
|
1771
|
+
week?: number;
|
|
1772
|
+
/**
|
|
1773
|
+
* Required year filter
|
|
1774
|
+
*/
|
|
1775
|
+
year: number;
|
|
1776
|
+
};
|
|
1777
|
+
};
|
|
1778
|
+
export type GetPlayerGameSuccessRatesResponse = (Array<PlayerGameSuccessRate>);
|
|
1779
|
+
export type GetPlayerGameSuccessRatesError = unknown;
|
|
1663
1780
|
export type GetTeamStatsData = {
|
|
1664
1781
|
query?: {
|
|
1665
1782
|
/**
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "cfbd",
|
|
3
|
-
"version": "5.
|
|
3
|
+
"version": "5.17.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, GetConferencesError, GetConferencesResponse, GetTalentData, GetTalentError, GetTalentResponse, GetVenuesError, GetVenuesResponse, GetPlayerSeasonStatsData, GetPlayerSeasonStatsError, GetPlayerSeasonStatsResponse, 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';
|
|
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, 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';
|
|
5
5
|
|
|
6
6
|
export const client = createClient(createConfig({ baseUrl: 'https://api.collegefootballdata.com' }));
|
|
7
7
|
|
|
@@ -135,6 +135,26 @@ export const getPlayerSeasonStats = <ThrowOnError extends boolean = false>(optio
|
|
|
135
135
|
});
|
|
136
136
|
};
|
|
137
137
|
|
|
138
|
+
/**
|
|
139
|
+
* Retrieves player passing and rushing success rates by season
|
|
140
|
+
*/
|
|
141
|
+
export const getPlayerSeasonSuccessRates = <ThrowOnError extends boolean = false>(options?: OptionsLegacyParser<GetPlayerSeasonSuccessRatesData, ThrowOnError>) => {
|
|
142
|
+
return (options?.client ?? client).get<GetPlayerSeasonSuccessRatesResponse, GetPlayerSeasonSuccessRatesError, ThrowOnError>({
|
|
143
|
+
...options,
|
|
144
|
+
url: '/stats/player/success'
|
|
145
|
+
});
|
|
146
|
+
};
|
|
147
|
+
|
|
148
|
+
/**
|
|
149
|
+
* Retrieves player passing and rushing success rates by game
|
|
150
|
+
*/
|
|
151
|
+
export const getPlayerGameSuccessRates = <ThrowOnError extends boolean = false>(options: OptionsLegacyParser<GetPlayerGameSuccessRatesData, ThrowOnError>) => {
|
|
152
|
+
return (options?.client ?? client).get<GetPlayerGameSuccessRatesResponse, GetPlayerGameSuccessRatesError, ThrowOnError>({
|
|
153
|
+
...options,
|
|
154
|
+
url: '/stats/player/success/game'
|
|
155
|
+
});
|
|
156
|
+
};
|
|
157
|
+
|
|
138
158
|
/**
|
|
139
159
|
* Retrieves aggregated team season statistics
|
|
140
160
|
*/
|
package/src/types.gen.ts
CHANGED
|
@@ -811,6 +811,21 @@ export type PlayerGamePredictedPointsAdded = {
|
|
|
811
811
|
};
|
|
812
812
|
};
|
|
813
813
|
|
|
814
|
+
export type PlayerGameSuccessRate = {
|
|
815
|
+
season: number;
|
|
816
|
+
seasonType: SeasonTypeDB;
|
|
817
|
+
week: number;
|
|
818
|
+
gameId: number;
|
|
819
|
+
id: string;
|
|
820
|
+
name: string;
|
|
821
|
+
position: string;
|
|
822
|
+
team: string;
|
|
823
|
+
conference: string;
|
|
824
|
+
opponent: string;
|
|
825
|
+
passing: PlayerSuccessRateSplit;
|
|
826
|
+
rushing: PlayerSuccessRateSplit;
|
|
827
|
+
};
|
|
828
|
+
|
|
814
829
|
export type PlayerGameUsage = {
|
|
815
830
|
total: number;
|
|
816
831
|
quarter1: (number) | null;
|
|
@@ -850,6 +865,15 @@ export type PlayerSearchResult = {
|
|
|
850
865
|
hometown: string;
|
|
851
866
|
teamColor: string;
|
|
852
867
|
teamColorSecondary: string;
|
|
868
|
+
activeStartYear: (number) | null;
|
|
869
|
+
activeEndYear: (number) | null;
|
|
870
|
+
teamStints: Array<PlayerSearchTeamStint>;
|
|
871
|
+
};
|
|
872
|
+
|
|
873
|
+
export type PlayerSearchTeamStint = {
|
|
874
|
+
team: string;
|
|
875
|
+
startYear: (number) | null;
|
|
876
|
+
endYear: (number) | null;
|
|
853
877
|
};
|
|
854
878
|
|
|
855
879
|
export type PlayerSeasonOverview = {
|
|
@@ -938,6 +962,17 @@ export type PlayerSeasonPredictedPointsAdded = {
|
|
|
938
962
|
};
|
|
939
963
|
};
|
|
940
964
|
|
|
965
|
+
export type PlayerSeasonSuccessRate = {
|
|
966
|
+
season: number;
|
|
967
|
+
id: string;
|
|
968
|
+
name: string;
|
|
969
|
+
position: string;
|
|
970
|
+
team: string;
|
|
971
|
+
conference: string;
|
|
972
|
+
passing: PlayerSuccessRateSplit;
|
|
973
|
+
rushing: PlayerSuccessRateSplit;
|
|
974
|
+
};
|
|
975
|
+
|
|
941
976
|
export type PlayerStat = {
|
|
942
977
|
season: number;
|
|
943
978
|
playerId: string;
|
|
@@ -960,6 +995,12 @@ export type PlayerStatsByQuarter = {
|
|
|
960
995
|
passing: number;
|
|
961
996
|
};
|
|
962
997
|
|
|
998
|
+
export type PlayerSuccessRateSplit = {
|
|
999
|
+
plays: number;
|
|
1000
|
+
successes: number;
|
|
1001
|
+
successRate: (number) | null;
|
|
1002
|
+
};
|
|
1003
|
+
|
|
963
1004
|
export type PlayerTransfer = {
|
|
964
1005
|
season: number;
|
|
965
1006
|
firstName: string;
|
|
@@ -1804,6 +1845,92 @@ export type GetPlayerSeasonStatsResponse = (Array<PlayerStat>);
|
|
|
1804
1845
|
|
|
1805
1846
|
export type GetPlayerSeasonStatsError = unknown;
|
|
1806
1847
|
|
|
1848
|
+
export type GetPlayerSeasonSuccessRatesData = {
|
|
1849
|
+
query?: {
|
|
1850
|
+
/**
|
|
1851
|
+
* Optional conference abbreviation filter
|
|
1852
|
+
*/
|
|
1853
|
+
conference?: string;
|
|
1854
|
+
/**
|
|
1855
|
+
* Optional ending week range
|
|
1856
|
+
*/
|
|
1857
|
+
endWeek?: number;
|
|
1858
|
+
/**
|
|
1859
|
+
* Optional flag to exclude garbage time plays
|
|
1860
|
+
*/
|
|
1861
|
+
excludeGarbageTime?: boolean;
|
|
1862
|
+
/**
|
|
1863
|
+
* Player ID filter, required if year not specified
|
|
1864
|
+
*/
|
|
1865
|
+
playerId?: number;
|
|
1866
|
+
/**
|
|
1867
|
+
* Optional season type filter
|
|
1868
|
+
*/
|
|
1869
|
+
seasonType?: SeasonType;
|
|
1870
|
+
/**
|
|
1871
|
+
* Optional starting week range
|
|
1872
|
+
*/
|
|
1873
|
+
startWeek?: number;
|
|
1874
|
+
/**
|
|
1875
|
+
* Optional team filter
|
|
1876
|
+
*/
|
|
1877
|
+
team?: string;
|
|
1878
|
+
/**
|
|
1879
|
+
* Optional minimum credited passing plus rushing plays
|
|
1880
|
+
*/
|
|
1881
|
+
threshold?: number;
|
|
1882
|
+
/**
|
|
1883
|
+
* Year filter, required if playerId not specified
|
|
1884
|
+
*/
|
|
1885
|
+
year?: number;
|
|
1886
|
+
};
|
|
1887
|
+
};
|
|
1888
|
+
|
|
1889
|
+
export type GetPlayerSeasonSuccessRatesResponse = (Array<PlayerSeasonSuccessRate>);
|
|
1890
|
+
|
|
1891
|
+
export type GetPlayerSeasonSuccessRatesError = unknown;
|
|
1892
|
+
|
|
1893
|
+
export type GetPlayerGameSuccessRatesData = {
|
|
1894
|
+
query: {
|
|
1895
|
+
/**
|
|
1896
|
+
* Optional conference abbreviation filter
|
|
1897
|
+
*/
|
|
1898
|
+
conference?: string;
|
|
1899
|
+
/**
|
|
1900
|
+
* Optional flag to exclude garbage time plays
|
|
1901
|
+
*/
|
|
1902
|
+
excludeGarbageTime?: boolean;
|
|
1903
|
+
/**
|
|
1904
|
+
* Optional player ID filter
|
|
1905
|
+
*/
|
|
1906
|
+
playerId?: number;
|
|
1907
|
+
/**
|
|
1908
|
+
* Optional season type filter
|
|
1909
|
+
*/
|
|
1910
|
+
seasonType?: SeasonType;
|
|
1911
|
+
/**
|
|
1912
|
+
* Optional team filter
|
|
1913
|
+
*/
|
|
1914
|
+
team?: string;
|
|
1915
|
+
/**
|
|
1916
|
+
* Optional minimum credited passing plus rushing plays
|
|
1917
|
+
*/
|
|
1918
|
+
threshold?: number;
|
|
1919
|
+
/**
|
|
1920
|
+
* Week filter, required if team and playerId not specified
|
|
1921
|
+
*/
|
|
1922
|
+
week?: number;
|
|
1923
|
+
/**
|
|
1924
|
+
* Required year filter
|
|
1925
|
+
*/
|
|
1926
|
+
year: number;
|
|
1927
|
+
};
|
|
1928
|
+
};
|
|
1929
|
+
|
|
1930
|
+
export type GetPlayerGameSuccessRatesResponse = (Array<PlayerGameSuccessRate>);
|
|
1931
|
+
|
|
1932
|
+
export type GetPlayerGameSuccessRatesError = unknown;
|
|
1933
|
+
|
|
1807
1934
|
export type GetTeamStatsData = {
|
|
1808
1935
|
query?: {
|
|
1809
1936
|
/**
|
package/cfbd-5.15.0.tgz
DELETED
|
Binary file
|