Skip to main content
Version: main

MLB — MLB Stats API

sportsdataverse.mlb — 64 endpoints.

mlb_api_schedule_postseason

GET /api/v1/schedule/postseason — postseason-only schedule for a season.

Endpoint URL: GET https://statsapi.mlb.com/api/v1/schedule/postseason

Valid URL: https://statsapi.mlb.com/api/v1/schedule/postseason

API ParameterPythonPatternRequiredNullableDescription
seasonseasonYSeason year (e.g. 2024).
sportIdsport_idYsportId query parameter.
hydratehydrateYhydrate query 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
schedule_datecharacter
game_pkintegerUnique game identifier.
game_guidcharacterGlobally unique game identifier (GUID).
linkcharacterAPI link to the game feed.
game_typecharacterGame type code (R, P, etc.).
seasoncharacterSeason year.
game_datecharacterGame date (YYYY-MM-DD).
official_datecharacterOfficial game date (YYYY-MM-DD).
is_tielogicalWhether the game ended in a tie.
is_featured_gamelogicalWhether the game is a featured game.
game_numberintegerGame number within a doubleheader.
public_facinglogicalWhether the game is public-facing.
double_headercharacterDoubleheader indicator ('N', 'S', 'Y').
gameday_typecharacterGameday data feed type.
tiebreakercharacterWhether the game is a tiebreaker.
calendar_event_idcharacterCalendar event identifier.
season_displaycharacterDisplay string for the season.
day_nightcharacterDay or night game indicator.
descriptioncharacterLong-form description text.
scheduled_inningsintegerScheduled number of innings.
reverse_home_away_statuslogicalWhether home/away teams are reversed.
inning_break_lengthintegerLength of inning breaks in seconds.
games_in_seriesintegerNumber of games in the series.
series_game_numberintegerGame number within the series.
series_descriptioncharacterDescription of the series.
record_sourcecharacterSource of the schedule record.
if_necessarycharacterWhether the game is played only if necessary.
if_necessary_descriptioncharacterDescription of the if-necessary status.
status_abstract_game_statecharacterAbstract game state (e.g. 'Final').
status_coded_game_statecharacterCoded game state.
status_detailed_statecharacterDetailed game state.
status_status_codecharacterStatus code for the game.
status_start_time_tbdlogicalWhether the start time is TBD.
status_abstract_game_codecharacterAbstract game state code.
teams_away_team_idintegerAway team MLBAM ID.
teams_away_team_namecharacterAway team name.
teams_away_team_linkcharacterAPI link to the away team.
teams_away_league_record_winsintegerAway team league-record wins.
teams_away_league_record_lossesintegerAway team league-record losses.
teams_away_league_record_tiesintegerAway team league-record ties.
teams_away_league_record_pctcharacterAway team winning percentage.
teams_away_scoreintegerAway team score.
teams_away_is_winnerlogicalWhether the away team won.
teams_away_split_squadlogicalWhether the away team is a split squad.
teams_away_series_numberintegerAway team's series number.
teams_home_team_idintegerHome team MLBAM ID.
teams_home_team_namecharacterHome team name.
teams_home_team_linkcharacterAPI link to the home team.
teams_home_league_record_winsintegerHome team league-record wins.
teams_home_league_record_lossesintegerHome team league-record losses.
teams_home_league_record_tiesintegerHome team league-record ties.
teams_home_league_record_pctcharacterHome team winning percentage.
teams_home_scoreintegerHome team score.
teams_home_is_winnerlogicalWhether the home team won.
teams_home_split_squadlogicalWhether the home team is a split squad.
teams_home_series_numberintegerHome team's series number.
venue_idintegerMLBAM venue ID.
venue_namecharacterVenue name.
venue_linkcharacterAPI link to the venue.
content_linkcharacterAPI link to the game content.

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

Example

mlb_api_schedule_postseason()

Last validated n/a.

mlb_api_pbp

GET /api/v1.1/game/{gamePk}/feed/live — live firehose (v1.1).

Endpoint URL: GET https://statsapi.mlb.com/api/v1.1/game/{game_pk}/feed/live

Valid URL: https://statsapi.mlb.com/api/v1.1/game/716390/feed/live

API ParameterPythonPatternRequiredNullableDescription
game_pkgame_pkYgame_pk path parameter.
languagelanguageYlanguage query parameter.
languagetimecodeYlanguage query parameter.
hydratehydrateYhydrate query parameter.
fieldsfieldsYfields query parameter.

Returns

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

Example

mlb_api_pbp(game_pk=716390)

Last validated n/a.

mlb_api_boxscore

GET /api/v1/game/{gamePk}/boxscore — team + player boxscore for one game.

Endpoint URL: GET https://statsapi.mlb.com/api/v1/game/{game_pk}/boxscore

Valid URL: https://statsapi.mlb.com/api/v1/game/716390/boxscore

API ParameterPythonPatternRequiredNullableDescription
game_pkgame_pkYgame_pk path parameter.
timecodetimecodeYtimecode query parameter.
fieldsfieldsYfields query 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
team_sidecharacterHome or away indicator.
team_idintegerUnique ESPN team identifier.
team_namecharacterTeam name.
jersey_numbercharacterJersey number worn (often blank for non-uniformed roles).
parent_team_idinteger
batting_ordercharacterSpot in the batting order (1-9).
all_positionscharacter
person_idintegerMLB player ID.
person_full_namecharacterPlayer full name.
person_linkcharacterAPI relative link to the person.
person_boxscore_namecharacterName as shown in box scores.
position_codecharacterNumeric scorekeeping position code.
position_namecharacterPosition name.
position_typecharacterPosition category (e.g. 'Pitcher', 'Infielder').
position_abbreviationcharacterPosition abbreviation.
status_codecharacterStatus code identifier (e.g. 'S', 'P', 'I', 'F').
status_descriptioncharacterRoster status description (e.g. 'Active').
stats_batting_summarycharacter
stats_batting_games_playeddouble
stats_batting_fly_outsdouble
stats_batting_ground_outsdouble
stats_batting_air_outsdouble
stats_batting_runsdouble
stats_batting_doublesdouble
stats_batting_triplesdouble
stats_batting_home_runsdouble
stats_batting_strike_outsdouble
stats_batting_base_on_ballsdouble
stats_batting_intentional_walksdouble
stats_batting_hitsdouble
stats_batting_hit_by_pitchdouble
stats_batting_at_batsdouble
stats_batting_caught_stealingdouble
stats_batting_stolen_basesdouble
stats_batting_stolen_base_percentagecharacter
stats_batting_ground_into_double_playdouble
stats_batting_ground_into_triple_playdouble
stats_batting_plate_appearancesdouble
stats_batting_total_basesdouble
stats_batting_rbidouble
stats_batting_left_on_basedouble
stats_batting_sac_buntsdouble
stats_batting_sac_fliesdouble
stats_batting_catchers_interferencedouble
stats_batting_pickoffsdouble
stats_batting_at_bats_per_home_runcharacter
stats_batting_pop_outsdouble
stats_batting_line_outsdouble
stats_fielding_caught_stealingdouble
stats_fielding_stolen_basesdouble
stats_fielding_stolen_base_percentagecharacter
stats_fielding_caught_stealing_percentagecharacter
stats_fielding_assistsdouble
stats_fielding_put_outsdouble
stats_fielding_errorsdouble
stats_fielding_chancesdouble
stats_fielding_fieldingcharacter
stats_fielding_passed_balldouble
stats_fielding_pickoffsdouble
season_stats_batting_games_playedinteger
season_stats_batting_fly_outsinteger
season_stats_batting_ground_outsinteger
season_stats_batting_air_outsinteger
season_stats_batting_runsinteger
season_stats_batting_doublesinteger
season_stats_batting_triplesinteger
season_stats_batting_home_runsinteger
season_stats_batting_strike_outsinteger
season_stats_batting_base_on_ballsinteger
season_stats_batting_intentional_walksinteger
season_stats_batting_hitsinteger
season_stats_batting_hit_by_pitchinteger
season_stats_batting_avgcharacter
season_stats_batting_at_batsinteger
season_stats_batting_obpcharacter
season_stats_batting_slgcharacter
season_stats_batting_opscharacter
season_stats_batting_caught_stealinginteger
season_stats_batting_stolen_basesinteger
season_stats_batting_stolen_base_percentagecharacter
season_stats_batting_caught_stealing_percentagecharacter
season_stats_batting_ground_into_double_playinteger
season_stats_batting_ground_into_triple_playinteger
season_stats_batting_plate_appearancesinteger
season_stats_batting_total_basesinteger
season_stats_batting_rbiinteger
season_stats_batting_left_on_baseinteger
season_stats_batting_sac_buntsinteger
season_stats_batting_sac_fliesinteger
season_stats_batting_babipcharacter
season_stats_batting_ground_outs_to_airoutscharacter
season_stats_batting_catchers_interferenceinteger
season_stats_batting_pickoffsinteger
season_stats_batting_at_bats_per_home_runcharacter
season_stats_batting_pop_outsinteger
season_stats_batting_line_outsinteger
season_stats_pitching_games_playedinteger
season_stats_pitching_games_startedinteger
season_stats_pitching_fly_outsinteger
season_stats_pitching_ground_outsinteger
season_stats_pitching_air_outsinteger
season_stats_pitching_runsinteger
season_stats_pitching_doublesinteger
season_stats_pitching_triplesinteger
season_stats_pitching_home_runsinteger
season_stats_pitching_strike_outsinteger
season_stats_pitching_base_on_ballsinteger
season_stats_pitching_intentional_walksinteger
season_stats_pitching_hitsinteger
season_stats_pitching_hit_by_pitchinteger
season_stats_pitching_at_batsinteger
season_stats_pitching_obpcharacter
season_stats_pitching_caught_stealinginteger
season_stats_pitching_stolen_basesinteger
season_stats_pitching_stolen_base_percentagecharacter
season_stats_pitching_caught_stealing_percentagecharacter
season_stats_pitching_number_of_pitchesinteger
season_stats_pitching_eracharacter
season_stats_pitching_innings_pitchedcharacter
season_stats_pitching_winsinteger
season_stats_pitching_lossesinteger
season_stats_pitching_savesinteger
season_stats_pitching_save_opportunitiesinteger
season_stats_pitching_holdsinteger
season_stats_pitching_blown_savesinteger
season_stats_pitching_earned_runsinteger
season_stats_pitching_whipcharacter
season_stats_pitching_batters_facedinteger
season_stats_pitching_outsinteger
season_stats_pitching_games_pitchedinteger
season_stats_pitching_complete_gamesinteger
season_stats_pitching_shutoutsinteger
season_stats_pitching_ballsinteger
season_stats_pitching_strikesinteger
season_stats_pitching_strike_percentagecharacter
season_stats_pitching_hit_batsmeninteger
season_stats_pitching_balksinteger
season_stats_pitching_wild_pitchesinteger
season_stats_pitching_pickoffsinteger
season_stats_pitching_ground_outs_to_airoutscharacter
season_stats_pitching_rbiinteger
season_stats_pitching_win_percentagecharacter
season_stats_pitching_pitches_per_inningcharacter
season_stats_pitching_games_finishedinteger
season_stats_pitching_strikeout_walk_ratiocharacter
season_stats_pitching_strikeouts_per9_inncharacter
season_stats_pitching_walks_per9_inncharacter
season_stats_pitching_hits_per9_inncharacter
season_stats_pitching_runs_scored_per9character
season_stats_pitching_home_runs_per9character
season_stats_pitching_inherited_runnersinteger
season_stats_pitching_inherited_runners_scoredinteger
season_stats_pitching_catchers_interferenceinteger
season_stats_pitching_sac_buntsinteger
season_stats_pitching_sac_fliesinteger
season_stats_pitching_passed_ballinteger
season_stats_pitching_pop_outsinteger
season_stats_pitching_line_outsinteger
season_stats_fielding_caught_stealinginteger
season_stats_fielding_stolen_basesinteger
season_stats_fielding_stolen_base_percentagecharacter
season_stats_fielding_caught_stealing_percentagecharacter
season_stats_fielding_assistsinteger
season_stats_fielding_put_outsinteger
season_stats_fielding_errorsinteger
season_stats_fielding_chancesinteger
season_stats_fielding_fieldingcharacter
season_stats_fielding_passed_ballinteger
season_stats_fielding_pickoffsinteger
game_status_is_current_batterlogical
game_status_is_current_pitcherlogical
game_status_is_on_benchlogical
game_status_is_substitutelogical
stats_fielding_games_starteddouble
season_stats_fielding_games_starteddouble
season_stats_pitching_pitches_throwndouble
stats_pitching_summarycharacter
stats_pitching_games_playeddouble
stats_pitching_games_starteddouble
stats_pitching_fly_outsdouble
stats_pitching_ground_outsdouble
stats_pitching_air_outsdouble
stats_pitching_runsdouble
stats_pitching_doublesdouble
stats_pitching_triplesdouble
stats_pitching_home_runsdouble
stats_pitching_strike_outsdouble
stats_pitching_base_on_ballsdouble
stats_pitching_intentional_walksdouble
stats_pitching_hitsdouble
stats_pitching_hit_by_pitchdouble
stats_pitching_at_batsdouble
stats_pitching_caught_stealingdouble
stats_pitching_stolen_basesdouble
stats_pitching_stolen_base_percentagecharacter
stats_pitching_number_of_pitchesdouble
stats_pitching_innings_pitchedcharacter
stats_pitching_winsdouble
stats_pitching_lossesdouble
stats_pitching_savesdouble
stats_pitching_save_opportunitiesdouble
stats_pitching_holdsdouble
stats_pitching_blown_savesdouble
stats_pitching_earned_runsdouble
stats_pitching_batters_faceddouble
stats_pitching_outsdouble
stats_pitching_games_pitcheddouble
stats_pitching_complete_gamesdouble
stats_pitching_shutoutsdouble
stats_pitching_pitches_throwndouble
stats_pitching_ballsdouble
stats_pitching_strikesdouble
stats_pitching_strike_percentagecharacter
stats_pitching_hit_batsmendouble
stats_pitching_balksdouble
stats_pitching_wild_pitchesdouble
stats_pitching_pickoffsdouble
stats_pitching_rbidouble
stats_pitching_games_finisheddouble
stats_pitching_runs_scored_per9character
stats_pitching_home_runs_per9character
stats_pitching_inherited_runnersdouble
stats_pitching_inherited_runners_scoreddouble
stats_pitching_catchers_interferencedouble
stats_pitching_sac_buntsdouble
stats_pitching_sac_fliesdouble
stats_pitching_passed_balldouble
stats_pitching_pop_outsdouble
stats_pitching_line_outsdouble
stats_pitching_notecharacter
stats_batting_notecharacter

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

