Skip to contents

Get the ESPN core-v2 detail record for a single college football franchise – location, nickname, abbreviation, color, the associated venue and current team, and active status.

Usage

espn_cfb_franchise(franchise_id = NULL, team_detail = TRUE)

Arguments

franchise_id

(Integer required): ESPN franchise id.

team_detail

(Logical): when TRUE (default), the ESPN team catalog (espn_cfb_teams()) is fetched once and friendly team fields are joined in next to the team_id column. The sibling columns team_name, team_abbreviation, team_location, team_display_name, team_short_display_name, team_nickname, team_color, team_alternate_color, team_logo_href, team_logo_dark_href are inserted immediately after team_id. A catalog failure degrades to NA rather than erroring the wrapper. Set FALSE to skip the catalog fetch and the join, reproducing the prior output exactly.

Value

A single-row data frame:

col_nametypesdescription
franchise_idcharacterESPN franchise id.
uidcharacterESPN franchise UID string.
slugcharacterFranchise slug (e.g. auburn-tigers).
locationcharacterFranchise location (e.g. Auburn).
namecharacterFranchise name (e.g. Tigers).
nicknamecharacterFranchise nickname (e.g. Auburn).
abbreviationcharacterFranchise abbreviation (e.g. AUB).
display_namecharacterFull display name (e.g. Auburn Tigers).
short_display_namecharacterShort display name (e.g. Auburn).
colorcharacterPrimary team color (hex, no #).
is_activelogicalTRUE if the franchise is currently active.
venue_idcharacterESPN id of the franchise's venue (NA if none).
venue_namecharacterFull name of the franchise's venue.
team_idcharacterESPN id of the current team (parsed from team_ref).
team_namecharacterTeam nickname; team_detail = TRUE only.
team_abbreviationcharacterTeam abbreviation; team_detail = TRUE only.
team_locationcharacterTeam location / school name; team_detail = TRUE only.
team_display_namecharacterFull team display name; team_detail = TRUE only.
team_short_display_namecharacterShort team display name; team_detail = TRUE only.
team_nicknamecharacterTeam nickname label; team_detail = TRUE only.
team_colorcharacterPrimary team color; team_detail = TRUE only.
team_alternate_colorcharacterAlternate team color; team_detail = TRUE only.
team_logo_hrefcharacterDefault team logo URL; team_detail = TRUE only.
team_logo_dark_hrefcharacterDark-variant team logo URL; team_detail = TRUE only.
team_refcharacter$ref URL to the current team-in-season resource.
franchise_refcharacter$ref URL to the franchise resource.

Details

Wraps the ESPN core-v2 endpoint sports.core.api.espn.com/v2/sports/football/leagues/college-football/franchises/{franchise_id}. A franchise is the stable program identity, distinct from /teams (which is season-scoped). Returns a single-row tibble. Enumerate franchise_ids with espn_cfb_franchises().

See also

Other ESPN CFB Functions: espn_cfb_award(), espn_cfb_awards(), espn_cfb_clear_cache(), espn_cfb_coach(), espn_cfb_coach_record(), espn_cfb_coaches(), espn_cfb_franchises(), espn_cfb_futures(), espn_cfb_game_broadcasts(), espn_cfb_game_drive_plays(), espn_cfb_game_drives(), espn_cfb_game_leaders(), espn_cfb_game_odds(), espn_cfb_game_pbp(), espn_cfb_game_play(), espn_cfb_game_player_box(), espn_cfb_game_player_statistics(), espn_cfb_game_powerindex(), espn_cfb_game_predictor(), espn_cfb_game_probabilities(), espn_cfb_game_situation(), espn_cfb_game_status(), espn_cfb_game_team_leaders(), espn_cfb_game_team_linescores(), espn_cfb_game_team_records(), espn_cfb_game_team_roster(), espn_cfb_game_team_statistics(), espn_cfb_game_teams(), espn_cfb_groups(), espn_cfb_pbp_v2(), espn_cfb_player(), espn_cfb_player_career_stats(), espn_cfb_player_eventlog(), espn_cfb_player_gamelog(), espn_cfb_player_overview(), espn_cfb_player_seasons(), espn_cfb_player_splits(), espn_cfb_player_stats_v3(), espn_cfb_players(), espn_cfb_position(), espn_cfb_positions(), espn_cfb_powerindex(), espn_cfb_qbr(), espn_cfb_rankings(), espn_cfb_recruits(), espn_cfb_season_info(), espn_cfb_season_types(), espn_cfb_season_weeks(), espn_cfb_seasons(), espn_cfb_standings(), espn_cfb_team(), espn_cfb_team_ats(), espn_cfb_team_awards(), espn_cfb_team_coaches(), espn_cfb_team_events(), espn_cfb_team_leaders(), espn_cfb_team_powerindex(), espn_cfb_team_ranks(), espn_cfb_team_record(), espn_cfb_team_roster(), espn_cfb_team_schedule(), espn_cfb_teams(), espn_cfb_unnest_plays(), espn_cfb_venue(), espn_cfb_venues(), espn_cfb_week_rankings()

Examples

# \donttest{
  try(espn_cfb_franchise(franchise_id = 2))
#> ── Franchise detail from ESPN ──────────────────────────────── cfbfastR 2.3.0 ──
#>  Data updated: 2026-06-09 07:55:49 UTC
#> # A tibble: 1 × 26
#>   franchise_id uid       slug  location name  nickname abbreviation display_name
#>   <chr>        <chr>     <chr> <chr>    <chr> <chr>    <chr>        <chr>       
#> 1 2            s:20~l:2… aubu… Auburn   Tige… Auburn   AUB          Auburn Tige…
#> # ℹ 18 more variables: short_display_name <chr>, color <chr>, is_active <lgl>,
#> #   venue_id <chr>, venue_name <chr>, team_id <chr>, team_name <chr>,
#> #   team_abbreviation <chr>, team_location <chr>, team_display_name <chr>,
#> #   team_short_display_name <chr>, team_nickname <chr>, team_color <chr>,
#> #   team_alternate_color <chr>, team_logo_href <chr>,
#> #   team_logo_dark_href <chr>, team_ref <chr>, franchise_ref <chr>
  try(espn_cfb_franchise(franchise_id = 2, team_detail = FALSE))
#> ── Franchise detail from ESPN ──────────────────────────────── cfbfastR 2.3.0 ──
#>  Data updated: 2026-06-09 07:55:49 UTC
#> # A tibble: 1 × 16
#>   franchise_id uid       slug  location name  nickname abbreviation display_name
#>   <chr>        <chr>     <chr> <chr>    <chr> <chr>    <chr>        <chr>       
#> 1 2            s:20~l:2… aubu… Auburn   Tige… Auburn   AUB          Auburn Tige…
#> # ℹ 8 more variables: short_display_name <chr>, color <chr>, is_active <lgl>,
#> #   venue_id <chr>, venue_name <chr>, team_id <chr>, team_ref <chr>,
#> #   franchise_ref <chr>
# }