espn_nba_player_contracts: *Get ESPN NBA Athlete Contracts Index*

View source: R/espn_nba_athlete_contracts.R

espn_nba_player_contractsR Documentation

Get ESPN NBA Athlete Contracts Index

Description

Returns the index of contract seasons recorded for an NBA athlete from sports.core.api.espn.com/v2/sports/basketball/leagues/nba/athletes/{athlete_id}/contracts. Each row is one contract year — pass the season to espn_nba_player_contract() for the full contract record.

Returns the full contract record for one NBA athlete in one season, including salary, cap-rule flags, option type, Bird status, and trade protections. Backed by sports.core.api.espn.com/v2/sports/basketball/leagues/nba/athletes/{athlete_id}/contracts/{season}.

Usage

espn_nba_player_contracts(athlete_id, ...)

espn_nba_player_contract(athlete_id, season = most_recent_nba_season(), ...)

Arguments

athlete_id

ESPN athlete identifier (character or numeric).

...

Additional arguments; currently unused.

season

Season year (numeric). Defaults to the most recent NBA season.

Value

A tibble with one row per contract year.

col_name types description
athlete_id character ESPN athlete identifier.
season integer Contract season year.
ref character Full ⁠$ref⁠ URL for the contract detail.
league character League slug ("nba").

A single-row tibble.

col_name types description
athlete_id character ESPN athlete identifier.
season integer Contract season year.
bird_status integer Bird-rights tier (0 = Non, 1 = Early, 2 = Full).
salary numeric Total cap-counting salary for the season ($).
salary_remaining numeric Remaining salary owed.
years_remaining integer Years left on the contract.
incoming_trade_value numeric Trade value if receiving this contract ($).
outgoing_trade_value numeric Trade value if sending out this contract ($).
option_type integer Option type code (e.g. team / player option).
minimum_salary_exception logical Signed under the minimum-salary exception.
trade_restriction logical Whether a trade restriction is active.
unsigned_foreign_pick logical Unsigned-foreign-pick flag.
active logical Whether the contract is currently active.
base_year_compensation_active logical Base-year-compensation rule active.
poison_pill_provision_active logical Poison-pill provision active.
trade_kicker_active logical Trade kicker active.
trade_kicker_percentage numeric Trade kicker percentage of salary.
trade_kicker_value numeric Trade kicker dollar value.
trade_kicker_trade_value numeric Trade kicker post-trade dollar value.
season_ref character ⁠$ref⁠ to the season resource.
team_ref character ⁠$ref⁠ to the team-in-season resource.
team_id character ESPN team id parsed from team_ref.
league character League slug ("nba").

Author(s)

Saiem Gilani

See Also

Other ESPN NBA Functions: espn_mbb_athletes_index(), espn_mbb_award(), espn_mbb_calendar(), espn_mbb_coach(), espn_mbb_coach_record(), espn_mbb_coach_season(), espn_mbb_coaches(), espn_mbb_conferences(), espn_mbb_franchise(), espn_mbb_franchises(), espn_mbb_futures(), espn_mbb_game_all(), espn_mbb_game_odds(), espn_mbb_game_official_detail(), espn_mbb_game_play(), espn_mbb_game_play_personnel(), espn_mbb_game_player_box(), espn_mbb_game_probabilities(), espn_mbb_game_propbets(), espn_mbb_game_team_linescores(), espn_mbb_game_team_roster_entry(), espn_mbb_injuries(), espn_mbb_leaders(), espn_mbb_news(), espn_mbb_player_awards(), espn_mbb_player_career_stats(), espn_mbb_player_eventlog_v2(), espn_mbb_player_info(), espn_mbb_player_overview(), espn_mbb_player_seasons(), espn_mbb_player_stats(), espn_mbb_position(), espn_mbb_positions(), espn_mbb_powerindex(), espn_mbb_scoreboard(), espn_mbb_season_awards(), espn_mbb_season_group(), espn_mbb_season_groups(), espn_mbb_season_info(), espn_mbb_season_leaders(), espn_mbb_season_ranking(), espn_mbb_season_rankings(), espn_mbb_season_type(), espn_mbb_season_types(), espn_mbb_season_week(), espn_mbb_season_weeks(), espn_mbb_seasons(), espn_mbb_standings(), espn_mbb_team(), espn_mbb_team_current_roster(), espn_mbb_team_injuries(), espn_mbb_team_news(), espn_mbb_team_odds_records(), espn_mbb_team_record(), espn_mbb_team_record_detail(), espn_mbb_team_schedule(), espn_mbb_team_season_roster(), espn_mbb_team_season_statistics(), espn_mbb_team_stats(), espn_mbb_teams(), espn_mbb_tournament(), espn_mbb_tournament_season(), espn_mbb_tournament_seasons(), espn_mbb_tournaments(), espn_mbb_venues(), espn_mbb_week_ranking(), espn_mbb_week_rankings(), espn_mbb_wp(), espn_nba_draft_pick(), espn_nba_freeagents(), espn_nba_team_depthchart(), espn_nba_transactions()

Examples


  # LeBron James — athlete id 1966
  espn_nba_player_contracts(athlete_id = 1966)


  # LeBron James 2025 contract
  espn_nba_player_contract(athlete_id = 1966, season = 2025)


hoopR documentation built on Aug. 25, 2026, 9:07 a.m.