diff --git a/statsapi/index.html b/statsapi/index.html new file mode 100644 index 0000000..715e079 --- /dev/null +++ b/statsapi/index.html @@ -0,0 +1,8365 @@ + + + + Stats API Documentation + + + +

Stats API Documentation

+
Official API for Major League Baseball.
+
More information: https://openapi-generator.tech
+
Contact Info: team@openapitools.org
+
Version: 2.0.0
+
BasePath:
+
All rights reserved
+
http://apache.org/licenses/LICENSE-2.0.html
+

Access

+ +

Methods

+ [ Jump to Models ] + +

Table of Contents

+
+

Analytics

+ +

Attendance

+ +

Awards

+ +

BatTracking

+ +

Biomechanics

+ +

Broadcast

+ +

Conference

+ +

Division

+ +

Draft

+ +

Game

+ +

GamePace

+ +

HighLow

+ +

HomerunDerby

+ +

Job

+ +

League

+ +

Milestones

+ +

Misc

+ +

Person

+ +

Predictions

+ +

Reviews

+ +

Schedule

+ +

Season

+ +

Skeletal

+ +

Sports

+ +

Standings

+ +

Stats

+ +

Streaks

+ +

Teams

+ +

Transactions

+ +

Uniforms

+ +

Venues

+ +

Weather

+ + +

Analytics

+
+
+ Up +
get /api/v1/game/{gamePk}/{guid}/contextMetrics
+
Get context metrics for a specific gamePk. (contextMetrics)
+
Returns a json file containing raw coordinate data and refined calculated metrics.

This responses can be very large, so it is strongly recommended that you pass "Accept-Encoding: gzip" as a header to have the responses compressed.
+ +

Path parameters

+
+
gamePk (required)
+ +
Path Parameter — Unique Primary Key Representing a Game default: null
guid (required)
+ +
Path Parameter — Unique identifier for a play within a game default: null
+
+ + + + +

Query parameters

+
+
fields (optional)
+ +
Query Parameter — Comma delimited list of specific fields to be returned. Format: topLevelNode, childNode, attribute default: null
+
+ + + + + + + +

Responses

+

200

+ OK + +
+
+
+
+ Up +
get /api/v1/game/{gamePk}/{guid}/contextMetricsAverages
+
Get a json file containing raw coordinate data and refined calculated metrics. (contextMetricsWithAverages)
+
Returns a json file containing raw coordinate data and refined calculated metrics.

This responses can be very large, so it is strongly recommended that you pass "Accept-Encoding: gzip" as a header to have the responses compressed.
+ +

Path parameters

+
+
gamePk (required)
+ +
Path Parameter — Unique Primary Key Representing a Game default: null
guid (required)
+ +
Path Parameter — Unique identifier for a play within a game default: null
+
+ + + + +

Query parameters

+
+
fields (optional)
+ +
Query Parameter — Comma delimited list of specific fields to be returned. Format: topLevelNode, childNode, attribute default: null
+
+ + + + + + + +

Responses

+

200

+ OK + +
+
+
+
+ Up +
post /api/v1/game/{gamePk}/{guid}/contextMetricsAverages
+
Get a json file containing raw coordinate data and refined calculated metrics. (contextMetricsWithAveragesPost)
+
Returns a json file containing raw coordinate data and refined calculated metrics.

This responses can be very large, so it is strongly recommended that you pass "Accept-Encoding: gzip" as a header to have the responses compressed.
+ +

Path parameters

+
+
gamePk (required)
+ +
Path Parameter — Unique Primary Key Representing a Game default: null
guid (required)
+ +
Path Parameter — Unique identifier for a play within a game default: null
+
+ + + + +

Query parameters

+
+
fields (optional)
+ +
Query Parameter — Comma delimited list of specific fields to be returned. Format: topLevelNode, childNode, attribute default: null
+
+ + + + + + + +

Responses

+

200

+ OK + +
+
+
+
+ Up +
get /api/v1/game/{gamePk}/guids
+
Get the GUIDs (plays) for a specific game. (gameGuids)
+
+ +

Path parameters

+
+
gamePk (required)
+ +
Path Parameter — Unique Primary Key Representing a Game default: null
+
+ + + + +

Query parameters

+
+
fields (optional)
+ +
Query Parameter — Comma delimited list of specific fields to be returned. Format: topLevelNode, childNode, attribute default: null
gameModeId (optional)
+ +
Query Parameter — Statcast game mode. Format: 0 = Batting Practive, 1 = Warmup 2 = Live default: null
isPitch (optional)
+ +
Query Parameter — If there was a pitch default: null
isHit (optional)
+ +
Query Parameter — If there was a hit ball tracked default: null
isPickoff (optional)
+ +
Query Parameter — If there was a pickoff default: null
hasUpdates (optional)
+ +
Query Parameter — True if updated by an auditor default: null
since (optional)
+ +
Query Parameter — Returns all data that was created after the specified timestamp. Format: YYYY-MM-DDTHH:MM:SSZ default: null
updatedSince (optional)
+ +
Query Parameter — Return data updated since a specified date. Format: YYYY-MM-DDTHH:MM:SSZ default: null
lastPlayTime (optional)
+ +
Query Parameter — Returns all data that was created after the specified timestamp. Format: YYYY-MM-DDTHH:MM:SSZ default: null
lastUpdatedTime (optional)
+ +
Query Parameter — Return data updated since a specified date. Format: YYYY-MM-DDTHH:MM:SSZ default: null
lastMetricsUpdatedTime (optional)
+ +
Query Parameter — Return data updated since a specified date. Format: YYYY-MM-DDTHH:MM:SSZ default: null
lastAuditUpdatedTime (optional)
+ +
Query Parameter — Return data updated since a specified date. Format: YYYY-MM-DDTHH:MM:SSZ default: null
lastVideoUpdatedTime (optional)
+ +
Query Parameter — The last time SportyBot video was updated default: null
+
+ + + + + + + +

Responses

+

200

+ OK + +
+
+
+
+ Up +
get /api/v1/analytics/guids
+
Get the GUIDs (plays) for a specific game. (gameGuidsFromPostgresRange)
+
+ + + + + +

Query parameters

+
+
fields (optional)
+ +
Query Parameter — Comma delimited list of specific fields to be returned. Format: topLevelNode, childNode, attribute default: null
gameModeId (optional)
+ +
Query Parameter — Statcast game mode. Format: 0 = Batting Practive, 1 = Warmup 2 = Live default: null
isPitch (optional)
+ +
Query Parameter — If there was a pitch default: null
isHit (optional)
+ +
Query Parameter — If there was a hit ball tracked default: null
isPickoff (optional)
+ +
Query Parameter — If there was a pickoff default: null
isNonStatcast (optional)
+ +
Query Parameter — If non statcast games need to be included default: null
gamedayType (optional)
+ +
Query Parameter — Indicates the level of Gameday (tracking, play-by-play, linescore, etc...) default: null
hasUpdates (optional)
+ +
Query Parameter — True if updated by an auditor default: null
lastPlayTime (optional)
+ +
Query Parameter — Returns all data that was created after the specified timestamp. Format: YYYY-MM-DDTHH:MM:SSZ default: null
lastUpdatedTime (optional)
+ +
Query Parameter — Return data updated since a specified date. Format: YYYY-MM-DDTHH:MM:SSZ default: null
lastMetricsUpdatedTime (optional)
+ +
Query Parameter — Return data updated since a specified date. Format: YYYY-MM-DDTHH:MM:SSZ default: null
lastAuditUpdatedTime (optional)
+ +
Query Parameter — Return data updated since a specified date. Format: YYYY-MM-DDTHH:MM:SSZ default: null
lastVideoUpdatedTime (optional)
+ +
Query Parameter — The last time SportyBot video was updated default: null
gameDate (optional)
+ +
Query Parameter — Date of Game. Format: YYYY-MM-DD default: null
sportId (optional)
+ +
Query Parameter — Top level organization of a sport default: null
gameType (optional)
+ +
Query Parameter — Type of Game. Available types in /api/v1/gameTypes default: null
trackingSystemOwner (optional)
+ +
Query Parameter — Owner of the tracking system default: null
season (optional)
+ +
Query Parameter — Season of play default: null
sortBy (optional)
+ +
Query Parameter — Sort the set of data by the specified field default: null
limit (optional)
+ +
Query Parameter — Number of results to return default: null
offset (optional)
+ +
Query Parameter — The pointer to start for a return set; used for pagination default: null
+
+ + + + + + + +

Responses

+

200

+ OK + +
+
+
+
+ Up +
get /api/v1/analytics/game
+
Get all games by updated date. (gameGuidsFromPostgresRangeByGame)
+
+ + + + + +

Query parameters

+
+
fields (optional)
+ +
Query Parameter — Comma delimited list of specific fields to be returned. Format: topLevelNode, childNode, attribute default: null
gameModeId (optional)
+ +
Query Parameter — Statcast game mode. Format: 0 = Batting Practive, 1 = Warmup 2 = Live default: null
isPitch (optional)
+ +
Query Parameter — If there was a pitch default: null
isHit (optional)
+ +
Query Parameter — If there was a hit ball tracked default: null
isPickoff (optional)
+ +
Query Parameter — If there was a pickoff default: null
isNonStatcast (optional)
+ +
Query Parameter — If non statcast games need to be included default: null
gamedayType (optional)
+ +
Query Parameter — Indicates the level of Gameday (tracking, play-by-play, linescore, etc...) default: null
hasUpdates (optional)
+ +
Query Parameter — True if updated by an auditor default: null
lastPlayTime (optional)
+ +
Query Parameter — Returns all data that was created after the specified timestamp. Format: YYYY-MM-DDTHH:MM:SSZ default: null
lastVideoUpdatedTime (optional)
+ +
Query Parameter — The last time SportyBot video was updated default: null
lastUpdatedTime (optional)
+ +
Query Parameter — Return data updated since a specified date. Format: YYYY-MM-DDTHH:MM:SSZ default: null
lastMetricsUpdatedTime (optional)
+ +
Query Parameter — Return data updated since a specified date. Format: YYYY-MM-DDTHH:MM:SSZ default: null
lastAuditUpdatedTime (optional)
+ +
Query Parameter — Return data updated since a specified date. Format: YYYY-MM-DDTHH:MM:SSZ default: null
gameDate (optional)
+ +
Query Parameter — Date of Game. Format: YYYY-MM-DD default: null
sportId (optional)
+ +
Query Parameter — Top level organization of a sport default: null
gameType (optional)
+ +
Query Parameter — Type of Game. Available types in /api/v1/gameTypes default: null
season (optional)
+ +
Query Parameter — Season of play default: null
trackingSystemOwner (optional)
+ +
Query Parameter — Owner of the tracking system default: null
sortBy (optional)
+ +
Query Parameter — Sort the set of data by the specified field default: null
limit (optional)
+ +
Query Parameter — Number of results to return default: null
offset (optional)
+ +
Query Parameter — The pointer to start for a return set; used for pagination default: null
scheduleEventTypes (optional)
+ +
Query Parameter — Comma delimited list of type of event types default: null
+
+ + + + + + + +

Responses

+

200

+ OK + +
+
+
+
+ Up +
get /api/v1/game/lastPitch
+
Get the last pitch for a list of games (gameLastPitch)
+
+ + + + + +

Query parameters

+
+
gamePks (required)
+ +
Query Parameter — Unique Primary Key Representing a Game default: null
fields (optional)
+ +
Query Parameter — Comma delimited list of specific fields to be returned. Format: topLevelNode, childNode, attribute default: null
+
+ + + + + + + +

Responses

+

200

+ OK + +
+
+
+
+ Up +
get /api/v1/game/{gamePk}/{guid}/homeRunBallparks
+
Get if the play is a home run is each park for a specific play. (homeRunBallparks)
+
Returns a json file containing raw coordinate data and refined calculated metrics.

This responses can be very large, so it is strongly recommended that you pass "Accept-Encoding: gzip" as a header to have the responses compressed.
+ +

Path parameters

+
+
gamePk (required)
+ +
Path Parameter — Unique Primary Key Representing a Game default: null
guid (required)
+ +
Path Parameter — Unique identifier for a play within a game default: null
+
+ + + + +

Query parameters

+
+
isHomeRunParks (required)
+ +
Query Parameter — default: null
fields (optional)
+ +
Query Parameter — Comma delimited list of specific fields to be returned. Format: topLevelNode, childNode, attribute default: null
+
+ + + + + + + +

Responses

+

200

+ OK + +
+
+
+
+ Up +
get /api/v1/game/{gamePk}/{guid}/analytics
+
Get Statcast data for a specific play. (parsedJsonFormattedAnalytics)
+
Returns a json file containing raw coordinate data and refined calculated metrics.

This responses can be very large, so it is strongly recommended that you pass "Accept-Encoding: gzip" as a header to have the responses compressed.
+ +

Path parameters

+
+
gamePk (required)
+ +
Path Parameter — Unique Primary Key Representing a Game default: null
guid (required)
+ +
Path Parameter — Unique identifier for a play within a game default: null
+
+ + + + +

Query parameters

+
+
fields (optional)
+ +
Query Parameter — Comma delimited list of specific fields to be returned. Format: topLevelNode, childNode, attribute default: null
+
+ + + + + + + +

Responses

+

200

+ OK + +
+
+

Attendance

+
+
+ Up +
get /api/v1/attendance
+
Get team attendance (getTeamAttendance)
+
+ + + + + +

Query parameters

+
+
teamId (optional)
+ +
Query Parameter — Unique Team Identifier. Format: 141, 147, etc default: null
leagueId (optional)
+ +
Query Parameter — Comma delimited list of Unique league identifiers default: null
season (optional)
+ +
Query Parameter — Comma delimited list of Seasons of play default: null
leagueListId (optional)
+ +
Query Parameter — Unique League List Identifier default: null
gameType (optional)
+ +
Query Parameter — Type of Game. Available types in /api/v1/gameTypes default: null
date (optional)
+ +
Query Parameter — Date of Game. Format: YYYY-MM-DD default: null
startDate (optional)
+ +
Query Parameter — Start date for range of data (must be used with end date). Format: MM/DD/YYYY default: null
endDate (optional)
+ +
Query Parameter — End date for range of data (must be used with start date). Format: MM/DD/YYYY default: null
fields (optional)
+ +
Query Parameter — Comma delimited list of specific fields to be returned. Format: topLevelNode, childNode, attribute default: null
+
+ + + + + + + +

Responses

+

200

+ OK + +
+
+

Awards

+
+
+ Up +
get /api/v1/awards/{awardId}/recipients
+
View recipients of an award (awardRecipients)
+
+ +

Path parameters

+
+
awardId (required)
+ +
Path Parameter — Unique Award Identifier. Available awards in /api/v1/awards default: null
+
+ + + + +

Query parameters

+
+
season (optional)
+ +
Query Parameter — Season of play default: null
sportId (optional)
+ +
Query Parameter — Top level organization of a sport default: null
leagueId (optional)
+ +
Query Parameter — Comma delimited list of Unique league identifiers default: null
fields (optional)
+ +
Query Parameter — default: null
+
+ + + + + + + +

Responses

+

200

+ OK + +
+
+
+
+ Up +
get /api/v1/awards
+
View awards info (awards)
+
+ +

Path parameters

+
+
awardId (required)
+ +
Path Parameter — Unique Award Identifier. Available awards in /api/v1/awards default: null
+
+ + + + +

Query parameters

+
+
orgId (optional)
+ +
Query Parameter — Comma delimited list of top level organizations of a sport default: null
fields (optional)
+ +
Query Parameter — Comma delimited list of specific fields to be returned. Format: topLevelNode, childNode, attribute default: null
+
+ + + + + + + +

Responses

+

200

+ OK + +
+
+
+
+ Up +
get /api/v1/awards/{awardId}
+
View awards info (awards1)
+
+ +

Path parameters

+
+
awardId (required)
+ +
Path Parameter — Unique Award Identifier. Available awards in /api/v1/awards default: null
+
+ + + + +

Query parameters

+
+
orgId (optional)
+ +
Query Parameter — Comma delimited list of top level organizations of a sport default: null
fields (optional)
+ +
Query Parameter — Comma delimited list of specific fields to be returned. Format: topLevelNode, childNode, attribute default: null
+
+ + + + + + + +

Responses

+

200

+ OK + +
+
+

BatTracking

+
+
+ Up +
get /api/v1/batTracking/game/{gamePk}/{playId}
+
View Bat Tracking Data by playId and gameId (batTracking)
+
This endpoint allows you to pull bat tracking data by gameId and playId
+ +

Path parameters

+
+
gamePk (required)
+ +
Path Parameter — Unique Primary Key Representing a Game default: null
playId (required)
+ +
Path Parameter — Unique play identifier default: null
+
+ + + + +

Query parameters

+
+
fields (optional)
+ +
Query Parameter — Comma delimited list of specific fields to be returned. Format: topLevelNode, childNode, attribute default: null
+
+ + + + + + + +

Responses

+

200

+ OK + +
+
+

Biomechanics

+
+
+ Up +
get /api/v1/game/{gamePk}/{playId}/analytics/biomechanics/{positionId}
+
View Biomechanical data by playId and gameId filtered by player positionId (biomechanical)
+
This endpoint allows you to pull biomechanical tracking data by gameId and playId filtered by player positionId
+ +

Path parameters

+
+
gamePk (required)
+ +
Path Parameter — Unique Primary Key Representing a Game default: null
playId (required)
+ +
Path Parameter — Unique play identifier default: null
positionId (required)
+ +
Path Parameter — Position number. Format: 1, 2, 3, etc default: null
+
+ + + + +

Query parameters

+
+
fields (optional)
+ +
Query Parameter — Comma delimited list of specific fields to be returned. Format: topLevelNode, childNode, attribute default: null
+
+ + + + + + + +

Responses

+

200

+ OK + +
+
+

Broadcast

+
+
+ Up +
get /api/v1/broadcasters
+
Get All Active Broadcasters (getAllBroadcasters)
+
+ + + + + +

Query parameters

+
+
activeStatus (optional)
+ +
Query Parameter — Current status of the broadcaster. Format: Active = y, inactive = n, both = b default: null
fields (optional)
+ +
Query Parameter — Comma delimited list of specific fields to be returned. Format: topLevelNode, childNode, attribute default: null
+
+ + + + + + + +

Responses

+

200

+ OK + +
+
+
+
+ Up +
get /api/v1/broadcast
+
Get Broadcasters (getBroadcasts)
+
+ + + + + +

Query parameters

+
+
broadcasterIds (required)
+ +
Query Parameter — All of the broadcast details default: null
fields (optional)
+ +
Query Parameter — Comma delimited list of specific fields to be returned. Format: topLevelNode, childNode, attribute default: null
+
+ + + + + + + +

Responses

+

200

+ OK + +
+
+

Conference

+
+
+ Up +
get /api/v1/conferences
+
View conference info (conferences)
+
+ +

Path parameters

+
+
conferenceId (required)
+ +
Path Parameter — default: null
+
+ + + + +

Query parameters

+
+
season (optional)
+ +
Query Parameter — Season of play default: null
includeInactive (optional)
+ +
Query Parameter — default: null
fields (optional)
+ +
Query Parameter — Comma delimited list of specific fields to be returned. Format: topLevelNode, childNode, attribute default: null
+
+ + + + + + + +

Responses

+

200

+ OK + +
+
+
+
+ Up +
get /api/v1/conferences/{conferenceId}
+
View conference info (conferences1)
+
+ +

Path parameters

+
+
conferenceId (required)
+ +
Path Parameter — default: null
+
+ + + + +

Query parameters

+
+
season (optional)
+ +
Query Parameter — Season of play default: null
includeInactive (optional)
+ +
Query Parameter — default: null
fields (optional)
+ +
Query Parameter — Comma delimited list of specific fields to be returned. Format: topLevelNode, childNode, attribute default: null
+
+ + + + + + + +

Responses

+

200

+ OK + +
+
+

Division

+
+
+ Up +
get /api/v1/divisions
+
Get division information (divisions)
+
This endpoint allows you to pull divisions
+ +

Path parameters

+
+
divisionId (required)
+ +
Path Parameter — Unique Division Identifier default: null
+
+ + + + +

Query parameters

