Skip to main content
Version: 0.0.70

CFB — ESPN site API (v2)

sportsdataverse.cfb — 25 endpoints.

espn_cfb_scoreboard

ESPN endpoint.

Endpoint URL: GET https://site.api.espn.com/apis/site/v2/sports/football/college-football/scoreboard

Valid URL: https://site.api.espn.com/apis/site/v2/sports/football/college-football/scoreboard?dates=20240115

API ParameterPythonPatternRequiredNullableDescription
datesdatesYDate or date range filter (YYYYMMDD or YYYYMMDD-YYYYMMDD).
weekweekYWeek number within the season (football).
seasontypeseason_typeYSeason phase: 1=preseason, 2=regular season, 3=postseason.
groupsgroupsYConference or group id filter (e.g. an ESPN conference id).
limitlimitYMaximum number of items to return.

Returns

return_parsed=True (default) — a tidy polars.DataFrame with the columns below; pass return_as_pandas=True for a pandas.DataFrame.

col_nametypedescription
game_idcharacterESPN event id.
uidcharacterESPN global unique identifier.
datecharacterMatch start timestamp (ISO 8601, UTC).
namecharacterFull event name (e.g. 'Team A at Team B').
short_namecharacterAbbreviated event name (e.g. 'TA @ TB').
season_yearintegerSeason year string ('YYYY-YY' format).
season_typeintegerESPN season type (2 = regular, 3 = postseason).
season_slugcharacterSeason slug.
status_type_idcharacterUnique identifier for status type.
status_type_namecharacterStatus type name.
status_type_statecharacterStatus state (pre/in/post).
status_type_completedlogicalWhether the game is complete.
status_type_descriptioncharacterStatus type description.
status_type_detailcharacterStatus type detail.
status_type_short_detailcharacterStatus type short detail.
status_clockdoubleGame clock in seconds.
status_display_clockcharacterStatus display clock.
status_periodintegerCurrent period.
neutral_sitelogicalWhether the match is played at a neutral venue.
conference_competitionlogicalConference competition.
attendanceintegerReported attendance at the game.
venue_idcharacterReferencing venue id.
venue_full_namecharacterVenue full name.
venue_citycharacterCity where the venue is located.
venue_statecharacterState (or province/country) where the venue is located.
venue_indoorlogicalWhether the home venue is indoors.
broadcastcharacterBroadcast network short name.
notecharacterGame note or headline.
home_idcharacterHome team referencing id.
home_namecharacterHome team display name.
home_abbreviationcharacterHome team's abbreviation.
home_display_namecharacterHome team display name.
home_locationcharacterHome team's location.
home_colorcharacterHome team primary color hex.
home_alternate_colorcharacterColor code (hex) for home alternate.
home_logocharacterHome team logo URL.
home_scorecharacterHome team's score. For cricket, the innings string (e.g. '161/5 (18/20 ov, target 156)').
home_winnerlogicalWhether the home team won.
home_rankintegerHome team rank (if ranked).
away_idcharacterAway team referencing id.
away_namecharacterAway team display name.
away_abbreviationcharacterAway team's abbreviation.
away_display_namecharacterAway team display name.
away_locationcharacterAway team's location.
away_colorcharacterAway team primary color hex.
away_alternate_colorcharacterColor code (hex) for away alternate.
away_logocharacterAway team logo URL.
away_scorecharacterAway team's score. For cricket, the innings string.
away_winnerlogicalWhether the away team won.
away_rankintegerAway team rank (if ranked).

return_parsed=False — the raw JSON Dict payload, unparsed.

Example

espn_cfb_scoreboard(dates='20240115')

Last validated n/a.

espn_cfb_summary

ESPN endpoint.

Endpoint URL: GET https://site.api.espn.com/apis/site/v2/sports/football/college-football/summary

Valid URL: https://site.api.espn.com/apis/site/v2/sports/football/college-football/summary

API ParameterPythonPatternRequiredNullableDescription
eventevent_idYevent query parameter.

Returns

return_parsed=True (default) — a tidy polars.DataFrame with the columns below; pass return_as_pandas=True for a pandas.DataFrame. boxscore_player

