Skip to main content
Version: 0.1.5

MLB — additional Python functions — MLB Stats API

mlb_attendance​

mlb_attendance(team_id: 'Optional[int]' = None, league_id: 'Optional[Union[int, str]]' = None, season: 'Optional[Union[int, str]]' = None, league_list_id: 'Optional[str]' = None, game_type: 'Optional[str]' = None, **kwargs) -> 'Dict'

GET /api/v1/attendance — game attendance figures.

Parameters

ParameterTypeDefaultDescription
team_idOptional[int]None
league_idOptional[Union[int, str]]None
seasonOptional[Union[int, str]]None
league_list_idOptional[str]None
game_typeOptional[str]None

Returns

The StatsAPI JSON body for this endpoint, unparsed (no committed capture pins its keys yet; inspect .keys()).

mlb_divisions​

mlb_divisions(sport_id: 'int' = 1, league_id: 'Optional[Union[int, str]]' = None, division_id: 'Optional[int]' = None, **kwargs) -> 'Dict'

GET /api/v1/divisions — list divisions.

Parameters

ParameterTypeDefaultDescription
sport_idint1
league_idOptional[Union[int, str]]None
division_idOptional[int]None

Returns

The StatsAPI JSON body, unparsed: copyright and divisions (one dict per division).

mlb_draft_prospects​

mlb_draft_prospects(year: 'Union[int, str]', scouting_report: 'Optional[bool]' = None, limit: 'int' = 100, **kwargs) -> 'Dict'

GET /api/v1/draft/prospects/{year} — draft prospect list for a year.

Parameters

ParameterTypeDefaultDescription
yearUnion[int, str]
scouting_reportOptional[bool]None
limitint100

Returns

The StatsAPI JSON body for this endpoint, unparsed (no committed capture pins its keys yet; inspect .keys()).

mlb_pbp_diff​

mlb_pbp_diff(game_pk: 'int', start_timecode: 'str', end_timecode: 'Optional[str]' = None, **kwargs) -> 'Dict'

GET /api/v1/game/{gamePk}/feed/live/diffPatch — JSON-patch diff of the live feed.

Replays of in-game state for low-bandwidth clients.

Parameters

ParameterTypeDefaultDescription
game_pkint
start_timecodestr
end_timecodeOptional[str]None

Returns

dict | list: The parsed JSON body of the diff, unparsed (no committed capture pins its shape yet).

mlb_pbp_live​

mlb_pbp_live(game_pk: 'int', language: 'Optional[str]' = None, timecode: 'Optional[str]' = None, hydrate: 'Optional[str]' = None, fields: 'Optional[str]' = None, **kwargs) -> 'Dict'

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

Top-level keys: copyright, gamePk, link, metaData, gameData, liveData. Includes Statcast metrics where available. The historical name mlb_pbp is preserved as an alias in the generated module.

Parameters

ParameterTypeDefaultDescription
game_pkint
languageOptional[str]None
timecodeOptional[str]None
hydrateOptional[str]None
fieldsOptional[str]None

Returns

The StatsAPI JSON body, unparsed: copyright, gamePk, link, metaData, gameData (teams, players, venue, status) and liveData (plays, linescore, boxscore).

mlb_person_stats​

mlb_person_stats(person_id: 'int', stats: 'str', group: 'str' = 'hitting', season: 'Optional[Union[int, str]]' = None, season_type: 'Optional[str]' = None, sport_ids: 'Optional[Union[int, List[int]]]' = None, game_type: 'Optional[str]' = None, fields: 'Optional[str]' = None, **kwargs) -> 'Dict'

GET /api/v1/people/{personId}/stats — player aggregate stats.

stats: season, career, yearByYear, vsTeam, vsPlayer, byMonth, byDayOfWeek, homeAndAway, gameLog, lastXGames, …

Parameters

ParameterTypeDefaultDescription
person_idint
statsstr
groupstr'hitting'
seasonOptional[Union[int, str]]None
season_typeOptional[str]None
sport_idsOptional[Union[int, List[int]]]None
game_typeOptional[str]None
fieldsOptional[str]None