+
+
includeInactive (optional)
+ +
Query Parameter — Whether or not to include inactive default: null
leagueId (optional)
+ +
Query Parameter — Unique League Identifier default: null
sportId (optional)
+ +
Query Parameter — Top level organization of a sport default: null
season (optional)
+ +
Query Parameter — Season of play default: null
fields (optional)
+ +
Query Parameter — Comma delimited list of specific fields to be returned. Format: topLevelNode, childNode, attribute default: null
+
+ + + + + + + +

Responses

+

200

+ OK + +
+
+
+
+ Up +
get /api/v1/divisions/{divisionId}
+
Get division information (divisions1)
+
This endpoint allows you to pull divisions
+ +

Path parameters

+
+
divisionId (required)
+ +
Path Parameter — Unique Division Identifier default: null
+
+ + + + +

Query parameters

+
+
includeInactive (optional)
+ +
Query Parameter — Whether or not to include inactive default: null
leagueId (optional)
+ +
Query Parameter — Unique League Identifier default: null
sportId (optional)
+ +
Query Parameter — Top level organization of a sport default: null
season (optional)
+ +
Query Parameter — Season of play default: null
fields (optional)
+ +
Query Parameter — Comma delimited list of specific fields to be returned. Format: topLevelNode, childNode, attribute default: null
+
+ + + + + + + +

Responses

+

200

+ OK + +
+
+

Draft

+
+
+ Up +
get /api/v1/draft
+
View MLB Drafted Players (draftPicks)
+
+ +

Path parameters

+
+
year (required)
+ +
Path Parameter — Year the player was drafted. Format: 2000 default: null
+
+ + + + +

Query parameters

+
+
limit (optional)
+ +
Query Parameter — Number of results to return default: null
offset (optional)
+ +
Query Parameter — The pointer to start for a return set; used for pagination default: null
fields (optional)
+ +
Query Parameter — Comma delimited list of specific fields to be returned. Format: topLevelNode, childNode, attribute default: null
order (optional)
+ +
Query Parameter — The order of sorting, ascending or descending default: null
sortBy (optional)
+ +
Query Parameter — Sort the set of data by the specified field default: null
drafted (optional)
+ +
Query Parameter — Whether or not the players been drafted default: null
round (optional)
+ +
Query Parameter — Round in which a player was drafted default: null
name (optional)
+ +
Query Parameter — Filter players by the first letter of their name using using the specific character default: null
school (optional)
+ +
Query Parameter — Filter players by the first letter of their school using using the specific character default: null
position (optional)
+ +
Query Parameter — Position number. Format: 1, 2, 3, etc default: null
team (optional)
+ +
Query Parameter — Unique Team Code. Format: tor, nya, etc default: null
teamId (optional)
+ +
Query Parameter — Unique Team Identifier. Format: 141, 147, etc default: null
state (optional)
+ +
Query Parameter — State where the venue is located. Format: Ohio default: null
country (optional)
+ +
Query Parameter — Filter players by their home country default: null
playerId (optional)
+ +
Query Parameter — A unique identifier for a player default: null
bisPlayerId (optional)
+ +
Query Parameter — A unique identifier for a player in the EBIS system default: null
+
+ + + + + + + +

Responses

+

200

+ OK + +
+
+
+
+ Up +
get /api/v1/draft/{year}
+
View MLB Drafted Players (draftPicks1)
+
+ +

Path parameters

+
+
year (required)
+ +
Path Parameter — Year the player was drafted. Format: 2000 default: null
+
+ + + + +

Query parameters

+
+
limit (optional)
+ +
Query Parameter — Number of results to return default: null
offset (optional)
+ +
Query Parameter — The pointer to start for a return set; used for pagination default: null
fields (optional)
+ +
Query Parameter — Comma delimited list of specific fields to be returned. Format: topLevelNode, childNode, attribute default: null
order (optional)
+ +
Query Parameter — The order of sorting, ascending or descending default: null
sortBy (optional)
+ +
Query Parameter — Sort the set of data by the specified field default: null
drafted (optional)
+ +
Query Parameter — Whether or not the players been drafted default: null
round (optional)
+ +
Query Parameter — Round in which a player was drafted default: null
name (optional)
+ +
Query Parameter — Filter players by the first letter of their name using using the specific character default: null
school (optional)
+ +
Query Parameter — Filter players by the first letter of their school using using the specific character default: null
position (optional)
+ +
Query Parameter — Position number. Format: 1, 2, 3, etc default: null
team (optional)
+ +
Query Parameter — Unique Team Code. Format: tor, nya, etc default: null
teamId (optional)
+ +
Query Parameter — Unique Team Identifier. Format: 141, 147, etc default: null
state (optional)
+ +
Query Parameter — State where the venue is located. Format: Ohio default: null
country (optional)
+ +
Query Parameter — Filter players by their home country default: null
playerId (optional)
+ +
Query Parameter — A unique identifier for a player default: null
bisPlayerId (optional)
+ +
Query Parameter — A unique identifier for a player in the EBIS system default: null
+
+ + + + + + + +

Responses

+

200

+ OK + +
+
+
+
+ Up +
get /api/v1/draft/prospects
+
View MLB Draft Prospects (draftProspects)
+
+ +

Path parameters

+
+
year (required)
+ +
Path Parameter — Year the player was drafted. Format: 2000 default: null
+
+ + + + +

Query parameters

+
+
limit (optional)
+ +
Query Parameter — Number of results to return default: null
offset (optional)
+ +
Query Parameter — The pointer to start for a return set; used for pagination default: null
fields (optional)
+ +
Query Parameter — Comma delimited list of specific fields to be returned. Format: topLevelNode, childNode, attribute default: null
order (optional)
+ +
Query Parameter — The order of sorting, ascending or descending default: null
sortBy (optional)
+ +
Query Parameter — Sort the set of data by the specified field default: null
drafted (optional)
+ +
Query Parameter — Whether or not the players been drafted default: null
round (optional)
+ +
Query Parameter — Round in which a player was drafted default: null
name (optional)
+ +
Query Parameter — Filter players by the first letter of their name using using the specific character default: null
school (optional)
+ +
Query Parameter — Filter players by the first letter of their school using using the specific character default: null
position (optional)
+ +
Query Parameter — Position number. Format: 1, 2, 3, etc default: null
team (optional)
+ +
Query Parameter — Unique Team Code. Format: tor, nya, etc default: null
teamId (optional)
+ +
Query Parameter — Unique Team Identifier. Format: 141, 147, etc default: null
state (optional)
+ +
Query Parameter — State where the venue is located. Format: Ohio default: null
country (optional)
+ +
Query Parameter — Filter players by their home country default: null
playerId (optional)
+ +
Query Parameter — A unique identifier for a player default: null
bisPlayerId (optional)
+ +
Query Parameter — A unique identifier for a player in the EBIS system default: null
+
+ + + + + + + +

Responses

+

200

+ OK + +
+
+
+
+ Up +
get /api/v1/draft/prospects/{year}
+
View MLB Draft Prospects (draftProspects1)
+
+ +

Path parameters

+
+
year (required)
+ +
Path Parameter — Year the player was drafted. Format: 2000 default: null
+
+ + + + +

Query parameters

+
+
limit (optional)
+ +
Query Parameter — Number of results to return default: null
offset (optional)
+ +
Query Parameter — The pointer to start for a return set; used for pagination default: null
fields (optional)
+ +
Query Parameter — Comma delimited list of specific fields to be returned. Format: topLevelNode, childNode, attribute default: null
order (optional)
+ +
Query Parameter — The order of sorting, ascending or descending default: null
sortBy (optional)
+ +
Query Parameter — Sort the set of data by the specified field default: null
drafted (optional)
+ +
Query Parameter — Whether or not the players been drafted default: null
round (optional)
+ +
Query Parameter — Round in which a player was drafted default: null
name (optional)
+ +
Query Parameter — Filter players by the first letter of their name using using the specific character default: null
school (optional)
+ +
Query Parameter — Filter players by the first letter of their school using using the specific character default: null
position (optional)
+ +
Query Parameter — Position number. Format: 1, 2, 3, etc default: null
team (optional)
+ +
Query Parameter — Unique Team Code. Format: tor, nya, etc default: null
teamId (optional)
+ +
Query Parameter — Unique Team Identifier. Format: 141, 147, etc default: null
state (optional)
+ +
Query Parameter — State where the venue is located. Format: Ohio default: null
country (optional)
+ +
Query Parameter — Filter players by their home country default: null
playerId (optional)
+ +
Query Parameter — A unique identifier for a player default: null
bisPlayerId (optional)
+ +
Query Parameter — A unique identifier for a player in the EBIS system default: null
+
+ + + + + + + +

Responses

+

200

+ OK + +
+
+
+
+ Up +
get /api/v1/draft/{year}/latest
+
Get the last drafted player and the next 5 teams up to pick (latestDraftPicks)
+
+ +

Path parameters

+
+
year (required)
+ +
Path Parameter — Year the player was drafted. Format: 2000 default: null
+
+ + + + +

Query parameters

+
+
fields (optional)
+ +
Query Parameter — Comma delimited list of specific fields to be returned. Format: topLevelNode, childNode, attribute default: null
+
+ + + + + + + +

Responses

+

200

+ OK + +
+
+

Game

+
+
+ Up +
get /api/v1/game/{game_pk}/boxscore
+
Get game boxscore. (boxscore)
+
This endpoint allows you to pull a boxscore
+ +

Path parameters

+
+
game_pk (required)
+ +
Path Parameter — Unique Primary Key Representing a Game default: null
+
+ + + + +

Query parameters

+
+
timecode (optional)
+ +
Query Parameter — Use this parameter to return a snapshot of the data at the specified time. Format: YYYYMMDD_HHMMSS default: null
fields (optional)
+ +
Query Parameter — Comma delimited list of specific fields to be returned. Format: topLevelNode, childNode, attribute default: null
inclusiveTimecode (optional)
+ +
Query Parameter — True to include plays that happen before or at the specified timecode default: null
numPlayers (optional)
+ +
Query Parameter — Number of top player game scores to show. Default is 3. default: null
noTies (optional)
+ +
Query Parameter — If set to false, will show all players tied for the last spot in the game scores list. default: null
accent (optional)
+ +
Query Parameter — Boolean value to specify wanting a person's name with accents or without default: null
+
+ + + + + + + +

Responses

+

200

+ OK + +
+
+
+
+ Up +
get /api/v1/game/{game_pk}/feed/color
+
Get game color feed. (colorFeed)
+
This API can return very large payloads. It is STRONGLY recommended that clients ask for diffs and use "Accept-Encoding: gzip" header.
+ +

Path parameters

+
+
game_pk (required)
+ +
Path Parameter — Unique Primary Key Representing a Game default: null
+
+ + + + +

Query parameters

+
+
timecode (optional)
+ +
Query Parameter — Use this parameter to return a snapshot of the data at the specified time. Format: YYYYMMDD_HHMMSS default: null
fields (optional)
+ +
Query Parameter — Comma delimited list of specific fields to be returned. Format: topLevelNode, childNode, attribute default: null
+
+ + + + + + + +

Responses

+

200

+ OK + +
+
+
+
+ Up +
get /api/v1/game/{game_pk}/feed/color/timestamps
+
Retrieve all of the color timestamps for a game. (colorTimestamps)
+
This can be used for replaying games. Endpoint returns all of the timecodes that can be used with diffs for /v1/game/{game_pk}/feed/color
+ +

Path parameters

+
+
game_pk (required)
+ +
Path Parameter — Unique Primary Key Representing a Game default: null
+
+ + + + + + + + + + + +

Responses

+

200

+ OK + +
+
+
+
+ Up +
get /api/v1/game/{game_pk}/content
+
Retrieve all content for a game. (content)
+
+ +

Path parameters

+
+
game_pk (required)
+ +
Path Parameter — default: null
+
+ + + + +

Query parameters

+
+
highlightLimit (optional)
+ +
Query Parameter — Number of results to return default: null
+
+ + + + + + + +

Responses

+

200

+ OK + +
+
+
+
+ Up +
get /api/v1/game/changes
+
View a game change log (currentGameStats1)
+
+ + + + + +

Query parameters

+
+
updatedSince (optional)
+ +
Query Parameter — Format: YYYY-MM-DDTHH:MM:SSZ default: null
sportId (optional)
+ +
Query Parameter — Top level organization of a sport default: null
sportIds (optional)
+ +
Query Parameter — Comma delimited list of top level organizations of a sport default: null
gameType (optional)
+ +
Query Parameter — Type of Game. Available types in /api/v1/gameTypes default: null
gameTypes (optional)
+ +
Query Parameter — Comma delimited list of type of Game. Available types in /api/v1/gameTypes default: null
season (optional)
+ +
Query Parameter — Season of play default: null
gamePks (optional)
+ +
Query Parameter — Comma delimited list of unique primary keys default: null
limit (optional)
+ +
Query Parameter — Number of results to return default: null
offset (optional)
+ +
Query Parameter — The pointer to start for a return set; used for pagination default: null
fields (optional)
+ +
Query Parameter — Comma delimited list of specific fields to be returned. Format: topLevelNode, childNode, attribute default: null
+
+ + + + + + + +

Responses

+

200

+ OK + +
+
+
+
+ Up +
get /api/v1/game/{gamePk}/contextMetrics
+
Get the context metrics for this game based on its current state (getGameContextMetrics)
+
+ +

Path parameters

+
+
gamePk (required)
+ +
Path Parameter — Unique Primary Key Representing a Game default: null
+
+ + + + +

Query parameters

+
+
timecode (optional)
+ +
Query Parameter — Use this parameter to return a snapshot of the data at the specified time. Format: YYYYMMDD_HHMMSS default: null
fields (optional)
+ +
Query Parameter — Comma delimited list of specific fields to be returned. Format: topLevelNode, childNode, attribute default: null
+
+ + + + + + + +

Responses

+

200

+ OK + +
+
+
+
+ Up +
get /api/v1/game/{gamePk}/withMetrics
+
Get game info with metrics (getGameWithMetrics)
+
+ +

Path parameters

+
+
gamePk (required)
+ +
Path Parameter — Unique Primary Key Representing a Game default: null
+
+ + + + +

Query parameters

+
+
timecode (optional)
+ +
Query Parameter — Use this parameter to return a snapshot of the data at the specified time. Format: YYYYMMDD_HHMMSS default: null
inclusiveTimecode (optional)
+ +
Query Parameter — True to include plays that happen before or at the specified timecode default: null
fields (optional)
+ +
Query Parameter — Comma delimited list of specific fields to be returned. Format: topLevelNode, childNode, attribute default: null
accent (optional)
+ +
Query Parameter — Boolean value to specify wanting a person's name with accents or without default: null
+
+ + + + + + + +

Responses

+

200

+ OK + +
+
+
+
+ Up +
get /api/v1/game/{gamePk}/winProbability
+
Get the win probability for this game (getWinProbability)
+
+ +

Path parameters

+
+
gamePk (required)
+ +
Path Parameter — Unique Primary Key Representing a Game default: null
+
+ + + + +

Query parameters

+
+
timecode (optional)
+ +
Query Parameter — Use this parameter to return a snapshot of the data at the specified time. Format: YYYYMMDD_HHMMSS default: null
fields (optional)
+ +
Query Parameter — Comma delimited list of specific fields to be returned. Format: topLevelNode, childNode, attribute default: null
inclusiveTimecode (optional)
+ +
Query Parameter — True to include plays that happen before or at the specified timecode default: null
accent (optional)
+ +
Query Parameter — Boolean value to specify wanting a person's name with accents or without default: null
+
+ + + + + + + +

Responses

+

200

+ OK + +
+
+
+
+ Up +
get /api/v1/game/{game_pk}/linescore
+
Get game linescore (linescore)
+
This endpoint allows you to pull the linescore for a game
+ +

Path parameters

+
+
game_pk (required)
+ +
Path Parameter — Unique Primary Key Representing a Game default: null
+
+ + + + +

Query parameters

+
+
timecode (optional)
+ +
Query Parameter — Use this parameter to return a snapshot of the data at the specified time. Format: YYYYMMDD_HHMMSS default: null
fields (optional)
+ +
Query Parameter — Comma delimited list of specific fields to be returned. Format: topLevelNode, childNode, attribute default: null
inclusiveTimecode (optional)
+ +
Query Parameter — True to include plays that happen before or at the specified timecode default: null
+
+ + + + + + + +

Responses

+

200

+ OK + +
+
+
+
+ Up +
get /api/v1.1/game/{game_pk}/feed/live/diffPatch
+
Get live game status diffPatch. (liveGameDiffPatchV1)
+
This endpoint allows comparison of game files and shows any differences/discrepancies between the two

Diff/Patch System: startTimecode and endTimecode can be used for getting diffs.
Expected usage:
1) Request full payload by not passing startTimecode or endTimecode. This will return the most recent game state.
2) Find the latest timecode in this response.
3) Wait X seconds
4) Use the timecode from 2 as the startTimecode. This will give you a diff of everything that has happened since startTimecode.
5) If no data is returned, wait X seconds and do the same request.
6) If data is returned, get a new timeStamp from the response, and use that for the next call as startTimecode.
+ +

Path parameters

+
+
game_pk (required)
+ +
Path Parameter — Unique Primary Key Representing a Game default: null
+
+ + + + +

Query parameters

+
+
startTimecode (optional)
+ +
Query Parameter — Start time code will give you everything since that time. Format: MMDDYYYY_HHMMSS default: null
endTimecode (optional)
+ +
Query Parameter — End time code will give you a snapshot at that specific time. Format: MMDDYYYY_HHMMSS default: null
accent (optional)
+ +
Query Parameter — Boolean value to specify wanting a person's name with accents or without default: null
+
+ + + + + + + +

Responses

+

200

+ OK + +
+
+
+
+ Up +
get /api/v1.1/game/{game_pk}/feed/live
+
Get live game status. (liveGameV1)
+
This API can return very large payloads. It is STRONGLY recommended that clients ask for diffs and use "Accept-Encoding: gzip" header.
+ +

Path parameters

+
+
game_pk (required)
+ +
Path Parameter — Unique Primary Key Representing a Game default: null
+
+ + + + +

Query parameters

+
+
timecode (optional)
+ +
Query Parameter — Use this parameter to return a snapshot of the data at the specified time. Format: YYYYMMDD_HHMMSS default: null
fields (optional)
+ +
Query Parameter — Comma delimited list of specific fields to be returned. Format: topLevelNode, childNode, attribute default: null
inclusiveTimecode (optional)
+ +
Query Parameter — True to include plays that happen before or at the specified timecode default: null
accent (optional)
+ +
Query Parameter — Boolean value to specify wanting a person's name with accents or without default: null
+
+ + + + + + + +

Responses

+

200

+ OK + +
+
+
+
+ Up +
get /api/v1.1/game/{game_pk}/feed/live/timestamps
+
Retrieve all of the play timestamps for a game. (liveTimestampv11)
+
This can be used for replaying games. Endpoint returns all of the timecodes that can be used with diffs for /v1/game/{game_pk}/feed/live
+ +

Path parameters

+
+
game_pk (required)
+ +
Path Parameter — Unique Primary Key Representing a Game default: null
+
+ + + + + + + + + + + +

Responses

+

200

+ OK + +
+
+
+
+ Up +
get /api/v1/game/{game_pk}/playByPlay
+
Get game play By Play (playByPlay)
+
This endpoint allows you to pull the play by play of a game
+ +

Path parameters

+
+
game_pk (required)
+ +
Path Parameter — Unique Primary Key Representing a Game default: null
+
+ + + + +

Query parameters

+
+
timecode (optional)
+ +
Query Parameter — Use this parameter to return a snapshot of the data at the specified time. Format: YYYYMMDD_HHMMSS default: null
fields (optional)
+ +
Query Parameter — Comma delimited list of specific fields to be returned. Format: topLevelNode, childNode, attribute default: null
inclusiveTimecode (optional)
+ +
Query Parameter — True to include plays that happen before or at the specified timecode default: null
accent (optional)
+ +
Query Parameter — Boolean value to specify wanting a person's name with accents or without default: null
+
+ + + + + + + +

Responses

+

200

+ OK + +
+
+

GamePace

+
+
+ Up +
get /api/v1/gamePace
+
View time of game info (gamePace)
+
+ + + + + +

Query parameters