Example

mlb_api_boxscore(game_pk=716390)

Last validated n/a.

mlb_api_linescore

GET /api/v1/game/{gamePk}/linescore — inning-by-inning + current game state.

Endpoint URL: GET https://statsapi.mlb.com/api/v1/game/{game_pk}/linescore

Valid URL: https://statsapi.mlb.com/api/v1/game/716390/linescore

API ParameterPythonPatternRequiredNullableDescription
game_pkgame_pkYgame_pk path parameter.
timecodetimecodeYtimecode query parameter.
fieldsfieldsYfields query 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
numintegerInning number.
ordinal_numcharacterInning ordinal label (e.g. 1st).
home_runsintegerHome runs.
home_hitsintegerHome hits in the inning.
home_errorsintegerHome errors in the inning.
home_left_on_baseintegerHome runners left on base in the inning.
away_runsintegerAway runs scored in the inning.
away_hitsintegerAway hits in the inning.
away_errorsintegerAway errors in the inning.
away_left_on_baseintegerAway runners left on base in the inning.

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

Example

mlb_api_linescore(game_pk=716390)

Last validated n/a.

mlb_api_play_by_play

GET /api/v1/game/{gamePk}/playByPlay — play-by-play with at-bat detail.

Endpoint URL: GET https://statsapi.mlb.com/api/v1/game/{game_pk}/playByPlay

Valid URL: https://statsapi.mlb.com/api/v1/game/716390/playByPlay

API ParameterPythonPatternRequiredNullableDescription
game_pkgame_pkYgame_pk path parameter.
timecodetimecodeYtimecode query parameter.
fieldsfieldsYfields query 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
pitch_indexcharacter
action_indexcharacter
runner_indexcharacter
runnerscharacter
play_eventscharacter
play_end_timecharacter
at_bat_indexintegerZero-based index of the at-bat within the game.
result_typecharacter
result_eventcharacter
result_event_typecharacter
result_descriptioncharacter
result_rbiinteger
result_away_scoreinteger
result_home_scoreinteger
result_is_outlogical
about_at_bat_indexinteger
about_half_inningcharacter
about_is_top_inninglogical
about_inninginteger
about_start_timecharacter
about_end_timecharacter
about_is_completelogical
about_is_scoring_playlogical
about_has_reviewlogical
about_has_outlogical
about_captivating_indexinteger
count_ballsinteger
count_strikesinteger
count_outsinteger
matchup_batter_idinteger
matchup_batter_full_namecharacter
matchup_batter_linkcharacter
matchup_bat_side_codecharacter
matchup_bat_side_descriptioncharacter
matchup_pitcher_idinteger
matchup_pitcher_full_namecharacter
matchup_pitcher_linkcharacter
matchup_pitch_hand_codecharacter
matchup_pitch_hand_descriptioncharacter
matchup_post_on_first_iddouble
matchup_post_on_first_full_namecharacter
matchup_post_on_first_linkcharacter
matchup_batter_hot_cold_zonescharacter
matchup_pitcher_hot_cold_zonescharacter
matchup_splits_battercharacter
matchup_splits_pitchercharacter
matchup_splits_men_on_basecharacter
matchup_post_on_second_iddouble
matchup_post_on_second_full_namecharacter
matchup_post_on_second_linkcharacter
matchup_post_on_third_iddouble
matchup_post_on_third_full_namecharacter
matchup_post_on_third_linkcharacter
review_details_is_overturnedlogical
review_details_in_progresslogical
review_details_review_typecharacter
review_details_challenge_team_iddouble

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

Example

mlb_api_play_by_play(game_pk=716390)

Last validated n/a.

mlb_api_game_context_metrics

GET /api/v1/game/{gamePk}/contextMetrics — WP, leverage index, in-game context.

Endpoint URL: GET https://statsapi.mlb.com/api/v1/game/{game_pk}/contextMetrics

Valid URL: https://statsapi.mlb.com/api/v1/game/716390/contextMetrics

API ParameterPythonPatternRequiredNullableDescription
game_pkgame_pkYgame_pk path parameter.
fieldsfieldsYfields query parameter.

Returns

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

Example

mlb_api_game_context_metrics(game_pk=716390)

Last validated n/a.

mlb_api_win_probability

GET /api/v1/game/{gamePk}/winProbability — per-play WP timeline.

Endpoint URL: GET https://statsapi.mlb.com/api/v1/game/{game_pk}/winProbability

Valid URL: https://statsapi.mlb.com/api/v1/game/716390/winProbability

API ParameterPythonPatternRequiredNullableDescription
game_pkgame_pkYgame_pk path parameter.
fieldsfieldsYfields query 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
pitch_indexcharacter
action_indexcharacter
runner_indexcharacter
runnerscharacter
play_eventscharacter
creditscharacter
flagscharacter
home_team_win_probabilitydoubleHome team win probability (percent) entering the at-bat.
away_team_win_probabilitydoubleAway team win probability (percent) entering the at-bat.
home_team_win_probability_addeddoubleChange in home team win probability attributed to the at-bat.
play_end_timecharacter
at_bat_indexintegerZero-based index of the at-bat within the game.
result_typecharacter
result_eventcharacter
result_event_typecharacter
result_descriptioncharacter
result_rbiinteger
result_away_scoreinteger
result_home_scoreinteger
result_is_outlogical
about_at_bat_indexinteger
about_half_inningcharacter
about_is_top_inninglogical
about_inninginteger
about_start_timecharacter
about_end_timecharacter
about_is_completelogical
about_is_scoring_playlogical
about_has_reviewlogical
about_has_outlogical
about_captivating_indexinteger
count_ballsinteger
count_strikesinteger
count_outsinteger
matchup_batter_idinteger
matchup_batter_full_namecharacter
matchup_batter_linkcharacter
matchup_bat_side_codecharacter
matchup_bat_side_descriptioncharacter
matchup_pitcher_idinteger
matchup_pitcher_full_namecharacter
matchup_pitcher_linkcharacter
matchup_pitch_hand_codecharacter
matchup_pitch_hand_descriptioncharacter
matchup_post_on_first_iddouble
matchup_post_on_first_full_namecharacter
matchup_post_on_first_linkcharacter
matchup_batter_hot_cold_zonescharacter
matchup_pitcher_hot_cold_zonescharacter
matchup_splits_battercharacter
matchup_splits_pitchercharacter
matchup_splits_men_on_basecharacter
leverage_indexdoubleLeverage index quantifying the importance of the at-bat situation.
drama_indexdouble
matchup_post_on_second_iddouble
matchup_post_on_second_full_namecharacter
matchup_post_on_second_linkcharacter
matchup_post_on_third_iddouble
matchup_post_on_third_full_namecharacter
matchup_post_on_third_linkcharacter
review_details_is_overturnedlogical
review_details_in_progresslogical
review_details_review_typecharacter
review_details_challenge_team_iddouble

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

Example

mlb_api_win_probability(game_pk=716390)

Last validated n/a.

mlb_api_game_content

GET /api/v1/game/{gamePk}/content — articles, highlights, editorial content.

Endpoint URL: GET https://statsapi.mlb.com/api/v1/game/{game_pk}/content

Valid URL: https://statsapi.mlb.com/api/v1/game/716390/content

API ParameterPythonPatternRequiredNullableDescription
game_pkgame_pkYgame_pk path parameter.

Returns

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

Example

mlb_api_game_content(game_pk=716390)

Last validated n/a.

mlb_api_team

GET /api/v1/teams/{teamId} — single team detail.

Endpoint URL: GET https://statsapi.mlb.com/api/v1/teams/{team_id}

Valid URL: https://statsapi.mlb.com/api/v1/teams/10

API ParameterPythonPatternRequiredNullableDescription
team_idteam_idYteam_id path parameter.
seasonseasonYSeason year (e.g. 2024).
sportIdsport_idYsportId query parameter.
hydratehydrateYhydrate query parameter.
fieldsfieldsYfields query 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
all_star_statuscharacterAll-star status flag.
idintegerId.
namecharacterDisplay name.
linkcharacterAPI link to the game feed.
seasonintegerSeason year.
team_codecharacterInternal team code.
file_codecharacterFile code abbreviation.
abbreviationcharacterShort abbreviation.
team_namecharacterTeam name.
location_namecharacterTeam location (city).
first_year_of_playcharacterFirst year the franchise played.
short_namecharacterShort display name.
franchise_namecharacterFranchise name.
club_namecharacterClub name.
activelogicalWhether the player is currently active.
spring_league_idintegerSpring league MLBAM ID.
spring_league_namecharacterSpring league name.
spring_league_linkcharacterAPI link to the spring league.
spring_league_abbreviationcharacterSpring league abbreviation.
venue_idintegerMLBAM venue ID.
venue_namecharacterVenue name.
venue_linkcharacterAPI link to the venue.
spring_venue_idintegerSpring training venue MLBAM ID.
spring_venue_linkcharacterAPI link to the spring venue.
league_idintegerLeague MLBAM ID.
league_namecharacterLeague name.
league_linkcharacterAPI link to the league.
division_idintegerDivision MLBAM ID.
division_namecharacterDivision name.
division_linkcharacterAPI link to the division.
sport_idintegerSport MLBAM ID.
sport_linkcharacterAPI link to the sport.
sport_namecharacterSport name (e.g., Major League Baseball).

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

Example

mlb_api_team(team_id=10)

Last validated n/a.

mlb_api_team_roster

GET /api/v1/teams/{teamId}/roster — team roster.

Endpoint URL: GET https://statsapi.mlb.com/api/v1/teams/{team_id}/roster

Valid URL: https://statsapi.mlb.com/api/v1/teams/10/roster

API ParameterPythonPatternRequiredNullableDescription
team_idteam_idYteam_id path parameter.
seasonseasonYSeason year (e.g. 2024).
rosterTyperoster_typeYrosterType query parameter.
datedateYdate query parameter.
hydratehydrateYhydrate query parameter.
fieldsfieldsYfields query 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
jersey_numbercharacterJersey number worn (often blank for non-uniformed roles).
person_idintegerMLB player ID.
person_full_namecharacterPlayer full name.
person_linkcharacterAPI relative link to the person.
position_codecharacterNumeric scorekeeping position code.
position_namecharacterPosition name.
position_typecharacterPosition category (e.g. 'Pitcher', 'Infielder').
position_abbreviationcharacterPosition abbreviation.
status_codecharacterStatus code identifier (e.g. 'S', 'P', 'I', 'F').
status_descriptioncharacterRoster status description (e.g. 'Active').

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

Example

mlb_api_team_roster(team_id=10)

Last validated n/a.

mlb_api_team_alumni

GET /api/v1/teams/{teamId}/alumni — players who played for this team in a season.

Endpoint URL: GET https://statsapi.mlb.com/api/v1/teams/{team_id}/alumni

Valid URL: https://statsapi.mlb.com/api/v1/teams/10/alumni