col_nametypedescription
team_idcharacterTeam id.
team_abbreviationcharacterTeam abbreviation.
team_display_namecharacterTeam display name.
team_locationcharacterTeam location.
athlete_idcharacterAthlete id.
athlete_display_namecharacterAthlete display name.
athlete_short_namecharacterAthlete short name.
athlete_jerseycharacterAthlete jersey.
athlete_positioncharacterAthlete position.
startercharacterStarter.
activecharacterActive.
did_not_playcharacterDid not play.
ejectedcharacterEjected.
reasoncharacterReason.
completions/passing_attemptscharacterPass completion ratio for the player in the box score, expressed as completions divided by pass attempts.
passing_yardscharacterNumeric yards by the passer_player_name, including yards gained in pass plays with laterals. This should equal official passing statistics.
yards_per_pass_attemptcharacterAverage passing yards gained per pass attempt by the player in the box score.
passing_touchdownscharacterNumber of touchdown passes thrown by the player in the box score.
interceptionscharacterPassing interceptions.
adj_qbrcharacterESPN's Adjusted Quarterback Rating for the player, measuring overall passing efficiency on a 0-100 scale.
rushing_attemptscharacterTeam rushing attempts.
rushing_yardscharacterTeam rushing yards.
yards_per_rush_attemptcharacterTeam yards per rush attempt.
rushing_touchdownscharacterNumber of rushing touchdowns scored by the player in the box score.
long_rushingcharacterLongest single rushing gain recorded by the player in the game.
receptionscharacterThe number of pass receptions. Lateral receptions officially don't count as reception.
receiving_yardscharacterNumeric yards by the receiver_player_name, excluding yards gained in pass plays with laterals. This should equal official receiving statistics but could miss yards gained in pass plays with laterals. Please see the description of lateral_receiver_player_name for further information.
yards_per_receptioncharacterAverage receiving yards gained per reception by the player in the box score.
receiving_touchdownscharacterNumber of receiving touchdowns scored by the player in the box score.
long_receptioncharacterLongest single reception recorded by the player in the game.
fumblescharacterNumber of fumbles committed by the player in the box score.
fumbles_lostcharacterFumbles lost.
fumbles_recoveredcharacterTeam fumbles recovered.
total_tacklescharacterTotal tackles recorded by the player, including both solo and assisted tackles.
solo_tacklescharacterNumber of unassisted tackles recorded by the player in the box score.
sackscharacterTeam sacks.
tackles_for_losscharacterTeam tackles for a loss.
passes_defendedcharacterNumber of pass plays disrupted or broken up by the defensive player in the game.
hurriescharacterNumber of times the player pressured the opposing passer into an early or errant throw.
defensive_touchdownscharacterNumber of touchdowns scored by the player via defensive plays such as interception or fumble returns.
kick_returnscharacterNumber of kick returns.
kick_return_yardscharacterTeam kick return yards.
yards_per_kick_returncharacterAverage yards gained per kick return by the player in the box score.
long_kick_returncharacterLongest single kick return yardage recorded by the player in the game.
kick_return_touchdownscharacterNumber of touchdowns scored on kick returns by the player in the box score.
punt_returnscharacterNumber of punt returns.
punt_return_yardscharacterTeam punt return yards.
yards_per_punt_returncharacterAverage yards gained per punt return by the player in the box score.
long_punt_returncharacterLongest single punt return yardage recorded by the player in the game.
punt_return_touchdownscharacterNumber of touchdowns scored on punt returns by the player in the box score.
field_goals_made/field_goal_attemptscharacterField goal conversion ratio for the player, expressed as field goals made divided by attempts.
field_goal_pctcharacterField goal percentage (0-1).
long_field_goal_madecharacterDistance of the longest successful field goal kicked by the player in the game.
extra_points_made/extra_point_attemptscharacterExtra point conversion ratio for the player, expressed as extra points made divided by attempts.
total_kicking_pointscharacterTotal points contributed by the player through field goals and extra points in the game.
puntscharacterTotal number of punts executed by the player in the box score.
punt_yardscharacterTotal yardage of all punts executed by the player in the game.
gross_avg_punt_yardscharacterAverage gross punt distance before accounting for returns, recorded for the player in the game.
touchbackscharacterNumber of punts or kick-offs by the player that resulted in the opposing team starting from their own end zone.
punts_inside20characterNumber of punts by the player that were downed or stopped inside the opposing team's 20-yard line.
long_puntcharacterDistance of the longest individual punt executed by the player in the game.

boxscore_team

col_nametypedescription
team_idcharacterTeam id.
team_abbreviationcharacterTeam abbreviation.
team_display_namecharacterTeam display name.
home_awaycharacterHome away.
display_orderintegerDisplay order.
stat_namecharacterStat name.
stat_labelcharacterStat label.
stat_display_valuecharacterStat display value.
stat_valuecharacterStat value.

winprobability

col_nametypedescription
home_win_percentagedoubleHome win percentage.
tie_percentagedoubleTie percentage.
play_idcharacterPlay id.

leaders

col_nametypedescription
team_idcharacterTeam id.
team_abbreviationcharacterTeam abbreviation.
category_namecharacterCategory name.
category_display_namecharacterCategory display name.
athlete_idcharacterAthlete id.
athlete_display_namecharacterAthlete display name.
athlete_positioncharacterAthlete position.
valuedoubleValue.
display_valuecharacterDisplay value.
main_statcharacterMain stat.
summarycharacterSummary.

game_info

col_nametypedescription
attendanceintegerAttendance.
venue_idcharacterVenue id.
venue_guidcharacterVenue guid.
venue_full_namecharacterVenue full name.
venue_address_citycharacterVenue address city.
venue_address_statecharacterVenue address state.
venue_address_zip_codecharacterPostal zip code of the venue where the game was played.
venue_address_countrycharacterCountry of the venue where the game was played.
venue_grasslogicalVenue grass.

header

col_nametypedescription
idcharacterId.
uidcharacterUid.
time_validlogicalTime valid.
competitionscharacterCompetitions.
linkscharacterLinks.
weekintegerGame week of the season.
game_notecharacterOptional editorial note or context annotation attached to the game in the header.
season_yearintegerSeason year.
season_currentlogicalSeason current.
season_typeintegerSeason type.
league_idcharacterLeague id.
league_uidcharacterLeague uid.
league_namecharacterLeague name.
league_abbreviationcharacterLeague abbreviation.
league_midsize_namecharacterMedium-length display name for the league or competition as shown in the game header.
league_slugcharacterLeague slug.
league_is_tournamentlogicalLeague is tournament.
league_linkscharacterLeague links.
league_logoscharacterLeague logos.

standings

col_nametypedescription
group_headercharacterGroup header.
conference_headercharacterConference header.
division_headercharacterDivision header.
team_idcharacterTeam id.
team_uidcharacterTeam uid.
team_locationcharacterTeam location.
overallcharacterOverall draft pick number.
vs. conf.characterTeam's record against conference opponents, shown as part of the standings snapshot in the box score.

broadcasts