+
+
season (optional)
+ +
Query Parameter — Season of play default: null
teamId (optional)
+ +
Query Parameter — Unique Team Identifier. Format: 141, 147, etc default: null
teamIds (optional)
+ +
Query Parameter — Comma delimited list of Unique Team identifiers default: null
leagueId (optional)
+ +
Query Parameter — Unique League Identifier default: null
leagueIds (optional)
+ +
Query Parameter — Comma delimited list of Unique league identifiers default: null
leagueListId (optional)
+ +
Query Parameter — Unique League List Identifier default: null
sportId (optional)
+ +
Query Parameter — Top level organization of a sport default: null
sportIds (optional)
+ +
Query Parameter — Comma delimited list of top level organizations of a sport default: null
gameType (optional)
+ +
Query Parameter — Type of Game. Available types in /api/v1/gameTypes default: null
startDate (optional)
+ +
Query Parameter — Start date for range of data (must be used with end date). Format: MM/DD/YYYY default: null
endDate (optional)
+ +
Query Parameter — End date for range of data (must be used with start date). Format: MM/DD/YYYY default: null
venueIds (optional)
+ +
Query Parameter — Comma delimited list of Unique venue identifiers default: null
excludeVenueIds (optional)
+ +
Query Parameter — Comma delimited list of Unique venue identifiers default: null
excludeGamePks (optional)
+ +
Query Parameter — Comma delimited list of unique primary keys default: null
orgType (optional)
+ +
Query Parameter — Organization level. Format: T(Team), L(League), S(Sport) default: null
includeChildren (optional)
+ +
Query Parameter — Determines weather to include results from an organization's children (ex. a sport would also include results for the teams and leagues) default: null
fields (optional)
+ +
Query Parameter — Comma delimited list of specific fields to be returned. Format: topLevelNode, childNode, attribute default: null
+
+ + + + + + + +

Responses

+

200

+ OK + +
+
+

HighLow

+
+
+ Up +
get /api/v1/highLow/{highLowType}
+
View high/low stats by player or team (highLow)
+
+ +

Path parameters

+
+
highLowType (required)
+ +
Path Parameter — Type of high/low stats ('player', 'team', 'game') default: null
+
+ + + + +

Query parameters

+
+
statGroup (optional)
+ +
Query Parameter — Comma delimited list of categories of statistic to return. Available types in /api/v1/statGroups default: null
sortStat (optional)
+ +
Query Parameter — Comma delimited list of baseball stats to sort splits by. default: null
season (optional)
+ +
Query Parameter — Comma delimited list of Seasons of play default: null
gameType (optional)
+ +
Query Parameter — Comma delimited list of type of Game. Available types in /api/v1/gameTypes default: null
teamId (optional)
+ +
Query Parameter — Unique Team Identifier. Format: 141, 147, etc default: null
leagueId (optional)
+ +
Query Parameter — Unique League Identifier default: null
sportId (optional)
+ +
Query Parameter — Top level organization of a sport default: null
offset (optional)
+ +
Query Parameter — The pointer to start for a return set; used for pagination default: null
limit (optional)
+ +
Query Parameter — Number of results to return default: null
fields (optional)
+ +
Query Parameter — Comma delimited list of specific fields to be returned. Format: topLevelNode, childNode, attribute default: null
+
+ + + + + + + +

Responses

+

200

+ OK + +
+
+
+
+ Up +
get /api/v1/highLow/types
+
View high/low stat types (highLowStats)
+
+ + + + + + + + + + + + +

Responses

+

200

+ OK + +
+
+

HomerunDerby

+
+
+ Up +
get /api/v1/homeRunDerby/{gamePk}
+
View a home run derby object (homeRunDerbyBracket)
+
This endpoint allows you to pull home run derby information
+ +

Path parameters

+
+
gamePk (required)
+ +
Path Parameter — Unique Primary Key Representing a Game default: null
+
+ + + + +

Query parameters

+
+
fields (optional)
+ +
Query Parameter — Comma delimited list of specific fields to be returned. Format: topLevelNode, childNode, attribute default: null
+
+ + + + + + + +

Responses

+

200

+ OK + +
+
+
+
+ Up +
get /api/v1/homeRunDerby
+
View a home run derby object (homeRunDerbyBracket1)
+
This endpoint allows you to pull home run derby information
+ +

Path parameters

+
+
gamePk (required)
+ +
Path Parameter — Unique Primary Key Representing a Game default: null
+
+ + + + +

Query parameters

+
+
fields (optional)
+ +
Query Parameter — Comma delimited list of specific fields to be returned. Format: topLevelNode, childNode, attribute default: null
+
+ + + + + + + +

Responses

+

200

+ OK + +
+
+
+
+ Up +
get /api/v1/homeRunDerby/{gamePk}/bracket
+
View a home run derby object (homeRunDerbyBracket2)
+
This endpoint allows you to pull home run derby information
+ +

Path parameters

+
+
gamePk (required)
+ +
Path Parameter — Unique Primary Key Representing a Game default: null
+
+ + + + +

Query parameters

+
+
fields (optional)
+ +
Query Parameter — Comma delimited list of specific fields to be returned. Format: topLevelNode, childNode, attribute default: null
+
+ + + + + + + +

Responses

+

200

+ OK + +
+
+
+
+ Up +
get /api/v1/homeRunDerby/bracket
+
View a home run derby object (homeRunDerbyBracket3)
+
This endpoint allows you to pull home run derby information
+ +

Path parameters

+
+
gamePk (required)
+ +
Path Parameter — Unique Primary Key Representing a Game default: null
+
+ + + + +

Query parameters

+
+
fields (optional)
+ +
Query Parameter — Comma delimited list of specific fields to be returned. Format: topLevelNode, childNode, attribute default: null
+
+ + + + + + + +

Responses

+

200

+ OK + +
+
+
+
+ Up +
get /api/v1/homeRunDerby/{gamePk}/mixed
+
View home run derby mixed mode (Bracket/Pool combo) (homeRunDerbyMixedMode)
+
This endpoint allows you to pull home run derby information
+ +

Path parameters

+
+
gamePk (required)
+ +
Path Parameter — Unique Primary Key Representing a Game default: null
+
+ + + + +

Query parameters

+
+
fields (optional)
+ +
Query Parameter — Comma delimited list of specific fields to be returned. Format: topLevelNode, childNode, attribute default: null
+
+ + + + + + + +

Responses

+

200

+ OK + +
+
+
+
+ Up +
get /api/v1/homeRunDerby/mixed
+
View home run derby mixed mode (Bracket/Pool combo) (homeRunDerbyMixedMode1)
+
This endpoint allows you to pull home run derby information
+ +

Path parameters

+
+
gamePk (required)
+ +
Path Parameter — Unique Primary Key Representing a Game default: null
+
+ + + + +

Query parameters

+
+
fields (optional)
+ +
Query Parameter — Comma delimited list of specific fields to be returned. Format: topLevelNode, childNode, attribute default: null
+
+ + + + + + + +

Responses

+

200

+ OK + +
+
+
+
+ Up +
get /api/v1/homeRunDerby/{gamePk}/pool
+
View home run derby pool (homeRunDerbyPool)
+
This endpoint allows you to pull home run derby information
+ +

Path parameters

+
+
gamePk (required)
+ +
Path Parameter — Unique Primary Key Representing a Game default: null
+
+ + + + +

Query parameters

+
+
fields (optional)
+ +
Query Parameter — Comma delimited list of specific fields to be returned. Format: topLevelNode, childNode, attribute default: null
+
+ + + + + + + +

Responses

+

200

+ OK + +
+
+
+
+ Up +
get /api/v1/homeRunDerby/pool
+
View home run derby pool (homeRunDerbyPool1)
+
This endpoint allows you to pull home run derby information
+ +

Path parameters

+
+
gamePk (required)
+ +
Path Parameter — Unique Primary Key Representing a Game default: null
+
+ + + + +

Query parameters

+
+
fields (optional)
+ +
Query Parameter — Comma delimited list of specific fields to be returned. Format: topLevelNode, childNode, attribute default: null
+
+ + + + + + + +

Responses

+

200

+ OK + +
+
+

Job

+
+
+ Up +
get /api/v1/jobs/datacasters
+
Get datacaster jobs (datacasters)
+
Get datacaster jobs
+ + + + + +

Query parameters

+
+
sportId (optional)
+ +
Query Parameter — Top level organization of a sport default: null
date (optional)
+ +
Query Parameter — Date of Game. Format: YYYY-MM-DD default: null
fields (optional)
+ +
Query Parameter — Comma delimited list of specific fields to be returned. Format: topLevelNode, childNode, attribute default: null
+
+ + + + + + + +

Responses

+

200

+ OK + +
+
+
+
+ Up +
get /api/v1/jobs
+
Get jobs by type (getJobsByType)
+
This endpoint allows you to pull teams
+ + + + + +

Query parameters

+
+
jobType (required)
+ +
Query Parameter — Job Type Identifier (ie. UMPR, etc..) default: null
sportId (optional)
+ +
Query Parameter — Top level organization of a sport default: null
date (optional)
+ +
Query Parameter — Date of Game. Format: YYYY-MM-DD default: null
fields (optional)
+ +
Query Parameter — Comma delimited list of specific fields to be returned. Format: topLevelNode, childNode, attribute default: null
+
+ + + + + + + +

Responses

+

200

+ OK + +
+
+
+
+ Up +
get /api/v1/jobs/officialScorers
+
Get official scorers (officialScorers)
+
This endpoint allows you to pull teams
+ + + + + +

Query parameters

+
+
sportId (optional)
+ +
Query Parameter — Top level organization of a sport default: null
date (optional)
+ +
Query Parameter — Date of Game. Format: YYYY-MM-DD default: null
fields (optional)
+ +
Query Parameter — Comma delimited list of specific fields to be returned. Format: topLevelNode, childNode, attribute default: null
+
+ + + + + + + +

Responses

+

200

+ OK + +
+
+
+
+ Up +
get /api/v1/jobs/umpires/games/{umpireId}
+
Get umpires and associated game for umpireId (umpireSchedule)
+
This endpoint allows you to pull teams
+ +

Path parameters

+
+
umpireId (required)
+ +
Path Parameter — A unique identifier for an umpire default: null
+
+ + + + +

Query parameters

+
+
season (required)
+ +
Query Parameter — Season of play default: null
fields (optional)
+ +
Query Parameter — Comma delimited list of specific fields to be returned. Format: topLevelNode, childNode, attribute default: null
+
+ + + + + + + +

Responses

+

200

+ OK + +
+
+
+
+ Up +
get /api/v1/jobs/umpires
+
Get umpires (umpires)
+
This endpoint allows you to pull teams
+ + + + + +

Query parameters

+
+
sportId (optional)
+ +
Query Parameter — Top level organization of a sport default: null
date (optional)
+ +
Query Parameter — Date of Game. Format: YYYY-MM-DD default: null
fields (optional)
+ +
Query Parameter — Comma delimited list of specific fields to be returned. Format: topLevelNode, childNode, attribute default: null
season (optional)
+ +
Query Parameter — Season of play default: null
+
+ + + + + + + +

Responses

+

200

+ OK + +
+
+

League

+
+
+ Up +
get /api/v1/league/allStarBallot
+
View al star ballot info (allStarBallot)
+
+ +

Path parameters

+
+
leagueId (required)
+ +
Path Parameter — Unique League Identifier default: null
+
+ + + + +

Query parameters

+
+
leagueIds (optional)
+ +
Query Parameter — Comma delimited list of Unique league identifiers default: null
season (optional)
+ +
Query Parameter — Season of play default: null
fields (optional)
+ +
Query Parameter — Comma delimited list of specific fields to be returned. Format: topLevelNode, childNode, attribute default: null
+
+ + + + + + + +

Responses

+

200

+ OK + +
+
+
+
+ Up +
get /api/v1/league/{leagueId}/allStarBallot
+
View al star ballot info (allStarBallot1)
+
+ +

Path parameters

+
+
leagueId (required)
+ +
Path Parameter — Unique League Identifier default: null
+
+ + + + +

Query parameters

+
+
leagueIds (optional)
+ +
Query Parameter — Comma delimited list of Unique league identifiers default: null
season (optional)
+ +
Query Parameter — Season of play default: null
fields (optional)
+ +
Query Parameter — Comma delimited list of specific fields to be returned. Format: topLevelNode, childNode, attribute default: null
+
+ + + + + + + +

Responses

+

200

+ OK + +
+
+
+
+ Up +
get /api/v1/leagues/allStarBallot
+
View al star ballot info (allStarBallot2)
+
+ +

Path parameters

+
+
leagueId (required)
+ +
Path Parameter — Unique League Identifier default: null
+
+ + + + +

Query parameters

+
+
leagueIds (optional)
+ +
Query Parameter — Comma delimited list of Unique league identifiers default: null
season (optional)
+ +
Query Parameter — Season of play default: null
fields (optional)
+ +
Query Parameter — Comma delimited list of specific fields to be returned. Format: topLevelNode, childNode, attribute default: null
+
+ + + + + + + +

Responses

+

200

+ OK + +
+
+
+
+ Up +
get /api/v1/leagues/{leagueId}/allStarBallot
+
View al star ballot info (allStarBallot3)
+
+ +

Path parameters

+
+
leagueId (required)
+ +
Path Parameter — Unique League Identifier default: null
+
+ + + + +

Query parameters

+
+
leagueIds (optional)
+ +
Query Parameter — Comma delimited list of Unique league identifiers default: null
season (optional)
+ +
Query Parameter — Season of play default: null
fields (optional)
+ +
Query Parameter — Comma delimited list of specific fields to be returned. Format: topLevelNode, childNode, attribute default: null
+
+ + + + + + + +

Responses

+

200

+ OK + +
+
+
+
+ Up +
get /api/v1/league/{leagueId}/allStarFinalVote
+
View all star final vote info (allStarFinalVote)
+
+ +

Path parameters

+
+
leagueId (required)
+ +
Path Parameter — Unique League Identifier default: null
+
+ + + + +

Query parameters

+
+
season (optional)
+ +
Query Parameter — Season of play default: null
fields (optional)
+ +
Query Parameter — Comma delimited list of specific fields to be returned. Format: topLevelNode, childNode, attribute default: null
+
+ + + + + + + +

Responses

+

200

+ OK + +
+
+
+
+ Up +
get /api/v1/leagues/{leagueId}/allStarFinalVote
+
View all star final vote info (allStarFinalVote1)
+
+ +

Path parameters

+
+
leagueId (required)
+ +
Path Parameter — Unique League Identifier default: null
+
+ + + + +

Query parameters

+
+
season (optional)
+ +
Query Parameter — Season of play default: null
fields (optional)
+ +
Query Parameter — Comma delimited list of specific fields to be returned. Format: topLevelNode, childNode, attribute default: null
+
+ + + + + + + +

Responses

+

200

+ OK + +
+
+
+
+ Up +
get /api/v1/league/{leagueId}/allStarWriteIns
+
View all star write ins info (allStarWriteIns)
+
+ +

Path parameters

+
+
leagueId (required)
+ +
Path Parameter — Unique League Identifier default: null
+
+ + + + +

Query parameters

+
+
season (optional)
+ +
Query Parameter — Season of play default: null
fields (optional)
+ +
Query Parameter — Comma delimited list of specific fields to be returned. Format: topLevelNode, childNode, attribute default: null
+
+ + + + + + + +

Responses

+

200

+ OK + +
+
+
+
+ Up +
get /api/v1/leagues/{leagueId}/allStarWriteIns
+
View all star write ins info (allStarWriteIns1)
+
+ +

Path parameters

+
+
leagueId (required)
+ +
Path Parameter — Unique League Identifier default: null
+
+ + + + +

Query parameters

+
+
season (optional)
+ +
Query Parameter — Season of play default: null
fields (optional)
+ +
Query Parameter — Comma delimited list of specific fields to be returned. Format: topLevelNode, childNode, attribute default: null
+
+ + + + + + + +

Responses

+

200

+ OK + +
+
+
+
+ Up +
get /api/v1/league
+
View league info (league)
+
+ +

Path parameters

+
+
leagueId (required)
+ +
Path Parameter — Unique League Identifier default: null
+
+ + + + +

Query parameters

+
+
leagueIds (optional)
+ +
Query Parameter — Comma delimited list of Unique league identifiers default: null
season (optional)
+ +
Query Parameter — Season of play default: null
seasons (optional)
+ +
Query Parameter — Comma delimited list of Seasons of play default: null
fields (optional)
+ +
Query Parameter — Comma delimited list of specific fields to be returned. Format: topLevelNode, childNode, attribute default: null
sportId (optional)
+ +
Query Parameter — Top level organization of a sport default: null
activeStatus (optional)
+ +
Query Parameter — Flag for fetching leagues that are currently active (Y), inactive (N), pending (P), or all teams (B) default: null
+
+ + + + + + + +

Responses

+

200

+ OK + +
+
+
+
+ Up +
get /api/v1/league/{leagueId}
+
View league info (league1)
+
+ +

Path parameters

+
+
leagueId (required)
+ +
Path Parameter — Unique League Identifier default: null
+
+ + + + +

Query parameters

+
+
leagueIds (optional)
+ +
Query Parameter — Comma delimited list of Unique league identifiers default: null
season (optional)
+ +
Query Parameter — Season of play default: null
seasons (optional)
+ +
Query Parameter — Comma delimited list of Seasons of play default: null
fields (optional)
+ +
Query Parameter — Comma delimited list of specific fields to be returned. Format: topLevelNode, childNode, attribute default: null
sportId (optional)
+ +
Query Parameter — Top level organization of a sport default: null
activeStatus (optional)
+ +
Query Parameter — Flag for fetching leagues that are currently active (Y), inactive (N), pending (P), or all teams (B) default: null
+
+ + + + + + + +

Responses

+

200

+ OK + +
+
+
+
+ Up +
get /api/v1/leagues
+
View league info (league2)
+
+ +

Path parameters

+
+
leagueId (required)
+ +
Path Parameter — Unique League Identifier default: null
+
+ + + + +

Query parameters

+
+
leagueIds (optional)
+ +
Query Parameter — Comma delimited list of Unique league identifiers default: null
season (optional)
+ +
Query Parameter — Season of play default: null
seasons (optional)
+ +
Query Parameter — Comma delimited list of Seasons of play default: null
fields (optional)
+ +
Query Parameter — Comma delimited list of specific fields to be returned. Format: topLevelNode, childNode, attribute default: null
sportId (optional)
+ +
Query Parameter — Top level organization of a sport default: null
activeStatus (optional)
+ +
Query Parameter — Flag for fetching leagues that are currently active (Y), inactive (N), pending (P), or all teams (B) default: null
+
+ + + + + + + +

Responses

+

200

+ OK + +
+
+
+
+ Up +
get /api/v1/leagues/{leagueId}
+
View league info (league3)
+
+ +

Path parameters

+
+
leagueId (required)
+ +
Path Parameter — Unique League Identifier default: null
+
+ + + + +

Query parameters

+
+
leagueIds (optional)
+ +
Query Parameter — Comma delimited list of Unique league identifiers default: null
season (optional)
+ +
Query Parameter — Season of play default: null
seasons (optional)
+ +
Query Parameter — Comma delimited list of Seasons of play default: null
fields (optional)
+ +
Query Parameter — Comma delimited list of specific fields to be returned. Format: topLevelNode, childNode, attribute default: null
sportId (optional)
+ +
Query Parameter — Top level organization of a sport default: null
activeStatus (optional)
+ +
Query Parameter — Flag for fetching leagues that are currently active (Y), inactive (N), pending (P), or all teams (B) default: null
+
+ + + + + + + +

Responses

+

200

+ OK + +
+
+

Milestones

+
+
+ Up +
get /api/v1/achievementStatuses
+
View available achievementStatus options (achievementStatuses)
+
+ + + + + + + + + + + + +

Responses

+

200

+ OK + +
+
+
+
+ Up +
get /api/v1/milestoneDurations
+
View available milestoneDurations options (milestoneDurations)
+
+ + + + + + + + + + + + +

Responses

+

200

+ OK + +
+
+
+
+ Up +
get /api/v1/milestoneLookups
+
View available milestoneLookup options (milestoneLookups)
+
+ + + + + + + + + + + + +

Responses

+

200

+ OK + +
+
+
+
+ Up +
get /api/v1/milestoneStatistics
+
View available milestone statistics options (milestoneStatistics)
+
+ + + + + + + + + + + + +

Responses

+

200

+ OK + +
+
+
+
+ Up +
get /api/v1/milestoneTypes
+
View available milestoneType options (milestoneTypes)
+
+ + + + + + + + + + + + +