API ParameterPythonPatternRequiredNullableDescription
team_idteam_idYteam_id path parameter.
seasonseasonYSeason year (e.g. 2024).
groupgroupYConference or group id filter (e.g. an ESPN conference id).
hydratehydrateYhydrate query 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
idintegerId.
full_namecharacterPlayer's full name.
linkcharacterAPI link to the game feed.
first_namecharacterPlayer first name.
last_namecharacterPlayer last name.
primary_numbercharacterPlayer uniform number.
birth_datecharacterDate of birth (YYYY-MM-DD).
current_ageintegerCurrent age in years.
birth_citycharacterCity of birth.
birth_countrycharacterCountry of birth.
heightcharacterHeight (feet and inches).
weightintegerWeight in pounds.
activelogicalWhether the player is currently active.
use_namecharacterPreferred first name.
use_last_namecharacterPreferred last name.
middle_namecharacterPlayer middle name.
boxscore_namecharacterName as shown in box scores.
nick_namecharacterPlayer nickname.
gendercharacterPlayer gender.
is_playerlogicalWhether the person is a player.
is_verifiedlogicalWhether the player profile is verified.
pronunciationcharacterPhonetic name pronunciation.
mlb_debut_datecharacterMLB debut date (YYYY-MM-DD).
name_first_lastcharacterName in first-last order.
name_slugcharacterURL-friendly name slug.
first_last_namecharacterFirst and last name.
last_first_namecharacterName in last, first order.
last_init_namecharacterLast name with first initial.
init_last_namecharacterFirst initial with last name.
full_fml_namecharacterFull name (first-middle-last).
full_lfm_namecharacterFull name (last-first-middle).
strike_zone_topdoubleTop of the player's strike zone (feet).
strike_zone_bottomdoubleBottom of the player's strike zone (feet).
alumni_last_seasoncharacterLast season the player was with the team.
primary_position_codecharacterPrimary position code.
primary_position_namecharacterPrimary fielding position name.
primary_position_typecharacterPrimary position type (e.g. Infielder).
primary_position_abbreviationcharacterPrimary position abbreviation.
bat_side_codecharacterBatting side code (L/R/S).
bat_side_descriptioncharacterBatting side description.
pitch_hand_codecharacterThrowing hand code (L/R).
pitch_hand_descriptioncharacterThrowing hand description.
birth_state_provincecharacterState or province of birth.
draft_yeardoubleYear the player was drafted.
last_played_datecharacterDate of last MLB game played.
name_matrilinealcharacterMaternal family name.

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

Example

mlb_api_team_alumni(team_id=10)

Last validated n/a.

mlb_api_team_affiliates

GET /api/v1/teams/affiliates — org affiliates (MLB parent → minor league chain).

Endpoint URL: GET https://statsapi.mlb.com/api/v1/teams/affiliates

Valid URL: https://statsapi.mlb.com/api/v1/teams/affiliates

API ParameterPythonPatternRequiredNullableDescription
teamIdsteam_idsYteamIds query parameter.
sportIdsport_idYsportId query parameter.
seasonseasonYSeason year (e.g. 2024).
hydratehydrateYhydrate query 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
all_star_statuscharacterAll-star status flag.
idintegerId.
namecharacterDisplay name.
linkcharacterAPI link to the game feed.
seasonintegerSeason year.
team_codecharacterInternal team code.
file_codecharacterFile code abbreviation.
abbreviationcharacterShort abbreviation.
team_namecharacterTeam name.
location_namecharacterTeam location (city).
first_year_of_playcharacterFirst year the franchise played.
short_namecharacterShort display name.
franchise_namecharacterFranchise name.
club_namecharacterClub name.
activelogicalWhether the player is currently active.
spring_league_iddoubleSpring league MLBAM ID.
spring_league_namecharacterSpring league name.
spring_league_linkcharacterAPI link to the spring league.
spring_league_abbreviationcharacterSpring league abbreviation.
venue_idintegerMLBAM venue ID.
venue_namecharacterVenue name.
venue_linkcharacterAPI link to the venue.
spring_venue_iddoubleSpring training venue MLBAM ID.
spring_venue_linkcharacterAPI link to the spring venue.
league_iddoubleLeague MLBAM ID.
league_namecharacterLeague name.
league_linkcharacterAPI link to the league.
division_iddoubleDivision MLBAM ID.
division_namecharacterDivision name.
division_linkcharacterAPI link to the division.
sport_idintegerSport MLBAM ID.
sport_linkcharacterAPI link to the sport.
sport_namecharacterSport name (e.g., Major League Baseball).
parent_org_namecharacterParent organization name.
parent_org_iddoubleParent organization MLBAM ID.

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

Example

mlb_api_team_affiliates()

Last validated n/a.

mlb_api_people

GET /api/v1/people?personIds=... — bulk person lookup by MLBAM id.

Endpoint URL: GET https://statsapi.mlb.com/api/v1/people

Valid URL: https://statsapi.mlb.com/api/v1/people

API ParameterPythonPatternRequiredNullableDescription
personIdsperson_idsYpersonIds query parameter.
hydratehydrateYhydrate query parameter.
fieldsfieldsYfields query parameter.

Returns

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

Example

mlb_api_people()

Last validated n/a.

mlb_api_person

GET /api/v1/people/{personId} — single person detail.

Endpoint URL: GET https://statsapi.mlb.com/api/v1/people/{person_id}

Valid URL: https://statsapi.mlb.com/api/v1/people/660271

API ParameterPythonPatternRequiredNullableDescription
person_idperson_idYperson_id path parameter.
seasonseasonYSeason year (e.g. 2024).
hydratehydrateYhydrate query parameter.
fieldsfieldsYfields query parameter.

Returns

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

Example

mlb_api_person(person_id=660271)

Last validated n/a.

mlb_api_person_game_stats

GET /api/v1/people/{personId}/stats/game/{gamePk} — one player, one game.

Endpoint URL: GET https://statsapi.mlb.com/api/v1/people/{person_id}/stats/game/{game_pk}

Valid URL: https://statsapi.mlb.com/api/v1/people/660271/stats/game/716390

API ParameterPythonPatternRequiredNullableDescription
person_idperson_idYperson_id path parameter.
game_pkgame_pkYgame_pk path parameter.
fieldsfieldsYfields query parameter.

Returns

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

Example

mlb_api_person_game_stats(person_id=660271, game_pk=716390)

Last validated n/a.

mlb_api_sport_players

GET /api/v1/sports/{sportId}/players — every player in a sport for a season.

Endpoint URL: GET https://statsapi.mlb.com/api/v1/sports/{sport_id}/players

Valid URL: https://statsapi.mlb.com/api/v1/sports

API ParameterPythonPatternRequiredNullableDescription
sport_idsport_idYsport_id path parameter.
seasonseasonYSeason year (e.g. 2024).
hydratehydrateYhydrate query parameter.
fieldsfieldsYfields query 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
idintegerId.
full_namecharacterPlayer's full name.
linkcharacterAPI link to the game feed.
first_namecharacterPlayer first name.
last_namecharacterPlayer last name.
primary_numbercharacterPlayer uniform number.
birth_datecharacterDate of birth (YYYY-MM-DD).
current_ageintegerCurrent age in years.
birth_citycharacterCity of birth.
birth_state_provincecharacterState or province of birth.
birth_countrycharacterCountry of birth.
heightcharacterHeight (feet and inches).
weightintegerWeight in pounds.
activelogicalWhether the player is currently active.
use_namecharacterPreferred first name.
use_last_namecharacterPreferred last name.
middle_namecharacterPlayer middle name.
boxscore_namecharacterName as shown in box scores.
gendercharacterPlayer gender.
is_playerlogicalWhether the person is a player.
is_verifiedlogicalWhether the player profile is verified.
draft_yeardoubleYear the player was drafted.
mlb_debut_datecharacterMLB debut date (YYYY-MM-DD).
name_first_lastcharacterName in first-last order.
name_slugcharacterURL-friendly name slug.
first_last_namecharacterFirst and last name.
last_first_namecharacterName in last, first order.
last_init_namecharacterLast name with first initial.
init_last_namecharacterFirst initial with last name.
full_fml_namecharacterFull name (first-middle-last).
full_lfm_namecharacterFull name (last-first-middle).
strike_zone_topdoubleTop of the player's strike zone (feet).
strike_zone_bottomdoubleBottom of the player's strike zone (feet).
current_team_idintegerCurrent team MLBAM ID.
current_team_namecharacterCurrent team name.
current_team_linkcharacterAPI link to the current team.
primary_position_codecharacterPrimary position code.
primary_position_namecharacterPrimary fielding position name.
primary_position_typecharacterPrimary position type (e.g. Infielder).
primary_position_abbreviationcharacterPrimary position abbreviation.
bat_side_codecharacterBatting side code (L/R/S).
bat_side_descriptioncharacterBatting side description.
pitch_hand_codecharacterThrowing hand code (L/R).
pitch_hand_descriptioncharacterThrowing hand description.
name_matrilinealcharacterMaternal family name.
nick_namecharacterPlayer nickname.
pronunciationcharacterPhonetic name pronunciation.
last_played_datecharacterDate of last MLB game played.
name_titlecharacterName title.
name_suffixcharacterName suffix (e.g. Jr., Sr., III).

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

Example

mlb_api_sport_players()

Last validated n/a.

mlb_api_sports

GET /api/v1/sports — list known sports (MLB, MiLB, KBO, NPB, …).

Endpoint URL: GET https://statsapi.mlb.com/api/v1/sports

Valid URL: https://statsapi.mlb.com/api/v1/sports

API ParameterPythonPatternRequiredNullableDescription
sportIdsport_idYsportId query 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
idintegerId.
codecharacterFielder detail type code.
linkcharacterAPI link to the game feed.
namecharacterDisplay name.
abbreviationcharacterShort abbreviation.
sort_orderintegerDisplay sort order for the sport.
active_statuslogicalWhether the sport/level is active.

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

Example

mlb_api_sports()

Last validated n/a.

mlb_api_leagues

GET /api/v1/leagues — list leagues.

Endpoint URL: GET https://statsapi.mlb.com/api/v1/leagues

Valid URL: https://statsapi.mlb.com/api/v1/leagues

API ParameterPythonPatternRequiredNullableDescription
sportIdsport_idYsportId query parameter.
seasonseasonYSeason year (e.g. 2024).
leagueIdsleague_idsYleagueIds query 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
idintegerId.
namecharacterDisplay name.
linkcharacterAPI link to the game feed.
abbreviationcharacterShort abbreviation.
name_shortcharacterShort name of player (First Initial, Last Name)
season_statecharacter
has_wild_cardlogical
has_split_seasonlogical
num_gamesdouble
has_playoff_pointslogical
num_teamsdoubleNumber of teams the player appeared for.
num_wildcard_teamsdouble
seasoncharacterSeason year.
org_codecharacter
conferences_in_uselogicalWhether conferences were in use that season.
divisions_in_uselogicalWhether divisions were in use that season.
sort_orderintegerDisplay sort order for the sport.
activelogicalWhether the player is currently active.
season_date_info_season_idcharacterSeason identifier for the date info block.
season_date_info_pre_season_start_datecharacterPreseason start date (YYYY-MM-DD).
season_date_info_pre_season_end_datecharacterPreseason end date (YYYY-MM-DD).
season_date_info_season_start_datecharacterSeason start date (YYYY-MM-DD).
season_date_info_spring_start_datecharacterSpring training start date (YYYY-MM-DD).
season_date_info_spring_end_datecharacterSpring training end date (YYYY-MM-DD).
season_date_info_regular_season_start_datecharacterRegular season start date (YYYY-MM-DD).
season_date_info_last_date1st_halfcharacterLast date of the first half (YYYY-MM-DD).
season_date_info_all_star_datecharacterAll-Star Game date (YYYY-MM-DD).
season_date_info_first_date2nd_halfcharacterFirst date of the second half (YYYY-MM-DD).
season_date_info_regular_season_end_datecharacterRegular season end date (YYYY-MM-DD).
season_date_info_post_season_start_datecharacterPostseason start date (YYYY-MM-DD).
season_date_info_post_season_end_datecharacterPostseason end date (YYYY-MM-DD).
season_date_info_season_end_datecharacterSeason end date (YYYY-MM-DD).
season_date_info_offseason_start_datecharacterOffseason start date (YYYY-MM-DD).
season_date_info_off_season_end_datecharacterOffseason end date (YYYY-MM-DD).
season_date_info_season_level_gameday_typecharacterSeason-level Gameday data type code.
season_date_info_game_level_gameday_typecharacterGame-level Gameday data type code.
season_date_info_qualifier_plate_appearancesdoublePlate appearances per game needed to qualify.
season_date_info_qualifier_outs_pitcheddoubleOuts pitched per game needed to qualify.
sport_iddoubleSport MLBAM ID.
sport_linkcharacterAPI link to the sport.

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

Example

mlb_api_leagues()

Last validated n/a.

mlb_api_season

GET /api/v1/seasons/{seasonId} — single season detail.

Endpoint URL: GET https://statsapi.mlb.com/api/v1/seasons/{season_id}

Valid URL: https://statsapi.mlb.com/api/v1/seasons/X

API ParameterPythonPatternRequiredNullableDescription
season_idseason_idYseason_id path parameter.
sportIdsport_idYsportId query 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
season_idcharacterSeason year identifier.
has_wildcardlogicalWhether the season has a wild card round.
pre_season_start_datecharacterPre-season start date.
pre_season_end_datecharacterPre-season end date.
season_start_datecharacterSeason start date.
spring_start_datecharacterSpring training start date.
spring_end_datecharacterSpring training end date.
regular_season_start_datecharacterRegular season start date.
last_date1st_halfcharacterLast date of the first half.
all_star_datecharacterAll-Star Game date.
first_date2nd_halfcharacterFirst date of the second half.
regular_season_end_datecharacterRegular season end date.
post_season_start_datecharacterPost-season start date.
post_season_end_datecharacterPost-season end date.
season_end_datecharacterSeason end date.
offseason_start_datecharacterOff-season start date.
off_season_end_datecharacterOff-season end date.
season_level_gameday_typecharacterSeason-level Gameday data feed type.
game_level_gameday_typecharacterGame-level Gameday data feed type.
qualifier_plate_appearancesdoublePlate appearances per team game to qualify.
qualifier_outs_pitcheddoubleOuts pitched per team game to qualify.

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