col_nametypedescription
stationcharacterBroadcast station / network name (e.g. ESPN+).
station_keycharacterMachine-readable key identifying the broadcasting station airing the game.
langcharacterBroadcast language code.
regioncharacterBroadcast region code.
is_nationallogicalBoolean flag indicating whether the broadcast is a nationally distributed feed.
type_idcharacterType id.
type_short_namecharacterBroadcast type short name (e.g. "TV").
type_long_namecharacterBroadcast type long name (e.g. "Television").
type_slugcharacterBroadcast-type slug (e.g. streaming, tv).
market_idcharacterESPN futures-market identifier.
market_typecharacterGeographic market type (e.g. National).
media_call_letterscharacterBroadcast call letters for the outlet.
media_namecharacterESPN media name for the outlet.
media_short_namecharacterShort ESPN media name for the outlet.

format

col_nametypedescription
regulation_periodsintegerRegulation periods.
regulation_display_namecharacterRegulation display name.
regulation_slugcharacterRegulation slug.
regulation_clockdoubleRegulation clock.
overtime_display_namecharacterOvertime display name.
overtime_slugcharacterOvertime slug.
sudden_death_periodsintegerNumber of sudden-death overtime periods defined in the game format rules.

article

col_nametypedescription
idintegerId.
now_idcharacterNow id.
content_keycharacterContent key.
data_source_identifiercharacterData source identifier.
publishedkeycharacterPublishedkey.
typecharacterType.
game_idcharacterGame id.
headlinecharacterHeadline.
descriptioncharacterDescription.
link_textcharacterLink text.
categorizedcharacterCategorized.
originally_postedcharacterOriginally posted.
last_modifiedcharacterLast modified.
publishedcharacterPublished.
sectioncharacterSection.
sourcecharacterSource.
imagescharacterImages.
videocharacterVideo.
categoriescharacterCategories.
keywordscharacterKeywords.
storycharacterStory.
premiumlogicalPremium.
is_live_bloglogicalIs live blog.
allow_commentslogicalAllow comments.
allow_searchlogicalAllow search.
allow_content_reactionslogicalAllow content reactions.
links_web_hrefcharacterLinks web href.
links_mobile_hrefcharacterLinks mobile href.
links_api_self_hrefcharacterLinks api self href.
links_app_sportscenter_hrefcharacterLinks app sportscenter href.

news

col_nametypedescription
idintegerId.
now_idcharacterNow id.
content_keycharacterContent key.
data_source_identifiercharacterData source identifier.
typecharacterType.
headlinecharacterHeadline.
descriptioncharacterDescription.
last_modifiedcharacterLast modified.
publishedcharacterPublished.
imagescharacterImages.
categoriescharacterCategories.
premiumlogicalPremium.
links_web_hrefcharacterLinks web href.
links_web_self_hrefcharacterURL for the canonical web page of the associated article or editorial content.
links_web_self_dsi_hrefcharacterData-source-identified URL for the web page of the associated article content.
links_api_self_hrefcharacterLinks api self href.
links_api_artwork_hrefcharacterAPI endpoint URL for artwork or imagery associated with the article.
links_sportscenter_hrefcharacterURL for the article's page on ESPN's SportsCenter platform.
bylinecharacterByline.
links_mobile_hrefcharacterLinks mobile href.
links_app_sportscenter_hrefcharacterLinks app sportscenter href.

drives

col_nametypedescription
idcharacterId.
descriptioncharacterDescription.
yardsintegerTotal yards gained on the drive.
is_scorelogicalTRUE if the drive resulted in a score.
offensive_playsintegerNumber of offensive plays on the drive.
resultcharacterDrive result code (e.g. PUNT, TD).
short_display_resultcharacterShort drive-result label.
display_resultcharacterDrive-result label (e.g. Punt, Touchdown).
playscharacterTotal qualifying passing plays included in the WEPA calculation.
team_idcharacterTeam id.
team_namecharacterFull display name of the team.
team_abbreviationcharacterTeam abbreviation.
team_display_namecharacterTeam display name.
team_short_display_namecharacterShort team display name; team_detail = TRUE only.
team_logoscharacterTeam logos.
start_period_typecharacterPeriod type at the start of the drive (e.g. quarter).
start_period_numberintegerPeriod or quarter number in which the drive or sequence began.
start_clock_display_valuecharacterGame clock time displayed at the start of the drive or scoring sequence.
start_yard_lineintegerYard line at the start of the play.
start_textcharacterField-position text at the start of the drive.
end_period_typecharacterPeriod type at the end of the drive (e.g. quarter).
end_period_numberintegerPeriod or quarter number in which the drive or sequence ended.
end_clock_display_valuecharacterGame clock time displayed at the end of the drive or scoring sequence.
end_yard_lineintegerYard line at the end of the play.
end_textcharacterField-position text at the end of the drive.
time_elapsed_display_valuecharacterHuman-readable duration of time elapsed during the drive or scoring sequence.

drive_plays