Responses

+

200

+ OK + +
+
+
+
+ Up +
get /api/v1/milestones
+
View pending and achieved milestones. (milestones)
+
+ + + + + +

Query parameters

+
+
orgType (optional)
+ +
Query Parameter — Organization level. Format: T(Team), L(League), S(Sport) default: null
achievementStatuses (optional)
+ +
Query Parameter — Comma delimited list of milestone achievement types default: null
milestoneTypes (optional)
+ +
Query Parameter — Comma delimited list of milestone types default: null
isLastAchievement (optional)
+ +
Query Parameter — Filters out milestones that have already been surpassed. default: null
milestoneStatistics (optional)
+ +
Query Parameter — Comma delimited list of milestone statistics default: null
milestoneValues (optional)
+ +
Query Parameter — Comma delimited list of milestone values default: null
playerIds (optional)
+ +
Query Parameter — A unique identifier for players default: null
teamIds (optional)
+ +
Query Parameter — Comma delimited list of Unique Team identifiers default: null
leagueIds (optional)
+ +
Query Parameter — Comma delimited list of Unique league identifiers default: null
statGroup (optional)
+ +
Query Parameter — Category of statistic to return. Available types in /api/v1/statGroups default: null
season (optional)
+ +
Query Parameter — Season of play default: null
seasons (optional)
+ +
Query Parameter — Comma delimited list of Seasons of play default: null
venueIds (optional)
+ +
Query Parameter — Comma delimited list of Unique venue identifiers default: null
gamePks (optional)
+ +
Query Parameter — Comma delimited list of unique primary keys default: null
limit (optional)
+ +
Query Parameter — Number of results to return default: null
fields (optional)
+ +
Query Parameter — Comma delimited list of specific fields to be returned. Format: topLevelNode, childNode, attribute default: null
showFirsts (optional)
+ +
Query Parameter — True to show play first milestones, like first HR, first Save, etc default: null
+
+ + + + + + + +

Responses

+

200

+ OK + +
+
+

Misc

+
+
+ Up +
get /api/v1/sortModifiers
+
List all stat fields (aggregateSortEnum)
+
+ + + + + + + + + + + + +

Responses

+

200

+ OK + +
+
+
+
+ Up +
get /api/v1/baseballStats
+
List all baseball stats (baseballStats)
+
+ + + + + + + + + + + + +

Responses

+

200

+ OK + +
+
+
+
+ Up +
get /api/v1/broadcastAvailability
+
View broadcast availability options (broadcastAvailabilityTypes)
+
+ + + + + + + + + + + + +

Responses

+

200

+ OK + +
+
+
+
+ Up +
get /api/v1/coachingVideoTypes
+
List all coaching video types (coachingVideoTypes)
+
+ + + + + + + + + + + + +

Responses

+

200

+ OK + +
+
+
+
+ Up +
get /api/v1/eventStatus
+
List all possible event status types (eventStatus)
+
+ + + + + + + + + + + + +

Responses

+

200

+ OK + +
+
+
+
+ Up +
get /api/v1/eventTypes
+
List all event types (eventTypes)
+
+ + + + + +

Query parameters

+
+
fields (optional)
+ +
Query Parameter — Comma delimited list of specific fields to be returned. Format: topLevelNode, childNode, attribute default: null
+
+ + + + + + + +

Responses

+

200

+ OK + +
+
+
+
+ Up +
get /api/v1/fielderDetailTypes
+
List fielder detail types (fielderDetailTypes)
+
+ + + + + + + + + + + + +

Responses

+

200

+ OK + +
+
+
+
+ Up +
get /api/v1/freeGameTypes
+
View free game types (freeGameTypes)
+
+ + + + + + + + + + + + +

Responses

+

200

+ OK + +
+
+
+
+ Up +
get /api/v1/gameStatus
+
List all status types (gameStatus)
+
+ + + + + + + + + + + + +

Responses

+

200

+ OK + +
+
+
+
+ Up +
get /api/v1/gameTypes
+
List all game types (gameTypes)
+
+ + + + + +

Query parameters

+
+
sportId (optional)
+ +
Query Parameter — Top level organization of a sport default: null
leagueId (optional)
+ +
Query Parameter — Unique League Identifier default: null
season (optional)
+ +
Query Parameter — Season of play default: null
+
+ + + + + + + +

Responses

+

200

+ OK + +
+
+
+
+ Up +
get /api/v1/gamedayTypes
+
List all gameday types (gamedayTypes)
+
+ + + + + +

Query parameters

+
+
fields (optional)
+ +
Query Parameter — Comma delimited list of specific fields to be returned. Format: topLevelNode, childNode, attribute default: null
+
+ + + + + + + +

Responses

+

200

+ OK + +
+
+
+
+ Up +
get /api/v1/lookup/values/all
+
View all lookup values (getLookupValues)
+
+ + + + + + + + + + + + +

Responses

+

200

+ OK + +
+
+
+
+ Up +
get /api/v1/groupByTypes
+
List groupBy types (groupByTypes)
+
+ + + + + + + + + + + + +

Responses

+

200

+ OK + +
+
+
+
+ Up +
get /api/v1/hitTrajectories
+
List all hit trajectories (hitTrajectories)
+
+ + + + + +

Query parameters

+
+
fields (optional)
+ +
Query Parameter — Comma delimited list of specific fields to be returned. Format: topLevelNode, childNode, attribute default: null
+
+ + + + + + + +

Responses

+

200

+ OK + +
+
+
+
+ Up +
get /api/v1/jobTypes
+
List all job types (jobTypes)
+
+ + + + + +

Query parameters

+
+
fields (optional)
+ +
Query Parameter — Comma delimited list of specific fields to be returned. Format: topLevelNode, childNode, attribute default: null
+
+ + + + + + + +

Responses

+

200

+ OK + +
+
+
+
+ Up +
get /api/v1/languages
+
List all support languages (languages)
+
+ + + + + + + + + + + + +

Responses

+

200

+ OK + +
+
+
+
+ Up +
get /api/v1/leagueLeaderTypes
+
List all possible player league leader types (leagueLeaderTypes)
+
+ + + + + + + + + + + + +

Responses

+

200

+ OK + +
+
+
+
+ Up +
get /api/v1/logicalEvents
+
List all logical event types (logicalEvents)
+
+ + + + + +

Query parameters

+
+
fields (optional)
+ +
Query Parameter — Comma delimited list of specific fields to be returned. Format: topLevelNode, childNode, attribute default: null
+
+ + + + + + + +

Responses

+

200

+ OK + +
+
+
+
+ Up +
get /api/v1/mediaState
+
View media state options (mediaStateTypes)
+
+ + + + + + + + + + + + +

Responses

+

200

+ OK + +
+
+
+
+ Up +
get /api/v1/metrics
+
List all possible metrics (metrics)
+
+ + + + + + + + + + + + +

Responses

+

200

+ OK + +
+
+
+
+ Up +
get /api/v1/moundVisitTypes
+
List all mound visit types (moundVisitTypes)
+
+ + + + + +

Query parameters

+
+
fields (optional)
+ +
Query Parameter — Comma delimited list of specific fields to be returned. Format: topLevelNode, childNode, attribute default: null
+
+ + + + + + + +

Responses

+

200

+ OK + +
+
+
+
+ Up +
get /api/v1/performerTypes
+
List all possible performer types (performerTypes)
+
+ + + + + + + + + + + + +

Responses

+

200

+ OK + +
+
+
+
+ Up +
get /api/v1/pitchCodes
+
List all pitch codes (pitchCodes)
+
+ + + + + +

Query parameters

+
+
fields (optional)
+ +
Query Parameter — Comma delimited list of specific fields to be returned. Format: topLevelNode, childNode, attribute default: null
+
+ + + + + + + +

Responses

+

200

+ OK + +
+
+
+
+ Up +
get /api/v1/pitchTypes
+
List all pitch classification types (pitchTypes)
+
+ + + + + +

Query parameters

+
+
fields (optional)
+ +
Query Parameter — Comma delimited list of specific fields to be returned. Format: topLevelNode, childNode, attribute default: null
+
+ + + + + + + +

Responses

+

200

+ OK + +
+
+
+
+ Up +
get /api/v1/platforms
+
List all possible platforms (platforms)
+
+ + + + + + + + + + + + +

Responses

+

200

+ OK + +
+
+
+
+ Up +
get /api/v1/playerStatusCodes
+
List all player status codes (playerStatusCodes)
+
+ + + + + +

Query parameters

+
+
fields (optional)
+ +
Query Parameter — Comma delimited list of specific fields to be returned. Format: topLevelNode, childNode, attribute default: null
+
+ + + + + + + +

Responses

+

200

+ OK + +
+
+
+
+ Up +
get /api/v1/positions
+
List all possible positions (positions)
+
+ + + + + + + + + + + + +

Responses

+

200

+ OK + +
+
+
+
+ Up +
get /api/v1/reviewReasons
+
List all replay review reasons (reviewReasons)
+
+ + + + + +

Query parameters

+
+
fields (optional)
+ +
Query Parameter — Comma delimited list of specific fields to be returned. Format: topLevelNode, childNode, attribute default: null
+
+ + + + + + + +

Responses

+

200

+ OK + +
+
+
+
+ Up +
get /api/v1/roofTypes
+
List all roof types (roofTypes)
+
+ + + + + + + + + + + + +

Responses

+

200

+ OK + +
+
+
+
+ Up +
get /api/v1/rosterTypes
+
List all possible roster types (rosterTypes)
+
+ + + + + + + + + + + + +

Responses

+

200

+ OK + +
+
+
+
+ Up +
get /api/v1/ruleSettings
+
List all ruleSettings (ruleSettings)
+
+ + + + + + + + + + + + +

Responses

+

200

+ OK + +
+
+
+
+ Up +
get /api/v1/runnerDetailTypes
+
List runner detail types (runnerDetailTypes)
+
+ + + + + + + + + + + + +

Responses

+

200

+ OK + +
+
+
+
+ Up +
get /api/v1/scheduleEventTypes
+
List all schedule event types (scheduleEventTypes)
+
+ + + + + +

Query parameters

+
+
fields (optional)
+ +
Query Parameter — Comma delimited list of specific fields to be returned. Format: topLevelNode, childNode, attribute default: null
+
+ + + + + + + +

Responses

+

200

+ OK + +
+
+
+
+ Up +
get /api/v1/scheduleTypes
+
List all possible schedule types (scheduleTypes)
+
+ + + + + + + + + + + + +

Responses

+

200

+ OK + +
+
+
+
+ Up +
get /api/v1/situationCodes
+
List all situation codes (sitCodes)
+
+ + + + + +

Query parameters

+
+
fields (optional)
+ +
Query Parameter — Comma delimited list of specific fields to be returned. Format: topLevelNode, childNode, attribute default: null
season (optional)
+ +
Query Parameter — Season of play default: null
statGroup (optional)
+ +
Query Parameter — Category of statistic to return. Available types in /api/v1/statGroups default: null
+
+ + + + + + + +

Responses

+

200

+ OK + +
+
+
+
+ Up +
get /api/v1/sky
+
List all sky options (sky)
+
+ + + + + +

Query parameters

+
+
fields (optional)
+ +
Query Parameter — Comma delimited list of specific fields to be returned. Format: topLevelNode, childNode, attribute default: null
+
+ + + + + + + +

Responses

+

200

+ OK + +
+
+
+
+ Up +
get /api/v1/standingsTypes
+
List all standings types (standingsTypes)
+
+ + + + + + + + + + + + +

Responses

+

200

+ OK + +
+
+
+
+ Up +
get /api/v1/statFields
+
List all stat fields (statFields)
+
+ + + + + + + + + + + + +

Responses

+

200

+ OK + +
+
+
+
+ Up +
get /api/v1/statGroups
+
List all stat groups (statGroups)
+
+ + + + + + + + + + + + +

Responses

+

200

+ OK + +
+
+
+
+ Up +
get /api/v1/stats/search/config
+
Stats Search Config Endpoint (statSearchConfig)
+
+ + + + + +

Query parameters

+
+
filterLevel (optional)
+ +
Query Parameter — Categories of filters for stat search default: null
group (optional)
+ +
Query Parameter — Category of statistic to return. Available types in /api/v1/statGroups default: null
+
+ + + + + + + +

Responses

+

200

+ OK + +
+
+
+
+ Up +
get /api/v1/stats/search/groupByTypes
+
List groupBy types (statSearchGroupByTypes)
+
+ + + + + +

Query parameters

+
+
filterLevel (optional)
+ +
Query Parameter — Categories of filters for stat search default: null
+
+ + + + + + + +

Responses

+

200

+ OK + +
+
+
+
+ Up +
get /api/v1/stats/search/params
+
List stat search parameters (statSearchParams)
+
+ + + + + +

Query parameters

+
+
filterLevel (optional)
+ +
Query Parameter — Categories of filters for stat search default: null
+
+ + + + + + + +

Responses

+

200

+ OK + +
+
+
+
+ Up +
get /api/v1/stats/search/stats
+
List stat search stats (statSearchStats)
+
+ + + + + +

Query parameters

+
+
filterLevel (optional)
+ +
Query Parameter — Categories of filters for stat search default: null
+
+ + + + + + + +

Responses

+

200

+ OK + +
+
+
+
+ Up +
get /api/v1/statTypes
+
List all stat types (statTypes)
+
+ + + + + + + + + + + + +

Responses

+

200

+ OK + +
+
+
+
+ Up +
get /api/v1/statcastPositionTypes
+
List all statcast position types (statcastPositionTypes)
+
+ + + + + + + + + + + + +

Responses

+

200

+ OK + +
+
+
+
+ Up +
get /api/v1/trackingSoftwareVersions
+
List the tracking software versions and notes (trackingSoftwareVersions)
+
+ + + + + + + + + + + + +

Responses

+

200

+ OK + +
+
+
+
+ Up +
get /api/v1/trackingSystemOwners
+
List all tracking system owners (trackingSystemOwners)
+
+ + + + + + + + + + + + +

Responses

+

200

+ OK + +
+
+
+
+ Up +
get /api/v1/trackingVendors
+
List all tracking vendors (trackingVendors)
+
+ + + + + + + + + + + + +

Responses

+

200

+ OK + +
+
+
+
+ Up +
get /api/v1/trackingVersions
+
List all tracking versions (trackingVersions)
+
+ + + + + + + + + + + + +

Responses

+

200

+ OK + +
+
+
+
+ Up +
get /api/v1/transactionTypes
+
List all transaction types (transactionTypes)
+
+ + + + + +

Query parameters

+
+
fields (optional)
+ +
Query Parameter — Comma delimited list of specific fields to be returned. Format: topLevelNode, childNode, attribute default: null
+
+ + + + + + + +

Responses

+

200

+ OK + +
+
+
+
+ Up +
post /api/v1/gameStatus
+
Clear all status types (updateGameStatuses)
+
+ + + + + + + + + + + + +

Responses

+

200

+ OK + +
+
+
+
+ Up +
post /api/v1/jobTypes
+
(updateJobTypes)
+
+ + + + + + + + + + + + +

Responses

+

200

+ OK + +
+
+
+
+ Up +
get /api/v1/videoResolutionTypes
+
View video resolution options (videoResolutionTypes)
+
+ + + + + + + + + + + + +

Responses

+

200

+ OK + +
+
+
+
+ Up +
get /api/v1/violationTypes
+
View available violationType options (violationTypes)
+
+ + + + + + + + + + + + +

Responses

+

200

+ OK + +
+
+
+
+ Up +
get /api/v1/weatherTrajectoryConfidences
+
List all weather trajectories (weatherTrajectoryConfidences)
+
+ + + + + + + + + + + + +

Responses

+

200

+ OK + +
+
+
+
+ Up +
get /api/v1/windDirection
+
List all wind direction options (windDirection)
+
+ + + + + +

Query parameters

+
+
fields (optional)
+ +
Query Parameter — Comma delimited list of specific fields to be returned. Format: topLevelNode, childNode, attribute default: null
+
+ + + + + + + +

Responses

+

200

+ OK + +
+
+

Person

+
+
+ Up +
get /api/v1/people/{personId}/awards
+
View a player's awards (award)
+
+ +

Path parameters

+
+
personId (required)
+ +
Path Parameter — Unique Player Identifier. Format: 434538, 429665, etc default: null
+
+ + + + +

Query parameters

+
+
fields (optional)
+ +
Query Parameter — Comma delimited list of specific fields to be returned. Format: topLevelNode, childNode, attribute default: null
+
+ + + + + + + +

Responses

+

200

+ OK + +
+
+
+
+ Up +
get /api/v1/people/changes
+
View a player's change log (currentGameStats)
+
+ + + + + +

Query parameters

+
+
updatedSince (required)
+ +
Query Parameter — Format: YYYY-MM-DDTHH:MM:SSZ default: null
limit (optional)
+ +
Query Parameter — Number of results to return default: null
offset (optional)
+ +
Query Parameter — The pointer to start for a return set; used for pagination default: null
accent (optional)
+ +
Query Parameter — Boolean value to specify wanting a person's name with accents or without default: null
fields (optional)
+ +
Query Parameter — Comma delimited list of specific fields to be returned. Format: topLevelNode, childNode, attribute default: null
+
+ + + + + + + +

Responses

+

200

+ OK + +
+
+
+
+ Up +
get /api/v1/people/freeAgents
+
Get free agents (freeAgents)
+
+ + + + + +

Query parameters

+
+
season (required)
+ +
Query Parameter — Season of play default: null
order (optional)
+ +
Query Parameter — The order of sorting, ascending or descending default: null
accent (optional)
+ +
Query Parameter — Boolean value to specify wanting a person's name with accents or without default: null
fields (optional)
+ +
Query Parameter — default: null
+
+ + + + + + + +

Responses

+

200

+ OK + +
+
+
+
+ Up +
get /api/v1/people/{personId}
+
View a player (person)
+
This endpoint allows you to pull the information of players
+ +

Path parameters

+
+
personId (required)
+ +
Path Parameter — Unique Player Identifier. Format: 434538, 429665, etc default: null
+
+ + + + +

Query parameters

+
+
personIds (optional)
+ +
Query Parameter — Comma delimited list of person ID. Format: 1234, 2345 default: null
accent (optional)
+ +
Query Parameter — Boolean value to specify wanting a person's name with accents or without default: null
season (optional)
+ +
Query Parameter — Season of play default: null
group (optional)
+ +
Query Parameter — Category of statistic to return. Available types in /api/v1/statGroups default: null
fields (optional)
+ +
Query Parameter — Comma delimited list of specific fields to be returned. Format: topLevelNode, childNode, attribute default: null
+
+ + + + + + + +

Responses

+

200

+ OK + +
+
+
+
+ Up +
get /api/v1/people
+
View a player (person1)
+
This endpoint allows you to pull the information of players
+ +

Path parameters

+
+
personId (required)
+ +
Path Parameter — Unique Player Identifier. Format: 434538, 429665, etc default: null
+
+ + + + +

Query parameters

+
+
personIds (optional)
+ +
Query Parameter — Comma delimited list of person ID. Format: 1234, 2345 default: null
accent (optional)
+ +
Query Parameter — Boolean value to specify wanting a person's name with accents or without default: null
season (optional)
+ +
Query Parameter — Season of play default: null
group (optional)
+ +
Query Parameter — Category of statistic to return. Available types in /api/v1/statGroups default: null
fields (optional)
+ +
Query Parameter — Comma delimited list of specific fields to be returned. Format: topLevelNode, childNode, attribute default: null
+
+ + + + + + + +

Responses

+

200

+ OK + +
+
+
+
+ Up +
get /api/v1/people/{personId}/stats/game/{gamePk}
+
View a player's game stats (playerGameStats)
+
+ +

Path parameters

+
+
personId (required)
+ +
Path Parameter — Unique Player Identifier. Format: 434538, 429665, etc default: null
gamePk (required)
+ +
Path Parameter — Unique Primary Key Representing a Game default: null
+
+ + + + +

Query parameters

+
+
group (optional)
+ +
Query Parameter — Category of statistic to return. Available types in /api/v1/statGroups default: null
fields (optional)
+ +
Query Parameter — Comma delimited list of specific fields to be returned. Format: topLevelNode, childNode, attribute default: null
+
+ + + + + + + +

Responses

+

200