Example

mlb_api_season(season_id='X')

Last validated n/a.

mlb_api_venues

GET /api/v1/venues — list venues.

Endpoint URL: GET https://statsapi.mlb.com/api/v1/venues

Valid URL: https://statsapi.mlb.com/api/v1/venues

API ParameterPythonPatternRequiredNullableDescription
seasonseasonYSeason year (e.g. 2024).
sportIdssport_idsYsportIds query parameter.
hydratehydrateYhydrate query 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
idintegerId.
namecharacterDisplay name.
linkcharacterAPI link to the game feed.
activelogicalWhether the player is currently active.
seasoncharacterSeason year.

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

Example

mlb_api_venues()

Last validated n/a.

mlb_api_venue

GET /api/v1/venues/{venueId} — single venue detail.

Endpoint URL: GET https://statsapi.mlb.com/api/v1/venues/{venue_id}

Valid URL: https://statsapi.mlb.com/api/v1/venues/15

API ParameterPythonPatternRequiredNullableDescription
venue_idvenue_idYvenue_id path parameter.
seasonseasonYSeason year (e.g. 2024).
hydratehydrateYhydrate query 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
idintegerId.
namecharacterDisplay name.
linkcharacterAPI link to the game feed.
activelogicalWhether the player is currently active.
seasoncharacterSeason year.

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

Example

mlb_api_venue(venue_id=15)

Last validated n/a.

mlb_api_meta