col_nametypedescription
drive_idcharacterCFBD drive identifier the play belongs to.
drive_sequenceintegerSequential position of the drive within the game's broadcast or play-by-play listing.
idcharacterId.
sequence_numbercharacterSequence number.
textcharacterText.
away_scoreintegerAway score.
home_scoreintegerHome score.
scoring_playlogicalScoring play.
prioritylogicalTRUE if ESPN flags the play as a priority highlight.
modifiedcharacterISO timestamp the play record was last modified.
wallclockcharacterWallclock.
team_participantscharacterTeams or participants associated with a specific drive or sequence in the broadcast record.
is_penaltylogicalTRUE if the play was a penalty.
stat_yardageintegerYards gained or lost on the play.
is_turnoverlogicalTRUE if the play was a turnover.
type_idcharacterType id.
type_textcharacterType text.
type_abbreviationcharacterPlay-type abbreviation (e.g. RUSH, TD).
period_numberintegerPeriod number.
clock_display_valuecharacterClock display value.
start_downintegerDown at the start of the play.
start_distanceintegerYards to go at the start of the play.
start_yard_lineintegerYard line at the start of the play.
start_yards_to_endzoneintegerYards to the end zone at the start of the play.
start_team_idcharacterESPN team id in possession at the start of the play.
end_downintegerDown at the end of the play.
end_distanceintegerYards to go at the end of the play.
end_yard_lineintegerYard line at the end of the play.
end_yards_to_endzoneintegerYards to the end zone at the end of the play.
end_down_distance_textcharacterDown-and-distance text at the end of the play.
end_short_down_distance_textcharacterShort down-and-distance text at the end of the play.
end_possession_textcharacterField-position text at the end of the play.
end_team_idcharacterESPN team id in possession at the end of the play.
start_down_distance_textcharacterDown-and-distance text at the start of the play.
start_short_down_distance_textcharacterShort down-and-distance text at the start of the play.
start_possession_textcharacterField-position text at the start of the play.
scoring_type_namecharacterScoring-type key on a scoring play (e.g. touchdown).
scoring_type_display_namecharacterHuman-readable scoring-type name.
scoring_type_abbreviationcharacterScoring-type abbreviation (e.g. TD, FG).
point_after_attempt_iddoublePoint-after-attempt id on a scoring play.
point_after_attempt_textcharacterPoint-after-attempt text (e.g. Extra Point Good).
point_after_attempt_abbreviationcharacterPoint-after-attempt abbreviation.
point_after_attempt_valuedoublePoints added by the point-after attempt.
media_idcharacterESPN media id for the outlet.

scoring_plays

col_nametypedescription
idcharacterId.
textcharacterText.
away_scoreintegerAway score.
home_scoreintegerHome score.
type_idcharacterType id.
type_textcharacterType text.
type_abbreviationcharacterPlay-type abbreviation (e.g. RUSH, TD).
period_numberintegerPeriod number.
clock_valuedoubleClock value in seconds.
clock_display_valuecharacterClock display value.
team_idcharacterTeam id.
team_uidcharacterTeam uid.
team_display_namecharacterTeam display name.
team_abbreviationcharacterTeam abbreviation.
team_linkscharacterTeam links.
team_logocharacterTeam logo.
team_logoscharacterTeam logos.
scoring_type_namecharacterScoring-type key on a scoring play (e.g. touchdown).
scoring_type_display_namecharacterHuman-readable scoring-type name.
scoring_type_abbreviationcharacterScoring-type abbreviation (e.g. TD, FG).

return_parsed=False — the raw JSON Dict payload, unparsed.

Example

espn_cfb_summary()

Last validated n/a.

espn_cfb_calendar

ESPN endpoint.

Endpoint URL: GET https://site.api.espn.com/apis/site/v2/sports/football/college-football/calendar

Valid URL: https://site.api.espn.com/apis/site/v2/sports/football/college-football/calendar

API ParameterPythonPatternRequiredNullableDescription

Returns

return_parsed=True (default) — a tidy polars.DataFrame (parser: parse_items); pass return_as_pandas=True for a pandas.DataFrame. return_parsed=False — the raw JSON Dict payload, unparsed.

Example

espn_cfb_calendar()

Last validated n/a.

espn_cfb_news

ESPN endpoint.

Endpoint URL: GET https://site.api.espn.com/apis/site/v2/sports/football/college-football/news

Valid URL: https://site.api.espn.com/apis/site/v2/sports/football/college-football/news

API ParameterPythonPatternRequiredNullableDescription
limitlimitYMaximum number of items to return.

Returns

return_parsed=True (default) — a tidy polars.DataFrame with the columns below; pass return_as_pandas=True for a pandas.DataFrame.

col_nametypedescription
idintegerESPN numeric identifier for the article.
now_idcharacterESPN 'now' feed id.
content_keycharacterInternal content key.
data_source_identifiercharacterSource-system identifier.
typecharacterArticle type (Story, Media, HeadlineNews, etc.).
headlinecharacterArticle headline.
descriptioncharacterArticle summary/description.
last_modifiedcharacterLast-modified timestamp (ISO 8601).
publishedcharacterPublish timestamp (ISO 8601).
imagescharacterArticle images (list, stringified).
categoriescharacterArticle categories (list, stringified).
premiumlogicalWhether the article is premium/paywalled.
bylinecharacterAuthor byline string as published by ESPN.
links_web_hrefcharacterWeb article URL.
links_mobile_hrefcharacterMobile article URL.
links_api_self_hrefcharacterESPN API canonical self-link for the article resource.
links_app_sportscenter_hrefcharacterSportsCenter app deep link.
links_web_self_hrefcharacterPrimary canonical web URL for this news article on ESPN.com.
links_web_self_dsi_hrefcharacterAlternate canonical web URL for this news article using ESPN's DSI routing.
links_api_artwork_hrefcharacterESPN API URL for the artwork image associated with this news article.
links_sportscenter_hrefcharacterDeep-link URL to this news article within the ESPN SportsCenter app or web experience.

return_parsed=False — the raw JSON Dict payload, unparsed.

Example

espn_cfb_news()

Last validated n/a.

espn_cfb_injuries

ESPN endpoint.

Endpoint URL: GET https://site.api.espn.com/apis/site/v2/sports/football/college-football/injuries