+ OK + +
+
+
+
+ Up +
get /api/v1/people/search
+
Search for a player by name (search)
+
+ + + + + +

Query parameters

+
+
names (optional)
+ +
Query Parameter — Name a player uses default: null
personIds (optional)
+ +
Query Parameter — Comma delimited list of person ID. Format: 1234, 2345 default: null
sportIds (optional)
+ +
Query Parameter — Comma delimited list of top level organizations of a sport default: null
leagueIds (optional)
+ +
Query Parameter — Comma delimited list of Unique league identifiers default: null
teamIds (optional)
+ +
Query Parameter — Comma delimited list of Unique Team identifiers default: null
leagueListId (optional)
+ +
Query Parameter — Unique League List Identifier default: null
active (optional)
+ +
Query Parameter — Whether or not a player is active default: null
verified (optional)
+ +
Query Parameter — Complete and confirmed all biographical data default: null
rookie (optional)
+ +
Query Parameter — Whether or not a player is a rookie default: null
seasons (optional)
+ +
Query Parameter — Comma delimited list of Seasons of play default: null
fields (optional)
+ +
Query Parameter — Comma delimited list of specific fields to be returned. Format: topLevelNode, childNode, attribute default: null
accent (optional)
+ +
Query Parameter — Boolean value to specify wanting a person's name with accents or without default: null
limit (optional)
+ +
Query Parameter — Number of results to return default: null
+
+ + + + + + + +

Responses

+

200

+ OK + +
+
+
+
+ Up +
get /api/v1/people/{personId}/stats
+
View a players stats (stats3)
+
+ +

Path parameters

+
+
personId (required)
+ +
Path Parameter — Unique Player Identifier. Format: 434538, 429665, etc default: null
+
+ + + + +

Query parameters

+
+
stats (required)
+ +
Query Parameter — Type of statistics. Format: Individual, Team, Career, etc. Available types in /api/v1/statTypes default: null
group (optional)
+ +
Query Parameter — Category of statistic to return. Available types in /api/v1/statGroups default: null
season (optional)
+ +
Query Parameter — Season of play default: null
seasons (optional)
+ +
Query Parameter — Comma delimited list of Seasons of play default: null
sportId (optional)
+ +
Query Parameter — Top level organization of a sport default: null
opposingTeamId (optional)
+ +
Query Parameter — A unique identifier for the opposing team. Must be used with Team ID default: null
opposingPlayerId (optional)
+ +
Query Parameter — A unique identifier for the opposing team default: null
metrics (optional)
+ +
Query Parameter — Name of metric(s) for metric log stats. Available metrics in /api/v1/metrics default: null
leagueId (optional)
+ +
Query Parameter — Unique League Identifier default: null
leagueListId (optional)
+ +
Query Parameter — Unique League List Identifier default: null
sitCodes (optional)
+ +
Query Parameter — Situation code for a given stat split. default: null
combineSits (optional)
+ +
Query Parameter — If true, gathers stats where all of the situational criteria are met. If false, returns stats where any of the situational criteria are met. Default: false default: null
startDate (optional)
+ +
Query Parameter — Start date for range of data (must be used with end date). Format: MM/DD/YYYY default: null
endDate (optional)
+ +
Query Parameter — End date for range of data (must be used with start date). Format: MM/DD/YYYY default: null
daysBack (optional)
+ +
Query Parameter — Returns results from the last 'X' days (Starting from yesterday). default: null
gamesBack (optional)
+ +
Query Parameter — Returns results from the last 'X' games played. default: null
limit (optional)
+ +
Query Parameter — Number of results to return default: null
eventType (optional)
+ +
Query Parameter — Type of event default: null
pitchType (optional)
+ +
Query Parameter — Classification of pitch (fastball, curveball, etc...) default: null
hitTrajectory (optional)
+ +
Query Parameter — Trajectory of hit (line drive, fly ball, etc...) default: null
batSide (optional)
+ +
Query Parameter — Bat side of hitter default: null
gameType (optional)
+ +
Query Parameter — Type of Game. Available types in /api/v1/gameTypes default: null
groupBy (optional)
+ +
Query Parameter — Group stats by PLAYER, TEAM, SEASON, VENUE, SPORT or STAT_GROUP default: null
accent (optional)
+ +
Query Parameter — Boolean value to specify wanting a person's name with accents or without default: null
fields (optional)
+ +
Query Parameter — Comma delimited list of specific fields to be returned. Format: topLevelNode, childNode, attribute default: null
+
+ + + + + + + +

Responses

+

200

+ OK + +
+
+
+
+ Up +
get /api/v1/people/{personId}/stats/metrics
+
View a player's stat metrics (statsMetrics)
+
+ +

Path parameters

+
+
personId (required)
+ +
Path Parameter — Unique Player Identifier. Format: 434538, 429665, etc default: null
+
+ + + + +

Query parameters

+
+
stats (required)
+ +
Query Parameter — Type of statistics. Format: Individual, Team, Career, etc. Available types in /api/v1/statTypes default: null
group (optional)
+ +
Query Parameter — Category of statistic to return. Available types in /api/v1/statGroups default: null
season (optional)
+ +
Query Parameter — Season of play default: null
seasons (optional)
+ +
Query Parameter — Comma delimited list of Seasons of play default: null
sportId (optional)
+ +
Query Parameter — Top level organization of a sport default: null
opposingTeamId (optional)
+ +
Query Parameter — A unique identifier for the opposing team. Must be used with Team ID default: null
opposingPlayerId (optional)
+ +
Query Parameter — A unique identifier for the opposing team default: null
metrics (optional)
+ +
Query Parameter — Name of metric(s) for metric log stats. Available metrics in /api/v1/metrics default: null
leagueId (optional)
+ +
Query Parameter — Unique League Identifier default: null
leagueListId (optional)
+ +
Query Parameter — Unique League List Identifier default: null
sitCodes (optional)
+ +
Query Parameter — Situation code for a given stat split. default: null
combineSits (optional)
+ +
Query Parameter — If true, gathers stats where all of the situational criteria are met. If false, returns stats where any of the situational criteria are met. Default: false default: null
startDate (optional)
+ +
Query Parameter — Start date for range of data (must be used with end date). Format: MM/DD/YYYY default: null
endDate (optional)
+ +
Query Parameter — End date for range of data (must be used with start date). Format: MM/DD/YYYY default: null
daysBack (optional)
+ +
Query Parameter — Returns results from the last 'X' days (Starting from yesterday). default: null
gamesBack (optional)
+ +
Query Parameter — Returns results from the last 'X' games played. default: null
limit (optional)
+ +
Query Parameter — Number of results to return default: null
eventType (optional)
+ +
Query Parameter — Type of event default: null
pitchType (optional)
+ +
Query Parameter — Classification of pitch (fastball, curveball, etc...) default: null
hitTrajectory (optional)
+ +
Query Parameter — Trajectory of hit (line drive, fly ball, etc...) default: null
batSide (optional)
+ +
Query Parameter — Bat side of hitter default: null
gameType (optional)
+ +
Query Parameter — Type of Game. Available types in /api/v1/gameTypes default: null
groupBy (optional)
+ +
Query Parameter — Group stats by PLAYER, TEAM, SEASON, VENUE, SPORT or STAT_GROUP default: null
accent (optional)
+ +
Query Parameter — Boolean value to specify wanting a person's name with accents or without default: null
fields (optional)
+ +
Query Parameter — Comma delimited list of specific fields to be returned. Format: topLevelNode, childNode, attribute default: null
+
+ + + + + + + +

Responses

+

200

+ OK + +
+
+

Predictions

+
+
+ Up +
get /api/v1/props/play/predictions
+
Get play-level predictions based on input scenarios (getProps)
+
This endpoint allows you to get play-level predictions based on input scenarios
+ + + + + +

Query parameters

+
+
batterId (optional)
+ +
Query Parameter — Unique Player Identifier. Format: 434538, 429665, etc default: null
pitcherId (optional)
+ +
Query Parameter — Unique Player Identifier. Format: 434538, 429665, etc default: null
venueId (optional)
+ +
Query Parameter — Unique Venue Identifier default: null
batSide (optional)
+ +
Query Parameter — Bat side of hitter default: null
pitchHand (optional)
+ +
Query Parameter — Handedness of pitcher default: null
batterPosition (optional)
+ +
Query Parameter — Position abbreviation. Format: SS, P, 1B, etc default: null
pitcherPosition (optional)
+ +
Query Parameter — Position abbreviation. Format: SS, P, 1B, etc default: null
+
+ + + + + + + +

Responses

+

200

+ OK + +
+
+
+
+ Up +
get /api/v1/props/play/predictions/adjust
+
Get play-level predictions based on input scenarios (getPropsAdjust)
+
This endpoint allows you to get play-level predictions based on input scenarios
+ + + + + +

Query parameters

+
+
gamePk (required)
+ +
Query Parameter — Unique Primary Key Representing a Game default: null
+
+ + + + + + + +

Responses

+

200

+ OK + +
+
+

Reviews

+
+
+ Up +
get /api/v1/review
+
Get review info (getReviewInfo)
+
+ + + + + +

Query parameters

+
+
sportId (required)
+ +
Query Parameter — Unique Team Identifier. Format: 141, 147, etc default: null
season (required)
+ +
Query Parameter — Comma delimited list of Seasons of play default: null
gameType (optional)
+ +
Query Parameter — Type of Game. Available types in /api/v1/gameTypes default: null
fields (optional)
+ +
Query Parameter — Comma delimited list of specific fields to be returned. Format: topLevelNode, childNode, attribute default: null
+
+ + + + + + + +

Responses

+

200

+ OK + +
+
+

Schedule

+
+
+ Up +
get /api/v1/schedule/postseason
+
Get postseason schedule (postseasonSchedule)
+
This endpoint allows you to pull postseason schedules
+ + + + + +

Query parameters

+
+
gameTypes (optional)
+ +
Query Parameter — Comma delimited list of type of Game. Available types in /api/v1/gameTypes default: null
seriesNumber (optional)
+ +
Query Parameter — default: null
teamId (optional)
+ +
Query Parameter — Unique Team Identifier. Format: 141, 147, etc default: null
sportId (optional)
+ +
Query Parameter — Unique League Identifier default: null
useLatestGames (optional)
+ +
Query Parameter — default: null
useFeaturedGame (optional)
+ +
Query Parameter — default: null
season (optional)
+ +
Query Parameter — default: null
publicFacing (optional)
+ +
Query Parameter — Return public, non-public or all games. Format: Public Facing = 'Y', Non-Public Facing = 'N', All = 'A' default: null
fields (optional)
+ +
Query Parameter — Comma delimited list of specific fields to be returned. Format: topLevelNode, childNode, attribute default: null
+
+ + + + + + + +

Responses

+

200

+ OK + +
+
+
+
+ Up +
get /api/v1/schedule/postseason/series
+
Get postseason series schedules (postseasonScheduleSeries)
+
This endpoint allows you to pull postseason schedules
+ + + + + +

Query parameters

+
+
gameTypes (optional)
+ +
Query Parameter — Comma delimited list of type of Game. Available types in /api/v1/gameTypes default: null
seriesNumber (optional)
+ +
Query Parameter — default: null
teamId (optional)
+ +
Query Parameter — Unique Team Identifier. Format: 141, 147, etc default: null
sportId (optional)
+ +
Query Parameter — Unique League Identifier default: null
date (optional)
+ +
Query Parameter — Date of Game. Format: YYYY-MM-DD default: null
startDate (optional)
+ +
Query Parameter — Start date for range of data (must be used with end date). Format: MM/DD/YYYY default: null
endDate (optional)
+ +
Query Parameter — End date for range of data (must be used with start date). Format: MM/DD/YYYY default: null
useLatestGames (optional)
+ +
Query Parameter — default: null
useFeaturedGame (optional)
+ +
Query Parameter — default: null
season (optional)
+ +
Query Parameter — default: null
fields (optional)
+ +
Query Parameter — Comma delimited list of specific fields to be returned. Format: topLevelNode, childNode, attribute default: null
+
+ + + + + + + +

Responses

+

200

+ OK + +
+
+
+
+ Up +
get /api/v1/schedule
+
View schedule info based on scheduleType. (schedule)
+
View schedule info. This endpoint allows you to pull schedules
+ + + + + +

Query parameters

+
+
calendarTypes (optional)
+ +
Query Parameter — Comma delimited list of type of calendar types default: null
eventTypes (optional)
+ +
Query Parameter — Comma delimited list of type of events. Note: Don't Use. This will be deprecated in favor of calendarTypes default: null
scheduleEventTypes (optional)
+ +
Query Parameter — Comma delimited list of type of event types default: null
teamId (optional)
+ +
Query Parameter — Unique Team Identifier. Format: 141, 147, etc default: null
leagueId (optional)
+ +
Query Parameter — Unique League Identifier default: null
sportId (optional)
+ +
Query Parameter — Top level organization of a sport default: null
gamePk (optional)
+ +
Query Parameter — Unique Primary Key Representing a Game default: null
gamePks (optional)
+ +
Query Parameter — Comma delimited list of unique primary keys default: null
eventIds (optional)
+ +
Query Parameter — A unique identifier for non-game event default: null
venueIds (optional)
+ +
Query Parameter — Unique Venue Identifier default: null
performerIds (optional)
+ +
Query Parameter — A unique identifier for non-team event performers default: null
gameTypes (optional)
+ +
Query Parameter — Comma delimited list of type of Game. Available types in /api/v1/gameTypes default: null
gameType (optional)
+ +
Query Parameter — Type of Game. Available types in /api/v1/gameTypes default: null
season (optional)
+ +
Query Parameter — Season of play default: null
seasons (optional)
+ +
Query Parameter — Comma delimited list of Seasons of play default: null
date (optional)
+ +
Query Parameter — Date of Game. Format: YYYY-MM-DD default: null
startDate (optional)
+ +
Query Parameter — Start date for range of data (must be used with end date). Format: MM/DD/YYYY default: null
endDate (optional)
+ +
Query Parameter — End date for range of data (must be used with start date). Format: MM/DD/YYYY default: null
timecode (optional)
+ +
Query Parameter — Use this parameter to return a snapshot of the data at the specified time. Format: YYYYMMDD_HHMMSS default: null
useLatestGames (optional)
+ +
Query Parameter — default: null
opponentId (optional)
+ +
Query Parameter — A unique identifier for the opposing team. Must be used with Team ID default: null
publicFacing (optional)
+ +
Query Parameter — Return public, non-public or all games. Format: Public Facing = 'Y', Non-Public Facing = 'N', All = 'A' default: null
fields (optional)
+ +
Query Parameter — Comma delimited list of specific fields to be returned. Format: topLevelNode, childNode, attribute default: null
usingPrivateEndpoint (required)
+ +
Query Parameter — default: null
+
+ + + + + + + +

Responses

+

200

+ OK + +
+
+
+
+ Up +
get /api/v1/schedule/{scheduleType}
+
View schedule info based on scheduleType. (schedule1)
+
View schedule info. This endpoint allows you to pull schedules
+ + + + + +

Query parameters

+
+
calendarTypes (optional)
+ +
Query Parameter — Comma delimited list of type of calendar types default: null
eventTypes (optional)
+ +
Query Parameter — Comma delimited list of type of events. Note: Don't Use. This will be deprecated in favor of calendarTypes default: null
scheduleEventTypes (optional)
+ +
Query Parameter — Comma delimited list of type of event types default: null
teamId (optional)
+ +
Query Parameter — Unique Team Identifier. Format: 141, 147, etc default: null
leagueId (optional)
+ +
Query Parameter — Unique League Identifier default: null
sportId (optional)
+ +
Query Parameter — Top level organization of a sport default: null
gamePk (optional)
+ +
Query Parameter — Unique Primary Key Representing a Game default: null
gamePks (optional)
+ +
Query Parameter — Comma delimited list of unique primary keys default: null
eventIds (optional)
+ +
Query Parameter — A unique identifier for non-game event default: null
venueIds (optional)
+ +
Query Parameter — Unique Venue Identifier default: null
performerIds (optional)
+ +
Query Parameter — A unique identifier for non-team event performers default: null
gameTypes (optional)
+ +
Query Parameter — Comma delimited list of type of Game. Available types in /api/v1/gameTypes default: null
gameType (optional)
+ +
Query Parameter — Type of Game. Available types in /api/v1/gameTypes default: null
season (optional)
+ +
Query Parameter — Season of play default: null
seasons (optional)
+ +
Query Parameter — Comma delimited list of Seasons of play default: null
date (optional)
+ +
Query Parameter — Date of Game. Format: YYYY-MM-DD default: null
startDate (optional)
+ +
Query Parameter — Start date for range of data (must be used with end date). Format: MM/DD/YYYY default: null
endDate (optional)
+ +
Query Parameter — End date for range of data (must be used with start date). Format: MM/DD/YYYY default: null
timecode (optional)
+ +
Query Parameter — Use this parameter to return a snapshot of the data at the specified time. Format: YYYYMMDD_HHMMSS default: null
useLatestGames (optional)
+ +
Query Parameter — default: null
opponentId (optional)
+ +
Query Parameter — A unique identifier for the opposing team. Must be used with Team ID default: null
publicFacing (optional)
+ +
Query Parameter — Return public, non-public or all games. Format: Public Facing = 'Y', Non-Public Facing = 'N', All = 'A' default: null
fields (optional)
+ +
Query Parameter — Comma delimited list of specific fields to be returned. Format: topLevelNode, childNode, attribute default: null
usingPrivateEndpoint (required)
+ +
Query Parameter — default: null
+
+ + + + + + + +

Responses

+

200

+ OK + +
+
+
+
+ Up +
get /api/v1/schedule/games/tied
+
Get tied game schedules (tieGames)
+
This endpoint allows you to pull tie game schedules for the given season
+ + + + + +

Query parameters

+
+
sportId (optional)
+ +
Query Parameter — Top level organization of a sport default: null
gameTypes (optional)
+ +
Query Parameter — Comma delimited list of type of Game. Available types in /api/v1/gameTypes default: null
season (required)
+ +
Query Parameter — Season of play default: null
fields (optional)
+ +
Query Parameter — Comma delimited list of specific fields to be returned. Format: topLevelNode, childNode, attribute default: null
+
+ + + + + + + +

Responses

+

200

+ OK + +
+
+
+
+ Up +
get /api/v1/schedule/trackingEvents
+
Get tracking event schedules (trackingEventsSchedule)
+
This endpoint allows you to pull schedules for tracking events
+ + + + + +

Query parameters

+
+
calendarTypes (optional)
+ +
Query Parameter — Comma delimited list of type of calendar types default: null
eventTypes (optional)
+ +
Query Parameter — Comma delimited list of type of events. Note: Don't Use. This will be deprecated in favor of calendarTypes default: null
teamId (optional)
+ +
Query Parameter — Unique Team Identifier. Format: 141, 147, etc default: null
leagueId (optional)
+ +
Query Parameter — Unique League Identifier default: null
sportId (optional)
+ +
Query Parameter — Top level organization of a sport default: null
gamePk (optional)
+ +
Query Parameter — Unique Primary Key Representing a Game default: null
gamePks (optional)
+ +
Query Parameter — Comma delimited list of unique primary keys default: null
eventIds (optional)
+ +
Query Parameter — A unique identifier for non-game event default: null
venueIds (optional)
+ +
Query Parameter — Unique Venue Identifier default: null
performerIds (optional)
+ +
Query Parameter — A unique identifier for non-team event performers default: null
gameTypes (optional)
+ +
Query Parameter — Comma delimited list of type of Game. Available types in /api/v1/gameTypes default: null
gameType (optional)
+ +
Query Parameter — Type of Game. Available types in /api/v1/gameTypes default: null
season (optional)
+ +
Query Parameter — Season of play default: null
seasons (optional)
+ +
Query Parameter — Comma delimited list of Seasons of play default: null
date (optional)
+ +
Query Parameter — Date of Game. Format: YYYY-MM-DD default: null
startDate (optional)
+ +
Query Parameter — Start date for range of data (must be used with end date). Format: MM/DD/YYYY default: null
endDate (optional)
+ +
Query Parameter — End date for range of data (must be used with start date). Format: MM/DD/YYYY default: null
timecode (optional)
+ +
Query Parameter — Use this parameter to return a snapshot of the data at the specified time. Format: YYYYMMDD_HHMMSS default: null
useLatestGames (optional)
+ +
Query Parameter — default: null
opponentId (optional)
+ +
Query Parameter — A unique identifier for the opposing team. Must be used with Team ID default: null
publicFacing (optional)
+ +
Query Parameter — Return public, non-public or all games. Format: Public Facing = 'Y', Non-Public Facing = 'N', All = 'A' default: null
fields (optional)
+ +
Query Parameter — Comma delimited list of specific fields to be returned. Format: topLevelNode, childNode, attribute default: null
+
+ + + + + + + +

