cfbd/dist/sdk.gen.d.ts

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.

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, GetTeamStatsData, GetTeamStatsResponse, GetCategoriesResponse, GetAdvancedSeasonStatsData, GetAdvancedSeasonStatsResponse, GetAdvancedGameStatsData, GetAdvancedGameStatsResponse, 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, GetReturningProductionData, GetReturningProductionResponse, GetTransferPortalData, GetTransferPortalResponse, GetPredictedPointsData, GetPredictedPointsResponse, GetPredictedPointsAddedByTeamData, GetPredictedPointsAddedByTeamResponse, GetPredictedPointsAddedByGameData, GetPredictedPointsAddedByGameResponse, GetPredictedPointsAddedByPlayerGameData, GetPredictedPointsAddedByPlayerGameResponse, GetPredictedPointsAddedByPlayerSeasonData, GetPredictedPointsAddedByPlayerSeasonResponse, GetWinProbabilityData, GetWinProbabilityResponse, GetPregameWinProbabilitiesData, GetPregameWinProbabilitiesResponse, GetFieldGoalExpectedPointsResponse, GetLivePlaysData, GetLinesData, GetLinesResponse, GetUserInfoResponse, 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';
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
 */
export declare const getAdjustedTeamSeasonStats: <ThrowOnError extends boolean = false>(options?: OptionsLegacyParser<GetAdjustedTeamSeasonStatsData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetAdjustedTeamSeasonStatsResponse, unknown, ThrowOnError>;
/**
 * Retrieve opponent-adjusted player passing statistics
 */
export declare const getAdjustedPlayerPassingStats: <ThrowOnError extends boolean = false>(options?: OptionsLegacyParser<GetAdjustedPlayerPassingStatsData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetAdjustedPlayerPassingStatsResponse, unknown, ThrowOnError>;
/**
 * Retrieve opponent-adjusted player rushing statistics
 */
export declare const getAdjustedPlayerRushingStats: <ThrowOnError extends boolean = false>(options?: OptionsLegacyParser<GetAdjustedPlayerRushingStatsData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetAdjustedPlayerRushingStatsResponse, unknown, ThrowOnError>;
/**
 * Retrieve Points Added Above Replacement (PAAR) ratings for kickers
 */
export declare const getKickerPaar: <ThrowOnError extends boolean = false>(options?: OptionsLegacyParser<GetKickerPaarData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetKickerPaarResponse, unknown, ThrowOnError>;
/**
 * Retrieves team information
 */
export declare const getTeams: <ThrowOnError extends boolean = false>(options?: OptionsLegacyParser<GetTeamsData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetTeamsResponse, unknown, ThrowOnError>;
/**
 * Retrieves information on teams playing in the highest division of CFB
 */
export declare const getFbsTeams: <ThrowOnError extends boolean = false>(options?: OptionsLegacyParser<GetFbsTeamsData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetFbsTeamsResponse, unknown, ThrowOnError>;
/**
 * Retrieves historical matchup details for two given teams
 */
export declare const getMatchup: <ThrowOnError extends boolean = false>(options: OptionsLegacyParser<GetMatchupData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<import("./types.gen").Matchup, unknown, ThrowOnError>;
/**
 * Retrieves against-the-spread (ATS) summary by team
 */
export declare const getTeamsAts: <ThrowOnError extends boolean = false>(options: OptionsLegacyParser<GetTeamsAtsData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetTeamsAtsResponse, unknown, ThrowOnError>;
/**
 * Retrieves historical roster data
 */
export declare const getRoster: <ThrowOnError extends boolean = false>(options?: OptionsLegacyParser<GetRosterData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetRosterResponse, unknown, ThrowOnError>;
/**
 * Retrieves list of conferences
 */
export declare const getConferences: <ThrowOnError extends boolean = false>(options?: OptionsLegacyParser<unknown, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetConferencesResponse, unknown, ThrowOnError>;
/**
 * Retrieve 247 Team Talent Composite for a given year
 */
export declare const getTalent: <ThrowOnError extends boolean = false>(options: OptionsLegacyParser<GetTalentData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetTalentResponse, unknown, ThrowOnError>;
/**
 * Retrieve list of venues
 */
export declare const getVenues: <ThrowOnError extends boolean = false>(options?: OptionsLegacyParser<unknown, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetVenuesResponse, unknown, ThrowOnError>;
/**
 * Retrieves aggregated player statistics for a given season
 */
export declare const getPlayerSeasonStats: <ThrowOnError extends boolean = false>(options: OptionsLegacyParser<GetPlayerSeasonStatsData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetPlayerSeasonStatsResponse, unknown, ThrowOnError>;
/**
 * Retrieves aggregated team season statistics
 */
export declare const getTeamStats: <ThrowOnError extends boolean = false>(options?: OptionsLegacyParser<GetTeamStatsData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetTeamStatsResponse, unknown, ThrowOnError>;
/**
 * Gets team statistical categories
 */
export declare const getCategories: <ThrowOnError extends boolean = false>(options?: OptionsLegacyParser<unknown, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetCategoriesResponse, unknown, ThrowOnError>;
/**
 * Retrieves advanced season statistics for teams
 */
export declare const getAdvancedSeasonStats: <ThrowOnError extends boolean = false>(options?: OptionsLegacyParser<GetAdvancedSeasonStatsData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetAdvancedSeasonStatsResponse, unknown, ThrowOnError>;
/**
 * Retrieves advanced statistics aggregated by game
 */
export declare const getAdvancedGameStats: <ThrowOnError extends boolean = false>(options?: OptionsLegacyParser<GetAdvancedGameStatsData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetAdvancedGameStatsResponse, unknown, ThrowOnError>;
/**
 * Retrieves player recruiting rankings
 */
export declare const getRecruits: <ThrowOnError extends boolean = false>(options?: OptionsLegacyParser<GetRecruitsData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetRecruitsResponse, unknown, ThrowOnError>;
/**
 * Retrieves team recruiting rankings
 */
export declare const getTeamRecruitingRankings: <ThrowOnError extends boolean = false>(options?: OptionsLegacyParser<GetTeamRecruitingRankingsData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetTeamRecruitingRankingsResponse, unknown, ThrowOnError>;
/**
 * Retrieves aggregated recruiting statistics by team and position grouping
 */
export declare const getAggregatedTeamRecruitingRatings: <ThrowOnError extends boolean = false>(options?: OptionsLegacyParser<GetAggregatedTeamRecruitingRatingsData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetAggregatedTeamRecruitingRatingsResponse, unknown, ThrowOnError>;
/**
 * Retrieves SP+ ratings for a given year or school
 */
export declare const getSp: <ThrowOnError extends boolean = false>(options?: OptionsLegacyParser<GetSpData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetSpResponse, unknown, ThrowOnError>;
/**
 * Retrieves aggregated historical conference SP+ data
 */
export declare const getConferenceSp: <ThrowOnError extends boolean = false>(options?: OptionsLegacyParser<GetConferenceSpData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetConferenceSpResponse, unknown, ThrowOnError>;
/**
 * Retrieves historical SRS for a year or team
 */
export declare const getSrs: <ThrowOnError extends boolean = false>(options?: OptionsLegacyParser<GetSrsData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetSrsResponse, unknown, ThrowOnError>;
/**
 * Retrieves historical Elo ratings
 */
export declare const getElo: <ThrowOnError extends boolean = false>(options?: OptionsLegacyParser<GetEloData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetEloResponse, unknown, ThrowOnError>;
/**
 * Retrieves historical Football Power Index (FPI) ratings
 */
export declare const getFpi: <ThrowOnError extends boolean = false>(options?: OptionsLegacyParser<GetFpiData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetFpiResponse, unknown, ThrowOnError>;
/**
 * 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>;
/**
 * Retrieves historical play data
 */
export declare const getPlays: <ThrowOnError extends boolean = false>(options: OptionsLegacyParser<GetPlaysData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetPlaysResponse, unknown, ThrowOnError>;
/**
 * Retrieves available play types
 */
export declare const getPlayTypes: <ThrowOnError extends boolean = false>(options?: OptionsLegacyParser<unknown, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetPlayTypesResponse, unknown, ThrowOnError>;
/**
 * Retrieve player-play associations (limit 2000)
 */
export declare const getPlayStats: <ThrowOnError extends boolean = false>(options?: OptionsLegacyParser<GetPlayStatsData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetPlayStatsResponse, unknown, ThrowOnError>;
/**
 * 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>;
/**
 * Search for players (lists top 100 results)
 */
export declare const searchPlayers: <ThrowOnError extends boolean = false>(options: OptionsLegacyParser<SearchPlayersData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<SearchPlayersResponse, unknown, ThrowOnError>;
/**
 * Retrieves player usage data for a given season
 */
export declare const getPlayerUsage: <ThrowOnError extends boolean = false>(options: OptionsLegacyParser<GetPlayerUsageData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetPlayerUsageResponse, unknown, ThrowOnError>;
/**
 * Retrieves returning production data. Either a year or team filter must be specified.
 */
export declare const getReturningProduction: <ThrowOnError extends boolean = false>(options?: OptionsLegacyParser<GetReturningProductionData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetReturningProductionResponse, unknown, ThrowOnError>;
/**
 * Retrieves transfer portal data for a given year
 */
export declare const getTransferPortal: <ThrowOnError extends boolean = false>(options: OptionsLegacyParser<GetTransferPortalData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetTransferPortalResponse, unknown, ThrowOnError>;
/**
 * Query Predicted Points values by down and distance
 */
export declare const getPredictedPoints: <ThrowOnError extends boolean = false>(options: OptionsLegacyParser<GetPredictedPointsData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetPredictedPointsResponse, unknown, ThrowOnError>;
/**
 * Retrieves historical team PPA metrics by season
 */
export declare const getPredictedPointsAddedByTeam: <ThrowOnError extends boolean = false>(options?: OptionsLegacyParser<GetPredictedPointsAddedByTeamData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetPredictedPointsAddedByTeamResponse, unknown, ThrowOnError>;
/**
 * Retrieves historical team PPA metrics by game
 */
export declare const getPredictedPointsAddedByGame: <ThrowOnError extends boolean = false>(options: OptionsLegacyParser<GetPredictedPointsAddedByGameData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetPredictedPointsAddedByGameResponse, unknown, ThrowOnError>;
/**
 * Queries player PPA statistics by game
 */
export declare const getPredictedPointsAddedByPlayerGame: <ThrowOnError extends boolean = false>(options: OptionsLegacyParser<GetPredictedPointsAddedByPlayerGameData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetPredictedPointsAddedByPlayerGameResponse, unknown, ThrowOnError>;
/**
 * Queries player PPA statistics by season
 */
export declare const getPredictedPointsAddedByPlayerSeason: <ThrowOnError extends boolean = false>(options?: OptionsLegacyParser<GetPredictedPointsAddedByPlayerSeasonData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetPredictedPointsAddedByPlayerSeasonResponse, unknown, ThrowOnError>;
/**
 * Query play win probabilities by game
 */
export declare const getWinProbability: <ThrowOnError extends boolean = false>(options: OptionsLegacyParser<GetWinProbabilityData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetWinProbabilityResponse, unknown, ThrowOnError>;
/**
 * Queries pregame win probabilities
 */
export declare const getPregameWinProbabilities: <ThrowOnError extends boolean = false>(options?: OptionsLegacyParser<GetPregameWinProbabilitiesData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetPregameWinProbabilitiesResponse, unknown, ThrowOnError>;
/**
 * Queries field goal expected points values
 */
export declare const getFieldGoalExpectedPoints: <ThrowOnError extends boolean = false>(options?: OptionsLegacyParser<unknown, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetFieldGoalExpectedPointsResponse, unknown, ThrowOnError>;
/**
 * Queries live play-by-play data and advanced stats
 */
export declare const getLivePlays: <ThrowOnError extends boolean = false>(options: OptionsLegacyParser<GetLivePlaysData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<import("./types.gen").LiveGame, unknown, ThrowOnError>;
/**
 * Retrieves historical betting data
 */
export declare const getLines: <ThrowOnError extends boolean = false>(options?: OptionsLegacyParser<GetLinesData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetLinesResponse, unknown, ThrowOnError>;
/**
 * Retrieves information about the user, including their Patreon level and remaining API calls.
 */
export declare const getUserInfo: <ThrowOnError extends boolean = false>(options?: OptionsLegacyParser<unknown, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetUserInfoResponse, unknown, ThrowOnError>;
/**
 * 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>;
/**
 * Retrieves team box score statistics
 */
export declare const getGameTeamStats: <ThrowOnError extends boolean = false>(options?: OptionsLegacyParser<GetGameTeamStatsData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetGameTeamStatsResponse, unknown, ThrowOnError>;
/**
 * Retrieves player box score statistics
 */
export declare const getGamePlayerStats: <ThrowOnError extends boolean = false>(options?: OptionsLegacyParser<GetGamePlayerStatsData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetGamePlayerStatsResponse, unknown, ThrowOnError>;
/**
 * Retrieves media information for games
 */
export declare const getMedia: <ThrowOnError extends boolean = false>(options: OptionsLegacyParser<GetMediaData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetMediaResponse, unknown, ThrowOnError>;
/**
 * Retrieve historical and future weather data (Patreon only)
 */
export declare const getWeather: <ThrowOnError extends boolean = false>(options?: OptionsLegacyParser<GetWeatherData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetWeatherResponse, unknown, ThrowOnError>;
/**
 * Retrieves historical team records
 */
export declare const getRecords: <ThrowOnError extends boolean = false>(options?: OptionsLegacyParser<GetRecordsData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetRecordsResponse, unknown, ThrowOnError>;
/**
 * Retrieves calendar information
 */
export declare const getCalendar: <ThrowOnError extends boolean = false>(options: OptionsLegacyParser<GetCalendarData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetCalendarResponse, unknown, ThrowOnError>;
/**
 * Retrieves live scoreboard data
 */
export declare const getScoreboard: <ThrowOnError extends boolean = false>(options?: OptionsLegacyParser<GetScoreboardData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetScoreboardResponse, unknown, ThrowOnError>;
/**
 * Retrieves historical drive data
 */
export declare const getDrives: <ThrowOnError extends boolean = false>(options: OptionsLegacyParser<GetDrivesData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetDrivesResponse, unknown, ThrowOnError>;
/**
 * Retrieves list of NFL teams
 */
export declare const getDraftTeams: <ThrowOnError extends boolean = false>(options?: OptionsLegacyParser<unknown, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetDraftTeamsResponse, unknown, ThrowOnError>;
/**
 * Retrieves list of player position categories for the NFL Draft
 */
export declare const getDraftPositions: <ThrowOnError extends boolean = false>(options?: OptionsLegacyParser<unknown, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetDraftPositionsResponse, unknown, ThrowOnError>;
/**
 * Retrieve historical NFL draft data
 */
export declare const getDraftPicks: <ThrowOnError extends boolean = false>(options?: OptionsLegacyParser<GetDraftPicksData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetDraftPicksResponse, unknown, ThrowOnError>;
/**
 * Retrieves historical head coach information and records
 */
export declare const getCoaches: <ThrowOnError extends boolean = false>(options?: OptionsLegacyParser<GetCoachesData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetCoachesResponse, unknown, ThrowOnError>;
/**
 * Retrieves an advanced box score for a game
 */
export declare const getAdvancedBoxScore: <ThrowOnError extends boolean = false>(options: OptionsLegacyParser<GetAdvancedBoxScoreData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<import("./types.gen").AdvancedBoxScore, unknown, ThrowOnError>;