Valid URL: https://site.api.espn.com/apis/site/v2/sports/football/college-football/injuries

API ParameterPythonPatternRequiredNullableDescription

Returns

return_parsed=True (default) — a tidy polars.DataFrame with the columns below; pass return_as_pandas=True for a pandas.DataFrame.

col_nametypedescription
idcharacterESPN numeric identifier for the athlete.
display_namecharacterAthlete's full display name as shown on ESPN.
injuriescharacterInjury entries for the athlete (list of dicts, stringified): status, type, details, dates.

return_parsed=False — the raw JSON Dict payload, unparsed.

Example

espn_cfb_injuries()

Last validated n/a.

espn_cfb_transactions

ESPN endpoint.

Endpoint URL: GET https://site.api.espn.com/apis/site/v2/sports/football/college-football/transactions

Valid URL: https://site.api.espn.com/apis/site/v2/sports/football/college-football/transactions

API ParameterPythonPatternRequiredNullableDescription

Returns

return_parsed=True (default) — a tidy polars.DataFrame (parser: parse_items); pass return_as_pandas=True for a pandas.DataFrame. return_parsed=False — the raw JSON Dict payload, unparsed.

Example

espn_cfb_transactions()

Last validated n/a.

espn_cfb_conferences

ESPN endpoint.

Endpoint URL: GET https://site.api.espn.com/apis/site/v2/sports/football/college-football/groups

Valid URL: https://site.api.espn.com/apis/site/v2/sports/football/college-football/groups

API ParameterPythonPatternRequiredNullableDescription

Returns

return_parsed=True (default) — a tidy polars.DataFrame (parser: parse_groups); pass return_as_pandas=True for a pandas.DataFrame. return_parsed=False — the raw JSON Dict payload, unparsed.

Example

espn_cfb_conferences()

Last validated n/a.

espn_cfb_statistics_league

ESPN endpoint.

Endpoint URL: GET https://site.api.espn.com/apis/site/v2/sports/football/college-football/statistics

Valid URL: https://site.api.espn.com/apis/site/v2/sports/football/college-football/statistics

API ParameterPythonPatternRequiredNullableDescription

Returns

return_parsed=True (default) — a tidy polars.DataFrame (parser: parse_items); pass return_as_pandas=True for a pandas.DataFrame. return_parsed=False — the raw JSON Dict payload, unparsed.

Example

espn_cfb_statistics_league()

Last validated n/a.

espn_cfb_draft

ESPN endpoint.

Endpoint URL: GET https://site.api.espn.com/apis/site/v2/sports/football/college-football/draft

Valid URL: https://site.api.espn.com/apis/site/v2/sports/football/college-football/draft

API ParameterPythonPatternRequiredNullableDescription

Returns

return_parsed=True (default) — a tidy polars.DataFrame (parser: parse_items); pass return_as_pandas=True for a pandas.DataFrame. return_parsed=False — the raw JSON Dict payload, unparsed.

Example

espn_cfb_draft()

Last validated n/a.

espn_cfb_teams_site

ESPN endpoint.

Endpoint URL: GET https://site.api.espn.com/apis/site/v2/sports/football/college-football/teams

Valid URL: https://site.api.espn.com/apis/site/v2/sports/football/college-football/teams

API ParameterPythonPatternRequiredNullableDescription
limitlimitYMaximum number of items to return.

Returns

return_parsed=True (default) — a tidy polars.DataFrame with the columns below; pass return_as_pandas=True for a pandas.DataFrame.

col_nametypedescription
team_abbreviationcharacterShort team abbreviation (e.g. "BOS").
team_alternate_colorcharacterSecondary team color as a hex string (no leading '#').
team_colorcharacterPrimary team color as a hex string (no leading '#').
team_display_namecharacterFull team display name (location + nickname).
team_idcharacterESPN team id (stable join key across ESPN endpoints).
team_is_activelogicalWhether the team is currently active.
team_is_all_starlogicalWhether the entry is an all-star squad rather than a franchise.
team_locationcharacterTeam location / city (e.g. "Boston").
team_logoscharacterPipe-delimited logo image URLs.
team_namecharacterTeam nickname/mascot (e.g. "Celtics").
team_nicknamecharacterTeam nickname as ESPN labels it (often equals team_name).
team_short_display_namecharacterAbbreviated display name for compact UIs.
team_slugcharacterURL slug used in ESPN web paths.
team_uidcharacterESPN global UID (encodes sport/league/team).

return_parsed=False — the raw JSON Dict payload, unparsed.

Example

espn_cfb_teams_site()

Last validated n/a.

espn_cfb_team

ESPN endpoint.

Endpoint URL: GET https://site.api.espn.com/apis/site/v2/sports/football/college-football/teams/{team_id}

Valid URL: https://site.api.espn.com/apis/site/v2/sports/football/college-football/teams/4

API ParameterPythonPatternRequiredNullableDescription
team_idteam_idYteam_id path parameter.

Returns

return_parsed=True (default) — a tidy polars.DataFrame (parser: parse_single_entity); pass return_as_pandas=True for a pandas.DataFrame. return_parsed=False — the raw JSON Dict payload, unparsed.

Example

espn_cfb_team(team_id='4')

Last validated n/a.

espn_cfb_team_roster

ESPN endpoint.

Endpoint URL: GET https://site.api.espn.com/apis/site/v2/sports/football/college-football/teams/{team_id}/roster

Valid URL: https://site.api.espn.com/apis/site/v2/sports/football/college-football/teams/4/roster

API ParameterPythonPatternRequiredNullableDescription
team_idteam_idYteam_id path parameter.