Responses

+

200

+ OK + +
+
+
+
+ Up +
get /api/v1/schedule/postseason/tuneIn
+
Get postseason TuneIn schedules (tuneIn)
+
This endpoint allows you to pull postseason schedules
+ + + + + +

Query parameters

+
+
teamId (optional)
+ +
Query Parameter — Unique Team Identifier. Format: 141, 147, etc default: null
sportId (optional)
+ +
Query Parameter — Unique League Identifier default: null
season (optional)
+ +
Query Parameter — Unique Primary Key Representing a Game default: null
fields (optional)
+ +
Query Parameter — Comma delimited list of specific fields to be returned. Format: topLevelNode, childNode, attribute default: null
+
+ + + + + + + +

Responses

+

200

+ OK + +
+
+

Season

+
+
+ Up +
get /api/v1/seasons/all
+
View all seasons (allSeasons)
+
This endpoint allows you to view all seasons for a given Division, League or Sport
+ + + + + +

Query parameters

+
+
divisionId (optional)
+ +
Query Parameter — Unique Division Identifier default: null
leagueId (optional)
+ +
Query Parameter — Unique League Identifier default: null
sportId (optional)
+ +
Query Parameter — Top level organization of a sport default: null
withGameTypeDates (optional)
+ +
Query Parameter — Retrieve dates for each game type default: null
fields (optional)
+ +
Query Parameter — Comma delimited list of specific fields to be returned. Format: topLevelNode, childNode, attribute default: null
+
+ + + + + + + +

Responses

+

200

+ OK + +
+
+
+
+ Up +
get /api/v1/seasons
+
View season info (seasons)
+
This endpoint allows you to pull seasons
+ +

Path parameters

+
+
seasonId (required)
+ +
Path Parameter — Season of play default: null
+
+ + + + +

Query parameters

+
+
season (optional)
+ +
Query Parameter — Season of play default: null
sportId (optional)
+ +
Query Parameter — Top level organization of a sport default: null
withGameTypeDates (optional)
+ +
Query Parameter — Retrieve dates for each game type default: null
fields (optional)
+ +
Query Parameter — Comma delimited list of specific fields to be returned. Format: topLevelNode, childNode, attribute default: null
+
+ + + + + + + +

Responses

+

200

+ OK + +
+
+
+
+ Up +
get /api/v1/seasons/{seasonId}
+
View season info (seasons1)
+
This endpoint allows you to pull seasons
+ +

Path parameters

+
+
seasonId (required)
+ +
Path Parameter — Season of play default: null
+
+ + + + +

Query parameters

+
+
season (optional)
+ +
Query Parameter — Season of play default: null
sportId (optional)
+ +
Query Parameter — Top level organization of a sport default: null
withGameTypeDates (optional)
+ +
Query Parameter — Retrieve dates for each game type default: null
fields (optional)
+ +
Query Parameter — Comma delimited list of specific fields to be returned. Format: topLevelNode, childNode, attribute default: null
+
+ + + + + + + +

Responses

+

200

+ OK + +
+
+

Skeletal

+
+
+ Up +
get /api/v1/game/{gamePk}/{playId}/analytics/skeletalData/chunked
+
View Skeletal Data by playId and gameId chunked (skeletalChunked)
+
This endpoint allows you to pull chunked skeletal tracking data by gameId and playId
+ +

Path parameters

+
+
gamePk (required)
+ +
Path Parameter — Unique Primary Key Representing a Game default: null
playId (required)
+ +
Path Parameter — Unique play identifier default: null
+
+ + + + +

Query parameters

+
+
fileName (required)
+ +
Query Parameter — Skeletal chunked file name default: null
fields (optional)
+ +
Query Parameter — Comma delimited list of specific fields to be returned. Format: topLevelNode, childNode, attribute default: null
+
+ + + + + + + +

Responses

+

200

+ OK + +
+
+
+
+ Up +
get /api/v1/game/{gamePk}/{playId}/analytics/skeletalData/files
+
View Skeletal Data by playId and gameId files (skeletalDataFileNames)
+
This endpoint allows you to pull chunked skeletal tracking data by gameId and playId
+ +

Path parameters

+
+
gamePk (required)
+ +
Path Parameter — Unique Primary Key Representing a Game default: null
playId (required)
+ +
Path Parameter — Unique play identifier default: null
+
+ + + + +

Query parameters

+
+
fields (optional)
+ +
Query Parameter — Comma delimited list of specific fields to be returned. Format: topLevelNode, childNode, attribute default: null
+
+ + + + + + + +

Responses

+

200

+ OK + +
+
+

Sports

+
+
+ Up +
get /api/v1/sports/{sportId}/allSportBallot
+
Get ALL MLB ballot for sport (allSportBallot)
+
This endpoint allows you to get all players for MLB ballot
+ +

Path parameters

+
+
sportId (required)
+ +
Path Parameter — Top level organization of a sport default: null
+
+ + + + +

Query parameters

+
+
season (required)
+ +
Query Parameter — season default: null
fields (optional)
+ +
Query Parameter — default: null
+
+ + + + + + + +

Responses

+

200

+ OK + +
+
+
+
+ Up +
get /api/v1/sports/{sportId}/players
+
Get all players for a sport level (sportPlayers)
+
This endpoint allows you to pull all players for a given sport
+ +

Path parameters

+
+
sportId (required)
+ +
Path Parameter — Top level organization of a sport default: null
+
+ + + + +

Query parameters

+
+
season (optional)
+ +
Query Parameter — Season of play default: null
gameType (optional)
+ +
Query Parameter — Type of Game. Available types in /api/v1/gameTypes default: null
hasStats (optional)
+ +
Query Parameter — Returns sports that have individual player stats default: null
accent (optional)
+ +
Query Parameter — Boolean value to specify wanting a person's name with accents or without default: null
fields (optional)
+ +
Query Parameter — Comma delimited list of specific fields to be returned. Format: topLevelNode, childNode, attribute default: null
+
+ + + + + + + +

Responses

+

200

+ OK + +
+
+
+
+ Up +
get /api/v1/sports
+
Get sports information (sports)
+
This endpoint allows you to pull sports
+ +

Path parameters

+
+
sportId (required)
+ +
Path Parameter — Top level organization of a sport default: null
+
+ + + + +

Query parameters

+
+
season (optional)
+ +
Query Parameter — Season of play default: null
fields (optional)
+ +
Query Parameter — Comma delimited list of specific fields to be returned. Format: topLevelNode, childNode, attribute default: null
hasStats (optional)
+ +
Query Parameter — Returns sports that have individual player stats default: null
activeStatus (optional)
+ +
Query Parameter — Flag for fetching sports that are currently active (Y), inactive (N), pending (P), or all teams (B) default: null
+
+ + + + + + + +

Responses

+

200

+ OK + +
+
+
+
+ Up +
get /api/v1/sports/{sportId}
+
Get sports information (sports1)
+
This endpoint allows you to pull sports
+ +

Path parameters

+
+
sportId (required)
+ +
Path Parameter — Top level organization of a sport default: null
+
+ + + + +

Query parameters

+
+
season (optional)
+ +
Query Parameter — Season of play default: null
fields (optional)
+ +
Query Parameter — Comma delimited list of specific fields to be returned. Format: topLevelNode, childNode, attribute default: null
hasStats (optional)
+ +
Query Parameter — Returns sports that have individual player stats default: null
activeStatus (optional)
+ +
Query Parameter — Flag for fetching sports that are currently active (Y), inactive (N), pending (P), or all teams (B) default: null
+
+ + + + + + + +

Responses

+

200

+ OK + +
+
+

Standings

+
+
+ Up +
get /api/v1/standings/{standingsType}
+
View standings for a league (standings)
+
This endpoint allows you to pull standings
+ +

Path parameters

+
+
standingsType (required)
+ +
Path Parameter — Type of season. Available types in /api/v1/standingsTypes default: null
+
+ + + + +

Query parameters

+
+
leagueId (optional)
+ +
Query Parameter — Unique League Identifier default: null
season (optional)
+ +
Query Parameter — Season of play default: null
standingsTypes (optional)
+ +
Query Parameter — Type of season. Available types in /api/v1/standingsTypes default: null
date (optional)
+ +
Query Parameter — Date of Game. Format: YYYY-MM-DD default: null
teamId (optional)
+ +
Query Parameter — Unique Team Identifier. Format: 141, 147, etc default: null
includeMLB (optional)
+ +
Query Parameter — Determines whether to include major league teams when using the 'BY_ORGANIZATION' standings type default: null
fields (optional)
+ +
Query Parameter — Comma delimited list of specific fields to be returned. Format: topLevelNode, childNode, attribute default: null
+
+ + + + + + + +

Responses

+

200

+ OK + +
+
+
+
+ Up +
get /api/v1/standings
+
View standings for a league (standings1)
+
This endpoint allows you to pull standings
+ +

Path parameters

+
+
standingsType (required)
+ +
Path Parameter — Type of season. Available types in /api/v1/standingsTypes default: null
+
+ + + + +

Query parameters

+
+
leagueId (optional)
+ +
Query Parameter — Unique League Identifier default: null
season (optional)
+ +
Query Parameter — Season of play default: null
standingsTypes (optional)
+ +
Query Parameter — Type of season. Available types in /api/v1/standingsTypes default: null
date (optional)
+ +
Query Parameter — Date of Game. Format: YYYY-MM-DD default: null
teamId (optional)
+ +
Query Parameter — Unique Team Identifier. Format: 141, 147, etc default: null
includeMLB (optional)
+ +
Query Parameter — Determines whether to include major league teams when using the 'BY_ORGANIZATION' standings type default: null
fields (optional)
+ +
Query Parameter — Comma delimited list of specific fields to be returned. Format: topLevelNode, childNode, attribute default: null
+
+ + + + + + + +

Responses

+

200

+ OK + +
+
+

Stats

+
+
+ Up +
get /api/v1/stats/search
+
View stats from search (beastStats)
+
+ + + + + +

Query parameters

+
+
group (required)
+ +
Query Parameter — Category of statistic to return. Available types in /api/v1/statGroups default: null
gamePks (optional)
+ +
Query Parameter — Comma delimited list of unique primary keys default: null
playIds (optional)
+ +
Query Parameter — Comma delimited list of unique play identifiers default: null
seasons (optional)
+ +
Query Parameter — Comma delimited list of Seasons of play default: null
gameTypes (optional)
+ +
Query Parameter — Type of Game. Available types in /api/v1/gameTypes default: null
date (optional)
+ +
Query Parameter — Date of Game. Format: YYYY-MM-DD default: null
startDate (optional)
+ +
Query Parameter — Date of Game. Format: YYYY-MM-DD default: null
endDate (optional)
+ +
Query Parameter — Date of Game. Format: YYYY-MM-DD default: null
teamIds (optional)
+ +
Query Parameter — Unique Team Identifier. Format: 141, 147, etc default: null
pitcherTeamIds (optional)
+ +
Query Parameter — Unique Team Identifier. Format: 141, 147, etc default: null
batterTeamIds (optional)
+ +
Query Parameter — Unique Team Identifier. Format: 141, 147, etc default: null
sportIds (optional)
+ +
Query Parameter — Comma delimited list of top level organizations of a sport default: null
pitcherSportIds (optional)
+ +
Query Parameter — Comma delimited list of top level organizations of a sport default: null
batterSportIds (optional)
+ +
Query Parameter — Comma delimited list of top level organizations of a sport default: null
leagueIds (optional)
+ +
Query Parameter — Comma delimited list of Unique league identifiers default: null
pitcherLeagueIds (optional)
+ +
Query Parameter — Comma delimited list of Unique league identifiers default: null
batterLeagueIds (optional)
+ +
Query Parameter — Comma delimited list of Unique league identifiers default: null
divisionIds (optional)
+ +
Query Parameter — Comma delimited list of Unique League Identifiers default: null
pitcherDivisionIds (optional)
+ +
Query Parameter — Comma delimited list of Unique League Identifiers default: null
batterDivisionIds (optional)
+ +
Query Parameter — Comma delimited list of Unique League Identifiers default: null
pitchersOnTeamIds (optional)
+ +
Query Parameter — Unique Team Identifier. Format: 141, 147, etc default: null
battersOnTeamIds (optional)
+ +
Query Parameter — Unique Team Identifier. Format: 141, 147, etc default: null
playerIds (optional)
+ +
Query Parameter — A unique identifier for a player default: null
playerPool (optional)
+ +
Query Parameter — Return "ALL" or only "QUALIFIED" players based on plate appearances. default: null
pitcherIds (optional)
+ +
Query Parameter — A unique identifier for a player default: null
batterIds (optional)
+ +
Query Parameter — A unique identifier for a player default: null
catcherIds (optional)
+ +
Query Parameter — A unique identifier for a player default: null
firstBasemanIds (optional)
+ +
Query Parameter — A unique identifier for a player default: null
secondBasemanIds (optional)
+ +
Query Parameter — A unique identifier for a player default: null
thirdBasemanIds (optional)
+ +
Query Parameter — A unique identifier for a player default: null
shortstopIds (optional)
+ +
Query Parameter — A unique identifier for a player default: null
leftFielderIds (optional)
+ +
Query Parameter — A unique identifier for a player default: null
centerFielderIds (optional)
+ +
Query Parameter — A unique identifier for a player default: null
rightFielderIds (optional)
+ +
Query Parameter — A unique identifier for a player default: null
runnerFirstIds (optional)
+ +
Query Parameter — A unique identifier for a player default: null
runnerSecondIds (optional)
+ +
Query Parameter — A unique identifier for a player default: null
runnerThirdIds (optional)
+ +
Query Parameter — A unique identifier for a player default: null
venueIds (optional)
+ +
Query Parameter — Unique Venue Identifier default: null
pitchHand (optional)
+ +
Query Parameter — Handedness of pitcher default: null
batSide (optional)
+ +
Query Parameter — Bat side of hitter default: null
pitchTypes (optional)
+ +
Query Parameter — Classification of pitch (fastball, curveball, etc...) default: null
pitchCodes (optional)
+ +
Query Parameter — Result of the pitch (ball, called strike, etc...) default: null
eventTypes (optional)
+ +
Query Parameter — Type of event default: null
positions (optional)
+ +
Query Parameter — All of the details of a player's position default: null
primaryPositions (optional)
+ +
Query Parameter — All of the details of a player's position default: null
minPitchSpeed (optional)
+ +
Query Parameter — Minimum value to filter on default: null
maxPitchSpeed (optional)
+ +
Query Parameter — Maximum value to filter on default: null
minSpinRate (optional)
+ +
Query Parameter — Minimum value to filter on default: null
maxSpinRate (optional)
+ +
Query Parameter — Maximum value to filter on default: null
minExtension (optional)
+ +
Query Parameter — Minimum value to filter on default: null
maxExtension (optional)
+ +
Query Parameter — Maximum value to filter on default: null
minExitVelocityAgainst (optional)
+ +
Query Parameter — Minimum value to filter on default: null
maxExitVelocityAgainst (optional)
+ +
Query Parameter — Maximum value to filter on default: null
minLaunchAngleAgainst (optional)
+ +
Query Parameter — Minimum value to filter on default: null
maxLaunchAngleAgainst (optional)
+ +
Query Parameter — Maximum value to filter on default: null
minExitVelocity (optional)
+ +
Query Parameter — Minimum value to filter on default: null
maxExitVelocity (optional)
+ +
Query Parameter — Maximum value to filter on default: null
minLaunchAngle (optional)
+ +
Query Parameter — Minimum value to filter on default: null
maxLaunchAngle (optional)
+ +
Query Parameter — Maximum value to filter on default: null
minHomeRunDistance (optional)
+ +
Query Parameter — Minimum value to filter on default: null
maxHomeRunDistance (optional)
+ +
Query Parameter — Maximum value to filter on default: null
minHitDistance (optional)
+ +
Query Parameter — Minimum value to filter on default: null
maxHitDistance (optional)
+ +
Query Parameter — Maximum value to filter on default: null
minHangTime (optional)
+ +
Query Parameter — Minimum value to filter on default: null
maxHangTime (optional)
+ +
Query Parameter — Maximum value to filter on default: null
minHitProbability (optional)
+ +
Query Parameter — Minimum value to filter on default: null
maxHitProbability (optional)
+ +
Query Parameter — Maximum value to filter on default: null
minCatchProbability (optional)
+ +
Query Parameter — Minimum value to filter on default: null
maxCatchProbability (optional)
+ +
Query Parameter — Maximum value to filter on default: null
minAttackAngle (optional)
+ +
Query Parameter — Minimum value to filter on default: null
maxAttackAngle (optional)
+ +
Query Parameter — Maximum value to filter on default: null
minBatSpeed (optional)
+ +
Query Parameter — Minimum value to filter on default: null
maxBatSpeed (optional)
+ +
Query Parameter — Maximum value to filter on default: null
minHomeRunXBallparks (optional)
+ +
Query Parameter — Minimum value to filter on default: null
maxHomeRunXBallparks (optional)
+ +
Query Parameter — Maximum value to filter on default: null
isBarrel (optional)
+ +
Query Parameter — Whether or not a play resulted in a barreled ball default: null
hitTrajectories (optional)
+ +
Query Parameter — Trajectory of hit (line drive, fly ball, etc...) default: null
limit (optional)
+ +
Query Parameter — Number of results to return default: null
offset (optional)
+ +
Query Parameter — The pointer to start for a return set; used for pagination default: null
groupBy (optional)
+ +
Query Parameter — Group stats by PLAYER, TEAM, SEASON, VENUE, SPORT or STAT_GROUP default: null
compareOver (optional)
+ +
Query Parameter — Group stats by PLAYER, TEAM, SEASON, VENUE, SPORT or STAT_GROUP default: null
sortStat (optional)
+ +
Query Parameter — Baseball stat to sort splits by. default: null
sortModifier (optional)
+ +
Query Parameter — The prefix modifier for the sort stat. avg, min, max. I.E minExitVelocity, maxLaunchAngle, avgHitDistance default: null
sortOrder (optional)
+ +
Query Parameter — The order of sorting, ascending or descending default: null
percentile (optional)
+ +
Query Parameter — Only return averages above this percentile. used for best effort plays default: null
minOccurrences (optional)
+ +
Query Parameter — Minimum occurrences to filter upon default: null
minPlateAppearances (optional)
+ +
Query Parameter — Minimum occurrences to filter upon default: null
minInnings (optional)
+ +
Query Parameter — Minimum occurrences to filter upon default: null
qualifierRate (optional)
+ +
Query Parameter — Minimum occurrences to filter upon default: null
sitCodes (optional)
+ +
Query Parameter — Situation code for a given stat split. default: null
showTotals (optional)
+ +
Query Parameter — Columns to return totals default: null
includeNullMetrics (optional)
+ +
Query Parameter — Show events with null metrics default: null
statFields (optional)
+ +
Query Parameter — Baseball stat fields to populate default: null
atBatNumbers (optional)
+ +
Query Parameter — The at bat number of a given game. Format: 1, 2, 3, etc default: null
pitchNumbers (optional)
+ +
Query Parameter — The pitch number of a given game. Format: 1, 2, 3, etc default: null
fields (optional)
+ +
Query Parameter — Comma delimited list of specific fields to be returned. Format: topLevelNode, childNode, attribute default: null
debug (optional)
+ +
Query Parameter — default: null
activeStatus (optional)
+ +
Query Parameter — Whether or not a player is active default: null
+
+ + + + + + + +

Responses

+

200

+ OK + +
+
+
+
+ Up +
get /api/v1/stats/analytics/outsAboveAverage
+
Get outs above average for the current batter (getOutsAboveAverage)
+
+ + + + + +

Query parameters

+
+
gamePk (required)
+ +
Query Parameter — default: null
timecode (optional)
+ +
Query Parameter — default: null
fields (optional)
+ +
Query Parameter — Comma delimited list of specific fields to be returned. Format: topLevelNode, childNode, attribute default: null
+
+ + + + + + + +