Returns

The StatsAPI JSON body, unparsed: copyright and stats -- one dict per requested stat type with type, group and splits.

mlb_schedule​

mlb_schedule(date: 'Optional[str]' = None, start_date: 'Optional[str]' = None, end_date: 'Optional[str]' = None, team_id: 'Optional[int]' = None, opponent_id: 'Optional[int]' = None, season: 'Optional[Union[int, str]]' = None, sport_id: 'int' = 1, game_type: 'Optional[str]' = None, league_id: 'Optional[Union[int, str]]' = None, hydrate: 'Optional[str]' = None, fields: 'Optional[str]' = None, **kwargs) -> 'Dict'

GET /api/v1/schedule — schedule of games for a date, range, team, or season.

Response: dates[].games[].

Parameters

ParameterTypeDefaultDescription
dateOptional[str]None
start_dateOptional[str]None
end_dateOptional[str]None
team_idOptional[int]None
opponent_idOptional[int]None
seasonOptional[Union[int, str]]None
sport_idint1
game_typeOptional[str]None
league_idOptional[Union[int, str]]None
hydrateOptional[str]None
fieldsOptional[str]None

Returns

The StatsAPI JSON body, unparsed: copyright, the totalItems / totalGames / totalGamesInProgress counts and dates -- one dict per date, each with its own counts and a games list.

mlb_seasons​

mlb_seasons(sport_id: 'int' = 1, season: 'Optional[Union[int, str]]' = None, all_seasons: 'bool' = False, **kwargs) -> 'Dict'

GET /api/v1/seasons — list of seasons for a sport.

Parameters

ParameterTypeDefaultDescription
sport_idint1
seasonOptional[Union[int, str]]None
all_seasonsboolFalse

Returns

The StatsAPI JSON body, unparsed: copyright and seasons (one dict per season with its key dates).

mlb_standings​

mlb_standings(league_id: 'Union[int, str, List[int]]' = '103,104', season: 'Optional[Union[int, str]]' = None, date: 'Optional[str]' = None, standings_types: 'Optional[str]' = None, hydrate: 'Optional[str]' = None, fields: 'Optional[str]' = None, **kwargs) -> 'Dict'

GET /api/v1/standings — league standings.

league_id: 103 AL, 104 NL (comma-separated for both, the default). standings_types e.g. regularSeason, wildCard, divisionLeaders.

Parameters

ParameterTypeDefaultDescription
league_idUnion[int, str, List[int]]'103,104'
seasonOptional[Union[int, str]]None
dateOptional[str]None
standings_typesOptional[str]None
hydrateOptional[str]None
fieldsOptional[str]None

Returns

The StatsAPI JSON body, unparsed: copyright and records -- one dict per division standings table (standingsType, league, division, lastUpdated and teamRecords).

mlb_stats​

mlb_stats(stats: 'str', group: 'str', season: 'Optional[Union[int, str]]' = None, sport_id: 'int' = 1, league_id: 'Optional[Union[int, str]]' = None, team_id: 'Optional[int]' = None, player_pool: 'Optional[str]' = None, game_type: 'Optional[str]' = None, limit: 'int' = 50, offset: 'int' = 0, fields: 'Optional[str]' = None, **kwargs) -> 'Dict'

GET /api/v1/stats — generic stats query.

stats selects the slice (season, career, yearByYear, …) and group selects the stat group (hitting, pitching, fielding). Filters: season, team_id, league_id, game_type, player_pool.

Parameters

ParameterTypeDefaultDescription
statsstr
groupstr
seasonOptional[Union[int, str]]None
sport_idint1
league_idOptional[Union[int, str]]None
team_idOptional[int]None
player_poolOptional[str]None
game_typeOptional[str]None
limitint50
offsetint0
fieldsOptional[str]None

Returns

The StatsAPI JSON body for this endpoint, unparsed (no committed capture pins its keys yet; inspect .keys()).

mlb_stats_leaders​