Returns

return_parsed=True (default) — a tidy polars.DataFrame with the columns below; pass return_as_pandas=True for a pandas.DataFrame.

col_nametypedescription
position_groupcharacterPosition group of the recruits (e.g. Offensive Line, Defensive Back).
idcharacterId.
uidcharacterUid.
guidcharacterGuid.
first_namecharacterFirst name.
last_namecharacterLast name.
full_namecharacterFull name.
display_namecharacterDisplay name.
short_namecharacterShort name.
weightdoubleWeight.
display_weightcharacterDisplay weight.
heightdoubleHeight.
display_heightcharacterDisplay height.
linkscharacterLinks.
slugcharacterSlug.
jerseycharacterJersey.
injuriescharacterInjuries.
alternate_ids_sdrcharacterAlternate ids sdr.
birth_place_citycharacterBirth place city.
birth_place_statecharacterBirth place state.
birth_place_countrycharacterBirth place country.
birth_place_display_textcharacterBirth place display text.
birth_country_alternate_idcharacterAlternate identifier for the athlete's country of birth used in ESPN's country-flag reference system.
birth_country_abbreviationcharacterBirth country abbreviation.
college_idcharacterCollege id.
college_guidcharacterCollege guid.
college_mascotcharacterCollege mascot.
college_namecharacterCollege name.
college_short_namecharacterCollege short name.
college_abbrevcharacterCollege abbrev.
college_logoscharacterCollege logos.
headshot_hrefcharacterHeadshot href.
headshot_altcharacterHeadshot alt.
flag_hrefcharacterURL of the SVG or PNG flag image representing the athlete's country of birth.
flag_altcharacterAlt-text string for the athlete's country-of-birth flag image, typically the full country name.
flag_relcharacterRelationship descriptor for the athlete's country-of-birth flag link (e.g., "flag").
position_idcharacterPosition id.
position_namecharacterPosition name.
position_display_namecharacterPosition display name.
position_abbreviationcharacterPosition abbreviation.
position_leaflogicalPosition leaf.
position_parent_idcharacterESPN id of the parent position; position_detail = TRUE only.
position_parent_namecharacterParent position name.
position_parent_display_namecharacterParent position display name.
position_parent_abbreviationcharacterParent position abbreviation.
position_parent_leaflogicalWhether parent position is leaf.
experience_yearsintegerExperience years.
experience_display_valuecharacterExperience display value.
experience_abbreviationcharacterExperience abbreviation.
status_idcharacterStatus id.
status_namecharacterStatus name.
status_typecharacterStatus type.
status_abbreviationcharacterStatus abbreviation.
hand_typecharacterHand type.
hand_abbreviationcharacterHand abbreviation.
hand_display_valuecharacterHand display value.

return_parsed=False — the raw JSON Dict payload, unparsed.

Example

espn_cfb_team_roster(team_id='4')

Last validated n/a.

espn_cfb_team_schedule

ESPN endpoint.

Endpoint URL: GET https://site.api.espn.com/apis/site/v2/sports/football/college-football/teams/{team_id}/schedule

Valid URL: https://site.api.espn.com/apis/site/v2/sports/football/college-football/teams/4/schedule

API ParameterPythonPatternRequiredNullableDescription
team_idteam_idYteam_id path parameter.
seasonseasonYSeason year (e.g. 2024).

Returns

return_parsed=True (default) — a tidy polars.DataFrame with the columns below; pass return_as_pandas=True for a pandas.DataFrame.

col_nametypedescription
idcharacterESPN numeric event identifier.
datecharacterEvent timestamp (ISO 8601, UTC).
namecharacterFull event name (e.g. 'Team A at Team B').
short_namecharacterAbbreviated event name (e.g. 'TA @ TB').
time_validlogicalWhether the event time is confirmed.
competitionscharacterCompetition detail (list of dicts, stringified): competitors, venue, status.
linkscharacterRelated links (list, stringified).
season_yearintegerFour-digit season year.
season_display_namecharacterHuman-readable season label (e.g. '2024-25').
season_type_idcharacterESPN numeric identifier for the season type.
season_type_typeintegerSeason type numeric code.
season_type_namecharacterSeason type name (e.g. Regular Season).
season_type_abbreviationcharacterSeason type abbreviation.

return_parsed=False — the raw JSON Dict payload, unparsed.

Example

espn_cfb_team_schedule(team_id='4')

Last validated n/a.

espn_cfb_team_record

ESPN endpoint.

Endpoint URL: GET https://site.api.espn.com/apis/site/v2/sports/football/college-football/teams/{team_id}/record

Valid URL: https://site.api.espn.com/apis/site/v2/sports/football/college-football/teams/4/record

API ParameterPythonPatternRequiredNullableDescription
team_idteam_idYteam_id path parameter.

Returns

return_parsed=True (default) — a tidy polars.DataFrame (parser: parse_items); pass return_as_pandas=True for a pandas.DataFrame. return_parsed=False — the raw JSON Dict payload, unparsed.

Example

espn_cfb_team_record(team_id='4')

Last validated n/a.

espn_cfb_team_depthcharts

ESPN endpoint.

Endpoint URL: GET https://site.api.espn.com/apis/site/v2/sports/football/college-football/teams/{team_id}/depthcharts

Valid URL: https://site.api.espn.com/apis/site/v2/sports/football/college-football/teams/4/depthcharts

API ParameterPythonPatternRequiredNullableDescription
team_idteam_idYteam_id path parameter.

Returns

return_parsed=True (default) — a tidy polars.DataFrame (parser: parse_items); pass return_as_pandas=True for a pandas.DataFrame. return_parsed=False — the raw JSON Dict payload, unparsed.