Responses

+

200

+ OK + +
+
+
+
+ Up +
get /api/v1/stats/analytics/sprayChart
+
Get the spray chart info for the current batter (getSprayChart)
+
+ + + + + +

Query parameters

+
+
gamePk (required)
+ +
Query Parameter — default: null
timecode (optional)
+ +
Query Parameter — default: null
fields (optional)
+ +
Query Parameter — Comma delimited list of specific fields to be returned. Format: topLevelNode, childNode, attribute default: null
+
+ + + + + + + +

Responses

+

200

+ OK + +
+
+
+
+ Up +
get /api/v1/stats/analytics/stolenBaseProbability
+
Get the probability of a hit for the given hit data (getStolenBaseProbability)
+
+ + + + + +

Query parameters

+
+
gamePk (required)
+ +
Query Parameter — default: null
timecode (optional)
+ +
Query Parameter — default: null
+
+ + + + + + + +

Responses

+

200

+ OK + +
+
+
+
+ Up +
get /api/v1/stats/grouped
+
View grouped stats (groupedStats)
+
+ + + + + +

Query parameters

+
+
stats (required)
+ +
Query Parameter — Type of statistics. Format: Individual, Team, Career, etc. Available types in /api/v1/statTypes default: null
personId (optional)
+ +
Query Parameter — Unique Player Identifier. Format: 434538, 429665, etc default: null
teamId (optional)
+ +
Query Parameter — Unique Team Identifier. Format: 141, 147, etc default: null
teamIds (optional)
+ +
Query Parameter — Comma delimited list of Unique Team identifiers default: null
group (required)
+ +
Query Parameter — Category of statistic to return. Available types in /api/v1/statGroups default: null
gameType (optional)
+ +
Query Parameter — Type of Game. Available types in /api/v1/gameTypes default: null
season (optional)
+ +
Query Parameter — Season of play default: null
seasons (optional)
+ +
Query Parameter — Comma delimited list of Seasons of play default: null
sportId (optional)
+ +
Query Parameter — Top level organization of a sport default: null
sportIds (optional)
+ +
Query Parameter — Comma delimited list of top level organizations of a sport default: null
leagueId (optional)
+ +
Query Parameter — Unique League Identifier default: null
leagueIds (optional)
+ +
Query Parameter — Comma delimited list of Unique league identifiers default: null
leagueListId (optional)
+ +
Query Parameter — Unique League List Identifier default: null
metrics (optional)
+ +
Query Parameter — Name of metric(s) for metric log stats. Available metrics in /api/v1/metrics default: null
gamePk (optional)
+ +
Query Parameter — Unique Primary Key Representing a Game default: null
batterTeamId (optional)
+ +
Query Parameter — A unique identifier for the batter's team default: null
pitcherTeamId (optional)
+ +
Query Parameter — A unique identifier for the pitcher's team default: null
batterId (optional)
+ +
Query Parameter — Unique Player Identifier. Format: 434538, 429665, etc default: null
pitcherId (optional)
+ +
Query Parameter — Unique Player Identifier. Format: 434538, 429665, etc default: null
sitCodes (optional)
+ +
Query Parameter — Situation code for a given stat split. default: null
combineSits (optional)
+ +
Query Parameter — If true, gathers stats where all of the situational criteria are met. If false, returns stats where any of the situational criteria are met. Default: false default: null
opposingTeamId (optional)
+ +
Query Parameter — A unique identifier for the opposing team. Must be used with Team ID default: null
fields (optional)
+ +
Query Parameter — Comma delimited list of specific fields to be returned. Format: topLevelNode, childNode, attribute default: null
sortStat (optional)
+ +
Query Parameter — Baseball stat to sort splits by. default: null
order (optional)
+ +
Query Parameter — The order of sorting, ascending or descending default: null
playerPool (optional)
+ +
Query Parameter — Return "ALL" or only "QUALIFIED" players based on plate appearances. default: null
position (optional)
+ +
Query Parameter — Position number. Format: 1, 2, 3, etc default: null
startDate (optional)
+ +
Query Parameter — Start date for range of data (must be used with end date). Format: MM/DD/YYYY default: null
endDate (optional)
+ +
Query Parameter — End date for range of data (must be used with start date). Format: MM/DD/YYYY default: null
daysBack (optional)
+ +
Query Parameter — Returns results from the last 'X' days (Starting from yesterday). default: null
gamesBack (optional)
+ +
Query Parameter — Returns results from the last 'X' games played. default: null
excludeTradedPlayers (optional)
+ +
Query Parameter — Excludes players who have since been traded from the input team default: null
offset (optional)
+ +
Query Parameter — The pointer to start for a return set; used for pagination default: null
limit (optional)
+ +
Query Parameter — Number of results to return default: null
statFields (optional)
+ +
Query Parameter — Baseball stat fields to populate default: null
sortField (optional)
+ +
Query Parameter — Baseball statField to sort on. If no statField is given, sortField defaults to BASIC. If 1 statField is given, that is the default sortField. default: null
+
+ + + + + + + +

Responses

+

200

+ OK + +
+
+
+
+ Up +
get /api/v1/stats/leaders
+
Get leaders for a statistic (leaders2)
+
+ + + + + +

Query parameters

+
+
leaderCategories (optional)
+ +
Query Parameter — default: null
leaderGameTypes (optional)
+ +
Query Parameter — default: null
statGroup (optional)
+ +
Query Parameter — default: null
season (optional)
+ +
Query Parameter — default: null
expand (optional)
+ +
Query Parameter — default: null
sportId (optional)
+ +
Query Parameter — default: null
sportIds (optional)
+ +
Query Parameter — default: null
stats (optional)
+ +
Query Parameter — default: null
limit (optional)
+ +
Query Parameter — default: null
offset (optional)
+ +
Query Parameter — default: null
teamId (optional)
+ +
Query Parameter — default: null
teamIds (optional)
+ +
Query Parameter — default: null
leagueId (optional)
+ +
Query Parameter — default: null
leagueIds (optional)
+ +
Query Parameter — default: null
leagueListId (optional)
+ +
Query Parameter — default: null
playerPool (optional)
+ +
Query Parameter — default: null
statType (optional)
+ +
Query Parameter — default: null
playerActive (optional)
+ +
Query Parameter — default: null
position (optional)
+ +
Query Parameter — default: null
sitCodes (optional)
+ +
Query Parameter — default: null
opposingTeamId (optional)
+ +
Query Parameter — default: null
startDate (optional)
+ +
Query Parameter — default: null
endDate (optional)
+ +
Query Parameter — default: null
daysBack (optional)
+ +
Query Parameter — default: null
gamesBack (optional)
+ +
Query Parameter — default: null
groupBy (optional)
+ +
Query Parameter — default: null
fields (optional)
+ +
Query Parameter — default: null
+
+ + + + + + + +

Responses

+

200

+ OK + +
+
+
+
+ Up +
get /api/v1/stats/metrics
+
View metric stats (metricStats)
+
+ + + + + +

Query parameters

+
+
personId (optional)
+ +
Query Parameter — Unique Player Identifier. Format: 434538, 429665, etc default: null
personIds (optional)
+ +
Query Parameter — Unique Player Identifier. Format: 434538, 429665, etc default: null
batterId (optional)
+ +
Query Parameter — Unique Player Identifier. Format: 434538, 429665, etc default: null
pitcherId (optional)
+ +
Query Parameter — Unique Player Identifier. Format: 434538, 429665, etc default: null
teamId (optional)
+ +
Query Parameter — Unique Team Identifier. Format: 141, 147, etc default: null
stats (required)
+ +
Query Parameter — Type of statistics. Format: Individual, Team, Career, etc. Available types in /api/v1/statTypes default: null
group (optional)
+ +
Query Parameter — Category of statistic to return. Available types in /api/v1/statGroups default: null
season (optional)
+ +
Query Parameter — Season of play default: null
seasons (optional)
+ +
Query Parameter — Comma delimited list of Seasons of play default: null
sportId (optional)
+ +
Query Parameter — Top level organization of a sport default: null
opposingTeamId (optional)
+ +
Query Parameter — A unique identifier for the opposing team. Must be used with Team ID default: null
opposingPlayerId (optional)
+ +
Query Parameter — A unique identifier for the opposing team default: null
position (optional)
+ +
Query Parameter — All of the details of a player's position default: null
eventType (optional)
+ +
Query Parameter — Type of event default: null
pitchType (optional)
+ +
Query Parameter — Classification of pitch (fastball, curveball, etc...) default: null
hitTrajectory (optional)
+ +
Query Parameter — Trajectory of hit (line drive, fly ball, etc...) default: null
batSide (optional)
+ +
Query Parameter — Bat side of hitter default: null
pitchHand (optional)
+ +
Query Parameter — Handedness of pitcher default: null
venueId (optional)
+ +
Query Parameter — All of the details of a venue default: null
metrics (required)
+ +
Query Parameter — Name of metric(s) for metric log stats. Available metrics in /api/v1/metrics default: null
gamePk (optional)
+ +
Query Parameter — Unique Primary Key Representing a Game default: null
minValue (optional)
+ +
Query Parameter — Minimum value to filter on default: null
maxValue (optional)
+ +
Query Parameter — Maximum value to filter on default: null
percentile (optional)
+ +
Query Parameter — Only return averages above this percentile. used for best effort plays default: null
minOccurrences (optional)
+ +
Query Parameter — Minimum occurrences to filter upon default: null
offset (optional)
+ +
Query Parameter — The pointer to start for a return set; used for pagination default: null
limit (optional)
+ +
Query Parameter — Number of results to return default: null
order (optional)
+ +
Query Parameter — The order of sorting, ascending or descending default: null
date (optional)
+ +
Query Parameter — Date of Game. Format: YYYY-MM-DD default: null
startDate (optional)
+ +
Query Parameter — Start date for range of data (must be used with end date). Format: MM/DD/YYYY default: null
endDate (optional)
+ +
Query Parameter — End date for range of data (must be used with start date). Format: MM/DD/YYYY default: null
gameType (optional)
+ +
Query Parameter — Type of Game. Available types in /api/v1/gameTypes default: null
batterTeamId (optional)
+ +
Query Parameter — A unique identifier for the batter's team default: null
pitcherTeamId (optional)
+ +
Query Parameter — A unique identifier for the pitcher's team default: null
fields (optional)
+ +
Query Parameter — Comma delimited list of specific fields to be returned. Format: topLevelNode, childNode, attribute default: null
debug (optional)
+ +
Query Parameter — default: null
+
+ + + + + + + +

Responses

+

200

+ OK + +
+
+
+
+ Up +
get /api/v1/stats
+
View stats (stats2)
+
+ + + + + +

Query parameters

+
+
stats (required)
+ +
Query Parameter — Type of statistics. Format: Individual, Team, Career, etc. Available types in /api/v1/statTypes default: null
personId (optional)
+ +
Query Parameter — Unique Player Identifier. Format: 434538, 429665, etc default: null
teamId (optional)
+ +
Query Parameter — Unique Team Identifier. Format: 141, 147, etc default: null
teamIds (optional)
+ +
Query Parameter — Comma delimited list of Unique Team identifiers default: null
group (required)
+ +
Query Parameter — Category of statistic to return. Available types in /api/v1/statGroups default: null
gameType (optional)
+ +
Query Parameter — Type of Game. Available types in /api/v1/gameTypes default: null
season (optional)
+ +
Query Parameter — Season of play default: null
seasons (optional)
+ +
Query Parameter — Comma delimited list of Seasons of play default: null
sportId (optional)
+ +
Query Parameter — Top level organization of a sport default: null
sportIds (optional)
+ +
Query Parameter — Comma delimited list of top level organizations of a sport default: null
leagueId (optional)
+ +
Query Parameter — Unique League Identifier default: null
leagueIds (optional)
+ +
Query Parameter — Comma delimited list of Unique league identifiers default: null
leagueListId (optional)
+ +
Query Parameter — Unique League List Identifier default: null
metrics (optional)
+ +
Query Parameter — Name of metric(s) for metric log stats. Available metrics in /api/v1/metrics default: null
gamePk (optional)
+ +
Query Parameter — Unique Primary Key Representing a Game default: null
batterTeamId (optional)
+ +
Query Parameter — A unique identifier for the batter's team default: null
pitcherTeamId (optional)
+ +
Query Parameter — A unique identifier for the pitcher's team default: null
batterId (optional)
+ +
Query Parameter — Unique Player Identifier. Format: 434538, 429665, etc default: null
pitcherId (optional)
+ +
Query Parameter — Unique Player Identifier. Format: 434538, 429665, etc default: null
sitCodes (optional)
+ +
Query Parameter — Situation code for a given stat split. default: null
combineSits (optional)
+ +
Query Parameter — If true, gathers stats where all of the situational criteria are met. If false, returns stats where any of the situational criteria are met. Default: false default: null
opposingTeamId (optional)
+ +
Query Parameter — A unique identifier for the opposing team. Must be used with Team ID default: null
fields (optional)
+ +
Query Parameter — default: null
sortStat (optional)
+ +
Query Parameter — Baseball stat to sort splits by. default: null
order (optional)
+ +
Query Parameter — The order of sorting, ascending or descending default: null
playerPool (optional)
+ +
Query Parameter — Return "ALL" or only "QUALIFIED" players based on plate appearances. default: null
position (optional)
+ +
Query Parameter — Position number. Format: 1, 2, 3, etc default: null
startDate (optional)
+ +
Query Parameter — Start date for range of data (must be used with end date). Format: MM/DD/YYYY default: null
endDate (optional)
+ +
Query Parameter — End date for range of data (must be used with start date). Format: MM/DD/YYYY default: null
daysBack (optional)
+ +
Query Parameter — Returns results from the last 'X' days (Starting from yesterday). default: null
gamesBack (optional)
+ +
Query Parameter — Returns results from the last 'X' games played. default: null
excludeTradedPlayers (optional)
+ +
Query Parameter — Excludes players who have since been traded from the input team default: null
offset (optional)
+ +
Query Parameter — The pointer to start for a return set; used for pagination default: null
limit (optional)
+ +
Query Parameter — Number of results to return default: null
+
+ + + + + + + +

Responses

+

200

+ OK + +
+
+

Streaks

+
+
+ Up +
get /api/v1/streaks
+
View streaks (getStreaks)
+
+ + + + + +

Query parameters

+
+
streakOrg (optional)
+ +
Query Parameter — default: null
streakStat (optional)
+ +
Query Parameter — default: null
streakSpan (optional)
+ +
Query Parameter — default: null
streakLevel (optional)
+ +
Query Parameter — default: null
streakThreshold (optional)
+ +
Query Parameter — default: null
inverse (optional)
+ +
Query Parameter — default: null
startersOnly (optional)
+ +
Query Parameter — default: null
statGroup (optional)
+ +
Query Parameter — Category of statistic to return. Available types in /api/v1/statGroups default: null
gameType (optional)
+ +
Query Parameter — Type of Game. Available types in /api/v1/gameTypes default: null
season (optional)
+ +
Query Parameter — Season of play default: null
teamId (optional)
+ +
Query Parameter — Unique Team Identifier. Format: 141, 147, etc default: null
leagueId (optional)
+ +
Query Parameter — Unique League Identifier default: null
sportId (optional)
+ +
Query Parameter — Top level organization of a sport default: null
activeStreak (optional)
+ +
Query Parameter — Whether or not a player is active default: null
limit (optional)
+ +
Query Parameter — Number of results to return default: null
fields (optional)
+ +
Query Parameter — Comma delimited list of specific fields to be returned. Format: topLevelNode, childNode, attribute default: null
playerId (optional)
+ +
Query Parameter — A unique identifier for a player default: null
+
+ + + + + + + +

Responses

+

200

+ OK + +
+
+
+
+ Up +
get /api/v1/streaks/types
+
View streaks parameter options (streakTypes)
+
+ + + + + + + + + + + + +

Responses

+

200

+ OK + +
+
+

Teams

+
+
+ Up +
get /api/v1/teams/{teamId}/affiliates
+
View team and affiliate teams (affiliates)
+
+ +

Path parameters

+
+
teamId (required)
+ +
Path Parameter — Unique Team Identifier. Format: 141, 147, etc default: null
+
+ + + + +

Query parameters

+
+
teamIds (optional)
+ +
Query Parameter — Unique Team Identifier. Format: 141, 147, etc default: null
sportId (optional)
+ +
Query Parameter — Top level organization of a sport default: null
season (optional)
+ +
Query Parameter — Season of play default: null
gameType (optional)
+ +
Query Parameter — Type of Game. Available types in /api/v1/gameTypes default: null
fields (optional)
+ +
Query Parameter — Comma delimited list of specific fields to be returned. Format: topLevelNode, childNode, attribute default: null
+
+ + + + + + + +

Responses

+

200

+ OK + +
+
+
+
+ Up +
get /api/v1/teams/affiliates
+
View team and affiliate teams (affiliates1)
+
+ +

Path parameters

+
+
teamId (required)
+ +
Path Parameter — Unique Team Identifier. Format: 141, 147, etc default: null
+
+ + + + +

Query parameters

+
+
teamIds (optional)
+ +
Query Parameter — Unique Team Identifier. Format: 141, 147, etc default: null
sportId (optional)
+ +
Query Parameter — Top level organization of a sport default: null
season (optional)
+ +
Query Parameter — Season of play default: null
gameType (optional)
+ +
Query Parameter — Type of Game. Available types in /api/v1/gameTypes default: null
fields (optional)
+ +
Query Parameter — Comma delimited list of specific fields to be returned. Format: topLevelNode, childNode, attribute default: null
+
+ + + + + + + +

Responses

+

200

+ OK + +
+
+
+
+ Up +
get /api/v1/teams/{teamId}/history
+
View historical records for a list of teams (allTeams)
+
+ +

Path parameters

+
+
teamId (required)
+ +
Path Parameter — Unique Team Identifier. Format: 141, 147, etc default: null
+
+ + + + +

Query parameters

+
+
teamIds (optional)
+ +
Query Parameter — Comma delimited list of Unique Team identifiers default: null
startSeason (optional)
+ +
Query Parameter — Start date for range of data (used with end date optionally). Example: '2018' or '2018.2' default: null
endSeason (optional)
+ +
Query Parameter — End date for range of data (used with start date optionally). Format: '2018' or '2018.2' default: null
fields (optional)
+ +
Query Parameter — default: null
+
+ + + + + + + +

Responses

+

200

+ OK + +
+
+
+
+ Up +
get /api/v1/teams/history
+
View historical records for a list of teams (allTeams1)
+
+ +

Path parameters

+
+
teamId (required)
+ +
Path Parameter — Unique Team Identifier. Format: 141, 147, etc default: null
+
+ + + + +

Query parameters

+
+
teamIds (optional)
+ +
Query Parameter — Comma delimited list of Unique Team identifiers default: null
startSeason (optional)
+ +
Query Parameter — Start date for range of data (used with end date optionally). Example: '2018' or '2018.2' default: null
endSeason (optional)
+ +
Query Parameter — End date for range of data (used with start date optionally). Format: '2018' or '2018.2' default: null
fields (optional)
+ +
Query Parameter — default: null
+
+ + + + + + + +

Responses

+

200

+ OK + +
+
+
+
+ Up +
get /api/v1/teams/{teamId}/alumni
+
View all team alumni (alumni)
+
+ +

Path parameters

+
+
teamId (required)
+ +
Path Parameter — Unique Team Identifier. Format: 141, 147, etc default: null
+
+ + + + +

Query parameters

+
+
season (required)
+ +
Query Parameter — Season of play default: null
group (optional)
+ +
Query Parameter — Category of statistic to return. Available types in /api/v1/statGroups default: null
fields (optional)
+ +
Query Parameter — default: null
+
+ + + + + + + +

Responses

+

200

+ OK + +
+
+
+
+ Up +
get /api/v1/teams/{teamId}/coaches
+
View all coaches for a team (coaches)
+
+ +

Path parameters

+
+
teamId (required)
+ +
Path Parameter — Unique Team Identifier. Format: 141, 147, etc default: null
+
+ + + + +

Query parameters

+
+
season (optional)
+ +
Query Parameter — Season of play default: null
date (optional)
+ +
Query Parameter — Date of Game. Format: YYYY-MM-DD default: null
fields (optional)
+ +
Query Parameter — default: null
+
+ + + + + + + +

Responses

+

200