mlb_stats_leaders(leader_categories: 'str', season: 'Optional[Union[int, str]]' = None, leader_game_types: 'Optional[str]' = None, stat_group: 'Optional[str]' = None, league_id: 'Optional[Union[int, str]]' = None, sport_id: 'int' = 1, limit: 'int' = 10, **kwargs) -> 'Dict'

GET /api/v1/stats/leaders — top-N leaders for a stat category.

Parameters

ParameterTypeDefaultDescription
leader_categoriesstr
seasonOptional[Union[int, str]]None
leader_game_typesOptional[str]None
stat_groupOptional[str]None
league_idOptional[Union[int, str]]None
sport_idint1
limitint10

Returns

The StatsAPI JSON body for this endpoint, unparsed (no committed capture pins its keys yet; inspect .keys()).

mlb_stats_streaks​

mlb_stats_streaks(streak_type: 'str', streak_threshold: 'int' = 1, season: 'Optional[Union[int, str]]' = None, stat_group: 'Optional[str]' = None, active_streak: 'Optional[bool]' = None, sport_id: 'int' = 1, **kwargs) -> 'Dict'

GET /api/v1/stats/streaks — active or historical streaks.

streak_type e.g. hittingStreakOverall, onBaseOverall.

Parameters

ParameterTypeDefaultDescription
streak_typestr
streak_thresholdint1
seasonOptional[Union[int, str]]None
stat_groupOptional[str]None
active_streakOptional[bool]None
sport_idint1

Returns

The StatsAPI JSON body for this endpoint, unparsed (no committed capture pins its keys yet; inspect .keys()).

mlb_team_leaders​

mlb_team_leaders(team_id: 'int', leader_categories: 'str', season: 'Optional[Union[int, str]]' = None, leader_game_types: 'Optional[str]' = None, limit: 'int' = 10, **kwargs) -> 'Dict'

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

leader_categories e.g. homeRuns, battingAverage, wins, earnedRunAverage (comma-separated for multi).

Parameters

ParameterTypeDefaultDescription
team_idint
leader_categoriesstr
seasonOptional[Union[int, str]]None
leader_game_typesOptional[str]None
limitint10

Returns

The StatsAPI JSON body for this endpoint, unparsed (no committed capture pins its keys yet; inspect .keys()).

mlb_team_stats​

mlb_team_stats(team_id: 'int', season: 'Union[int, str]', stats: 'str' = 'season', group: 'str' = 'hitting', sport_ids: 'Optional[Union[int, List[int]]]' = None, game_type: 'Optional[str]' = None, fields: 'Optional[str]' = None, **kwargs) -> 'Dict'

GET /api/v1/teams/{teamId}/stats — team-level stats.

stats: season, career, yearByYear, byMonth, byDayOfWeek, … group: hitting, pitching, fielding.

Parameters

ParameterTypeDefaultDescription
team_idint
seasonUnion[int, str]
statsstr'season'
groupstr'hitting'
sport_idsOptional[Union[int, List[int]]]None
game_typeOptional[str]None
fieldsOptional[str]None

Returns

The StatsAPI JSON body for this endpoint, unparsed (no committed capture pins its keys yet; inspect .keys()).

mlb_teams​

mlb_teams(season: 'Optional[Union[int, str]]' = None, sport_id: 'int' = 1, league_ids: 'Optional[Union[int, List[int], str]]' = None, active_status: 'Optional[str]' = None, all_star_statuses: 'Optional[str]' = None, hydrate: 'Optional[str]' = None, fields: 'Optional[str]' = None, **kwargs) -> 'Dict'

GET /api/v1/teams — list teams. sport_id=1 = MLB.

Parameters

ParameterTypeDefaultDescription
seasonOptional[Union[int, str]]None
sport_idint1
league_idsOptional[Union[int, List[int], str]]None
active_statusOptional[str]None
all_star_statusesOptional[str]None
hydrateOptional[str]None
fieldsOptional[str]None

Returns

The StatsAPI JSON body, unparsed: copyright and teams (one dict per team).