GET /api/v1/{metaType} — enum lookup (the API's self-describing surface).

Endpoint URL: GET https://statsapi.mlb.com/api/v1/{meta_type}

Valid URL: https://statsapi.mlb.com/api/v1/leagueLeaderTypes

API ParameterPythonPatternRequiredNullableDescription
meta_typemeta_typeYmeta_type path parameter.

Returns

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

Example

mlb_api_meta(meta_type='leagueLeaderTypes')

Last validated n/a.

mlb_api_awards

GET /api/v1/awards — list award IDs (call with no params to enumerate).

Endpoint URL: GET https://statsapi.mlb.com/api/v1/awards

Valid URL: https://statsapi.mlb.com/api/v1/awards

API ParameterPythonPatternRequiredNullableDescription
sportIdsport_idYsportId query 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
idcharacterId.
namecharacterDisplay name.
descriptioncharacterLong-form description text.
sort_orderdoubleDisplay sort order for the sport.
activelogicalWhether the player is currently active.
sport_iddoubleSport MLBAM ID.
sport_linkcharacterAPI link to the sport.
league_iddoubleLeague MLBAM ID.
league_linkcharacterAPI link to the league.
notescharacterNotes.

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

Example

mlb_api_awards()

Last validated n/a.

mlb_api_award_recipients

GET /api/v1/awards/{awardId}/recipients — historical winners of one award.

Endpoint URL: GET https://statsapi.mlb.com/api/v1/awards/{award_id}/recipients

Valid URL: https://statsapi.mlb.com/api/v1/awards/MLBHOF/recipients

API ParameterPythonPatternRequiredNullableDescription
award_idaward_idYaward_id path parameter.
seasonseasonYSeason year (e.g. 2024).
sportIdsport_idYsportId query parameter.
hydratehydrateYhydrate query 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
idcharacterId.
namecharacterDisplay name.
datecharacterDate in YYYY-MM-DD format.
seasoncharacterSeason year.
team_idintegerUnique ESPN team identifier.
team_linkcharacterAPI link to the team.
player_idintegerMLBAM player ID.
player_linkcharacterAPI relative link to the player.
player_primary_position_codecharacterRecipient primary fielding position code.
player_primary_position_namecharacterRecipient primary fielding position name.
player_primary_position_typecharacterParticipant primary position type (e.g. 'Hitter').
player_primary_position_abbreviationcharacterParticipant primary position abbreviation (e.g. 'DH').
player_name_first_lastcharacterParticipant name in first-last order.
votesdoubleNumber of votes received.

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

Example

mlb_api_award_recipients(award_id='MLBHOF')

Last validated n/a.

mlb_api_draft

GET /api/v1/draft/{year} — draft results for a year (optionally one round).

Endpoint URL: GET https://statsapi.mlb.com/api/v1/draft/{year}

Valid URL: https://statsapi.mlb.com/api/v1/draft/2024

API ParameterPythonPatternRequiredNullableDescription
yearyearYyear path parameter.
roundround_Yround query parameter.
teamIdteam_idYteamId query parameter.
playerIdplayer_idYplayerId query parameter.
limitlimitYMaximum number of items to return.

Returns

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

Example

mlb_api_draft(year=2024)

Last validated n/a.

mlb_api_umpires

GET /api/v1/jobs/umpires — current umpire crew assignments.

Endpoint URL: GET https://statsapi.mlb.com/api/v1/jobs/umpires

Valid URL: https://statsapi.mlb.com/api/v1/jobs/umpires

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
jersey_numbercharacterJersey number worn (often blank for non-uniformed roles).
jobcharacterJob title (e.g. 'Umpire').
job_idcharacterJob code identifier.
titlecharacterSpecific role title for the assignment.
person_idintegerMLB player ID.
person_full_namecharacterPlayer full name.
person_linkcharacterAPI relative link to the person.

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

Example

mlb_api_umpires()

Last validated n/a.

mlb_api_conferences

View all PCL conferences.

Endpoint URL: GET https://statsapi.mlb.com/api/v1/conferences

Valid URL: https://statsapi.mlb.com/api/v1/conferences

API ParameterPythonPatternRequiredNullableDescription
conferenceIdconference_idYconferenceId query parameter.
seasonseasonYSeason year (e.g. 2024).
fieldsfieldsYfields query 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
idintegerId.
namecharacterDisplay name.
linkcharacterAPI link to the game feed.
abbreviationcharacterShort abbreviation.
has_wildcardlogicalWhether the season has a wild card round.
name_shortcharacterShort name of player (First Initial, Last Name)
league_idintegerLeague MLBAM ID.
league_linkcharacterAPI link to the league.
sport_idintegerSport MLBAM ID.
sport_linkcharacterAPI link to the sport.

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

Example

mlb_api_conferences()

Last validated n/a.

mlb_api_conference

View PCL conferences by conferenceId.

Endpoint URL: GET https://statsapi.mlb.com/api/v1/conferences/{conference_id}

Valid URL: https://statsapi.mlb.com/api/v1/conferences/301

API ParameterPythonPatternRequiredNullableDescription
conference_idconference_idYconference_id path parameter.
seasonseasonYSeason year (e.g. 2024).
fieldsfieldsYfields query 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
idintegerId.
namecharacterDisplay name.
linkcharacterAPI link to the game feed.
abbreviationcharacterShort abbreviation.
has_wildcardlogicalWhether the season has a wild card round.
name_shortcharacterShort name of player (First Initial, Last Name)
league_idintegerLeague MLBAM ID.
league_linkcharacterAPI link to the league.
sport_idintegerSport MLBAM ID.
sport_linkcharacterAPI link to the sport.

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

Example

mlb_api_conference(conference_id=301)

Last validated n/a.

mlb_api_draft_latest

View latest player drafted, endpoint best used when draft is currently open.

Endpoint URL: GET https://statsapi.mlb.com/api/v1/draft/{year}/latest

Valid URL: https://statsapi.mlb.com/api/v1/draft/2023/latest

API ParameterPythonPatternRequiredNullableDescription
yearyearYyear 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
numberintegerWeek number as returned by the API.
next_upcharacter
pick_pick_roundcharacter
pick_pick_numberinteger
pick_display_pick_numberinteger
pick_round_pick_numberinteger
pick_signing_bonuscharacter
pick_home_citycharacter
pick_home_statecharacter
pick_home_countrycharacter
pick_school_namecharacter
pick_school_school_classcharacter
pick_school_citycharacter
pick_school_countrycharacter
pick_school_statecharacter
pick_headshot_linkcharacter
pick_person_idinteger
pick_person_full_namecharacter
pick_person_linkcharacter
pick_person_first_namecharacter
pick_person_last_namecharacter
pick_person_birth_datecharacter
pick_person_current_ageinteger
pick_person_birth_citycharacter
pick_person_birth_state_provincecharacter
pick_person_birth_countrycharacter
pick_person_heightcharacter
pick_person_weightinteger
pick_person_activelogical
pick_person_primary_position_codecharacter
pick_person_primary_position_namecharacter
pick_person_primary_position_typecharacter
pick_person_primary_position_abbreviationcharacter
pick_person_use_namecharacter
pick_person_use_last_namecharacter
pick_person_middle_namecharacter
pick_person_boxscore_namecharacter
pick_person_gendercharacter
pick_person_is_playerlogical
pick_person_is_verifiedlogical
pick_person_draft_yearinteger
pick_person_bat_side_codecharacter
pick_person_bat_side_descriptioncharacter
pick_person_pitch_hand_codecharacter
pick_person_pitch_hand_descriptioncharacter
pick_person_name_first_lastcharacter
pick_person_name_slugcharacter
pick_person_first_last_namecharacter
pick_person_last_first_namecharacter
pick_person_last_init_namecharacter
pick_person_init_last_namecharacter
pick_person_full_fml_namecharacter
pick_person_full_lfm_namecharacter
pick_person_strike_zone_topdouble
pick_person_strike_zone_bottomdouble
pick_person_xref_idscharacter
pick_team_spring_league_idinteger
pick_team_spring_league_namecharacter
pick_team_spring_league_linkcharacter
pick_team_spring_league_abbreviationcharacter
pick_team_all_star_statuscharacter
pick_team_idinteger
pick_team_namecharacter
pick_team_linkcharacter
pick_team_seasoninteger
pick_team_venue_idinteger
pick_team_venue_namecharacter
pick_team_venue_linkcharacter
pick_team_spring_venue_idinteger
pick_team_spring_venue_linkcharacter
pick_team_team_codecharacter
pick_team_file_codecharacter
pick_team_abbreviationcharacter
pick_team_team_namecharacter
pick_team_location_namecharacter
pick_team_first_year_of_playcharacter
pick_team_league_idinteger
pick_team_league_namecharacter
pick_team_league_linkcharacter
pick_team_division_idinteger
pick_team_division_namecharacter
pick_team_division_linkcharacter
pick_team_sport_idinteger
pick_team_sport_linkcharacter
pick_team_sport_namecharacter
pick_team_short_namecharacter
pick_team_franchise_namecharacter
pick_team_club_namecharacter
pick_team_activelogical
pick_draft_type_codecharacter
pick_draft_type_descriptioncharacter
pick_is_draftedlogical
pick_is_passlogical
pick_yearcharacter

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

Example

mlb_api_draft_latest(year=2023)

Last validated n/a.

mlb_api_game_timestamps

Retrieve all of the play timecodes for a game in GUMBO feed.

Endpoint URL: GET https://statsapi.mlb.com/api/v1.1/game/{game_pk}/feed/live/timestamps

Valid URL: https://statsapi.mlb.com/api/v1.1/game/716390/feed/live/timestamps

API ParameterPythonPatternRequiredNullableDescription
game_pkgame_pkYgame_pk 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
timecodecharacter

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

Example

mlb_api_game_timestamps(game_pk=716390)

Last validated n/a.

mlb_api_game_changes

View corrected non Statcast information for games

Endpoint URL: GET https://statsapi.mlb.com/api/v1/game/changes

Valid URL: https://statsapi.mlb.com/api/v1/game/changes?updatedSince=2023-09-01T00%3A00%3A00Z&sportId=1

API ParameterPythonPatternRequiredNullableDescription
updatedSinceupdated_sinceYupdatedSince query parameter.
sportIdsport_idYsportId query parameter.
fieldsfieldsYfields query 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
schedule_datecharacter
game_pkintegerUnique game identifier.
game_guidcharacterGlobally unique game identifier (GUID).
linkcharacterAPI link to the game feed.
game_typecharacterGame type code (R, P, etc.).
seasoncharacterSeason year.
game_datecharacterGame date (YYYY-MM-DD).
official_datecharacterOfficial game date (YYYY-MM-DD).
is_tielogicalWhether the game ended in a tie.
game_numberintegerGame number within a doubleheader.
public_facinglogicalWhether the game is public-facing.
double_headercharacterDoubleheader indicator ('N', 'S', 'Y').
gameday_typecharacterGameday data feed type.
tiebreakercharacterWhether the game is a tiebreaker.
calendar_event_idcharacterCalendar event identifier.
season_displaycharacterDisplay string for the season.
day_nightcharacterDay or night game indicator.
scheduled_inningsintegerScheduled number of innings.
reverse_home_away_statuslogicalWhether home/away teams are reversed.
inning_break_lengthintegerLength of inning breaks in seconds.
games_in_seriesdoubleNumber of games in the series.
series_game_numberdoubleGame number within the series.
series_descriptioncharacterDescription of the series.
record_sourcecharacterSource of the schedule record.
if_necessarycharacterWhether the game is played only if necessary.
if_necessary_descriptioncharacterDescription of the if-necessary status.
status_abstract_game_statecharacterAbstract game state (e.g. 'Final').
status_coded_game_statecharacterCoded game state.
status_detailed_statecharacterDetailed game state.
status_status_codecharacterStatus code for the game.
status_start_time_tbdlogicalWhether the start time is TBD.
status_abstract_game_codecharacterAbstract game state code.
teams_away_team_idintegerAway team MLBAM ID.
teams_away_team_namecharacterAway team name.
teams_away_team_linkcharacterAPI link to the away team.
teams_away_league_record_winsintegerAway team league-record wins.
teams_away_league_record_lossesintegerAway team league-record losses.
teams_away_league_record_tiesintegerAway team league-record ties.
teams_away_league_record_pctcharacterAway team winning percentage.
teams_away_scoreintegerAway team score.
teams_away_is_winnerlogicalWhether the away team won.
teams_away_split_squadlogicalWhether the away team is a split squad.
teams_away_series_numberdoubleAway team's series number.
teams_home_team_idintegerHome team MLBAM ID.
teams_home_team_namecharacterHome team name.
teams_home_team_linkcharacterAPI link to the home team.
teams_home_league_record_winsintegerHome team league-record wins.
teams_home_league_record_lossesintegerHome team league-record losses.
teams_home_league_record_tiesintegerHome team league-record ties.
teams_home_league_record_pctcharacterHome team winning percentage.
teams_home_scoreintegerHome team score.
teams_home_is_winnerlogicalWhether the home team won.
teams_home_split_squadlogicalWhether the home team is a split squad.
teams_home_series_numberdoubleHome team's series number.
venue_idintegerMLBAM venue ID.
venue_namecharacterVenue name.
venue_linkcharacterAPI link to the venue.
content_linkcharacterAPI link to the game content.
rescheduled_fromcharacterOriginal date-time the game was rescheduled from.
rescheduled_from_datecharacterOriginal date the game was rescheduled from.
descriptioncharacterLong-form description text.
status_reasoncharacterReason for the game status (e.g. 'Rain').
resumed_fromcharacterOriginal date-time if the game was resumed.
resumed_from_datecharacterOriginal date if the game was resumed.

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

Example

mlb_api_game_changes(sport_id=1, updated_since='2023-09-01T00:00:00Z')

Last validated n/a.

mlb_api_analytics_games

View timestamps of most recent data corrections made to games.

Endpoint URL: GET https://statsapi.mlb.com/api/v1/game/analytics/game

Valid URL: https://statsapi.mlb.com/api/v1/game/analytics/game

API ParameterPythonPatternRequiredNullableDescription
gameModeIdgame_mode_idYgameModeId query parameter.
timecodetimecodeYtimecode query parameter.
limitlimitYMaximum number of items to return.
sortBysort_byYsortBy query parameter.
isNonStatcastis_non_statcastYisNonStatcast query parameter.
offsetoffsetYoffset query parameter.
fieldsfieldsYfields query parameter.

Returns

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

Example

mlb_api_analytics_games()

Last validated n/a.

mlb_api_analytics_guids

View timestamps of most recent data corrections made to GUIDs.

Endpoint URL: GET https://statsapi.mlb.com/api/v1/game/analytics/guids

Valid URL: https://statsapi.mlb.com/api/v1/game/analytics/guids

API ParameterPythonPatternRequiredNullableDescription
gameModeIdgame_mode_idYgameModeId query parameter.
timecodetimecodeYtimecode query parameter.
limitlimitYMaximum number of items to return.
sortBysort_byYsortBy query parameter.
isNonStatcastis_non_statcastYisNonStatcast query parameter.
offsetoffsetYoffset query parameter.
fieldsfieldsYfields query parameter.

Returns

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

Example

mlb_api_analytics_guids()

Last validated n/a.

mlb_api_game_guids

View Statcast data for a specific game.

Endpoint URL: GET https://statsapi.mlb.com/api/v1/game/{game_pk}/guids

Valid URL: https://statsapi.mlb.com/api/v1/game/716390/guids

API ParameterPythonPatternRequiredNullableDescription
game_pkgame_pkYgame_pk path parameter.
gameModeIdgame_mode_idYgameModeId query parameter.
updatedSinceupdated_sinceYupdatedSince query parameter.
isPitchis_pitchYisPitch query parameter.
isHitis_hitYisHit query parameter.
isPickoffis_pickoffYisPickoff query parameter.
hydratehydrateYhydrate query parameter.
parsed/rawparsed_rawYparsed/raw query parameter.
fieldsfieldsYfields query parameter.

Returns

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

Example

mlb_api_game_guids(game_pk=716390)

Last validated n/a.

mlb_api_play_analytics

View Statcast data for a specific play.

Endpoint URL: GET https://statsapi.mlb.com/api/v1/game/{game_pk}/{guid}/analytics

Valid URL: https://statsapi.mlb.com/api/v1/game/716390/90groovy-2438-test-guid-placeholder0/analytics

API ParameterPythonPatternRequiredNullableDescription
game_pkgame_pkYgame_pk path parameter.
guidguidYguid path parameter.
hydratehydrateYhydrate query parameter.
fieldsfieldsYfields query parameter.

Returns

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

Example

mlb_api_play_analytics(game_pk=716390, guid='90groovy-2438-test-guid-placeholder0')

Last validated n/a.

mlb_api_play_context_metrics_averages

View Statcast contextMetrics data for a specific play.

Endpoint URL: GET https://statsapi.mlb.com/api/v1/game/{game_pk}/{guid}/contextMetricsAverages

Valid URL: https://statsapi.mlb.com/api/v1/game/716390/90groovy-2438-test-guid-placeholder0/contextMetricsAverages

API ParameterPythonPatternRequiredNullableDescription
game_pkgame_pkYgame_pk path parameter.
guidguidYguid path parameter.
fieldsfieldsYfields query parameter.

Returns

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

Example

mlb_api_play_context_metrics_averages(game_pk=716390, guid='90groovy-2438-test-guid-placeholder0')

Last validated n/a.

mlb_api_game_color

View game color commentary info.

Endpoint URL: GET https://statsapi.mlb.com/api/v1/game/{game_pk}/feed/color

Valid URL: https://statsapi.mlb.com/api/v1/game/716390/feed/color

API ParameterPythonPatternRequiredNullableDescription
game_pkgame_pkYgame_pk path parameter.
timecodetimecodeYtimecode query parameter.
fieldsfieldsYfields query parameter.

Returns

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

Example

mlb_api_game_color(game_pk=716390)

Last validated n/a.

mlb_api_game_color_diff

View game color feed.

Endpoint URL: GET https://statsapi.mlb.com/api/v1/game/{game_pk}/feed/color/diffPatch

Valid URL: https://statsapi.mlb.com/api/v1/game/716390/feed/color/diffPatch

API ParameterPythonPatternRequiredNullableDescription
game_pkgame_pkYgame_pk path parameter.
startTimecodestart_timecodeYstartTimecode query parameter.
endTimecodeend_timecodeYendTimecode query parameter.

Returns

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

Example

mlb_api_game_color_diff(game_pk=716390)

Last validated n/a.

mlb_api_game_color_timestamps

View all of the color timecodes for a game.

Endpoint URL: GET https://statsapi.mlb.com/api/v1/game/{game_pk}/feed/color/timestamps

Valid URL: https://statsapi.mlb.com/api/v1/game/716390/feed/color/timestamps

API ParameterPythonPatternRequiredNullableDescription
game_pkgame_pkYgame_pk path parameter.

Returns

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

Example

mlb_api_game_color_timestamps(game_pk=716390)

Last validated n/a.

mlb_api_game_pace

View time of game info.

Endpoint URL: GET https://statsapi.mlb.com/api/v1/gamePace

Valid URL: https://statsapi.mlb.com/api/v1/gamePace?season=2023

API ParameterPythonPatternRequiredNullableDescription
seasonseasonYSeason year (e.g. 2024).
teamIdsteam_idsYteamIds query parameter.
leagueIdsleague_idsYleagueIds query parameter.
leagueListIdleague_list_idYleagueListId query parameter.
sportIdsport_idYsportId query parameter.
gameTypegame_typeYgameType query parameter.
startDatestart_dateYstartDate query parameter.
endDateend_dateYendDate query parameter.
venueIdsvenue_idsYvenueIds query parameter.
orgTypeorg_typeYorgType query parameter.
includeChildreninclude_childrenYincludeChildren query parameter.
fieldsfieldsYfields query 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
hits_per9_inndouble
runs_per9_inndouble
pitches_per9_inndouble
plate_appearances_per9_inndouble
hits_per_gamedoubleHits per game.
runs_per_gamedoubleRuns per game.
innings_played_per_gamedoubleInnings played per game.
pitches_per_gamedoublePitches per game.
pitchers_per_gamedoublePitchers used per game.
plate_appearances_per_gamedoublePlate appearances per game.
total_game_timecharacterTotal game time (HHH:MM:SS).
total_innings_playeddoubleTotal innings played.
total_hitsintegerTotal hits.
total_runsintegerTotal runs.
total_plate_appearancesintegerTotal plate appearances.
total_pitchersintegerTotal pitchers used.
total_pitchesintegerTotal pitches thrown.
total_gamesintegerTotal games on the date.
total7_inn_gamesinteger
total9_inn_gamesdouble
total_extra_inn_gamesintegerTotal extra-inning games.
time_per_gamecharacterAverage time per game (HH:MM:SS).
time_per_pitchcharacterAverage time per pitch (HH:MM:SS).
time_per_hitcharacterAverage time per hit (HH:MM:SS).
time_per_runcharacterAverage time per run (HH:MM:SS).
time_per_plate_appearancecharacterAverage time per plate appearance (HH:MM:SS).
time_per9_inncharacter
time_per77_plate_appearancescharacter
total_extra_inn_timecharacterTotal extra-inning time (HHH:MM:SS).
time_per7_inn_game_without_extra_inncharacter
total9_inn_games_completed_earlyinteger
total9_inn_games_without_extra_inndouble
total9_inn_games_scheduledinteger
hits_per_rundoubleHits per run.
pitches_per_pitcherdoublePitches per pitcher.
seasoncharacterSeason year.
sport_idintegerSport MLBAM ID.
sport_codecharacterShort sport code (e.g. 'mlb', 'aaa').
sport_linkcharacterAPI link to the sport.
pr_portal_calculated_fields_total7_inn_gamesinteger
pr_portal_calculated_fields_total9_inn_gamesdouble
pr_portal_calculated_fields_total_extra_inn_gamesintegerPortal-calculated total extra-inning games.
pr_portal_calculated_fields_time_per7_inn_gamecharacter
pr_portal_calculated_fields_time_per9_inn_gamecharacter
pr_portal_calculated_fields_time_per_extra_inn_gamecharacterPortal-calculated time per extra-inning game.
time_per7_inn_gamecharacter
total7_inn_games_scheduleddouble
total7_inn_games_without_extra_inndouble
total7_inn_games_completed_earlydouble

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

Example

mlb_api_game_pace(season='2023')

Last validated n/a.

mlb_api_high_low

View high/low stats by player or team.

Endpoint URL: GET https://statsapi.mlb.com/api/v1/highLow/{org_type}

Valid URL: https://statsapi.mlb.com/api/v1/highLow/player?statGroup=hitting&sortStat=homeRuns&season=2023

API ParameterPythonPatternRequiredNullableDescription
org_typeorg_typeYorg_type path parameter.
statGroupstat_groupYstatGroup query parameter.
sortStatsort_statYsortStat query parameter.
seasonseasonYSeason year (e.g. 2024).
gameTypegame_typeYgameType query parameter.
teamIdteam_idYteamId query parameter.
leagueIdleague_idYleagueId query parameter.
sportIdssport_idsYsportIds query parameter.
limitlimitYMaximum number of items to return.
fieldsfieldsYfields query 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
total_splitsintegerTotal number of splits in the leaderboard.
exemptionscharacter
splitscharacterSplits.
splits_tied_with_offsetcharacterPlayers tied at the offset boundary.
splits_tied_with_limitcharacterPlayers tied at the limit boundary.
seasoncharacterSeason year.
combined_statslogicalWhether the stat combines multiple split sources.
group_display_namecharacterStat group display name.
game_type_idcharacterGame type code (e.g., R for regular season).
game_type_descriptioncharacterGame type description.
sort_stat_namecharacterSnake-case name of the sorted statistic (e.g. 'at_bats').
sort_stat_lookup_paramcharacterAPI lookup parameter for the sorted statistic (e.g. 'atBats').
sort_stat_is_countinglogicalWhether the sorted statistic is a counting stat.
sort_stat_labelcharacterHuman-readable label of the sorted statistic (e.g. 'At bats').
sort_stat_stat_groupscharacter
sort_stat_org_typescharacter
sort_stat_high_low_typescharacter
sort_stat_streak_levelscharacter

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

Example

mlb_api_high_low(org_type='player', stat_group='hitting', sort_stat='homeRuns', season='2023')

Last validated n/a.

mlb_api_home_run_derby

View a home run derby object based on gamePk.

Endpoint URL: GET https://statsapi.mlb.com/api/v1/homeRunDerby/{game_pk}

Valid URL: https://statsapi.mlb.com/api/v1/homeRunDerby/511101

API ParameterPythonPatternRequiredNullableDescription
game_pkgame_pkYgame_pk path parameter.
fieldsfieldsYfields query 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
idintegerId.
full_namecharacterPlayer's full name.
linkcharacterAPI link to the game feed.
first_namecharacterPlayer first name.
last_namecharacterPlayer last name.
primary_numbercharacterPlayer uniform number.
birth_datecharacterDate of birth (YYYY-MM-DD).
current_ageintegerCurrent age in years.
birth_citycharacterCity of birth.
birth_state_provincecharacterState or province of birth.
birth_countrycharacterCountry of birth.
heightcharacterHeight (feet and inches).
weightintegerWeight in pounds.
activelogicalWhether the player is currently active.
use_namecharacterPreferred first name.
use_last_namecharacterPreferred last name.
middle_namecharacterPlayer middle name.
boxscore_namecharacterName as shown in box scores.
nick_namecharacterPlayer nickname.
gendercharacterPlayer gender.
is_playerlogicalWhether the person is a player.
is_verifiedlogicalWhether the player profile is verified.
draft_yeardoubleYear the player was drafted.
pronunciationcharacterPhonetic name pronunciation.
statscharacterStats.
mlb_debut_datecharacterMLB debut date (YYYY-MM-DD).
name_first_lastcharacterName in first-last order.
name_slugcharacterURL-friendly name slug.
first_last_namecharacterFirst and last name.
last_first_namecharacterName in last, first order.
last_init_namecharacterLast name with first initial.
init_last_namecharacterFirst initial with last name.
full_fml_namecharacterFull name (first-middle-last).
full_lfm_namecharacterFull name (last-first-middle).
strike_zone_topdoubleTop of the player's strike zone (feet).
strike_zone_bottomdoubleBottom of the player's strike zone (feet).
current_team_spring_league_iddouble
current_team_spring_league_namecharacter
current_team_spring_league_linkcharacter
current_team_spring_league_abbreviationcharacter
current_team_all_star_statuscharacter
current_team_idintegerCurrent team MLBAM ID.
current_team_namecharacterCurrent team name.
current_team_linkcharacterAPI link to the current team.
current_team_seasoninteger
current_team_venue_idinteger
current_team_venue_namecharacter
current_team_venue_linkcharacter
current_team_spring_venue_iddouble
current_team_spring_venue_linkcharacter
current_team_team_codecharacter
current_team_file_codecharacter
current_team_abbreviationcharacter
current_team_team_namecharacter
current_team_location_namecharacter
current_team_first_year_of_playcharacter
current_team_league_idinteger
current_team_league_namecharacter
current_team_league_linkcharacter
current_team_division_iddouble
current_team_division_namecharacter
current_team_division_linkcharacter
current_team_sport_idinteger
current_team_sport_linkcharacter
current_team_sport_namecharacter
current_team_short_namecharacter
current_team_franchise_namecharacter
current_team_club_namecharacter
current_team_activelogical
primary_position_codecharacterPrimary position code.
primary_position_namecharacterPrimary fielding position name.
primary_position_typecharacterPrimary position type (e.g. Infielder).
primary_position_abbreviationcharacterPrimary position abbreviation.
bat_side_codecharacterBatting side code (L/R/S).
bat_side_descriptioncharacterBatting side description.
pitch_hand_codecharacterThrowing hand code (L/R).
pitch_hand_descriptioncharacterThrowing hand description.
last_played_datecharacterDate of last MLB game played.
name_matrilinealcharacterMaternal family name.
current_team_parent_org_namecharacter
current_team_parent_org_iddouble

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

Example

mlb_api_home_run_derby(game_pk=511101)

Last validated n/a.

mlb_api_home_run_derby_bracket

View a home run derby object based on bracket.

Endpoint URL: GET https://statsapi.mlb.com/api/v1/homeRunDerby/{game_pk}/bracket

Valid URL: https://statsapi.mlb.com/api/v1/homeRunDerby/511101/bracket

API ParameterPythonPatternRequiredNullableDescription
game_pkgame_pkYgame_pk path parameter.
fieldsfieldsYfields query 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
idintegerId.
full_namecharacterPlayer's full name.
linkcharacterAPI link to the game feed.
first_namecharacterPlayer first name.
last_namecharacterPlayer last name.
primary_numbercharacterPlayer uniform number.
birth_datecharacterDate of birth (YYYY-MM-DD).
current_ageintegerCurrent age in years.
birth_citycharacterCity of birth.
birth_state_provincecharacterState or province of birth.
birth_countrycharacterCountry of birth.
heightcharacterHeight (feet and inches).
weightintegerWeight in pounds.
activelogicalWhether the player is currently active.
use_namecharacterPreferred first name.
use_last_namecharacterPreferred last name.
middle_namecharacterPlayer middle name.
boxscore_namecharacterName as shown in box scores.
nick_namecharacterPlayer nickname.
gendercharacterPlayer gender.
is_playerlogicalWhether the person is a player.
is_verifiedlogicalWhether the player profile is verified.
draft_yeardoubleYear the player was drafted.
pronunciationcharacterPhonetic name pronunciation.
statscharacterStats.
mlb_debut_datecharacterMLB debut date (YYYY-MM-DD).
name_first_lastcharacterName in first-last order.
name_slugcharacterURL-friendly name slug.
first_last_namecharacterFirst and last name.
last_first_namecharacterName in last, first order.
last_init_namecharacterLast name with first initial.
init_last_namecharacterFirst initial with last name.
full_fml_namecharacterFull name (first-middle-last).
full_lfm_namecharacterFull name (last-first-middle).
strike_zone_topdoubleTop of the player's strike zone (feet).
strike_zone_bottomdoubleBottom of the player's strike zone (feet).
current_team_spring_league_iddouble
current_team_spring_league_namecharacter
current_team_spring_league_linkcharacter
current_team_spring_league_abbreviationcharacter
current_team_all_star_statuscharacter
current_team_idintegerCurrent team MLBAM ID.
current_team_namecharacterCurrent team name.
current_team_linkcharacterAPI link to the current team.
current_team_seasoninteger
current_team_venue_idinteger
current_team_venue_namecharacter
current_team_venue_linkcharacter
current_team_spring_venue_iddouble
current_team_spring_venue_linkcharacter
current_team_team_codecharacter
current_team_file_codecharacter
current_team_abbreviationcharacter
current_team_team_namecharacter
current_team_location_namecharacter
current_team_first_year_of_playcharacter
current_team_league_idinteger
current_team_league_namecharacter
current_team_league_linkcharacter
current_team_division_iddouble
current_team_division_namecharacter
current_team_division_linkcharacter
current_team_sport_idinteger
current_team_sport_linkcharacter
current_team_sport_namecharacter
current_team_short_namecharacter
current_team_franchise_namecharacter
current_team_club_namecharacter
current_team_activelogical
primary_position_codecharacterPrimary position code.
primary_position_namecharacterPrimary fielding position name.
primary_position_typecharacterPrimary position type (e.g. Infielder).
primary_position_abbreviationcharacterPrimary position abbreviation.
bat_side_codecharacterBatting side code (L/R/S).
bat_side_descriptioncharacterBatting side description.
pitch_hand_codecharacterThrowing hand code (L/R).
pitch_hand_descriptioncharacterThrowing hand description.
last_played_datecharacterDate of last MLB game played.
name_matrilinealcharacterMaternal family name.
current_team_parent_org_namecharacter
current_team_parent_org_iddouble

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

Example

mlb_api_home_run_derby_bracket(game_pk=511101)

Last validated n/a.

mlb_api_home_run_derby_pool

View a home run derby object based on pool.

Endpoint URL: GET https://statsapi.mlb.com/api/v1/homeRunDerby/{game_pk}/pool

Valid URL: https://statsapi.mlb.com/api/v1/homeRunDerby/511101/pool

API ParameterPythonPatternRequiredNullableDescription
game_pkgame_pkYgame_pk path parameter.
fieldsfieldsYfields query 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
idintegerId.
full_namecharacterPlayer's full name.
linkcharacterAPI link to the game feed.
first_namecharacterPlayer first name.
last_namecharacterPlayer last name.
primary_numbercharacterPlayer uniform number.
birth_datecharacterDate of birth (YYYY-MM-DD).
current_ageintegerCurrent age in years.
birth_citycharacterCity of birth.
birth_state_provincecharacterState or province of birth.
birth_countrycharacterCountry of birth.
heightcharacterHeight (feet and inches).
weightintegerWeight in pounds.
activelogicalWhether the player is currently active.
use_namecharacterPreferred first name.
use_last_namecharacterPreferred last name.
middle_namecharacterPlayer middle name.
boxscore_namecharacterName as shown in box scores.
nick_namecharacterPlayer nickname.
gendercharacterPlayer gender.
is_playerlogicalWhether the person is a player.
is_verifiedlogicalWhether the player profile is verified.
draft_yeardoubleYear the player was drafted.
pronunciationcharacterPhonetic name pronunciation.
statscharacterStats.
mlb_debut_datecharacterMLB debut date (YYYY-MM-DD).
name_first_lastcharacterName in first-last order.
name_slugcharacterURL-friendly name slug.
first_last_namecharacterFirst and last name.
last_first_namecharacterName in last, first order.
last_init_namecharacterLast name with first initial.
init_last_namecharacterFirst initial with last name.
full_fml_namecharacterFull name (first-middle-last).
full_lfm_namecharacterFull name (last-first-middle).
strike_zone_topdoubleTop of the player's strike zone (feet).
strike_zone_bottomdoubleBottom of the player's strike zone (feet).
current_team_spring_league_iddouble
current_team_spring_league_namecharacter
current_team_spring_league_linkcharacter
current_team_spring_league_abbreviationcharacter
current_team_all_star_statuscharacter
current_team_idintegerCurrent team MLBAM ID.
current_team_namecharacterCurrent team name.
current_team_linkcharacterAPI link to the current team.
current_team_seasoninteger
current_team_venue_idinteger
current_team_venue_namecharacter
current_team_venue_linkcharacter
current_team_spring_venue_iddouble
current_team_spring_venue_linkcharacter
current_team_team_codecharacter
current_team_file_codecharacter
current_team_abbreviationcharacter
current_team_team_namecharacter
current_team_location_namecharacter
current_team_first_year_of_playcharacter
current_team_league_idinteger
current_team_league_namecharacter
current_team_league_linkcharacter
current_team_division_iddouble
current_team_division_namecharacter
current_team_division_linkcharacter
current_team_sport_idinteger
current_team_sport_linkcharacter
current_team_sport_namecharacter
current_team_short_namecharacter
current_team_franchise_namecharacter
current_team_club_namecharacter
current_team_activelogical
primary_position_codecharacterPrimary position code.
primary_position_namecharacterPrimary fielding position name.
primary_position_typecharacterPrimary position type (e.g. Infielder).
primary_position_abbreviationcharacterPrimary position abbreviation.
bat_side_codecharacterBatting side code (L/R/S).
bat_side_descriptioncharacterBatting side description.
pitch_hand_codecharacterThrowing hand code (L/R).
pitch_hand_descriptioncharacterThrowing hand description.
last_played_datecharacterDate of last MLB game played.
name_matrilinealcharacterMaternal family name.
current_team_parent_org_namecharacter
current_team_parent_org_iddouble

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

Example

mlb_api_home_run_derby_pool(game_pk=511101)

Last validated n/a.

mlb_api_all_star_ballot

View All-Star Ballots per league.

Endpoint URL: GET https://statsapi.mlb.com/api/v1/league/{league_id}/allStarBallot

Valid URL: https://statsapi.mlb.com/api/v1/league/103/allStarBallot?season=2023

API ParameterPythonPatternRequiredNullableDescription
league_idleague_idYleague_id path parameter.
seasonseasonYSeason year (e.g. 2024).
fieldsfieldsYfields query 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
idintegerId.
full_namecharacterPlayer's full name.
linkcharacterAPI link to the game feed.
first_namecharacterPlayer first name.
last_namecharacterPlayer last name.
primary_numbercharacterPlayer uniform number.
birth_datecharacterDate of birth (YYYY-MM-DD).
current_ageintegerCurrent age in years.
birth_citycharacterCity of birth.
birth_countrycharacterCountry of birth.
heightcharacterHeight (feet and inches).
weightintegerWeight in pounds.
activelogicalWhether the player is currently active.
use_namecharacterPreferred first name.
use_last_namecharacterPreferred last name.
middle_namecharacterPlayer middle name.
boxscore_namecharacterName as shown in box scores.
nick_namecharacterPlayer nickname.
gendercharacterPlayer gender.
name_matrilinealcharacterMaternal family name.
is_playerlogicalWhether the person is a player.
is_verifiedlogicalWhether the player profile is verified.
pronunciationcharacterPhonetic name pronunciation.
last_played_datecharacterDate of last MLB game played.
mlb_debut_datecharacterMLB debut date (YYYY-MM-DD).
name_first_lastcharacterName in first-last order.
name_slugcharacterURL-friendly name slug.
first_last_namecharacterFirst and last name.
last_first_namecharacterName in last, first order.
last_init_namecharacterLast name with first initial.
init_last_namecharacterFirst initial with last name.
full_fml_namecharacterFull name (first-middle-last).
full_lfm_namecharacterFull name (last-first-middle).
strike_zone_topdoubleTop of the player's strike zone (feet).
strike_zone_bottomdoubleBottom of the player's strike zone (feet).
primary_position_codecharacterPrimary position code.
primary_position_namecharacterPrimary fielding position name.
primary_position_typecharacterPrimary position type (e.g. Infielder).
primary_position_abbreviationcharacterPrimary position abbreviation.
bat_side_codecharacterBatting side code (L/R/S).
bat_side_descriptioncharacterBatting side description.
pitch_hand_codecharacterThrowing hand code (L/R).
pitch_hand_descriptioncharacterThrowing hand description.
birth_state_provincecharacterState or province of birth.
draft_yeardoubleYear the player was drafted.
name_titlecharacterName title.
name_suffixcharacterName suffix (e.g. Jr., Sr., III).

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

Example

mlb_api_all_star_ballot(league_id='103', season='2023')

Last validated n/a.

mlb_api_all_star_write_ins

View All-Star Write-ins per league.

Endpoint URL: GET https://statsapi.mlb.com/api/v1/league/{league_id}/allStarWriteIns

Valid URL: https://statsapi.mlb.com/api/v1/league/103/allStarWriteIns?season=2023

API ParameterPythonPatternRequiredNullableDescription
league_idleague_idYleague_id path parameter.
seasonseasonYSeason year (e.g. 2024).
fieldsfieldsYfields query 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
idintegerId.
full_namecharacterPlayer's full name.
linkcharacterAPI link to the game feed.
first_namecharacterPlayer first name.
last_namecharacterPlayer last name.
birth_datecharacterDate of birth (YYYY-MM-DD).
current_ageintegerCurrent age in years.
birth_citycharacterCity of birth.
birth_state_provincecharacterState or province of birth.
birth_countrycharacterCountry of birth.
heightcharacterHeight (feet and inches).
weightintegerWeight in pounds.
activelogicalWhether the player is currently active.
use_namecharacterPreferred first name.
use_last_namecharacterPreferred last name.
boxscore_namecharacterName as shown in box scores.
gendercharacterPlayer gender.
is_playerlogicalWhether the person is a player.
is_verifiedlogicalWhether the player profile is verified.
pronunciationcharacterPhonetic name pronunciation.
mlb_debut_datecharacterMLB debut date (YYYY-MM-DD).
name_first_lastcharacterName in first-last order.
name_slugcharacterURL-friendly name slug.
first_last_namecharacterFirst and last name.
last_first_namecharacterName in last, first order.
last_init_namecharacterLast name with first initial.
init_last_namecharacterFirst initial with last name.
full_fml_namecharacterFull name (first-middle-last).
full_lfm_namecharacterFull name (last-first-middle).
strike_zone_topdoubleTop of the player's strike zone (feet).
strike_zone_bottomdoubleBottom of the player's strike zone (feet).
bat_side_codecharacterBatting side code (L/R/S).
bat_side_descriptioncharacterBatting side description.
pitch_hand_codecharacterThrowing hand code (L/R).
pitch_hand_descriptioncharacterThrowing hand description.
primary_numbercharacterPlayer uniform number.
draft_yeardoubleYear the player was drafted.
middle_namecharacterPlayer middle name.
name_matrilinealcharacterMaternal family name.
last_played_datecharacterDate of last MLB game played.
nick_namecharacterPlayer nickname.
name_titlecharacterName title.
name_suffixcharacterName suffix (e.g. Jr., Sr., III).

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

Example

mlb_api_all_star_write_ins(league_id='103', season='2023')

Last validated n/a.

mlb_api_all_star_final_vote

View All-Star Final Vote per league.

Endpoint URL: GET https://statsapi.mlb.com/api/v1/league/{league_id}/allStarFinalVote

Valid URL: https://statsapi.mlb.com/api/v1/league/103/allStarFinalVote?season=2023

API ParameterPythonPatternRequiredNullableDescription
league_idleague_idYleague_id path parameter.
seasonseasonYSeason year (e.g. 2024).
fieldsfieldsYfields query 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
idintegerId.
full_namecharacterPlayer's full name.
linkcharacterAPI link to the game feed.
first_namecharacterPlayer first name.
last_namecharacterPlayer last name.
primary_numbercharacterPlayer uniform number.
birth_datecharacterDate of birth (YYYY-MM-DD).
current_ageintegerCurrent age in years.
birth_citycharacterCity of birth.
birth_countrycharacterCountry of birth.
heightcharacterHeight (feet and inches).
weightintegerWeight in pounds.
activelogicalWhether the player is currently active.
use_namecharacterPreferred first name.
use_last_namecharacterPreferred last name.
boxscore_namecharacterName as shown in box scores.
nick_namecharacterPlayer nickname.
gendercharacterPlayer gender.
is_playerlogicalWhether the person is a player.
is_verifiedlogicalWhether the player profile is verified.
pronunciationcharacterPhonetic name pronunciation.
mlb_debut_datecharacterMLB debut date (YYYY-MM-DD).
name_first_lastcharacterName in first-last order.
name_slugcharacterURL-friendly name slug.
first_last_namecharacterFirst and last name.
last_first_namecharacterName in last, first order.
last_init_namecharacterLast name with first initial.
init_last_namecharacterFirst initial with last name.
full_fml_namecharacterFull name (first-middle-last).
full_lfm_namecharacterFull name (last-first-middle).
strike_zone_topdoubleTop of the player's strike zone (feet).
strike_zone_bottomdoubleBottom of the player's strike zone (feet).
primary_position_codecharacterPrimary position code.
primary_position_namecharacterPrimary fielding position name.
primary_position_typecharacterPrimary position type (e.g. Infielder).
primary_position_abbreviationcharacterPrimary position abbreviation.
bat_side_codecharacterBatting side code (L/R/S).
bat_side_descriptioncharacterBatting side description.
pitch_hand_codecharacterThrowing hand code (L/R).
pitch_hand_descriptioncharacterThrowing hand description.
name_matrilinealcharacterMaternal family name.
birth_state_provincecharacterState or province of birth.
name_titlecharacterName title.
name_suffixcharacterName suffix (e.g. Jr., Sr., III).
middle_namecharacterPlayer middle name.
draft_yeardoubleYear the player was drafted.
last_played_datecharacterDate of last MLB game played.

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

Example

mlb_api_all_star_final_vote(league_id='103', season='2023')

Last validated n/a.

mlb_api_free_agents

View biographical information and stats for Free Agents.

Endpoint URL: GET https://statsapi.mlb.com/api/v1/people/freeAgents

Valid URL: https://statsapi.mlb.com/api/v1/people/freeAgents?season=2023

API ParameterPythonPatternRequiredNullableDescription
seasonseasonYSeason year (e.g. 2024).
orderorderYorder query parameter.
hydratehydrateYhydrate query parameter.
fieldsfieldsYfields query 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
notescharacterNotes.
date_declaredcharacterDate the player declared free agency (YYYY-MM-DD).
player_idintegerMLBAM player ID.
player_full_namecharacterPlayer full name.
player_linkcharacterAPI relative link to the player.
original_team_iddoubleTeam id the player left.
original_team_namecharacterName of the team the player left.
original_team_linkcharacterAPI relative link to the original team.
new_team_linkcharacterAPI relative link to the new team.
position_codecharacterNumeric scorekeeping position code.
position_namecharacterPosition name.
position_typecharacterPosition category (e.g. 'Pitcher', 'Infielder').
position_abbreviationcharacterPosition abbreviation.
date_signedcharacterDate the player signed a new contract (YYYY-MM-DD).
new_team_iddoubleTeam id the player signed with.
new_team_namecharacterName of the team the player signed with.
sort_orderdoubleDisplay sort order for the sport.

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

Example

mlb_api_free_agents(season='2023')

Last validated n/a.

mlb_api_jobs

View directory by jobType.

Endpoint URL: GET https://statsapi.mlb.com/api/v1/jobs

Valid URL: https://statsapi.mlb.com/api/v1/jobs?jobType=UMPR

API ParameterPythonPatternRequiredNullableDescription
jobTypejob_typeYjobType query parameter.
sportIdsport_idYsportId query parameter.
datedateYdate query parameter.
fieldsfieldsYfields query 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
jersey_numbercharacterJersey number worn (often blank for non-uniformed roles).
jobcharacterJob title (e.g. 'Umpire').
job_idcharacterJob code identifier.
titlecharacterSpecific role title for the assignment.
person_idintegerMLB player ID.
person_full_namecharacterPlayer full name.
person_linkcharacterAPI relative link to the person.

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

Example

mlb_api_jobs(job_type='UMPR')

Last validated n/a.

mlb_api_datacasters

View datacasters directory.

Endpoint URL: GET https://statsapi.mlb.com/api/v1/jobs/datacasters

Valid URL: https://statsapi.mlb.com/api/v1/jobs/datacasters

API ParameterPythonPatternRequiredNullableDescription
sportIdsport_idYsportId query parameter.
datedateYdate query parameter.
hydratehydrateYhydrate query parameter.
fieldsfieldsYfields query 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
jersey_numbercharacterJersey number worn (often blank for non-uniformed roles).
jobcharacterJob title (e.g. 'Umpire').
job_idcharacterJob code identifier.
titlecharacterSpecific role title for the assignment.
person_idintegerMLB player ID.
person_full_namecharacterPlayer full name.
person_linkcharacterAPI relative link to the person.

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

Example

mlb_api_datacasters()

Last validated n/a.

mlb_api_official_scorers

View official scorer directory.

Endpoint URL: GET https://statsapi.mlb.com/api/v1/jobs/officialScorers

Valid URL: https://statsapi.mlb.com/api/v1/jobs/officialScorers

API ParameterPythonPatternRequiredNullableDescription
sportIdsport_idYsportId query parameter.
datedateYdate query parameter.
hydratehydrateYhydrate query parameter.
fieldsfieldsYfields query 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
jersey_numbercharacterJersey number worn (often blank for non-uniformed roles).
jobcharacterJob title (e.g. 'Umpire').
job_idcharacterJob code identifier.
titlecharacterSpecific role title for the assignment.
person_idintegerMLB player ID.
person_full_namecharacterPlayer full name.
person_linkcharacterAPI relative link to the person.

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

Example

mlb_api_official_scorers()

Last validated n/a.

mlb_api_umpire_games

Get umpires and associated game for umpireId.

Endpoint URL: GET https://statsapi.mlb.com/api/v1/jobs/umpires/games/{umpire_id}

Valid URL: https://statsapi.mlb.com/api/v1/jobs/umpires/games/596809?season=2023

API ParameterPythonPatternRequiredNullableDescription
umpire_idumpire_idYumpire_id path parameter.
seasonseasonYSeason year (e.g. 2024).
hydratehydrateYhydrate query parameter.
fieldsfieldsYfields query parameter.

Returns

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

Example

mlb_api_umpire_games(umpire_id=596809, season='2023')

Last validated n/a.

mlb_api_schedule_tied

View tied game schedule info.

Endpoint URL: GET https://statsapi.mlb.com/api/v1/schedule/games/tied

Valid URL: https://statsapi.mlb.com/api/v1/schedule/games/tied?season=2016

API ParameterPythonPatternRequiredNullableDescription
gameTypesgame_typesYgameTypes query parameter.
seasonseasonYSeason year (e.g. 2024).
hydratehydrateYhydrate query parameter.
fieldsfieldsYfields query 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
schedule_datecharacter
game_pkintegerUnique game identifier.
game_guidcharacterGlobally unique game identifier (GUID).
linkcharacterAPI link to the game feed.
game_typecharacterGame type code (R, P, etc.).
seasoncharacterSeason year.
game_datecharacterGame date (YYYY-MM-DD).
official_datecharacterOfficial game date (YYYY-MM-DD).
is_tielogicalWhether the game ended in a tie.
game_numberintegerGame number within a doubleheader.
public_facinglogicalWhether the game is public-facing.
double_headercharacterDoubleheader indicator ('N', 'S', 'Y').
gameday_typecharacterGameday data feed type.
tiebreakercharacterWhether the game is a tiebreaker.
calendar_event_idcharacterCalendar event identifier.
season_displaycharacterDisplay string for the season.
day_nightcharacterDay or night game indicator.
scheduled_inningsintegerScheduled number of innings.
reverse_home_away_statuslogicalWhether home/away teams are reversed.
inning_break_lengthintegerLength of inning breaks in seconds.
games_in_seriesintegerNumber of games in the series.
series_game_numberintegerGame number within the series.
series_descriptioncharacterDescription of the series.
record_sourcecharacterSource of the schedule record.
if_necessarycharacterWhether the game is played only if necessary.
if_necessary_descriptioncharacterDescription of the if-necessary status.
status_abstract_game_statecharacterAbstract game state (e.g. 'Final').
status_coded_game_statecharacterCoded game state.
status_detailed_statecharacterDetailed game state.
status_status_codecharacterStatus code for the game.
status_start_time_tbdlogicalWhether the start time is TBD.
status_reasoncharacterReason for the game status (e.g. 'Rain').
status_abstract_game_codecharacterAbstract game state code.
teams_away_team_idintegerAway team MLBAM ID.
teams_away_team_namecharacterAway team name.
teams_away_team_linkcharacterAPI link to the away team.
teams_away_league_record_winsintegerAway team league-record wins.
teams_away_league_record_lossesintegerAway team league-record losses.
teams_away_league_record_tiesintegerAway team league-record ties.
teams_away_league_record_pctcharacterAway team winning percentage.
teams_away_scoreintegerAway team score.
teams_away_split_squadlogicalWhether the away team is a split squad.
teams_away_series_numberintegerAway team's series number.
teams_home_team_idintegerHome team MLBAM ID.
teams_home_team_namecharacterHome team name.
teams_home_team_linkcharacterAPI link to the home team.
teams_home_league_record_winsintegerHome team league-record wins.
teams_home_league_record_lossesintegerHome team league-record losses.
teams_home_league_record_tiesintegerHome team league-record ties.
teams_home_league_record_pctcharacterHome team winning percentage.
teams_home_scoreintegerHome team score.
teams_home_split_squadlogicalWhether the home team is a split squad.
teams_home_series_numberintegerHome team's series number.
venue_idintegerMLBAM venue ID.
venue_namecharacterVenue name.
venue_linkcharacterAPI link to the venue.
content_linkcharacterAPI link to the game content.

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

Example

mlb_api_schedule_tied(season='2016')

Last validated n/a.

mlb_api_schedule_postseason_series

View schedule info for postseason based on series.

Endpoint URL: GET https://statsapi.mlb.com/api/v1/schedule/postseason/series

Valid URL: https://statsapi.mlb.com/api/v1/schedule/postseason/series?season=2023

API ParameterPythonPatternRequiredNullableDescription
gameTypesgame_typesYgameTypes query parameter.
seriesNumberseries_numberYseriesNumber query parameter.
teamIdteam_idYteamId query parameter.
sportIdsport_idYsportId query parameter.
seasonseasonYSeason year (e.g. 2024).
fieldsfieldsYfields query 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
total_itemsintegerTotal schedule items on the date.
total_gamesintegerTotal games on the date.
total_games_in_progressintegerGames currently in progress on the date.
gamescharacterNumber of games included in the ATS summary.
sort_orderintegerDisplay sort order for the sport.
series_idcharacterSeries identifier (e.g. 'W_1').
series_sort_numberintegerSort number for the series.
series_is_defaultlogicalWhether the series is the default series.
series_game_typecharacterGame type code for the series.

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

Example

mlb_api_schedule_postseason_series(season='2023')

Last validated n/a.

mlb_api_schedule_postseason_tunein

View schedule info for the tuneIn application.

Endpoint URL: GET https://statsapi.mlb.com/api/v1/schedule/postseason/tuneIn

Valid URL: https://statsapi.mlb.com/api/v1/schedule/postseason/tuneIn?season=2023

API ParameterPythonPatternRequiredNullableDescription
teamIdteam_idYteamId query parameter.
sportIdsport_idYsportId query parameter.
seasonseasonYSeason year (e.g. 2024).
hydratehydrateYhydrate query parameter.
fieldsfieldsYfields query parameter.

Returns

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

Example

mlb_api_schedule_postseason_tunein(season='2023')

Last validated n/a.

mlb_api_seasons_all

View information for all seasons based on id.

Endpoint URL: GET https://statsapi.mlb.com/api/v1/seasons/all

Valid URL: https://statsapi.mlb.com/api/v1/seasons/all?sportId=1

API ParameterPythonPatternRequiredNullableDescription
divisionIddivision_idYdivisionId query parameter.
leagueIdleague_idYleagueId query parameter.
withGameTypeDateswith_game_type_datesYwithGameTypeDates query parameter.
sportIdsport_idYsportId query parameter.
fieldsfieldsYfields query 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
season_idcharacterSeason year identifier.
has_wildcardlogicalWhether the season has a wild card round.
pre_season_start_datecharacterPre-season start date.
season_start_datecharacterSeason start date.
regular_season_start_datecharacterRegular season start date.
regular_season_end_datecharacterRegular season end date.
season_end_datecharacterSeason end date.
offseason_start_datecharacterOff-season start date.
off_season_end_datecharacterOff-season end date.
season_level_gameday_typecharacterSeason-level Gameday data feed type.
game_level_gameday_typecharacterGame-level Gameday data feed type.
qualifier_plate_appearancesdoublePlate appearances per team game to qualify.
qualifier_outs_pitcheddoubleOuts pitched per team game to qualify.
post_season_start_datecharacterPost-season start date.
post_season_end_datecharacterPost-season end date.
last_date1st_halfcharacterLast date of the first half.
all_star_datecharacterAll-Star Game date.
first_date2nd_halfcharacterFirst date of the second half.
pre_season_end_datecharacterPre-season end date.
spring_start_datecharacterSpring training start date.
spring_end_datecharacterSpring training end date.

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

Example

mlb_api_seasons_all(sport_id=1)

Last validated n/a.

mlb_api_sport

View information for any given sportId.

Endpoint URL: GET https://statsapi.mlb.com/api/v1/sports/{sport_id}

Valid URL: https://statsapi.mlb.com/api/v1/sports/1

API ParameterPythonPatternRequiredNullableDescription
sport_idsport_idYsport_id path parameter.
fieldsfieldsYfields query 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
idintegerId.
codecharacterFielder detail type code.
linkcharacterAPI link to the game feed.
namecharacterDisplay name.
abbreviationcharacterShort abbreviation.
sort_orderintegerDisplay sort order for the sport.
active_statuslogicalWhether the sport/level is active.

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

Example

mlb_api_sport(sport_id=1)

Last validated n/a.

mlb_api_stats_metrics

View Statcast stats.

Endpoint URL: GET https://statsapi.mlb.com/api/v1/stats/metrics

Valid URL: https://statsapi.mlb.com/api/v1/stats/metrics

API ParameterPythonPatternRequiredNullableDescription
statsstatsYstats query parameter.
groupgroupYConference or group id filter (e.g. an ESPN conference id).
gameTypegame_typeYgameType query parameter.
seasonseasonYSeason year (e.g. 2024).
startDatestart_dateYstartDate query parameter.
endDateend_dateYendDate query parameter.
venueIdvenue_idYvenueId query parameter.
minOccurrencesmin_occurrencesYminOccurrences query parameter.
percentilepercentileYpercentile query parameter.
personIdperson_idYpersonId query parameter.
teamIdteam_idYteamId query parameter.
limitlimitYMaximum number of items to return.
offsetoffsetYoffset query parameter.
hydratehydrateYhydrate query parameter.
fieldsfieldsYfields query parameter.

Returns

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

Example

mlb_api_stats_metrics()

Last validated n/a.

mlb_api_teams_history

View historical records for a list of teams.

Endpoint URL: GET https://statsapi.mlb.com/api/v1/teams/history

Valid URL: https://statsapi.mlb.com/api/v1/teams/history?teamIds=147

API ParameterPythonPatternRequiredNullableDescription
teamIdsteam_idsYteamIds query parameter.
startSeasonstart_seasonYstartSeason query parameter.
endSeasonend_seasonYendSeason query parameter.
fieldsfieldsYfields query 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
all_star_statuscharacterAll-star status flag.
idintegerId.
namecharacterDisplay name.
linkcharacterAPI link to the game feed.
seasonintegerSeason year.
team_codecharacterInternal team code.
file_codecharacterFile code abbreviation.
abbreviationcharacterShort abbreviation.
team_namecharacterTeam name.
location_namecharacterTeam location (city).
first_year_of_playcharacterFirst year the franchise played.
short_namecharacterShort display name.
franchise_namecharacterFranchise name.
club_namecharacterClub name.
activelogicalWhether the player is currently active.
venue_idintegerMLBAM venue ID.
venue_namecharacterVenue name.
venue_linkcharacterAPI link to the venue.
spring_venue_iddoubleSpring training venue MLBAM ID.
spring_venue_linkcharacterAPI link to the spring venue.
league_idintegerLeague MLBAM ID.
league_namecharacterLeague name.
league_linkcharacterAPI link to the league.
sport_idintegerSport MLBAM ID.
sport_linkcharacterAPI link to the sport.
sport_namecharacterSport name (e.g., Major League Baseball).

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

Example

mlb_api_teams_history(team_ids='147')

Last validated n/a.

mlb_api_teams_stats

View team stats.

Endpoint URL: GET https://statsapi.mlb.com/api/v1/teams/stats

Valid URL: https://statsapi.mlb.com/api/v1/teams/stats?season=2023&sportIds=1&group=hitting&stats=season

API ParameterPythonPatternRequiredNullableDescription
seasonseasonYSeason year (e.g. 2024).
sportIdssport_idsYsportIds query parameter.
groupstat_groupYgroup query parameter.
gameTypegame_typeYgameType query parameter.
statsstatsYstats query parameter.
orderorderYorder query parameter.
sortStatsort_statYsortStat query parameter.
fieldsfieldsYfields query 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
total_splitsintegerTotal number of splits in the leaderboard.
exemptionscharacter
splitscharacterSplits.
splits_tied_with_offsetcharacterPlayers tied at the offset boundary.
splits_tied_with_limitcharacterPlayers tied at the limit boundary.
type_display_namecharacterStat type display name.
group_display_namecharacterStat group display name.

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

Example

mlb_api_teams_stats(season='2023', sport_ids='1', stat_group='hitting', stats='season')

Last validated n/a.

mlb_api_teams_stats_leaders

View leaders for a statistic.

Endpoint URL: GET https://statsapi.mlb.com/api/v1/teams/stats/leaders

Valid URL: https://statsapi.mlb.com/api/v1/teams/stats/leaders?leaderCategories=homeRuns&season=2023

API ParameterPythonPatternRequiredNullableDescription
leaderCategoriesleader_categoriesYleaderCategories query parameter.
sitCodessit_codesYsitCodes query parameter.
gameTypesgame_typesYgameTypes query parameter.
statGroupstat_groupYstatGroup query parameter.
seasonseasonYSeason year (e.g. 2024).
leagueIdsleague_idsYleagueIds query parameter.
startDatestart_dateYstartDate query parameter.
endDateend_dateYendDate query parameter.
sportIdsport_idYsportId query parameter.
hydratehydrateYhydrate query parameter.
limitlimitYMaximum number of items to return.
fieldsfieldsYfields query 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
leader_categorycharacterTeam leader category (e.g., homeRuns).
seasoncharacterSeason year.
leaderscharacter
stat_groupcharacterStat group (e.g., hitting).
total_splitsintegerTotal number of splits in the leaderboard.
game_type_idcharacterGame type code (e.g., R for regular season).
game_type_descriptioncharacterGame type description.

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

Example

mlb_api_teams_stats_leaders(leader_categories='homeRuns', season='2023')

Last validated n/a.

mlb_api_team_coaches

View biographical information on all coaches for a given club.

Endpoint URL: GET https://statsapi.mlb.com/api/v1/teams/{team_id}/coaches

Valid URL: https://statsapi.mlb.com/api/v1/teams/147/coaches?season=2023

API ParameterPythonPatternRequiredNullableDescription
team_idteam_idYteam_id path parameter.
seasonseasonYSeason year (e.g. 2024).
datedateYdate query parameter.
fieldsfieldsYfields query 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
jersey_numbercharacterJersey number worn (often blank for non-uniformed roles).
jobcharacterJob title (e.g. 'Umpire').
job_idcharacterJob code identifier.
titlecharacterSpecific role title for the assignment.
person_idintegerMLB player ID.
person_full_namecharacterPlayer full name.
person_linkcharacterAPI relative link to the person.

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

Example

mlb_api_team_coaches(team_id=147, season='2023')

Last validated n/a.

mlb_api_team_personnel

View biographical information on all personnel for a given club.

Endpoint URL: GET https://statsapi.mlb.com/api/v1/teams/{team_id}/personnel

Valid URL: https://statsapi.mlb.com/api/v1/teams/147/personnel

API ParameterPythonPatternRequiredNullableDescription
team_idteam_idYteam_id path parameter.
datedateYdate query parameter.
fieldsfieldsYfields query 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
jersey_numbercharacterJersey number worn (often blank for non-uniformed roles).
jobcharacterJob title (e.g. 'Umpire').
job_idcharacterJob code identifier.
titlecharacterSpecific role title for the assignment.
person_idintegerMLB player ID.
person_full_namecharacterPlayer full name.
person_linkcharacterAPI relative link to the person.

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

Example

mlb_api_team_personnel(team_id=147)

Last validated n/a.

mlb_api_team_roster_type

View biographical and statistical information for a club's roster based on roster type.

Endpoint URL: GET https://statsapi.mlb.com/api/v1/teams/{team_id}/roster/{roster_type}

Valid URL: https://statsapi.mlb.com/api/v1/teams/147/roster/active?season=2023

API ParameterPythonPatternRequiredNullableDescription
team_idteam_idYteam_id path parameter.
roster_typeroster_typeYroster_type path parameter.
seasonseasonYSeason year (e.g. 2024).
datedateYdate query parameter.
hydratehydrateYhydrate query parameter.
fieldsfieldsYfields query 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
jersey_numbercharacterJersey number worn (often blank for non-uniformed roles).
person_idintegerMLB player ID.
person_full_namecharacterPlayer full name.
person_linkcharacterAPI relative link to the person.
position_codecharacterNumeric scorekeeping position code.
position_namecharacterPosition name.
position_typecharacterPosition category (e.g. 'Pitcher', 'Infielder').
position_abbreviationcharacterPosition abbreviation.
status_codecharacterStatus code identifier (e.g. 'S', 'P', 'I', 'F').
status_descriptioncharacterRoster status description (e.g. 'Active').

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

Example

mlb_api_team_roster_type(team_id=147, roster_type='active', season='2023')

Last validated n/a.