Example

espn_cfb_team_depthcharts(team_id='4')

Last validated n/a.

espn_cfb_team_injuries

ESPN endpoint.

Endpoint URL: GET https://site.api.espn.com/apis/site/v2/sports/football/college-football/teams/{team_id}/injuries

Valid URL: https://site.api.espn.com/apis/site/v2/sports/football/college-football/teams/4/injuries

API ParameterPythonPatternRequiredNullableDescription
team_idteam_idYteam_id path parameter.

Returns

return_parsed=True (default) — a tidy polars.DataFrame with the columns below; pass return_as_pandas=True for a pandas.DataFrame.

col_nametypedescription
idcharacterESPN numeric identifier for the athlete.
display_namecharacterAthlete's full display name as shown on ESPN.
injuriescharacterInjury entries for the athlete (list of dicts, stringified): status, type, details, dates.

return_parsed=False — the raw JSON Dict payload, unparsed.

Example

espn_cfb_team_injuries(team_id='4')

Last validated n/a.

espn_cfb_team_transactions

ESPN endpoint.

Endpoint URL: GET https://site.api.espn.com/apis/site/v2/sports/football/college-football/teams/{team_id}/transactions

Valid URL: https://site.api.espn.com/apis/site/v2/sports/football/college-football/teams/4/transactions

API ParameterPythonPatternRequiredNullableDescription
team_idteam_idYteam_id path parameter.

Returns

return_parsed=True (default) — a tidy polars.DataFrame (parser: parse_items); pass return_as_pandas=True for a pandas.DataFrame. return_parsed=False — the raw JSON Dict payload, unparsed.

Example

espn_cfb_team_transactions(team_id='4')

Last validated n/a.

espn_cfb_team_history

ESPN endpoint.

Endpoint URL: GET https://site.api.espn.com/apis/site/v2/sports/football/college-football/teams/{team_id}/history

Valid URL: https://site.api.espn.com/apis/site/v2/sports/football/college-football/teams/4/history

API ParameterPythonPatternRequiredNullableDescription
team_idteam_idYteam_id path parameter.

Returns

return_parsed=True (default) — a tidy polars.DataFrame (parser: parse_items); pass return_as_pandas=True for a pandas.DataFrame. return_parsed=False — the raw JSON Dict payload, unparsed.

Example

espn_cfb_team_history(team_id='4')

Last validated n/a.

espn_cfb_team_news

ESPN endpoint.

Endpoint URL: GET https://site.api.espn.com/apis/site/v2/sports/football/college-football/teams/{team_id}/news

Valid URL: https://site.api.espn.com/apis/site/v2/sports/football/college-football/teams/4/news

API ParameterPythonPatternRequiredNullableDescription
team_idteam_idYteam_id path parameter.
limitlimitYMaximum number of items to return.

Returns

return_parsed=True (default) — a tidy polars.DataFrame with the columns below; pass return_as_pandas=True for a pandas.DataFrame.

col_nametypedescription
idintegerESPN numeric identifier for the article.
now_idcharacterESPN 'now' feed id.
content_keycharacterInternal content key.
data_source_identifiercharacterSource-system identifier.
typecharacterArticle type (Story, Media, HeadlineNews, etc.).
headlinecharacterArticle headline.
descriptioncharacterArticle summary/description.
last_modifiedcharacterLast-modified timestamp (ISO 8601).
publishedcharacterPublish timestamp (ISO 8601).
imagescharacterArticle images (list, stringified).
categoriescharacterArticle categories (list, stringified).
premiumlogicalWhether the article is premium/paywalled.
bylinecharacterAuthor byline string as published by ESPN.
links_web_hrefcharacterWeb article URL.
links_mobile_hrefcharacterMobile article URL.
links_api_self_hrefcharacterESPN API canonical self-link for the article resource.
links_app_sportscenter_hrefcharacterSportsCenter app deep link.
links_web_self_hrefcharacterPrimary canonical web URL for this news article on ESPN.com.
links_web_self_dsi_hrefcharacterAlternate canonical web URL for this news article using ESPN's DSI routing.
links_api_artwork_hrefcharacterESPN API URL for the artwork image associated with this news article.
links_sportscenter_hrefcharacterDeep-link URL to this news article within the ESPN SportsCenter app or web experience.

return_parsed=False — the raw JSON Dict payload, unparsed.

Example

espn_cfb_team_news(team_id='4')

Last validated n/a.

espn_cfb_team_leaders

ESPN endpoint.

Endpoint URL: GET https://site.api.espn.com/apis/site/v2/sports/football/college-football/teams/{team_id}/leaders

Valid URL: https://site.api.espn.com/apis/site/v2/sports/football/college-football/teams/4/leaders

API ParameterPythonPatternRequiredNullableDescription
team_idteam_idYteam_id path parameter.

Returns

return_parsed=True (default) — a tidy polars.DataFrame (parser: parse_items); pass return_as_pandas=True for a pandas.DataFrame. return_parsed=False — the raw JSON Dict payload, unparsed.

Example

espn_cfb_team_leaders(team_id='4')

Last validated n/a.

espn_cfb_player_info

ESPN endpoint.

Endpoint URL: GET https://site.api.espn.com/apis/site/v2/sports/football/college-football/athletes/{athlete_id}

Valid URL: https://site.api.espn.com/apis/site/v2/sports/football/college-football/athletes/4239

API ParameterPythonPatternRequiredNullableDescription
athlete_idathlete_idYathlete_id path parameter.

Returns