+ OK + +
+
+
+
+ Up +
get /api/v1/teams/{teamId}/leaders
+
View team stat leaders (leaders)
+
+ +

Path parameters

+
+
teamId (required)
+ +
Path Parameter — default: null
+
+ + + + +

Query parameters

+
+
leaderCategories (optional)
+ +
Query Parameter — default: null
season (optional)
+ +
Query Parameter — default: null
leaderGameTypes (optional)
+ +
Query Parameter — default: null
expand (optional)
+ +
Query Parameter — default: null
limit (optional)
+ +
Query Parameter — default: null
offset (optional)
+ +
Query Parameter — default: null
playerPool (optional)
+ +
Query Parameter — default: null
fields (optional)
+ +
Query Parameter — default: null
+
+ + + + + + + +

Responses

+

200

+ OK + +
+
+
+
+ Up +
get /api/v1/teams/stats/leaders
+
View leaders for team stats (leaders1)
+
+ + + + + +

Query parameters

+
+
leaderCategories (optional)
+ +
Query Parameter — TBD default: null
gameTypes (optional)
+ +
Query Parameter — Type of Game. Available types in /api/v1/gameTypes default: null
stats (optional)
+ +
Query Parameter — Type of statistics. Format: Individual, Team, Career, etc. Available types in /api/v1/statTypes default: null
statType (optional)
+ +
Query Parameter — default: null
sportId (optional)
+ +
Query Parameter — Top level organization of a sport default: null
sportIds (optional)
+ +
Query Parameter — Comma delimited list of top level organizations of a sport default: null
leagueId (optional)
+ +
Query Parameter — Unique League Identifier default: null
leagueIds (optional)
+ +
Query Parameter — Comma delimited list of Unique league identifiers default: null
season (optional)
+ +
Query Parameter — Season of play default: null
statGroup (optional)
+ +
Query Parameter — Category of statistic to return. Available types in /api/v1/statGroups default: null
group (optional)
+ +
Query Parameter — Category of statistic to return. Available types in /api/v1/statGroups default: null
startDate (optional)
+ +
Query Parameter — Start date for range of data (must be used with end date). Format: MM/DD/YYYY default: null
endDate (optional)
+ +
Query Parameter — End date for range of data (must be used with start date). Format: MM/DD/YYYY default: null
daysBack (optional)
+ +
Query Parameter — Returns results from the last 'X' days (Starting from yesterday). default: null
sitCodes (optional)
+ +
Query Parameter — Situation code for a given stat split. default: null
opposingTeamId (optional)
+ +
Query Parameter — A unique identifier for the opposing team. Must be used with Team ID default: null
limit (optional)
+ +
Query Parameter — Number of results to return default: null
offset (optional)
+ +
Query Parameter — The pointer to start for a return set; used for pagination default: null
fields (optional)
+ +
Query Parameter — default: null
+
+ + + + + + + +

Responses

+

200

+ OK + +
+
+
+
+ Up +
get /api/v1/teams/{teamId}/personnel
+
View all coaches for a team (personnel)
+
+ +

Path parameters

+
+
teamId (required)
+ +
Path Parameter — Unique Team Identifier. Format: 141, 147, etc default: null
+
+ + + + +

Query parameters

+
+
season (optional)
+ +
Query Parameter — Season of play default: null
date (optional)
+ +
Query Parameter — Date of Game. Format: YYYY-MM-DD default: null
fields (optional)
+ +
Query Parameter — default: null
+
+ + + + + + + +

Responses

+

200

+ OK + +
+
+
+
+ Up +
get /api/v1/teams/{teamId}/roster
+
View a teams roster (roster)
+
This endpoint allows you to pull teams
+ +

Path parameters

+
+
teamId (required)
+ +
Path Parameter — Unique Team Identifier. Format: 141, 147, etc default: null
rosterType (required)
+ +
Path Parameter — Type of roster. Available types in /api/v1/rosterTypes default: null
+
+ + + + +

Query parameters

+
+
season (optional)
+ +
Query Parameter — Season of play default: null
date (optional)
+ +
Query Parameter — Date of Game. Format: YYYY-MM-DD default: null
gameType (optional)
+ +
Query Parameter — Type of Game. Available types in /api/v1/gameTypes default: null
fields (optional)
+ +
Query Parameter — Comma delimited list of specific fields to be returned. Format: topLevelNode, childNode, attribute default: null
+
+ + + + + + + +

Responses

+

200

+ OK + +
+
+
+
+ Up +
get /api/v1/teams/{teamId}/roster/{rosterType}
+
View a teams roster (roster1)
+
This endpoint allows you to pull teams
+ +

Path parameters

+
+
teamId (required)
+ +
Path Parameter — Unique Team Identifier. Format: 141, 147, etc default: null
rosterType (required)
+ +
Path Parameter — Type of roster. Available types in /api/v1/rosterTypes default: null
+
+ + + + +

Query parameters

+
+
season (optional)
+ +
Query Parameter — Season of play default: null
date (optional)
+ +
Query Parameter — Date of Game. Format: YYYY-MM-DD default: null
gameType (optional)
+ +
Query Parameter — Type of Game. Available types in /api/v1/gameTypes default: null
fields (optional)
+ +
Query Parameter — Comma delimited list of specific fields to be returned. Format: topLevelNode, childNode, attribute default: null
+
+ + + + + + + +

Responses

+

200

+ OK + +
+
+
+
+ Up +
get /api/v1/teams/{teamId}/stats
+
View a teams stats (stats)
+
+ +

Path parameters

+
+
teamId (required)
+ +
Path Parameter — Unique Team Identifier. Format: 141, 147, etc default: null
+
+ + + + +

Query parameters

+
+
sportId (optional)
+ +
Query Parameter — Top level organization of a sport default: null
season (optional)
+ +
Query Parameter — Season of play default: null
gameType (optional)
+ +
Query Parameter — Type of Game. Available types in /api/v1/gameTypes default: null
stats (optional)
+ +
Query Parameter — Type of statistics. Format: Individual, Team, Career, etc. Available types in /api/v1/statTypes default: null
group (required)
+ +
Query Parameter — Category of statistic to return. Available types in /api/v1/statGroups default: null
sortStat (optional)
+ +
Query Parameter — Baseball stat to sort splits by. default: null
order (optional)
+ +
Query Parameter — The order of sorting, ascending or descending default: null
groupBy (optional)
+ +
Query Parameter — Group stats by PLAYER, TEAM, SEASON, VENUE, SPORT or STAT_GROUP default: null
opposingTeamId (optional)
+ +
Query Parameter — A unique identifier for the opposing team. Must be used with Team ID default: null
opposingPlayerId (optional)
+ +
Query Parameter — A unique identifier for the opposing team default: null
sitCodes (optional)
+ +
Query Parameter — Situation code for a given stat split. default: null
startDate (optional)
+ +
Query Parameter — Start date for range of data (must be used with end date). Format: MM/DD/YYYY default: null
endDate (optional)
+ +
Query Parameter — End date for range of data (must be used with start date). Format: MM/DD/YYYY default: null
fields (optional)
+ +
Query Parameter — Comma delimited list of specific fields to be returned. Format: topLevelNode, childNode, attribute default: null
+
+ + + + + + + +

Responses

+

200

+ OK + +
+
+
+
+ Up +
get /api/v1/teams/stats
+
View a teams stats (stats1)
+
+ + + + + +

Query parameters

+
+
gameType (optional)
+ +
Query Parameter — Type of Game. Available types in /api/v1/gameTypes default: null
stats (optional)
+ +
Query Parameter — Type of statistics. Format: Individual, Team, Career, etc. Available types in /api/v1/statTypes default: null
sportId (optional)
+ +
Query Parameter — Top level organization of a sport default: null
sportIds (optional)
+ +
Query Parameter — Comma delimited list of top level organizations of a sport default: null
leagueIds (optional)
+ +
Query Parameter — Comma delimited list of Unique league identifiers default: null
season (optional)
+ +
Query Parameter — Season of play default: null
group (required)
+ +
Query Parameter — Category of statistic to return. Available types in /api/v1/statGroups default: null
sortStat (optional)
+ +
Query Parameter — Baseball stat to sort splits by. default: null
order (optional)
+ +
Query Parameter — The order of sorting, ascending or descending default: null
startDate (optional)
+ +
Query Parameter — Start date for range of data (must be used with end date). Format: MM/DD/YYYY default: null
endDate (optional)
+ +
Query Parameter — End date for range of data (must be used with start date). Format: MM/DD/YYYY default: null
daysBack (optional)
+ +
Query Parameter — Returns results from the last 'X' days (Starting from yesterday). default: null
sitCodes (optional)
+ +
Query Parameter — Situation code for a given stat split. default: null
combineSits (optional)
+ +
Query Parameter — If true, gathers stats where all of the situational criteria are met. If false, returns stats where any of the situational criteria are met. Default: false default: null
opposingTeamId (optional)
+ +
Query Parameter — A unique identifier for the opposing team. Must be used with Team ID default: null
offset (optional)
+ +
Query Parameter — The pointer to start for a return set; used for pagination default: null
limit (optional)
+ +
Query Parameter — Number of results to return default: null
fields (optional)
+ +
Query Parameter — default: null
+
+ + + + + + + +

Responses

+

200

+ OK + +
+
+
+
+ Up +
get /api/v1/teams
+
View info for all teams (teams)
+
This endpoint allows you to pull teams
+ +

Path parameters

+
+
teamId (required)
+ +
Path Parameter — Unique Team Identifier. Format: 141, 147, etc default: null
+
+ + + + +

Query parameters

+
+
season (optional)
+ +
Query Parameter — Season of play default: null
sportId (optional)
+ +
Query Parameter — Top level organization of a sport default: null
divisionId (optional)
+ +
Query Parameter — Unique Division Identifier default: null
gameType (optional)
+ +
Query Parameter — Type of Game. Available types in /api/v1/gameTypes default: null
leagueIds (optional)
+ +
Query Parameter — Comma delimited list of Unique league identifiers default: null
sportIds (optional)
+ +
Query Parameter — Comma delimited list of top level organizations of a sport default: null
activeStatus (optional)
+ +
Query Parameter — Flag for fetching teams that are currently active (Y), inactive (N), pending (P), or all teams (B) default: null
leagueListId (optional)
+ +
Query Parameter — Unique League List Identifier default: null
allStarStatuses (optional)
+ +
Query Parameter — default: null
fields (optional)
+ +
Query Parameter — Comma delimited list of specific fields to be returned. Format: topLevelNode, childNode, attribute default: null
+
+ + + + + + + +

Responses

+

200

+ OK + +
+
+
+
+ Up +
get /api/v1/teams/{teamId}
+
View info for all teams (teams1)
+
This endpoint allows you to pull teams
+ +

Path parameters

+
+
teamId (required)
+ +
Path Parameter — Unique Team Identifier. Format: 141, 147, etc default: null
+
+ + + + +

Query parameters

+
+
season (optional)
+ +
Query Parameter — Season of play default: null
sportId (optional)
+ +
Query Parameter — Top level organization of a sport default: null
divisionId (optional)
+ +
Query Parameter — Unique Division Identifier default: null
gameType (optional)
+ +
Query Parameter — Type of Game. Available types in /api/v1/gameTypes default: null
leagueIds (optional)
+ +
Query Parameter — Comma delimited list of Unique league identifiers default: null
sportIds (optional)
+ +
Query Parameter — Comma delimited list of top level organizations of a sport default: null
activeStatus (optional)
+ +
Query Parameter — Flag for fetching teams that are currently active (Y), inactive (N), pending (P), or all teams (B) default: null
leagueListId (optional)
+ +
Query Parameter — Unique League List Identifier default: null
allStarStatuses (optional)
+ +
Query Parameter — default: null
fields (optional)
+ +
Query Parameter — Comma delimited list of specific fields to be returned. Format: topLevelNode, childNode, attribute default: null
+
+ + + + + + + +

Responses

+

200

+ OK + +
+
+
+
+ Up +
post /api/v1/teams/{teamId}/alumni
+
(updateAlumni)
+
+ +

Path parameters

+
+
teamId (required)
+ +
Path Parameter — Unique Team Identifier. Format: 141, 147, etc default: null
+
+ + + + +

Query parameters

+
+
season (required)
+ +
Query Parameter — Season of play default: null
group (optional)
+ +
Query Parameter — Category of statistic to return. Available types in /api/v1/statGroups default: null
fields (optional)
+ +
Query Parameter — default: null
+
+ + + + + + + +

Responses

+

200

+ OK + +
+
+

Transactions

+
+
+ Up +
get /api/v1/transactions
+
View transaction info (transactions)
+
This endpoint allows you to pull transactions.
+ + + + + +

Query parameters

+
+
leagueId (optional)
+ +
Query Parameter — Comma delimited list of Unique league identifiers default: null
sportId (optional)
+ +
Query Parameter — Comma delimited list of top level organizations of a sport default: null
teamId (optional)
+ +
Query Parameter — Comma delimited list of Unique Team identifiers default: null
playerId (optional)
+ +
Query Parameter — A unique identifier for a player default: null
date (optional)
+ +
Query Parameter — Date of Game. Format: YYYY-MM-DD default: null
startDate (optional)
+ +
Query Parameter — Start date for range of data (must be used with end date). Format: MM/DD/YYYY default: null
endDate (optional)
+ +
Query Parameter — End date for range of data (must be used with start date). Format: MM/DD/YYYY default: null
transactionIds (optional)
+ +
Query Parameter — default: null
transactionTypes (optional)
+ +
Query Parameter — default: null
divisionIds (optional)
+ +
Query Parameter — default: null
order (optional)
+ +
Query Parameter — default: null
limit (optional)
+ +
Query Parameter — default: null
fields (optional)
+ +
Query Parameter — Comma delimited list of specific fields to be returned. Format: topLevelNode, childNode, attribute default: null
+
+ + + + + + + +

Responses

+

200

+ OK + +
+
+

Uniforms

+
+
+ Up +
get /api/v1/uniforms/game
+
View Game Uniform info (uniformsByGame)
+
This endpoint allows you to pull team uniform data for a game
+ + + + + +

Query parameters

+
+
gamePks (required)
+ +
Query Parameter — Comma delimited list of unique primary keys default: null
fields (optional)
+ +
Query Parameter — Comma delimited list of specific fields to be returned. Format: topLevelNode, childNode, attribute default: null
+
+ + + + + + + +

Responses

+

200

+ OK + +
+
+
+
+ Up +
get /api/v1/uniforms/team
+
View Team Uniform info (uniformsByTeam)
+
This endpoint allows you to pull team uniform data for a season
+ + + + + +

Query parameters

+
+
teamIds (required)
+ +
Query Parameter — default: null
season (optional)
+ +
Query Parameter — Season of play default: null
fields (optional)
+ +
Query Parameter — Comma delimited list of specific fields to be returned. Format: topLevelNode, childNode, attribute default: null
+
+ + + + + + + +

Responses

+

200

+ OK + +
+
+

Venues

+
+
+ Up +
get /api/v1/venues
+
View venue info (venues)
+
This endpoint allows you to pull venues
+ +

Path parameters

+
+
venueId (required)
+ +
Path Parameter — Unique Venue Identifier default: null
+
+ + + + +

Query parameters

+
+
venueIds (optional)
+ +
Query Parameter — Comma delimited list of Unique venue identifiers default: null
leagueId (optional)
+ +
Query Parameter — Unique League Identifier default: null
leagueIds (optional)
+ +
Query Parameter — Comma delimited list of Unique league identifiers default: null
gameType (optional)
+ +
Query Parameter — Type of Game. Available types in /api/v1/gameTypes default: null
gameTypes (optional)
+ +
Query Parameter — Comma delimited list of type of Game. Available types in /api/v1/gameTypes default: null
season (optional)
+ +
Query Parameter — Season of play default: null
seasons (optional)
+ +
Query Parameter — Comma delimited list of Seasons of play default: null
fields (optional)
+ +
Query Parameter — Comma delimited list of specific fields to be returned. Format: topLevelNode, childNode, attribute default: null
active (optional)
+ +
Query Parameter — Whether or not a player is active default: null
includeEvents (optional)
+ +
Query Parameter — default: null
sportId (optional)
+ +
Query Parameter — Top level organization of a sport default: null
sportIds (optional)
+ +
Query Parameter — Comma delimited list of top level organizations of a sport default: null
+
+ + + + + + + +

Responses

+

200

+ OK + +
+
+
+
+ Up +
get /api/v1/venues/{venueId}
+
View venue info (venues1)
+
This endpoint allows you to pull venues
+ +

Path parameters

+
+
venueId (required)
+ +
Path Parameter — Unique Venue Identifier default: null
+
+ + + + +

Query parameters

+
+
venueIds (optional)
+ +
Query Parameter — Comma delimited list of Unique venue identifiers default: null
leagueId (optional)
+ +
Query Parameter — Unique League Identifier default: null
leagueIds (optional)
+ +
Query Parameter — Comma delimited list of Unique league identifiers default: null
gameType (optional)
+ +
Query Parameter — Type of Game. Available types in /api/v1/gameTypes default: null
gameTypes (optional)
+ +
Query Parameter — Comma delimited list of type of Game. Available types in /api/v1/gameTypes default: null
season (optional)
+ +
Query Parameter — Season of play default: null
seasons (optional)
+ +
Query Parameter — Comma delimited list of Seasons of play default: null
fields (optional)
+ +
Query Parameter — Comma delimited list of specific fields to be returned. Format: topLevelNode, childNode, attribute default: null
active (optional)
+ +
Query Parameter — Whether or not a player is active default: null
includeEvents (optional)
+ +
Query Parameter — default: null
sportId (optional)
+ +
Query Parameter — Top level organization of a sport default: null
sportIds (optional)
+ +
Query Parameter — Comma delimited list of top level organizations of a sport default: null
+
+ + + + + + + +

Responses

+

200

+ OK + +
+
+

Weather

+
+
+ Up +
get /api/v1/weather/venues/{venueId}/basic
+
Get basic weather for a venue. (weatherBasic)
+
Returns a json file containing basic weather for a specific venue.
+ +

Path parameters

+
+
venueId (required)
+ +
Path Parameter — Unique Venue Identifier default: null
+
+ + + + +

Query parameters

+
+
fields (optional)
+ +
Query Parameter — Comma delimited list of specific fields to be returned. Format: topLevelNode, childNode, attribute default: null
+
+ + + + + + + +

Responses

+

200

+ OK + +
+
+
+
+ Up +
get /api/v1/weather/game/{gamePk}/{playId}
+
Get the raw field weather data. (weatherDataBasedOnPlay)
+
Returns a json file containing weather for the current play.
+ +

Path parameters

+
+
gamePk (required)
+ +
Path Parameter — Unique Primary Key Representing a Game default: null
playId (required)
+ +
Path Parameter — Unique identifier for a play within a game default: null
+
+ + + + +

Query parameters

+
+
fields (optional)
+ +
Query Parameter — Comma delimited list of specific fields to be returned. Format: topLevelNode, childNode, attribute default: null
+
+ + + + + + + +

Responses

+

200

+ OK + +
+
+
+
+ Up +
get /api/v1/weather/game/{gamePk}/forecast/{roofType}
+
Get the weather forecast for a game. (weatherForecast)
+
Returns a json file containing the weather forecast for a specific game.
+ +

Path parameters

+
+
gamePk (required)
+ +
Path Parameter — Unique Primary Key Representing a Game default: null
roofType (required)
+ +
Path Parameter — Venue roof type default: null
+
+ + + + +

Query parameters

+
+
fields (optional)
+ +
Query Parameter — Comma delimited list of specific fields to be returned. Format: topLevelNode, childNode, attribute default: null
+
+ + + + + + + +

Responses

+

200

+ OK + +
+
+
+
+ Up +
get /api/v1/weather/venues/{venueId}/full
+
Get full weather for a venue. (weatherFull)
+
Returns a json file containing full weather for a specific venue.
+ +

Path parameters

+
+
venueId (required)
+ +
Path Parameter — Unique Venue Identifier default: null
+
+ + + + +

Query parameters

+
+
fields (optional)
+ +
Query Parameter — Comma delimited list of specific fields to be returned. Format: topLevelNode, childNode, attribute default: null
+
+ + + + + + + +

Responses

+

200

+ OK + +
+
+ +

Models

+ [ Jump to Methods ] + +

Table of Contents

+
    +
+ + +