return_parsed=True (default) — a tidy polars.DataFrame (parser: parse_single_entity); pass return_as_pandas=True for a pandas.DataFrame. return_parsed=False — the raw JSON Dict payload, unparsed.

Example

espn_cfb_player_info(athlete_id='4239')

Last validated n/a.

espn_cfb_player_bio

ESPN endpoint.

Endpoint URL: GET https://site.api.espn.com/apis/site/v2/sports/football/college-football/athletes/{athlete_id}/bio

Valid URL: https://site.api.espn.com/apis/site/v2/sports/football/college-football/athletes/4239/bio

API ParameterPythonPatternRequiredNullableDescription
athlete_idathlete_idYathlete_id path parameter.

Returns

return_parsed=True (default) — a tidy polars.DataFrame (parser: parse_single_entity); pass return_as_pandas=True for a pandas.DataFrame. return_parsed=False — the raw JSON Dict payload, unparsed.

Example

espn_cfb_player_bio(athlete_id='4239')

Last validated n/a.

espn_cfb_player_news

ESPN endpoint.

Endpoint URL: GET https://site.api.espn.com/apis/site/v2/sports/football/college-football/athletes/{athlete_id}/news

Valid URL: https://site.api.espn.com/apis/site/v2/sports/football/college-football/athletes/4239/news

API ParameterPythonPatternRequiredNullableDescription
athlete_idathlete_idYathlete_id path parameter.

Returns

return_parsed=True (default) — a tidy polars.DataFrame with the columns below; pass return_as_pandas=True for a pandas.DataFrame.

col_nametypedescription
idintegerESPN numeric identifier for the article.
now_idcharacterESPN 'now' feed id.
content_keycharacterInternal content key.
data_source_identifiercharacterSource-system identifier.
typecharacterArticle type (Story, Media, HeadlineNews, etc.).
headlinecharacterArticle headline.
descriptioncharacterArticle summary/description.
last_modifiedcharacterLast-modified timestamp (ISO 8601).
publishedcharacterPublish timestamp (ISO 8601).
imagescharacterArticle images (list, stringified).
categoriescharacterArticle categories (list, stringified).
premiumlogicalWhether the article is premium/paywalled.
bylinecharacterAuthor byline string as published by ESPN.
links_web_hrefcharacterWeb article URL.
links_mobile_hrefcharacterMobile article URL.
links_api_self_hrefcharacterESPN API canonical self-link for the article resource.
links_app_sportscenter_hrefcharacterSportsCenter app deep link.
links_web_self_hrefcharacterPrimary canonical web URL for this news article on ESPN.com.
links_web_self_dsi_hrefcharacterAlternate canonical web URL for this news article using ESPN's DSI routing.
links_api_artwork_hrefcharacterESPN API URL for the artwork image associated with this news article.
links_sportscenter_hrefcharacterDeep-link URL to this news article within the ESPN SportsCenter app or web experience.

return_parsed=False — the raw JSON Dict payload, unparsed.

Example

espn_cfb_player_news(athlete_id='4239')

Last validated n/a.

espn_cfb_standings

ESPN endpoint.

Endpoint URL: GET https://site.api.espn.com/apis/v2/sports/football/college-football/standings

Valid URL: https://site.api.espn.com/apis/v2/sports/football/college-football/standings

API ParameterPythonPatternRequiredNullableDescription
seasonseasonYSeason year (e.g. 2024).
groupgroupYConference or group id filter (e.g. an ESPN conference id).
typestandings_typeYStandings variant (e.g. 'by-division' or 'by-conference').

Returns

return_parsed=True (default) — a tidy polars.DataFrame with the columns below; pass return_as_pandas=True for a pandas.DataFrame.

col_nametypedescription
group_namecharacterGroup name.
group_abbreviationcharacterGroup abbreviation.
team_idcharacterTeam id.
team_namecharacterTeam name.
team_abbreviationcharacterTeam abbreviation.
team_display_namecharacterTeam display name.
team_locationcharacterTeam location.
team_logocharacterTeam logo.
games_behinddoubleGames behind.
league_win_percentdoubleLeague win percent.
playoff_seeddoublePlayoff seed.
point_differentialdoublePoint differential.
points_againstdoublePoints against.
points_fordoublePoints for.
streakdoubleStreak.
winsdoubleWins.
division_lossesdoubleNumber of games the team has lost against opponents within their own division.
division_tiesdoubleNumber of games the team has tied against opponents within their own division.
division_winsdoubleNumber of games the team has won against opponents within their own division.
overallcharacterOverall.
homecharacterHome.
awaycharacterAway team name.
vs. conf.characterVs. conf..
vs ap top 25characterThe team's win-loss record against opponents ranked in the AP Top 25 poll.
vs usa ranked teamscharacterThe team's win-loss record against opponents ranked in the USA Today Coaches Poll.
vs divisiondoubleThe team's win-loss(-tie) record against opponents within their own division, serialized as a numeric value.

return_parsed=False — the raw JSON Dict payload, unparsed.

Example

espn_cfb_standings()

Last validated n/a.

espn_cfb_rankings

ESPN endpoint.

Endpoint URL: GET https://site.api.espn.com/apis/site/v2/sports/football/college-football/rankings

Valid URL: https://site.api.espn.com/apis/site/v2/sports/football/college-football/rankings

API ParameterPythonPatternRequiredNullableDescription

Returns

return_parsed=True (default) — a tidy polars.DataFrame (parser: parse_items); pass return_as_pandas=True for a pandas.DataFrame. return_parsed=False — the raw JSON Dict payload, unparsed.

Example

espn_cfb_rankings()

Last validated n/a.