filifa
/
mlbstats
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
mlbstats/api/api/openapi.yaml

7120 lines
203 KiB
YAML
Raw Permalink Blame History

openapi: 3.0.1
info:
description: Official API for Major League Baseball.
title: Stats API Documentation
version: 2.0.0
servers:
- url: /
tags:
- name: Reviews
- description: 'Operations pertaining to bat tracking data '
name: Bat Tracking
- name: Attendance
- description: Operations pertaining to leagues
name: League
- name: Predictions
- description: Operations pertaining to sports
name: Sports
- description: 'Operations pertaining to weather data '
name: Weather
- name: Misc
- description: Operations pertaining to high/low stats
name: High/Low
- description: Operations pertaining to jobs
name: Job
- description: Operations pertaining to divisions
name: Division
- description: Operations pertaining to games
name: Game
- description: Config elements
name: Misc
- description: Operations pertaining to home run derby
name: Homerun Derby
- description: Collapsed tags
name: Closed
x-tag-expanded: "false"
- description: Endpoints for stats streaks
name: Streaks
- description: Operations pertaining to stats
name: Stats
- description: Operations pertaining to venues
name: Venues
- description: Operations pertaining to players
name: Person
- description: Operations pertaining to awards
name: Awards
- name: Game Pace
- description: Operations pertaining to field tracking and analytics.
name: analytics
x-tag-expanded: "true"
- description: Operations pertaining to broadcasts
name: Broadcast
- description: Operations pertaining to schedules
name: Schedule
x-tag-expanded: "false"
- description: Operations pertaining to uniforms
name: Uniforms
- description: Operations pertaining to MLB BaseballDraft
name: Draft
- description: Operations pertaining to teams
name: Teams
- description: 'Operations pertaining to biomechanical data '
name: Biomechanics
- description: Operations pertaining to teams
name: Standings
- description: Operations pertaining to conferences
name: Conference
- description: Operations pertaining to transactions
name: Transactions
- description: 'Operations pertaining to skeletal data '
name: Skeletal
- description: Operations pertaining to seasons
name: Season
- description: Operations pertaining to milestones
name: Milestones
paths:
/api/v1/teams/{teamId}/alumni:
get:
operationId: alumni
parameters:
- description: "Unique Team Identifier. Format: 141, 147, etc"
in: path
name: teamId
required: true
schema: {}
- description: Season of play
in: query
name: season
required: true
schema: {}
- description: Category of statistic to return. Available types in /api/v1/statGroups
in: query
name: group
schema: {}
- in: query
name: fields
schema: {}
responses:
"200":
content: {}
description: OK
summary: View all team alumni
tags:
- Teams
post:
operationId: updateAlumni
parameters:
- description: "Unique Team Identifier. Format: 141, 147, etc"
in: path
name: teamId
required: true
schema: {}
- description: Season of play
in: query
name: season
required: true
schema: {}
- description: Category of statistic to return. Available types in /api/v1/statGroups
in: query
name: group
schema: {}
- in: query
name: fields
schema: {}
responses:
"200":
content: {}
description: OK
security:
- basicAuth: []
- bearerAuth: []
tags:
- Teams
/api/v1/jobTypes:
get:
operationId: jobTypes
parameters:
- description: "Comma delimited list of specific fields to be returned. Format:\
\ topLevelNode, childNode, attribute"
in: query
name: fields
schema: {}
responses:
"200":
content: {}
description: OK
summary: List all job types
tags:
- Misc
post:
operationId: updateJobTypes
responses:
"200":
content: {}
description: OK
tags:
- Misc
/api/v1/gameStatus:
get:
operationId: gameStatus
responses:
"200":
content: {}
description: OK
summary: List all status types
tags:
- Misc
post:
operationId: updateGameStatuses
responses:
"200":
content: {}
description: OK
security:
- basicAuth: []
- bearerAuth: []
summary: Clear all status types
tags:
- Misc
/api/v1/game/{gamePk}/{guid}/contextMetricsAverages:
get:
description: "Returns a json file containing raw coordinate data and refined\
\ calculated metrics.<br/><br/>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."
operationId: contextMetricsWithAverages
parameters:
- description: Unique Primary Key Representing a Game
in: path
name: gamePk
required: true
schema: {}
- description: Unique identifier for a play within a game
in: path
name: guid
required: true
schema: {}
- description: "Comma delimited list of specific fields to be returned. Format:\
\ topLevelNode, childNode, attribute"
in: query
name: fields
schema: {}
responses:
"200":
content: {}
description: OK
security:
- basicAuth: []
- bearerAuth: []
summary: Get a json file containing raw coordinate data and refined calculated
metrics.
tags:
- analytics
post:
description: "Returns a json file containing raw coordinate data and refined\
\ calculated metrics.<br/><br/>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."
operationId: contextMetricsWithAveragesPost
parameters:
- description: Unique Primary Key Representing a Game
in: path
name: gamePk
required: true
schema: {}
- description: Unique identifier for a play within a game
in: path
name: guid
required: true
schema: {}
- description: "Comma delimited list of specific fields to be returned. Format:\
\ topLevelNode, childNode, attribute"
in: query
name: fields
schema: {}
responses:
"200":
content: {}
description: OK
security:
- basicAuth: []
- bearerAuth: []
summary: Get a json file containing raw coordinate data and refined calculated
metrics.
tags:
- analytics
/api/v1/windDirection:
get:
operationId: windDirection
parameters:
- description: "Comma delimited list of specific fields to be returned. Format:\
\ topLevelNode, childNode, attribute"
in: query
name: fields
schema: {}
responses:
"200":
content: {}
description: OK
summary: List all wind direction options
tags:
- Misc
/api/v1/weatherTrajectoryConfidences:
get:
operationId: weatherTrajectoryConfidences
responses:
"200":
content: {}
description: OK
summary: List all weather trajectories
tags:
- Misc
/api/v1/weather/venues/{venueId}/full:
get:
description: Returns a json file containing full weather for a specific venue.
operationId: weatherFull
parameters:
- description: Unique Venue Identifier
in: path
name: venueId
required: true
schema: {}
- description: "Comma delimited list of specific fields to be returned. Format:\
\ topLevelNode, childNode, attribute"
in: query
name: fields
schema: {}
responses:
"200":
content: {}
description: OK
security:
- basicAuth: []
- bearerAuth: []
summary: Get full weather for a venue.
tags:
- Weather
/api/v1/weather/venues/{venueId}/basic:
get:
description: Returns a json file containing basic weather for a specific venue.
operationId: weatherBasic
parameters:
- description: Unique Venue Identifier
in: path
name: venueId
required: true
schema: {}
- description: "Comma delimited list of specific fields to be returned. Format:\
\ topLevelNode, childNode, attribute"
in: query
name: fields
schema: {}
responses:
"200":
content: {}
description: OK
security:
- basicAuth: []
- bearerAuth: []
summary: Get basic weather for a venue.
tags:
- Weather
/api/v1/weather/game/{gamePk}/{playId}:
get:
description: Returns a json file containing weather for the current play.
operationId: weatherDataBasedOnPlay
parameters:
- description: Unique Primary Key Representing a Game
in: path
name: gamePk
required: true
schema: {}
- description: Unique identifier for a play within a game
in: path
name: playId
required: true
schema: {}
- description: "Comma delimited list of specific fields to be returned. Format:\
\ topLevelNode, childNode, attribute"
in: query
name: fields
schema: {}
responses:
"200":
content: {}
description: OK
security:
- basicAuth: []
- bearerAuth: []
summary: Get the raw field weather data.
tags:
- Weather
/api/v1/weather/game/{gamePk}/forecast/{roofType}:
get:
description: Returns a json file containing the weather forecast for a specific
game.
operationId: weatherForecast
parameters:
- description: Unique Primary Key Representing a Game
in: path
name: gamePk
required: true
schema: {}
- description: Venue roof type
in: path
name: roofType
required: true
schema: {}
- description: "Comma delimited list of specific fields to be returned. Format:\
\ topLevelNode, childNode, attribute"
in: query
name: fields
schema: {}
responses:
"200":
content: {}
description: OK
security:
- basicAuth: []
- bearerAuth: []
summary: Get the weather forecast for a game.
tags:
- Weather
/api/v1/violationTypes:
get:
operationId: violationTypes
responses:
"200":
content: {}
description: OK
summary: View available violationType options
tags:
- Misc
/api/v1/videoResolutionTypes:
get:
operationId: videoResolutionTypes
responses:
"200":
content: {}
description: OK
summary: View video resolution options
tags:
- Misc
/api/v1/venues:
get:
description: This endpoint allows you to pull venues
operationId: venues
parameters:
- description: Unique Venue Identifier
in: path
name: venueId
required: true
schema: {}
- description: Comma delimited list of Unique venue identifiers
in: query
name: venueIds
schema: {}
- description: Unique League Identifier
in: query
name: leagueId
schema: {}
- description: Comma delimited list of Unique league identifiers
in: query
name: leagueIds
schema: {}
- description: Type of Game. Available types in /api/v1/gameTypes
in: query
name: gameType
schema: {}
- description: Comma delimited list of type of Game. Available types in /api/v1/gameTypes
in: query
name: gameTypes
schema: {}
- description: Season of play
in: query
name: season
schema: {}
- description: Comma delimited list of Seasons of play
in: query
name: seasons
schema: {}
- description: "Comma delimited list of specific fields to be returned. Format:\
\ topLevelNode, childNode, attribute"
in: query
name: fields
schema: {}
- description: Whether or not a player is active
in: query
name: active
schema: {}
- in: query
name: includeEvents
schema: {}
- description: Top level organization of a sport
in: query
name: sportId
schema: {}
- description: Comma delimited list of top level organizations of a sport
in: query
name: sportIds
schema: {}
responses:
"200":
content: {}
description: OK
summary: View venue info
tags:
- Venues
/api/v1/venues/{venueId}:
get:
description: This endpoint allows you to pull venues
operationId: venues_1
parameters:
- description: Unique Venue Identifier
in: path
name: venueId
required: true
schema: {}
- description: Comma delimited list of Unique venue identifiers
in: query
name: venueIds
schema: {}
- description: Unique League Identifier
in: query
name: leagueId
schema: {}
- description: Comma delimited list of Unique league identifiers
in: query
name: leagueIds
schema: {}
- description: Type of Game. Available types in /api/v1/gameTypes
in: query
name: gameType
schema: {}
- description: Comma delimited list of type of Game. Available types in /api/v1/gameTypes
in: query
name: gameTypes
schema: {}
- description: Season of play
in: query
name: season
schema: {}
- description: Comma delimited list of Seasons of play
in: query
name: seasons
schema: {}
- description: "Comma delimited list of specific fields to be returned. Format:\
\ topLevelNode, childNode, attribute"
in: query
name: fields
schema: {}
- description: Whether or not a player is active
in: query
name: active
schema: {}
- in: query
name: includeEvents
schema: {}
- description: Top level organization of a sport
in: query
name: sportId
schema: {}
- description: Comma delimited list of top level organizations of a sport
in: query
name: sportIds
schema: {}
responses:
"200":
content: {}
description: OK
summary: View venue info
tags:
- Venues
/api/v1/uniforms/team:
get:
description: This endpoint allows you to pull team uniform data for a season
operationId: uniformsByTeam
parameters:
- in: query
name: teamIds
required: true
schema: {}
- description: Season of play
in: query
name: season
schema: {}
- description: "Comma delimited list of specific fields to be returned. Format:\
\ topLevelNode, childNode, attribute"
in: query
name: fields
schema: {}
responses:
"200":
content: {}
description: OK
summary: View Team Uniform info
tags:
- Uniforms
/api/v1/uniforms/game:
get:
description: This endpoint allows you to pull team uniform data for a game
operationId: uniformsByGame
parameters:
- description: Comma delimited list of unique primary keys
in: query
name: gamePks
required: true
schema: {}
- description: "Comma delimited list of specific fields to be returned. Format:\
\ topLevelNode, childNode, attribute"
in: query
name: fields
schema: {}
responses:
"200":
content: {}
description: OK
summary: View Game Uniform info
tags:
- Uniforms
/api/v1/transactions:
get:
description: This endpoint allows you to pull transactions.
operationId: transactions
parameters:
- description: Comma delimited list of Unique league identifiers
in: query
name: leagueId
schema: {}
- description: Comma delimited list of top level organizations of a sport
in: query
name: sportId
schema: {}
- description: Comma delimited list of Unique Team identifiers
in: query
name: teamId
schema: {}
- description: A unique identifier for a player
in: query
name: playerId
schema: {}
- description: "Date of Game. Format: YYYY-MM-DD"
in: query
name: date
schema: {}
- description: "Start date for range of data (must be used with end date). Format:\
\ MM/DD/YYYY"
in: query
name: startDate
schema: {}
- description: "End date for range of data (must be used with start date). Format:\
\ MM/DD/YYYY"
in: query
name: endDate
schema: {}
- in: query
name: transactionIds
schema: {}
- in: query
name: transactionTypes
schema: {}
- in: query
name: divisionIds
schema: {}
- in: query
name: order
schema: {}
- in: query
name: limit
schema: {}
- description: "Comma delimited list of specific fields to be returned. Format:\
\ topLevelNode, childNode, attribute"
in: query
name: fields
schema: {}
responses:
"200":
content: {}
description: OK
summary: View transaction info
tags:
- Transactions
/api/v1/transactionTypes:
get:
operationId: transactionTypes
parameters:
- description: "Comma delimited list of specific fields to be returned. Format:\
\ topLevelNode, childNode, attribute"
in: query
name: fields
schema: {}
responses:
"200":
content: {}
description: OK
summary: List all transaction types
tags:
- Misc
/api/v1/trackingVersions:
get:
operationId: trackingVersions
responses:
"200":
content: {}
description: OK
summary: List all tracking versions
tags:
- Misc
/api/v1/trackingVendors:
get:
operationId: trackingVendors
responses:
"200":
content: {}
description: OK
summary: List all tracking vendors
tags:
- Misc
/api/v1/trackingSystemOwners:
get:
operationId: trackingSystemOwners
responses:
"200":
content: {}
description: OK
summary: List all tracking system owners
tags:
- Misc
/api/v1/trackingSoftwareVersions:
get:
operationId: trackingSoftwareVersions
responses:
"200":
content: {}
description: OK
summary: List the tracking software versions and notes
tags:
- Misc
/api/v1/teams/{teamId}/stats:
get:
operationId: stats
parameters:
- description: "Unique Team Identifier. Format: 141, 147, etc"
in: path
name: teamId
required: true
schema: {}
- description: Top level organization of a sport
in: query
name: sportId
schema: {}
- description: Season of play
in: query
name: season
schema: {}
- description: Type of Game. Available types in /api/v1/gameTypes
in: query
name: gameType
schema: {}
- description: "Type of statistics. Format: Individual, Team, Career, etc. Available\
\ types in /api/v1/statTypes"
in: query
name: stats
schema: {}
- description: Category of statistic to return. Available types in /api/v1/statGroups
in: query
name: group
required: true
schema: {}
- description: Baseball stat to sort splits by.
in: query
name: sortStat
schema: {}
- description: "The order of sorting, ascending or descending"
in: query
name: order
schema: {}
- description: "Group stats by PLAYER, TEAM, SEASON, VENUE, SPORT or STAT_GROUP"
in: query
name: groupBy
schema: {}
- description: A unique identifier for the opposing team. Must be used with
Team ID
in: query
name: opposingTeamId
schema: {}
- description: A unique identifier for the opposing team
in: query
name: opposingPlayerId
schema: {}
- description: Situation code for a given stat split.
in: query
name: sitCodes
schema: {}
- description: "Start date for range of data (must be used with end date). Format:\
\ MM/DD/YYYY"
in: query
name: startDate
schema: {}
- description: "End date for range of data (must be used with start date). Format:\
\ MM/DD/YYYY"
in: query
name: endDate
schema: {}
- description: "Comma delimited list of specific fields to be returned. Format:\
\ topLevelNode, childNode, attribute"
in: query
name: fields
schema: {}
responses:
"200":
content: {}
description: OK
summary: View a teams stats
tags:
- Teams
/api/v1/teams/{teamId}/roster:
get:
description: This endpoint allows you to pull teams
operationId: roster
parameters:
- description: "Unique Team Identifier. Format: 141, 147, etc"
in: path
name: teamId
required: true
schema: {}
- description: Type of roster. Available types in /api/v1/rosterTypes
in: path
name: rosterType
required: true
schema: {}
- description: Season of play
in: query
name: season
schema: {}
- description: "Date of Game. Format: YYYY-MM-DD"
in: query
name: date
schema: {}
- description: Type of Game. Available types in /api/v1/gameTypes
in: query
name: gameType
schema: {}
- description: "Comma delimited list of specific fields to be returned. Format:\
\ topLevelNode, childNode, attribute"
in: query
name: fields
schema: {}
responses:
"200":
content: {}
description: OK
summary: View a teams roster
tags:
- Teams
/api/v1/teams/{teamId}/roster/{rosterType}:
get:
description: This endpoint allows you to pull teams
operationId: roster_1
parameters:
- description: "Unique Team Identifier. Format: 141, 147, etc"
in: path
name: teamId
required: true
schema: {}
- description: Type of roster. Available types in /api/v1/rosterTypes
in: path
name: rosterType
required: true
schema: {}
- description: Season of play
in: query
name: season
schema: {}
- description: "Date of Game. Format: YYYY-MM-DD"
in: query
name: date
schema: {}
- description: Type of Game. Available types in /api/v1/gameTypes
in: query
name: gameType
schema: {}
- description: "Comma delimited list of specific fields to be returned. Format:\
\ topLevelNode, childNode, attribute"
in: query
name: fields
schema: {}
responses:
"200":
content: {}
description: OK
summary: View a teams roster
tags:
- Teams
/api/v1/teams/{teamId}/personnel:
get:
operationId: personnel
parameters:
- description: "Unique Team Identifier. Format: 141, 147, etc"
in: path
name: teamId
required: true
schema: {}
- description: Season of play
in: query
name: season
schema: {}
- description: "Date of Game. Format: YYYY-MM-DD"
in: query
name: date
schema: {}
- in: query
name: fields
schema: {}
responses:
"200":
content: {}
description: OK
summary: View all coaches for a team
tags:
- Teams
/api/v1/teams/{teamId}/leaders:
get:
operationId: leaders
parameters:
- in: path
name: teamId
required: true
schema: {}
- in: query
name: leaderCategories
schema: {}
- in: query
name: season
schema: {}
- in: query
name: leaderGameTypes
schema: {}
- in: query
name: expand
schema: {}
- in: query
name: limit
schema: {}
- in: query
name: offset
schema: {}
- in: query
name: playerPool
schema: {}
- in: query
name: fields
schema: {}
responses:
"200":
content: {}
description: OK
summary: View team stat leaders
tags:
- Teams
/api/v1/teams/{teamId}/history:
get:
operationId: allTeams
parameters:
- description: "Unique Team Identifier. Format: 141, 147, etc"
in: path
name: teamId
required: true
schema: {}
- description: Comma delimited list of Unique Team identifiers
in: query
name: teamIds
schema: {}
- description: "Start date for range of data (used with end date optionally).\
\ Example: '2018' or '2018.2'"
in: query
name: startSeason
schema: {}
- description: "End date for range of data (used with start date optionally).\
\ Format: '2018' or '2018.2'"
in: query
name: endSeason
schema: {}
- in: query
name: fields
schema: {}
responses:
"200":
content: {}
description: OK
summary: View historical records for a list of teams
tags:
- Teams
/api/v1/teams/history:
get:
operationId: allTeams_1
parameters:
- description: "Unique Team Identifier. Format: 141, 147, etc"
in: path
name: teamId
required: true
schema: {}
- description: Comma delimited list of Unique Team identifiers
in: query
name: teamIds
schema: {}
- description: "Start date for range of data (used with end date optionally).\
\ Example: '2018' or '2018.2'"
in: query
name: startSeason
schema: {}
- description: "End date for range of data (used with start date optionally).\
\ Format: '2018' or '2018.2'"
in: query
name: endSeason
schema: {}
- in: query
name: fields
schema: {}
responses:
"200":
content: {}
description: OK
summary: View historical records for a list of teams
tags:
- Teams
/api/v1/teams/{teamId}/coaches:
get:
operationId: coaches
parameters:
- description: "Unique Team Identifier. Format: 141, 147, etc"
in: path
name: teamId
required: true
schema: {}
- description: Season of play
in: query
name: season
schema: {}
- description: "Date of Game. Format: YYYY-MM-DD"
in: query
name: date
schema: {}
- in: query
name: fields
schema: {}
responses:
"200":
content: {}
description: OK
summary: View all coaches for a team
tags:
- Teams
/api/v1/teams/{teamId}/affiliates:
get:
operationId: affiliates
parameters:
- description: "Unique Team Identifier. Format: 141, 147, etc"
in: path
name: teamId
required: true
schema: {}
- description: "Unique Team Identifier. Format: 141, 147, etc"
in: query
name: teamIds
schema: {}
- description: Top level organization of a sport
in: query
name: sportId
schema: {}
- description: Season of play
in: query
name: season
schema: {}
- description: Type of Game. Available types in /api/v1/gameTypes
in: query
name: gameType
schema: {}
- description: "Comma delimited list of specific fields to be returned. Format:\
\ topLevelNode, childNode, attribute"
in: query
name: fields
schema: {}
responses:
"200":
content: {}
description: OK
summary: View team and affiliate teams
tags:
- Teams
/api/v1/teams/affiliates:
get:
operationId: affiliates_1
parameters:
- description: "Unique Team Identifier. Format: 141, 147, etc"
in: path
name: teamId
required: true
schema: {}
- description: "Unique Team Identifier. Format: 141, 147, etc"
in: query
name: teamIds
schema: {}
- description: Top level organization of a sport
in: query
name: sportId
schema: {}
- description: Season of play
in: query
name: season
schema: {}
- description: Type of Game. Available types in /api/v1/gameTypes
in: query
name: gameType
schema: {}
- description: "Comma delimited list of specific fields to be returned. Format:\
\ topLevelNode, childNode, attribute"
in: query
name: fields
schema: {}
responses:
"200":
content: {}
description: OK
summary: View team and affiliate teams
tags:
- Teams
/api/v1/teams/stats:
get:
operationId: stats_1
parameters:
- description: Type of Game. Available types in /api/v1/gameTypes
in: query
name: gameType
schema: {}
- description: "Type of statistics. Format: Individual, Team, Career, etc. Available\
\ types in /api/v1/statTypes"
in: query
name: stats
schema: {}
- description: Top level organization of a sport
in: query
name: sportId
schema: {}
- description: Comma delimited list of top level organizations of a sport
in: query
name: sportIds
schema: {}
- description: Comma delimited list of Unique league identifiers
in: query
name: leagueIds
schema: {}
- description: Season of play
in: query
name: season
schema: {}
- description: Category of statistic to return. Available types in /api/v1/statGroups
in: query
name: group
required: true
schema: {}
- description: Baseball stat to sort splits by.
in: query
name: sortStat
schema: {}
- description: "The order of sorting, ascending or descending"
in: query
name: order
schema: {}
- description: "Start date for range of data (must be used with end date). Format:\
\ MM/DD/YYYY"
in: query
name: startDate
schema: {}
- description: "End date for range of data (must be used with start date). Format:\
\ MM/DD/YYYY"
in: query
name: endDate
schema: {}
- description: Returns results from the last 'X' days (Starting from yesterday).
in: query
name: daysBack
schema: {}
- description: Situation code for a given stat split.
in: query
name: sitCodes
schema: {}
- description: "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"
in: query
name: combineSits
schema: {}
- description: A unique identifier for the opposing team. Must be used with
Team ID
in: query
name: opposingTeamId
schema: {}
- description: The pointer to start for a return set; used for pagination
in: query
name: offset
schema: {}
- description: Number of results to return
in: query
name: limit
schema: {}
- in: query
name: fields
schema: {}
responses:
"200":
content: {}
description: OK
summary: View a teams stats
tags:
- Teams
/api/v1/teams/stats/leaders:
get:
operationId: leaders_1
parameters:
- description: TBD
in: query
name: leaderCategories
schema: {}
- description: Type of Game. Available types in /api/v1/gameTypes
in: query
name: gameTypes
schema: {}
- description: "Type of statistics. Format: Individual, Team, Career, etc. Available\
\ types in /api/v1/statTypes"
in: query
name: stats
schema: {}
- in: query
name: statType
schema: {}
- description: Top level organization of a sport
in: query
name: sportId
schema: {}
- description: Comma delimited list of top level organizations of a sport
in: query
name: sportIds
schema: {}
- description: Unique League Identifier
in: query
name: leagueId
schema: {}
- description: Comma delimited list of Unique league identifiers
in: query
name: leagueIds
schema: {}
- description: Season of play
in: query
name: season
schema: {}
- description: Category of statistic to return. Available types in /api/v1/statGroups
in: query
name: statGroup
schema: {}
- description: Category of statistic to return. Available types in /api/v1/statGroups
in: query
name: group
schema: {}
- description: "Start date for range of data (must be used with end date). Format:\
\ MM/DD/YYYY"
in: query
name: startDate
schema: {}
- description: "End date for range of data (must be used with start date). Format:\
\ MM/DD/YYYY"
in: query
name: endDate
schema: {}
- description: Returns results from the last 'X' days (Starting from yesterday).
in: query
name: daysBack
schema: {}
- description: Situation code for a given stat split.
in: query
name: sitCodes
schema: {}
- description: A unique identifier for the opposing team. Must be used with
Team ID
in: query
name: opposingTeamId
schema: {}
- description: Number of results to return
in: query
name: limit
schema: {}
- description: The pointer to start for a return set; used for pagination
in: query
name: offset
schema: {}
- in: query
name: fields
schema: {}
responses:
"200":
content: {}
description: OK
summary: View leaders for team stats
tags:
- Teams
/api/v1/teams:
get:
description: This endpoint allows you to pull teams
operationId: teams
parameters:
- description: "Unique Team Identifier. Format: 141, 147, etc"
in: path
name: teamId
required: true
schema: {}
- description: Season of play
in: query
name: season
schema: {}
- description: Top level organization of a sport
in: query
name: sportId
schema: {}
- description: Unique Division Identifier
in: query
name: divisionId
schema: {}
- description: Type of Game. Available types in /api/v1/gameTypes
in: query
name: gameType
schema: {}
- description: Comma delimited list of Unique league identifiers
in: query
name: leagueIds
schema: {}
- description: Comma delimited list of top level organizations of a sport
in: query
name: sportIds
schema: {}
- description: "Flag for fetching teams that are currently active (Y), inactive\
\ (N), pending (P), or all teams (B)"
in: query
name: activeStatus
schema: {}
- description: Unique League List Identifier
in: query
name: leagueListId
schema: {}
- in: query
name: allStarStatuses
schema: {}
- description: "Comma delimited list of specific fields to be returned. Format:\
\ topLevelNode, childNode, attribute"
in: query
name: fields
schema: {}
responses:
"200":
content: {}
description: OK
summary: View info for all teams
tags:
- Teams
/api/v1/teams/{teamId}:
get:
description: This endpoint allows you to pull teams
operationId: teams_1
parameters:
- description: "Unique Team Identifier. Format: 141, 147, etc"
in: path
name: teamId
required: true
schema: {}
- description: Season of play
in: query
name: season
schema: {}
- description: Top level organization of a sport
in: query
name: sportId
schema: {}
- description: Unique Division Identifier
in: query
name: divisionId
schema: {}
- description: Type of Game. Available types in /api/v1/gameTypes
in: query
name: gameType
schema: {}
- description: Comma delimited list of Unique league identifiers
in: query
name: leagueIds
schema: {}
- description: Comma delimited list of top level organizations of a sport
in: query
name: sportIds
schema: {}
- description: "Flag for fetching teams that are currently active (Y), inactive\
\ (N), pending (P), or all teams (B)"
in: query
name: activeStatus
schema: {}
- description: Unique League List Identifier
in: query
name: leagueListId
schema: {}
- in: query
name: allStarStatuses
schema: {}
- description: "Comma delimited list of specific fields to be returned. Format:\
\ topLevelNode, childNode, attribute"
in: query
name: fields
schema: {}
responses:
"200":
content: {}
description: OK
summary: View info for all teams
tags:
- Teams
/api/v1/streaks:
get:
operationId: getStreaks
parameters:
- in: query
name: streakOrg
schema: {}
- in: query
name: streakStat
schema: {}
- in: query
name: streakSpan
schema: {}
- in: query
name: streakLevel
schema: {}
- in: query
name: streakThreshold
schema: {}
- in: query
name: inverse
schema: {}
- in: query
name: startersOnly
schema: {}
- description: Category of statistic to return. Available types in /api/v1/statGroups
in: query
name: statGroup
schema: {}
- description: Type of Game. Available types in /api/v1/gameTypes
in: query
name: gameType
schema: {}
- description: Season of play
in: query
name: season
schema: {}
- description: "Unique Team Identifier. Format: 141, 147, etc"
in: query
name: teamId
schema: {}
- description: Unique League Identifier
in: query
name: leagueId
schema: {}
- description: Top level organization of a sport
in: query
name: sportId
schema: {}
- description: Whether or not a player is active
in: query
name: activeStreak
schema: {}
- description: Number of results to return
in: query
name: limit
schema: {}
- description: "Comma delimited list of specific fields to be returned. Format:\
\ topLevelNode, childNode, attribute"
in: query
name: fields
schema: {}
- description: A unique identifier for a player
in: query
name: playerId
schema: {}
responses:
"200":
content: {}
description: OK
security:
- basicAuth: []
- bearerAuth: []
summary: View streaks
tags:
- Streaks
/api/v1/streaks/types:
get:
operationId: streakTypes
responses:
"200":
content: {}
description: OK
summary: View streaks parameter options
tags:
- Streaks
/api/v1/stats:
get:
operationId: stats_2
parameters:
- description: "Type of statistics. Format: Individual, Team, Career, etc. Available\
\ types in /api/v1/statTypes"
in: query
name: stats
required: true
schema: {}
- description: "Unique Player Identifier. Format: 434538, 429665, etc"
in: query
name: personId
schema: {}
- description: "Unique Team Identifier. Format: 141, 147, etc"
in: query
name: teamId
schema: {}
- description: Comma delimited list of Unique Team identifiers
in: query
name: teamIds
schema: {}
- description: Category of statistic to return. Available types in /api/v1/statGroups
in: query
name: group
required: true
schema: {}
- description: Type of Game. Available types in /api/v1/gameTypes
in: query
name: gameType
schema: {}
- description: Season of play
in: query
name: season
schema: {}
- description: Comma delimited list of Seasons of play
in: query
name: seasons
schema: {}
- description: Top level organization of a sport
in: query
name: sportId
schema: {}
- description: Comma delimited list of top level organizations of a sport
in: query
name: sportIds
schema: {}
- description: Unique League Identifier
in: query
name: leagueId
schema: {}
- description: Comma delimited list of Unique league identifiers
in: query
name: leagueIds
schema: {}
- description: Unique League List Identifier
in: query
name: leagueListId
schema: {}
- description: Name of metric(s) for metric log stats. Available metrics in
/api/v1/metrics
in: query
name: metrics
schema: {}
- description: Unique Primary Key Representing a Game
in: query
name: gamePk
schema: {}
- description: A unique identifier for the batter's team
in: query
name: batterTeamId
schema: {}
- description: A unique identifier for the pitcher's team
in: query
name: pitcherTeamId
schema: {}
- description: "Unique Player Identifier. Format: 434538, 429665, etc"
in: query
name: batterId
schema: {}
- description: "Unique Player Identifier. Format: 434538, 429665, etc"
in: query
name: pitcherId
schema: {}
- description: Situation code for a given stat split.
in: query
name: sitCodes
schema: {}
- description: "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"
in: query
name: combineSits
schema: {}
- description: A unique identifier for the opposing team. Must be used with
Team ID
in: query
name: opposingTeamId
schema: {}
- in: query
name: fields
schema: {}
- description: Baseball stat to sort splits by.
in: query
name: sortStat
schema: {}
- description: "The order of sorting, ascending or descending"
in: query
name: order
schema: {}
- description: Return "ALL" or only "QUALIFIED" players based on plate appearances.
in: query
name: playerPool
schema: {}
- description: "Position number. Format: 1, 2, 3, etc"
in: query
name: position
schema: {}
- description: "Start date for range of data (must be used with end date). Format:\
\ MM/DD/YYYY"
in: query
name: startDate
schema: {}
- description: "End date for range of data (must be used with start date). Format:\
\ MM/DD/YYYY"
in: query
name: endDate
schema: {}
- description: Returns results from the last 'X' days (Starting from yesterday).
in: query
name: daysBack
schema: {}
- description: Returns results from the last 'X' games played.
in: query
name: gamesBack
schema: {}
- description: Excludes players who have since been traded from the input team
in: query
name: excludeTradedPlayers
schema: {}
- description: The pointer to start for a return set; used for pagination
in: query
name: offset
schema: {}
- description: Number of results to return
in: query
name: limit
schema: {}
responses:
"200":
content: {}
description: OK
summary: View stats
tags:
- Stats
/api/v1/stats/search:
get:
operationId: beastStats
parameters:
- description: Category of statistic to return. Available types in /api/v1/statGroups
in: query
name: group
required: true
schema: {}
- description: Comma delimited list of unique primary keys
in: query
name: gamePks
schema: {}
- description: Comma delimited list of unique play identifiers
in: query
name: playIds
schema: {}
- description: Comma delimited list of Seasons of play
in: query
name: seasons
schema: {}
- description: Type of Game. Available types in /api/v1/gameTypes
in: query
name: gameTypes
schema: {}
- description: "Date of Game. Format: YYYY-MM-DD"
in: query
name: date
schema: {}
- description: "Date of Game. Format: YYYY-MM-DD"
in: query
name: startDate
schema: {}
- description: "Date of Game. Format: YYYY-MM-DD"
in: query
name: endDate
schema: {}
- description: "Unique Team Identifier. Format: 141, 147, etc"
in: query
name: teamIds
schema: {}
- description: "Unique Team Identifier. Format: 141, 147, etc"
in: query
name: pitcherTeamIds
schema: {}
- description: "Unique Team Identifier. Format: 141, 147, etc"
in: query
name: batterTeamIds
schema: {}
- description: Comma delimited list of top level organizations of a sport
in: query
name: sportIds
schema: {}
- description: Comma delimited list of top level organizations of a sport
in: query
name: pitcherSportIds
schema: {}
- description: Comma delimited list of top level organizations of a sport
in: query
name: batterSportIds
schema: {}
- description: Comma delimited list of Unique league identifiers
in: query
name: leagueIds
schema: {}
- description: Comma delimited list of Unique league identifiers
in: query
name: pitcherLeagueIds
schema: {}
- description: Comma delimited list of Unique league identifiers
in: query
name: batterLeagueIds
schema: {}
- description: Comma delimited list of Unique League Identifiers
in: query
name: divisionIds
schema: {}
- description: Comma delimited list of Unique League Identifiers
in: query
name: pitcherDivisionIds
schema: {}
- description: Comma delimited list of Unique League Identifiers
in: query
name: batterDivisionIds
schema: {}
- description: "Unique Team Identifier. Format: 141, 147, etc"
in: query
name: pitchersOnTeamIds
schema: {}
- description: "Unique Team Identifier. Format: 141, 147, etc"
in: query
name: battersOnTeamIds
schema: {}
- description: A unique identifier for a player
in: query
name: playerIds
schema: {}
- description: Return "ALL" or only "QUALIFIED" players based on plate appearances.
in: query
name: playerPool
schema: {}
- description: A unique identifier for a player
in: query
name: pitcherIds
schema: {}
- description: A unique identifier for a player
in: query
name: batterIds
schema: {}
- description: A unique identifier for a player
in: query
name: catcherIds
schema: {}
- description: A unique identifier for a player
in: query
name: firstBasemanIds
schema: {}
- description: A unique identifier for a player
in: query
name: secondBasemanIds
schema: {}
- description: A unique identifier for a player
in: query
name: thirdBasemanIds
schema: {}
- description: A unique identifier for a player
in: query
name: shortstopIds
schema: {}
- description: A unique identifier for a player
in: query
name: leftFielderIds
schema: {}
- description: A unique identifier for a player
in: query
name: centerFielderIds
schema: {}
- description: A unique identifier for a player
in: query
name: rightFielderIds
schema: {}
- description: A unique identifier for a player
in: query
name: runnerFirstIds
schema: {}
- description: A unique identifier for a player
in: query
name: runnerSecondIds
schema: {}
- description: A unique identifier for a player
in: query
name: runnerThirdIds
schema: {}
- description: Unique Venue Identifier
in: query
name: venueIds
schema: {}
- description: Handedness of pitcher
in: query
name: pitchHand
schema: {}
- description: Bat side of hitter
in: query
name: batSide
schema: {}
- description: "Classification of pitch (fastball, curveball, etc...)"
in: query
name: pitchTypes
schema: {}
- description: "Result of the pitch (ball, called strike, etc...)"
in: query
name: pitchCodes
schema: {}
- description: Type of event
in: query
name: eventTypes
schema: {}
- description: All of the details of a player's position
in: query
name: positions
schema: {}
- description: All of the details of a player's position
in: query
name: primaryPositions
schema: {}
- description: Minimum value to filter on
in: query
name: minPitchSpeed
schema: {}
- description: Maximum value to filter on
in: query
name: maxPitchSpeed
schema: {}
- description: Minimum value to filter on
in: query
name: minSpinRate
schema: {}
- description: Maximum value to filter on
in: query
name: maxSpinRate
schema: {}
- description: Minimum value to filter on
in: query
name: minExtension
schema: {}
- description: Maximum value to filter on
in: query
name: maxExtension
schema: {}
- description: Minimum value to filter on
in: query
name: minExitVelocityAgainst
schema: {}
- description: Maximum value to filter on
in: query
name: maxExitVelocityAgainst
schema: {}
- description: Minimum value to filter on
in: query
name: minLaunchAngleAgainst
schema: {}
- description: Maximum value to filter on
in: query
name: maxLaunchAngleAgainst
schema: {}
- description: Minimum value to filter on
in: query
name: minExitVelocity
schema: {}
- description: Maximum value to filter on
in: query
name: maxExitVelocity
schema: {}
- description: Minimum value to filter on
in: query
name: minLaunchAngle
schema: {}
- description: Maximum value to filter on
in: query
name: maxLaunchAngle
schema: {}
- description: Minimum value to filter on
in: query
name: minHomeRunDistance
schema: {}
- description: Maximum value to filter on
in: query
name: maxHomeRunDistance
schema: {}
- description: Minimum value to filter on
in: query
name: minHitDistance
schema: {}
- description: Maximum value to filter on
in: query
name: maxHitDistance
schema: {}
- description: Minimum value to filter on
in: query
name: minHangTime
schema: {}
- description: Maximum value to filter on
in: query
name: maxHangTime
schema: {}
- description: Minimum value to filter on
in: query
name: minHitProbability
schema: {}
- description: Maximum value to filter on
in: query
name: maxHitProbability
schema: {}
- description: Minimum value to filter on
in: query
name: minCatchProbability
schema: {}
- description: Maximum value to filter on
in: query
name: maxCatchProbability
schema: {}
- description: Minimum value to filter on
in: query
name: minAttackAngle
schema: {}
- description: Maximum value to filter on
in: query
name: maxAttackAngle
schema: {}
- description: Minimum value to filter on
in: query
name: minBatSpeed
schema: {}
- description: Maximum value to filter on
in: query
name: maxBatSpeed
schema: {}
- description: Minimum value to filter on
in: query
name: minHomeRunXBallparks
schema: {}
- description: Maximum value to filter on
in: query
name: maxHomeRunXBallparks
schema: {}
- description: Whether or not a play resulted in a barreled ball
in: query
name: isBarrel
schema: {}
- description: "Trajectory of hit (line drive, fly ball, etc...)"
in: query
name: hitTrajectories
schema: {}
- description: Number of results to return
in: query
name: limit
schema: {}
- description: The pointer to start for a return set; used for pagination
in: query
name: offset
schema: {}
- description: "Group stats by PLAYER, TEAM, SEASON, VENUE, SPORT or STAT_GROUP"
in: query
name: groupBy
schema: {}
- description: "Group stats by PLAYER, TEAM, SEASON, VENUE, SPORT or STAT_GROUP"
in: query
name: compareOver
schema: {}
- description: Baseball stat to sort splits by.
in: query
name: sortStat
schema: {}
- description: "The prefix modifier for the sort stat. avg, min, max. I.E minExitVelocity,\
\ maxLaunchAngle, avgHitDistance"
in: query
name: sortModifier
schema: {}
- description: "The order of sorting, ascending or descending"
in: query
name: sortOrder
schema: {}
- description: Only return averages above this percentile. used for best effort
plays
in: query
name: percentile
schema: {}
- description: Minimum occurrences to filter upon
in: query
name: minOccurrences
schema: {}
- description: Minimum occurrences to filter upon
in: query
name: minPlateAppearances
schema: {}
- description: Minimum occurrences to filter upon
in: query
name: minInnings
schema: {}
- description: Minimum occurrences to filter upon
in: query
name: qualifierRate
schema: {}
- description: Situation code for a given stat split.
in: query
name: sitCodes
schema: {}
- description: Columns to return totals
in: query
name: showTotals
schema: {}
- description: Show events with null metrics
in: query
name: includeNullMetrics
schema: {}
- description: Baseball stat fields to populate
in: query
name: statFields
schema: {}
- description: "The at bat number of a given game. Format: 1, 2, 3, etc"
in: query
name: atBatNumbers
schema: {}
- description: "The pitch number of a given game. Format: 1, 2, 3, etc"
in: query
name: pitchNumbers
schema: {}
- description: "Comma delimited list of specific fields to be returned. Format:\
\ topLevelNode, childNode, attribute"
in: query
name: fields
schema: {}
- in: query
name: debug
schema: {}
- description: Whether or not a player is active
in: query
name: activeStatus
schema: {}
responses:
"200":
content: {}
description: OK
security:
- basicAuth: []
- bearerAuth: []
summary: View stats from search
tags:
- Stats
/api/v1/stats/search/stats:
get:
operationId: statSearchStats
parameters:
- description: Categories of filters for stat search
in: query
name: filterLevel
schema: {}
responses:
"200":
content: {}
description: OK
summary: List stat search stats
tags:
- Misc
/api/v1/stats/search/params:
get:
operationId: statSearchParams
parameters:
- description: Categories of filters for stat search
in: query
name: filterLevel
schema: {}
responses:
"200":
content: {}
description: OK
summary: List stat search parameters
tags:
- Misc
/api/v1/stats/search/groupByTypes:
get:
operationId: statSearchGroupByTypes
parameters:
- description: Categories of filters for stat search
in: query
name: filterLevel
schema: {}
responses:
"200":
content: {}
description: OK
summary: List groupBy types
tags:
- Misc
/api/v1/stats/search/config:
get:
operationId: statSearchConfig
parameters:
- description: Categories of filters for stat search
in: query
name: filterLevel
schema: {}
- description: Category of statistic to return. Available types in /api/v1/statGroups
in: query
name: group
schema: {}
responses:
"200":
content: {}
description: OK
summary: Stats Search Config Endpoint
tags:
- Misc
/api/v1/stats/metrics:
get:
operationId: metricStats
parameters:
- description: "Unique Player Identifier. Format: 434538, 429665, etc"
in: query
name: personId
schema: {}
- description: "Unique Player Identifier. Format: 434538, 429665, etc"
in: query
name: personIds
schema: {}
- description: "Unique Player Identifier. Format: 434538, 429665, etc"
in: query
name: batterId
schema: {}
- description: "Unique Player Identifier. Format: 434538, 429665, etc"
in: query
name: pitcherId
schema: {}
- description: "Unique Team Identifier. Format: 141, 147, etc"
in: query
name: teamId
schema: {}
- description: "Type of statistics. Format: Individual, Team, Career, etc. Available\
\ types in /api/v1/statTypes"
in: query
name: stats
required: true
schema: {}
- description: Category of statistic to return. Available types in /api/v1/statGroups
in: query
name: group
schema: {}
- description: Season of play
in: query
name: season
schema: {}
- description: Comma delimited list of Seasons of play
in: query
name: seasons
schema: {}
- description: Top level organization of a sport
in: query
name: sportId
schema: {}
- description: A unique identifier for the opposing team. Must be used with
Team ID
in: query
name: opposingTeamId
schema: {}
- description: A unique identifier for the opposing team
in: query
name: opposingPlayerId
schema: {}
- description: All of the details of a player's position
in: query
name: position
schema: {}
- description: Type of event
in: query
name: eventType
schema: {}
- description: "Classification of pitch (fastball, curveball, etc...)"
in: query
name: pitchType
schema: {}
- description: "Trajectory of hit (line drive, fly ball, etc...)"
in: query
name: hitTrajectory
schema: {}
- description: Bat side of hitter
in: query
name: batSide
schema: {}
- description: Handedness of pitcher
in: query
name: pitchHand
schema: {}
- description: All of the details of a venue
in: query
name: venueId
schema: {}
- description: Name of metric(s) for metric log stats. Available metrics in
/api/v1/metrics
in: query
name: metrics
required: true
schema: {}
- description: Unique Primary Key Representing a Game
in: query
name: gamePk
schema: {}
- description: Minimum value to filter on
in: query
name: minValue
schema: {}
- description: Maximum value to filter on
in: query
name: maxValue
schema: {}
- description: Only return averages above this percentile. used for best effort
plays
in: query
name: percentile
schema: {}
- description: Minimum occurrences to filter upon
in: query
name: minOccurrences
schema: {}
- description: The pointer to start for a return set; used for pagination
in: query
name: offset
schema: {}
- description: Number of results to return
in: query
name: limit
schema: {}
- description: "The order of sorting, ascending or descending"
in: query
name: order
schema: {}
- description: "Date of Game. Format: YYYY-MM-DD"
in: query
name: date
schema: {}
- description: "Start date for range of data (must be used with end date). Format:\
\ MM/DD/YYYY"
in: query
name: startDate
schema: {}
- description: "End date for range of data (must be used with start date). Format:\
\ MM/DD/YYYY"
in: query
name: endDate
schema: {}
- description: Type of Game. Available types in /api/v1/gameTypes
in: query
name: gameType
schema: {}
- description: A unique identifier for the batter's team
in: query
name: batterTeamId
schema: {}
- description: A unique identifier for the pitcher's team
in: query
name: pitcherTeamId
schema: {}
- description: "Comma delimited list of specific fields to be returned. Format:\
\ topLevelNode, childNode, attribute"
in: query
name: fields
schema: {}
- in: query
name: debug
schema: {}
responses:
"200":
content: {}
description: OK
security:
- basicAuth: []
- bearerAuth: []
summary: View metric stats
tags:
- Stats
/api/v1/stats/leaders:
get:
operationId: leaders_2
parameters:
- in: query
name: leaderCategories
schema: {}
- in: query
name: leaderGameTypes
schema: {}
- in: query
name: statGroup
schema: {}
- in: query
name: season
schema: {}
- in: query
name: expand
schema: {}
- in: query
name: sportId
schema: {}
- in: query
name: sportIds
schema: {}
- in: query
name: stats
schema: {}
- in: query
name: limit
schema: {}
- in: query
name: offset
schema: {}
- in: query
name: teamId
schema: {}
- in: query
name: teamIds
schema: {}
- in: query
name: leagueId
schema: {}
- in: query
name: leagueIds
schema: {}
- in: query
name: leagueListId
schema: {}
- in: query
name: playerPool
schema: {}
- in: query
name: statType
schema: {}
- in: query
name: playerActive
schema: {}
- in: query
name: position
schema: {}
- in: query
name: sitCodes
schema: {}
- in: query
name: opposingTeamId
schema: {}
- in: query
name: startDate
schema: {}
- in: query
name: endDate
schema: {}
- in: query
name: daysBack
schema: {}
- in: query
name: gamesBack
schema: {}
- in: query
name: groupBy
schema: {}
- in: query
name: fields
schema: {}
responses:
"200":
content: {}
description: OK
summary: Get leaders for a statistic
tags:
- Stats
/api/v1/stats/grouped:
get:
operationId: groupedStats
parameters:
- description: "Type of statistics. Format: Individual, Team, Career, etc. Available\
\ types in /api/v1/statTypes"
in: query
name: stats
required: true
schema: {}
- description: "Unique Player Identifier. Format: 434538, 429665, etc"
in: query
name: personId
schema: {}
- description: "Unique Team Identifier. Format: 141, 147, etc"
in: query
name: teamId
schema: {}
- description: Comma delimited list of Unique Team identifiers
in: query
name: teamIds
schema: {}
- description: Category of statistic to return. Available types in /api/v1/statGroups
in: query
name: group
required: true
schema: {}
- description: Type of Game. Available types in /api/v1/gameTypes
in: query
name: gameType
schema: {}
- description: Season of play
in: query
name: season
schema: {}
- description: Comma delimited list of Seasons of play
in: query
name: seasons
schema: {}
- description: Top level organization of a sport
in: query
name: sportId
schema: {}
- description: Comma delimited list of top level organizations of a sport
in: query
name: sportIds
schema: {}
- description: Unique League Identifier
in: query
name: leagueId
schema: {}
- description: Comma delimited list of Unique league identifiers
in: query
name: leagueIds
schema: {}
- description: Unique League List Identifier
in: query
name: leagueListId
schema: {}
- description: Name of metric(s) for metric log stats. Available metrics in
/api/v1/metrics
in: query
name: metrics
schema: {}
- description: Unique Primary Key Representing a Game
in: query
name: gamePk
schema: {}
- description: A unique identifier for the batter's team
in: query
name: batterTeamId
schema: {}
- description: A unique identifier for the pitcher's team
in: query
name: pitcherTeamId
schema: {}
- description: "Unique Player Identifier. Format: 434538, 429665, etc"
in: query
name: batterId
schema: {}
- description: "Unique Player Identifier. Format: 434538, 429665, etc"
in: query
name: pitcherId
schema: {}
- description: Situation code for a given stat split.
in: query
name: sitCodes
schema: {}
- description: "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"
in: query
name: combineSits
schema: {}
- description: A unique identifier for the opposing team. Must be used with
Team ID
in: query
name: opposingTeamId
schema: {}
- description: "Comma delimited list of specific fields to be returned. Format:\
\ topLevelNode, childNode, attribute"
in: query
name: fields
schema: {}
- description: Baseball stat to sort splits by.
in: query
name: sortStat
schema: {}
- description: "The order of sorting, ascending or descending"
in: query
name: order
schema: {}
- description: Return "ALL" or only "QUALIFIED" players based on plate appearances.
in: query
name: playerPool
schema: {}
- description: "Position number. Format: 1, 2, 3, etc"
in: query
name: position
schema: {}
- description: "Start date for range of data (must be used with end date). Format:\
\ MM/DD/YYYY"
in: query
name: startDate
schema: {}
- description: "End date for range of data (must be used with start date). Format:\
\ MM/DD/YYYY"
in: query
name: endDate
schema: {}
- description: Returns results from the last 'X' days (Starting from yesterday).
in: query
name: daysBack
schema: {}
- description: Returns results from the last 'X' games played.
in: query
name: gamesBack
schema: {}
- description: Excludes players who have since been traded from the input team
in: query
name: excludeTradedPlayers
schema: {}
- description: The pointer to start for a return set; used for pagination
in: query
name: offset
schema: {}
- description: Number of results to return
in: query
name: limit
schema: {}
- description: Baseball stat fields to populate
in: query
name: statFields
schema: {}
- description: "Baseball statField to sort on. If no statField is given, sortField\
\ defaults to BASIC. If 1 statField is given, that is the default sortField."
in: query
name: sortField
schema: {}
responses:
"200":
content: {}
description: OK
summary: View grouped stats
tags:
- Stats
/api/v1/stats/analytics/stolenBaseProbability:
get:
operationId: getStolenBaseProbability
parameters:
- in: query
name: gamePk
required: true
schema: {}
- in: query
name: timecode
schema: {}
responses:
"200":
content: {}
description: OK
security:
- basicAuth: []
- bearerAuth: []
summary: Get the probability of a hit for the given hit data
tags:
- Stats
/api/v1/stats/analytics/sprayChart:
get:
operationId: getSprayChart
parameters:
- in: query
name: gamePk
required: true
schema: {}
- in: query
name: timecode
schema: {}
- description: "Comma delimited list of specific fields to be returned. Format:\
\ topLevelNode, childNode, attribute"
in: query
name: fields
schema: {}
responses:
"200":
content: {}
description: OK
security:
- basicAuth: []
- bearerAuth: []
summary: Get the spray chart info for the current batter
tags:
- Stats
/api/v1/stats/analytics/outsAboveAverage:
get:
operationId: getOutsAboveAverage
parameters:
- in: query
name: gamePk
required: true
schema: {}
- in: query
name: timecode
schema: {}
- description: "Comma delimited list of specific fields to be returned. Format:\
\ topLevelNode, childNode, attribute"
in: query
name: fields
schema: {}
responses:
"200":
content: {}
description: OK
security:
- basicAuth: []
- bearerAuth: []
summary: Get outs above average for the current batter
tags:
- Stats
/api/v1/statcastPositionTypes:
get:
operationId: statcastPositionTypes
responses:
"200":
content: {}
description: OK
summary: List all statcast position types
tags:
- Misc
/api/v1/statTypes:
get:
operationId: statTypes
responses:
"200":
content: {}
description: OK
summary: List all stat types
tags:
- Misc
/api/v1/statGroups:
get:
operationId: statGroups
responses:
"200":
content: {}
description: OK
summary: List all stat groups
tags:
- Misc
/api/v1/statFields:
get:
operationId: statFields
responses:
"200":
content: {}
description: OK
summary: List all stat fields
tags:
- Misc
/api/v1/standingsTypes:
get:
operationId: standingsTypes
responses:
"200":
content: {}
description: OK
summary: List all standings types
tags:
- Misc
/api/v1/standings/{standingsType}:
get:
description: This endpoint allows you to pull standings
operationId: standings
parameters:
- description: Type of season. Available types in /api/v1/standingsTypes
in: path
name: standingsType
required: true
schema: {}
- description: Unique League Identifier
in: query
name: leagueId
schema: {}
- description: Season of play
in: query
name: season
schema: {}
- description: Type of season. Available types in /api/v1/standingsTypes
in: query
name: standingsTypes
schema: {}
- description: "Date of Game. Format: YYYY-MM-DD"
in: query
name: date
schema: {}
- description: "Unique Team Identifier. Format: 141, 147, etc"
in: query
name: teamId
schema: {}
- description: Determines whether to include major league teams when using the
'BY_ORGANIZATION' standings type
in: query
name: includeMLB
schema: {}
- description: "Comma delimited list of specific fields to be returned. Format:\
\ topLevelNode, childNode, attribute"
in: query
name: fields
schema: {}
responses:
"200":
content: {}
description: OK
summary: View standings for a league
tags:
- Standings
/api/v1/standings:
get:
description: This endpoint allows you to pull standings
operationId: standings_1
parameters:
- description: Type of season. Available types in /api/v1/standingsTypes
in: path
name: standingsType
required: true
schema: {}
- description: Unique League Identifier
in: query
name: leagueId
schema: {}
- description: Season of play
in: query
name: season
schema: {}
- description: Type of season. Available types in /api/v1/standingsTypes
in: query
name: standingsTypes
schema: {}
- description: "Date of Game. Format: YYYY-MM-DD"
in: query
name: date
schema: {}
- description: "Unique Team Identifier. Format: 141, 147, etc"
in: query
name: teamId
schema: {}
- description: Determines whether to include major league teams when using the
'BY_ORGANIZATION' standings type
in: query
name: includeMLB
schema: {}
- description: "Comma delimited list of specific fields to be returned. Format:\
\ topLevelNode, childNode, attribute"
in: query
name: fields
schema: {}
responses:
"200":
content: {}
description: OK
summary: View standings for a league
tags:
- Standings
/api/v1/sports/{sportId}/players:
get:
description: This endpoint allows you to pull all players for a given sport
operationId: sportPlayers
parameters:
- description: Top level organization of a sport
in: path
name: sportId
required: true
schema: {}
- description: Season of play
in: query
name: season
schema: {}
- description: Type of Game. Available types in /api/v1/gameTypes
in: query
name: gameType
schema: {}
- description: Returns sports that have individual player stats
in: query
name: hasStats
schema: {}
- description: Boolean value to specify wanting a person's name with accents
or without
in: query
name: accent
schema: {}
- description: "Comma delimited list of specific fields to be returned. Format:\
\ topLevelNode, childNode, attribute"
in: query
name: fields
schema: {}
responses:
"200":
content: {}
description: OK
summary: Get all players for a sport level
tags:
- Sports
/api/v1/sports/{sportId}/allSportBallot:
get:
description: This endpoint allows you to get all players for MLB ballot
operationId: allSportBallot
parameters:
- description: Top level organization of a sport
in: path
name: sportId
required: true
schema: {}
- description: season
in: query
name: season
required: true
schema: {}
- in: query
name: fields
schema: {}
responses:
"200":
content: {}
description: OK
summary: Get ALL MLB ballot for sport
tags:
- Sports
/api/v1/sports:
get:
description: This endpoint allows you to pull sports
operationId: sports
parameters:
- description: Top level organization of a sport
in: path
name: sportId
required: true
schema: {}
- description: Season of play
in: query
name: season
schema: {}
- description: "Comma delimited list of specific fields to be returned. Format:\
\ topLevelNode, childNode, attribute"
in: query
name: fields
schema: {}
- description: Returns sports that have individual player stats
in: query
name: hasStats
schema: {}
- description: "Flag for fetching sports that are currently active (Y), inactive\
\ (N), pending (P), or all teams (B)"
in: query
name: activeStatus
schema: {}
responses:
"200":
content: {}
description: OK
summary: Get sports information
tags:
- Sports
/api/v1/sports/{sportId}:
get:
description: This endpoint allows you to pull sports
operationId: sports_1
parameters:
- description: Top level organization of a sport
in: path
name: sportId
required: true
schema: {}
- description: Season of play
in: query
name: season
schema: {}
- description: "Comma delimited list of specific fields to be returned. Format:\
\ topLevelNode, childNode, attribute"
in: query
name: fields
schema: {}
- description: Returns sports that have individual player stats
in: query
name: hasStats
schema: {}
- description: "Flag for fetching sports that are currently active (Y), inactive\
\ (N), pending (P), or all teams (B)"
in: query
name: activeStatus
schema: {}
responses:
"200":
content: {}
description: OK
summary: Get sports information
tags:
- Sports
/api/v1/sortModifiers:
get:
operationId: aggregateSortEnum
responses:
"200":
content: {}
description: OK
summary: List all stat fields
tags:
- Misc
/api/v1/sky:
get:
operationId: sky
parameters:
- description: "Comma delimited list of specific fields to be returned. Format:\
\ topLevelNode, childNode, attribute"
in: query
name: fields
schema: {}
responses:
"200":
content: {}
description: OK
summary: List all sky options
tags:
- Misc
/api/v1/situationCodes:
get:
operationId: sitCodes
parameters:
- description: "Comma delimited list of specific fields to be returned. Format:\
\ topLevelNode, childNode, attribute"
in: query
name: fields
schema: {}
- description: Season of play
in: query
name: season
schema: {}
- description: Category of statistic to return. Available types in /api/v1/statGroups
in: query
name: statGroup
schema: {}
responses:
"200":
content: {}
description: OK
summary: List all situation codes
tags:
- Misc
/api/v1/seasons/all:
get:
description: "This endpoint allows you to view all seasons for a given Division,\
\ League or Sport"
operationId: allSeasons
parameters:
- description: Unique Division Identifier
in: query
name: divisionId
schema: {}
- description: Unique League Identifier
in: query
name: leagueId
schema: {}
- description: Top level organization of a sport
in: query
name: sportId
schema: {}
- description: Retrieve dates for each game type
in: query
name: withGameTypeDates
schema: {}
- description: "Comma delimited list of specific fields to be returned. Format:\
\ topLevelNode, childNode, attribute"
in: query
name: fields
schema: {}
responses:
"200":
content: {}
description: OK
summary: View all seasons
tags:
- Season
/api/v1/seasons:
get:
description: This endpoint allows you to pull seasons
operationId: seasons
parameters:
- description: Season of play
in: path
name: seasonId
required: true
schema: {}
- description: Season of play
in: query
name: season
schema: {}
- description: Top level organization of a sport
in: query
name: sportId
schema: {}
- description: Retrieve dates for each game type
in: query
name: withGameTypeDates
schema: {}
- description: "Comma delimited list of specific fields to be returned. Format:\
\ topLevelNode, childNode, attribute"
in: query
name: fields
schema: {}
responses:
"200":
content: {}
description: OK
summary: View season info
tags:
- Season
/api/v1/seasons/{seasonId}:
get:
description: This endpoint allows you to pull seasons
operationId: seasons_1
parameters:
- description: Season of play
in: path
name: seasonId
required: true
schema: {}
- description: Season of play
in: query
name: season
schema: {}
- description: Top level organization of a sport
in: query
name: sportId
schema: {}
- description: Retrieve dates for each game type
in: query
name: withGameTypeDates
schema: {}
- description: "Comma delimited list of specific fields to be returned. Format:\
\ topLevelNode, childNode, attribute"
in: query
name: fields
schema: {}
responses:
"200":
content: {}
description: OK
summary: View season info
tags:
- Season
/api/v1/scheduleTypes:
get:
operationId: scheduleTypes
responses:
"200":
content: {}
description: OK
summary: List all possible schedule types
tags:
- Misc
/api/v1/scheduleEventTypes:
get:
operationId: scheduleEventTypes
parameters:
- description: "Comma delimited list of specific fields to be returned. Format:\
\ topLevelNode, childNode, attribute"
in: query
name: fields
schema: {}
responses:
"200":
content: {}
description: OK
summary: List all schedule event types
tags:
- Misc
/api/v1/schedule/trackingEvents:
get:
description: This endpoint allows you to pull schedules for tracking events
operationId: trackingEventsSchedule
parameters:
- description: Comma delimited list of type of calendar types
in: query
name: calendarTypes
schema: {}
- description: "Comma delimited list of type of events. <b>Note: Don't Use.\
\ This will be deprecated in favor of calendarTypes</b>"
in: query
name: eventTypes
schema: {}
- description: "Unique Team Identifier. Format: 141, 147, etc"
in: query
name: teamId
schema: {}
- description: Unique League Identifier
in: query
name: leagueId
schema: {}
- description: Top level organization of a sport
in: query
name: sportId
schema: {}
- description: Unique Primary Key Representing a Game
in: query
name: gamePk
schema: {}
- description: Comma delimited list of unique primary keys
in: query
name: gamePks
schema: {}
- description: A unique identifier for non-game event
in: query
name: eventIds
schema: {}
- description: Unique Venue Identifier
in: query
name: venueIds
schema: {}
- description: A unique identifier for non-team event performers
in: query
name: performerIds
schema: {}
- description: Comma delimited list of type of Game. Available types in /api/v1/gameTypes
in: query
name: gameTypes
schema: {}
- description: Type of Game. Available types in /api/v1/gameTypes
in: query
name: gameType
schema: {}
- description: Season of play
in: query
name: season
schema: {}
- description: Comma delimited list of Seasons of play
in: query
name: seasons
schema: {}
- description: "Date of Game. Format: YYYY-MM-DD"
in: query
name: date
schema: {}
- description: "Start date for range of data (must be used with end date). Format:\
\ MM/DD/YYYY"
in: query
name: startDate
schema: {}
- description: "End date for range of data (must be used with start date). Format:\
\ MM/DD/YYYY"
in: query
name: endDate
schema: {}
- description: "Use this parameter to return a snapshot of the data at the specified\
\ time. Format: YYYYMMDD_HHMMSS"
in: query
name: timecode
schema: {}
- in: query
name: useLatestGames
schema: {}
- description: A unique identifier for the opposing team. Must be used with
Team ID
in: query
name: opponentId
schema: {}
- description: "Return public, non-public or all games. Format: Public Facing\
\ = 'Y', Non-Public Facing = 'N', All = 'A'"
in: query
name: publicFacing
schema: {}
- description: "Comma delimited list of specific fields to be returned. Format:\
\ topLevelNode, childNode, attribute"
in: query
name: fields
schema: {}
responses:
"200":
content: {}
description: OK
security:
- basicAuth: []
- bearerAuth: []
summary: Get tracking event schedules
tags:
- Schedule
/api/v1/schedule/postseason:
get:
description: This endpoint allows you to pull postseason schedules
operationId: postseasonSchedule
parameters:
- description: Comma delimited list of type of Game. Available types in /api/v1/gameTypes
in: query
name: gameTypes
schema: {}
- in: query
name: seriesNumber
schema: {}
- description: "Unique Team Identifier. Format: 141, 147, etc"
in: query
name: teamId
schema: {}
- description: Unique League Identifier
in: query
name: sportId
schema: {}
- in: query
name: useLatestGames
schema: {}
- in: query
name: useFeaturedGame
schema: {}
- in: query
name: season
schema: {}
- description: "Return public, non-public or all games. Format: Public Facing\
\ = 'Y', Non-Public Facing = 'N', All = 'A'"
in: query
name: publicFacing
schema: {}
- description: "Comma delimited list of specific fields to be returned. Format:\
\ topLevelNode, childNode, attribute"
in: query
name: fields
schema: {}
responses:
"200":
content: {}
description: OK
summary: Get postseason schedule
tags:
- Schedule
/api/v1/schedule/postseason/tuneIn:
get:
description: This endpoint allows you to pull postseason schedules
operationId: tuneIn
parameters:
- description: "Unique Team Identifier. Format: 141, 147, etc"
in: query
name: teamId
schema: {}
- description: Unique League Identifier
in: query
name: sportId
schema: {}
- description: Unique Primary Key Representing a Game
in: query
name: season
schema: {}
- description: "Comma delimited list of specific fields to be returned. Format:\
\ topLevelNode, childNode, attribute"
in: query
name: fields
schema: {}
responses:
"200":
content: {}
description: OK
summary: Get postseason TuneIn schedules
tags:
- Schedule
/api/v1/schedule/postseason/series:
get:
description: This endpoint allows you to pull postseason schedules
operationId: postseasonScheduleSeries
parameters:
- description: Comma delimited list of type of Game. Available types in /api/v1/gameTypes
in: query
name: gameTypes
schema: {}
- in: query
name: seriesNumber
schema: {}
- description: "Unique Team Identifier. Format: 141, 147, etc"
in: query
name: teamId
schema: {}
- description: Unique League Identifier
in: query
name: sportId
schema: {}
- description: "Date of Game. Format: YYYY-MM-DD"
in: query
name: date
schema: {}
- description: "Start date for range of data (must be used with end date). Format:\
\ MM/DD/YYYY"
in: query
name: startDate
schema: {}
- description: "End date for range of data (must be used with start date). Format:\
\ MM/DD/YYYY"
in: query
name: endDate
schema: {}
- in: query
name: useLatestGames
schema: {}
- in: query
name: useFeaturedGame
schema: {}
- in: query
name: season
schema: {}
- description: "Comma delimited list of specific fields to be returned. Format:\
\ topLevelNode, childNode, attribute"
in: query
name: fields
schema: {}
responses:
"200":
content: {}
description: OK
summary: Get postseason series schedules
tags:
- Schedule
/api/v1/schedule/games/tied:
get:
description: This endpoint allows you to pull tie game schedules for the given
season
operationId: tieGames
parameters:
- description: Top level organization of a sport
in: query
name: sportId
schema: {}
- description: Comma delimited list of type of Game. Available types in /api/v1/gameTypes
in: query
name: gameTypes
schema: {}
- description: Season of play
in: query
name: season
required: true
schema: {}
- description: "Comma delimited list of specific fields to be returned. Format:\
\ topLevelNode, childNode, attribute"
in: query
name: fields
schema: {}
responses:
"200":
content: {}
description: OK
summary: Get tied game schedules
tags:
- Schedule
/api/v1/schedule:
get:
description: View schedule info. This endpoint allows you to pull schedules
operationId: schedule
parameters:
- description: Comma delimited list of type of calendar types
in: query
name: calendarTypes
schema: {}
- description: "Comma delimited list of type of events. <b>Note: Don't Use.\
\ This will be deprecated in favor of calendarTypes</b>"
in: query
name: eventTypes
schema: {}
- description: Comma delimited list of type of event types
in: query
name: scheduleEventTypes
schema: {}
- description: "Unique Team Identifier. Format: 141, 147, etc"
in: query
name: teamId
schema: {}
- description: Unique League Identifier
in: query
name: leagueId
schema: {}
- description: Top level organization of a sport
in: query
name: sportId
schema: {}
- description: Unique Primary Key Representing a Game
in: query
name: gamePk
schema: {}
- description: Comma delimited list of unique primary keys
in: query
name: gamePks
schema: {}
- description: A unique identifier for non-game event
in: query
name: eventIds
schema: {}
- description: Unique Venue Identifier
in: query
name: venueIds
schema: {}
- description: A unique identifier for non-team event performers
in: query
name: performerIds
schema: {}
- description: Comma delimited list of type of Game. Available types in /api/v1/gameTypes
in: query
name: gameTypes
schema: {}
- description: Type of Game. Available types in /api/v1/gameTypes
in: query
name: gameType
schema: {}
- description: Season of play
in: query
name: season
schema: {}
- description: Comma delimited list of Seasons of play
in: query
name: seasons
schema: {}
- description: "Date of Game. Format: YYYY-MM-DD"
in: query
name: date
schema: {}
- description: "Start date for range of data (must be used with end date). Format:\
\ MM/DD/YYYY"
in: query
name: startDate
schema: {}
- description: "End date for range of data (must be used with start date). Format:\
\ MM/DD/YYYY"
in: query
name: endDate
schema: {}
- description: "Use this parameter to return a snapshot of the data at the specified\
\ time. Format: YYYYMMDD_HHMMSS"
in: query
name: timecode
schema: {}
- in: query
name: useLatestGames
schema: {}
- description: A unique identifier for the opposing team. Must be used with
Team ID
in: query
name: opponentId
schema: {}
- description: "Return public, non-public or all games. Format: Public Facing\
\ = 'Y', Non-Public Facing = 'N', All = 'A'"
in: query
name: publicFacing
schema: {}
- description: "Comma delimited list of specific fields to be returned. Format:\
\ topLevelNode, childNode, attribute"
in: query
name: fields
schema: {}
- in: query
name: usingPrivateEndpoint
required: true
schema: {}
responses:
"200":
content: {}
description: OK
summary: View schedule info based on scheduleType.
tags:
- Schedule
/api/v1/schedule/{scheduleType}:
get:
description: View schedule info. This endpoint allows you to pull schedules
operationId: schedule_1
parameters:
- description: Comma delimited list of type of calendar types
in: query
name: calendarTypes
schema: {}
- description: "Comma delimited list of type of events. <b>Note: Don't Use.\
\ This will be deprecated in favor of calendarTypes</b>"
in: query
name: eventTypes
schema: {}
- description: Comma delimited list of type of event types
in: query
name: scheduleEventTypes
schema: {}
- description: "Unique Team Identifier. Format: 141, 147, etc"
in: query
name: teamId
schema: {}
- description: Unique League Identifier
in: query
name: leagueId
schema: {}
- description: Top level organization of a sport
in: query
name: sportId
schema: {}
- description: Unique Primary Key Representing a Game
in: query
name: gamePk
schema: {}
- description: Comma delimited list of unique primary keys
in: query
name: gamePks
schema: {}
- description: A unique identifier for non-game event
in: query
name: eventIds
schema: {}
- description: Unique Venue Identifier
in: query
name: venueIds
schema: {}
- description: A unique identifier for non-team event performers
in: query
name: performerIds
schema: {}
- description: Comma delimited list of type of Game. Available types in /api/v1/gameTypes
in: query
name: gameTypes
schema: {}
- description: Type of Game. Available types in /api/v1/gameTypes
in: query
name: gameType
schema: {}
- description: Season of play
in: query
name: season
schema: {}
- description: Comma delimited list of Seasons of play
in: query
name: seasons
schema: {}
- description: "Date of Game. Format: YYYY-MM-DD"
in: query
name: date
schema: {}
- description: "Start date for range of data (must be used with end date). Format:\
\ MM/DD/YYYY"
in: query
name: startDate
schema: {}
- description: "End date for range of data (must be used with start date). Format:\
\ MM/DD/YYYY"
in: query
name: endDate
schema: {}
- description: "Use this parameter to return a snapshot of the data at the specified\
\ time. Format: YYYYMMDD_HHMMSS"
in: query
name: timecode
schema: {}
- in: query
name: useLatestGames
schema: {}
- description: A unique identifier for the opposing team. Must be used with
Team ID
in: query
name: opponentId
schema: {}
- description: "Return public, non-public or all games. Format: Public Facing\
\ = 'Y', Non-Public Facing = 'N', All = 'A'"
in: query
name: publicFacing
schema: {}
- description: "Comma delimited list of specific fields to be returned. Format:\
\ topLevelNode, childNode, attribute"
in: query
name: fields
schema: {}
- in: query
name: usingPrivateEndpoint
required: true
schema: {}
responses:
"200":
content: {}
description: OK
summary: View schedule info based on scheduleType.
tags:
- Schedule
/api/v1/runnerDetailTypes:
get:
operationId: runnerDetailTypes
responses:
"200":
content: {}
description: OK
summary: List runner detail types
tags:
- Misc
/api/v1/ruleSettings:
get:
operationId: ruleSettings
responses:
"200":
content: {}
description: OK
security:
- basicAuth: []
- bearerAuth: []
summary: List all ruleSettings
tags:
- Misc
/api/v1/rosterTypes:
get:
operationId: rosterTypes
responses:
"200":
content: {}
description: OK
summary: List all possible roster types
tags:
- Misc
/api/v1/roofTypes:
get:
operationId: roofTypes
responses:
"200":
content: {}
description: OK
summary: List all roof types
tags:
- Misc
/api/v1/review:
get:
operationId: getReviewInfo
parameters:
- description: "Unique Team Identifier. Format: 141, 147, etc"
in: query
name: sportId
required: true
schema: {}
- description: Comma delimited list of Seasons of play
in: query
name: season
required: true
schema: {}
- description: Type of Game. Available types in /api/v1/gameTypes
in: query
name: gameType
schema: {}
- description: "Comma delimited list of specific fields to be returned. Format:\
\ topLevelNode, childNode, attribute"
in: query
name: fields
schema: {}
responses:
"200":
content: {}
description: OK
summary: Get review info
tags:
- Reviews
/api/v1/reviewReasons:
get:
operationId: reviewReasons
parameters:
- description: "Comma delimited list of specific fields to be returned. Format:\
\ topLevelNode, childNode, attribute"
in: query
name: fields
schema: {}
responses:
"200":
content: {}
description: OK
summary: List all replay review reasons
tags:
- Misc
/api/v1/props/play/predictions:
get:
description: This endpoint allows you to get play-level predictions based on
input scenarios
operationId: getProps
parameters:
- description: "Unique Player Identifier. Format: 434538, 429665, etc"
in: query
name: batterId
schema: {}
- description: "Unique Player Identifier. Format: 434538, 429665, etc"
in: query
name: pitcherId
schema: {}
- description: Unique Venue Identifier
in: query
name: venueId
schema: {}
- description: Bat side of hitter
in: query
name: batSide
schema: {}
- description: Handedness of pitcher
in: query
name: pitchHand
schema: {}
- description: "Position abbreviation. Format: SS, P, 1B, etc"
in: query
name: batterPosition
schema: {}
- description: "Position abbreviation. Format: SS, P, 1B, etc"
in: query
name: pitcherPosition
schema: {}
responses:
"200":
content: {}
description: OK
security:
- basicAuth: []
- bearerAuth: []
summary: Get play-level predictions based on input scenarios
tags:
- Predictions
/api/v1/props/play/predictions/adjust:
get:
description: This endpoint allows you to get play-level predictions based on
input scenarios
operationId: getPropsAdjust
parameters:
- description: Unique Primary Key Representing a Game
in: query
name: gamePk
required: true
schema: {}
responses:
"200":
content: {}
description: OK
security:
- basicAuth: []
- bearerAuth: []
summary: Get play-level predictions based on input scenarios
tags:
- Predictions
/api/v1/positions:
get:
operationId: positions
responses:
"200":
content: {}
description: OK
summary: List all possible positions
tags:
- Misc
/api/v1/playerStatusCodes:
get:
operationId: playerStatusCodes
parameters:
- description: "Comma delimited list of specific fields to be returned. Format:\
\ topLevelNode, childNode, attribute"
in: query
name: fields
schema: {}
responses:
"200":
content: {}
description: OK
summary: List all player status codes
tags:
- Misc
/api/v1/platforms:
get:
operationId: platforms
responses:
"200":
content: {}
description: OK
summary: List all possible platforms
tags:
- Misc
/api/v1/pitchTypes:
get:
operationId: pitchTypes
parameters:
- description: "Comma delimited list of specific fields to be returned. Format:\
\ topLevelNode, childNode, attribute"
in: query
name: fields
schema: {}
responses:
"200":
content: {}
description: OK
summary: List all pitch classification types
tags:
- Misc
/api/v1/pitchCodes:
get:
operationId: pitchCodes
parameters:
- description: "Comma delimited list of specific fields to be returned. Format:\
\ topLevelNode, childNode, attribute"
in: query
name: fields
schema: {}
responses:
"200":
content: {}
description: OK
summary: List all pitch codes
tags:
- Misc
/api/v1/performerTypes:
get:
operationId: performerTypes
responses:
"200":
content: {}
description: OK
summary: List all possible performer types
tags:
- Misc
/api/v1/people/{personId}/stats:
get:
operationId: stats_3
parameters:
- description: "Unique Player Identifier. Format: 434538, 429665, etc"
in: path
name: personId
required: true
schema: {}
- description: "Type of statistics. Format: Individual, Team, Career, etc. Available\
\ types in /api/v1/statTypes"
in: query
name: stats
required: true
schema: {}
- description: Category of statistic to return. Available types in /api/v1/statGroups
in: query
name: group
schema: {}
- description: Season of play
in: query
name: season
schema: {}
- description: Comma delimited list of Seasons of play
in: query
name: seasons
schema: {}
- description: Top level organization of a sport
in: query
name: sportId
schema: {}
- description: A unique identifier for the opposing team. Must be used with
Team ID
in: query
name: opposingTeamId
schema: {}
- description: A unique identifier for the opposing team
in: query
name: opposingPlayerId
schema: {}
- description: Name of metric(s) for metric log stats. Available metrics in
/api/v1/metrics
in: query
name: metrics
schema: {}
- description: Unique League Identifier
in: query
name: leagueId
schema: {}
- description: Unique League List Identifier
in: query
name: leagueListId
schema: {}
- description: Situation code for a given stat split.
in: query
name: sitCodes
schema: {}
- description: "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"
in: query
name: combineSits
schema: {}
- description: "Start date for range of data (must be used with end date). Format:\
\ MM/DD/YYYY"
in: query
name: startDate
schema: {}
- description: "End date for range of data (must be used with start date). Format:\
\ MM/DD/YYYY"
in: query
name: endDate
schema: {}
- description: Returns results from the last 'X' days (Starting from yesterday).
in: query
name: daysBack
schema: {}
- description: Returns results from the last 'X' games played.
in: query
name: gamesBack
schema: {}
- description: Number of results to return
in: query
name: limit
schema: {}
- description: Type of event
in: query
name: eventType
schema: {}
- description: "Classification of pitch (fastball, curveball, etc...)"
in: query
name: pitchType
schema: {}
- description: "Trajectory of hit (line drive, fly ball, etc...)"
in: query
name: hitTrajectory
schema: {}
- description: Bat side of hitter
in: query
name: batSide
schema: {}
- description: Type of Game. Available types in /api/v1/gameTypes
in: query
name: gameType
schema: {}
- description: "Group stats by PLAYER, TEAM, SEASON, VENUE, SPORT or STAT_GROUP"
in: query
name: groupBy
schema: {}
- description: Boolean value to specify wanting a person's name with accents
or without
in: query
name: accent
schema: {}
- description: "Comma delimited list of specific fields to be returned. Format:\
\ topLevelNode, childNode, attribute"
in: query
name: fields
schema: {}
responses:
"200":
content: {}
description: OK
summary: View a players stats
tags:
- Person
/api/v1/people/{personId}/stats/metrics:
get:
operationId: statsMetrics
parameters:
- description: "Unique Player Identifier. Format: 434538, 429665, etc"
in: path
name: personId
required: true
schema: {}
- description: "Type of statistics. Format: Individual, Team, Career, etc. Available\
\ types in /api/v1/statTypes"
in: query
name: stats
required: true
schema: {}
- description: Category of statistic to return. Available types in /api/v1/statGroups
in: query
name: group
schema: {}
- description: Season of play
in: query
name: season
schema: {}
- description: Comma delimited list of Seasons of play
in: query
name: seasons
schema: {}
- description: Top level organization of a sport
in: query
name: sportId
schema: {}
- description: A unique identifier for the opposing team. Must be used with
Team ID
in: query
name: opposingTeamId
schema: {}
- description: A unique identifier for the opposing team
in: query
name: opposingPlayerId
schema: {}
- description: Name of metric(s) for metric log stats. Available metrics in
/api/v1/metrics
in: query
name: metrics
schema: {}
- description: Unique League Identifier
in: query
name: leagueId
schema: {}
- description: Unique League List Identifier
in: query
name: leagueListId
schema: {}
- description: Situation code for a given stat split.
in: query
name: sitCodes
schema: {}
- description: "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"
in: query
name: combineSits
schema: {}
- description: "Start date for range of data (must be used with end date). Format:\
\ MM/DD/YYYY"
in: query
name: startDate
schema: {}
- description: "End date for range of data (must be used with start date). Format:\
\ MM/DD/YYYY"
in: query
name: endDate
schema: {}
- description: Returns results from the last 'X' days (Starting from yesterday).
in: query
name: daysBack
schema: {}
- description: Returns results from the last 'X' games played.
in: query
name: gamesBack
schema: {}
- description: Number of results to return
in: query
name: limit
schema: {}
- description: Type of event
in: query
name: eventType
schema: {}
- description: "Classification of pitch (fastball, curveball, etc...)"
in: query
name: pitchType
schema: {}
- description: "Trajectory of hit (line drive, fly ball, etc...)"
in: query
name: hitTrajectory
schema: {}
- description: Bat side of hitter
in: query
name: batSide
schema: {}
- description: Type of Game. Available types in /api/v1/gameTypes
in: query
name: gameType
schema: {}
- description: "Group stats by PLAYER, TEAM, SEASON, VENUE, SPORT or STAT_GROUP"
in: query
name: groupBy
schema: {}
- description: Boolean value to specify wanting a person's name with accents
or without
in: query
name: accent
schema: {}
- description: "Comma delimited list of specific fields to be returned. Format:\
\ topLevelNode, childNode, attribute"
in: query
name: fields
schema: {}
responses:
"200":
content: {}
description: OK
security:
- basicAuth: []
- bearerAuth: []
summary: View a player's stat metrics
tags:
- Person
/api/v1/people/{personId}/stats/game/{gamePk}:
get:
operationId: playerGameStats
parameters:
- description: "Unique Player Identifier. Format: 434538, 429665, etc"
in: path
name: personId
required: true
schema: {}
- description: Unique Primary Key Representing a Game
in: path
name: gamePk
required: true
schema: {}
- description: Category of statistic to return. Available types in /api/v1/statGroups
in: query
name: group
schema: {}
- description: "Comma delimited list of specific fields to be returned. Format:\
\ topLevelNode, childNode, attribute"
in: query
name: fields
schema: {}
responses:
"200":
content: {}
description: OK
summary: View a player's game stats
tags:
- Person
/api/v1/people/{personId}/awards:
get:
operationId: award
parameters:
- description: "Unique Player Identifier. Format: 434538, 429665, etc"
in: path
name: personId
required: true
schema: {}
- description: "Comma delimited list of specific fields to be returned. Format:\
\ topLevelNode, childNode, attribute"
in: query
name: fields
schema: {}
responses:
"200":
content: {}
description: OK
summary: View a player's awards
tags:
- Person
/api/v1/people/{personId}:
get:
description: This endpoint allows you to pull the information of players
operationId: person
parameters:
- description: "Unique Player Identifier. Format: 434538, 429665, etc"
in: path
name: personId
required: true
schema: {}
- description: "Comma delimited list of person ID. Format: 1234, 2345"
in: query
name: personIds
schema: {}
- description: Boolean value to specify wanting a person's name with accents
or without
in: query
name: accent
schema: {}
- description: Season of play
in: query
name: season
schema: {}
- description: Category of statistic to return. Available types in /api/v1/statGroups
in: query
name: group
schema: {}
- description: "Comma delimited list of specific fields to be returned. Format:\
\ topLevelNode, childNode, attribute"
in: query
name: fields
schema: {}
responses:
"200":
content: {}
description: OK
summary: View a player
tags:
- Person
/api/v1/people:
get:
description: This endpoint allows you to pull the information of players
operationId: person_1
parameters:
- description: "Unique Player Identifier. Format: 434538, 429665, etc"
in: path
name: personId
required: true
schema: {}
- description: "Comma delimited list of person ID. Format: 1234, 2345"
in: query
name: personIds
schema: {}
- description: Boolean value to specify wanting a person's name with accents
or without
in: query
name: accent
schema: {}
- description: Season of play
in: query
name: season
schema: {}
- description: Category of statistic to return. Available types in /api/v1/statGroups
in: query
name: group
schema: {}
- description: "Comma delimited list of specific fields to be returned. Format:\
\ topLevelNode, childNode, attribute"
in: query
name: fields
schema: {}
responses:
"200":
content: {}
description: OK
summary: View a player
tags:
- Person
/api/v1/people/search:
get:
operationId: search
parameters:
- description: Name a player uses
in: query
name: names
schema: {}
- description: "Comma delimited list of person ID. Format: 1234, 2345"
in: query
name: personIds
schema: {}
- description: Comma delimited list of top level organizations of a sport
in: query
name: sportIds
schema: {}
- description: Comma delimited list of Unique league identifiers
in: query
name: leagueIds
schema: {}
- description: Comma delimited list of Unique Team identifiers
in: query
name: teamIds
schema: {}
- description: Unique League List Identifier
in: query
name: leagueListId
schema: {}
- description: Whether or not a player is active
in: query
name: active
schema: {}
- description: Complete and confirmed all biographical data
in: query
name: verified
schema: {}
- description: Whether or not a player is a rookie
in: query
name: rookie
schema: {}
- description: Comma delimited list of Seasons of play
in: query
name: seasons
schema: {}
- description: "Comma delimited list of specific fields to be returned. Format:\
\ topLevelNode, childNode, attribute"
in: query
name: fields
schema: {}
- description: Boolean value to specify wanting a person's name with accents
or without
in: query
name: accent
schema: {}
- description: Number of results to return
in: query
name: limit
schema: {}
responses:
"200":
content: {}
description: OK
summary: Search for a player by name
tags:
- Person
/api/v1/people/freeAgents:
get:
operationId: freeAgents
parameters:
- description: Season of play
in: query
name: season
required: true
schema: {}
- description: "The order of sorting, ascending or descending"
in: query
name: order
schema: {}
- description: Boolean value to specify wanting a person's name with accents
or without
in: query
name: accent
schema: {}
- in: query
name: fields
schema: {}
responses:
"200":
content: {}
description: OK
summary: Get free agents
tags:
- Person
/api/v1/people/changes:
get:
operationId: currentGameStats
parameters:
- description: "Format: YYYY-MM-DDTHH:MM:SSZ"
in: query
name: updatedSince
required: true
schema: {}
- description: Number of results to return
in: query
name: limit
schema: {}
- description: The pointer to start for a return set; used for pagination
in: query
name: offset
schema: {}
- description: Boolean value to specify wanting a person's name with accents
or without
in: query
name: accent
schema: {}
- description: "Comma delimited list of specific fields to be returned. Format:\
\ topLevelNode, childNode, attribute"
in: query
name: fields
schema: {}
responses:
"200":
content: {}
description: OK
summary: View a player's change log
tags:
- Person
/api/v1/moundVisitTypes:
get:
operationId: moundVisitTypes
parameters:
- description: "Comma delimited list of specific fields to be returned. Format:\
\ topLevelNode, childNode, attribute"
in: query
name: fields
schema: {}
responses:
"200":
content: {}
description: OK
summary: List all mound visit types
tags:
- Misc
/api/v1/milestones:
get:
operationId: milestones
parameters:
- description: "Organization level. Format: T(Team), L(League), S(Sport)"
in: query
name: orgType
schema: {}
- description: Comma delimited list of milestone achievement types
in: query
name: achievementStatuses
schema: {}
- description: Comma delimited list of milestone types
in: query
name: milestoneTypes
schema: {}
- description: Filters out milestones that have already been surpassed.
in: query
name: isLastAchievement
schema: {}
- description: Comma delimited list of milestone statistics
in: query
name: milestoneStatistics
schema: {}
- description: Comma delimited list of milestone values
in: query
name: milestoneValues
schema: {}
- description: A unique identifier for players
in: query
name: playerIds
schema: {}
- description: Comma delimited list of Unique Team identifiers
in: query
name: teamIds
schema: {}
- description: Comma delimited list of Unique league identifiers
in: query
name: leagueIds
schema: {}
- description: Category of statistic to return. Available types in /api/v1/statGroups
in: query
name: statGroup
schema: {}
- description: Season of play
in: query
name: season
schema: {}
- description: Comma delimited list of Seasons of play
in: query
name: seasons
schema: {}
- description: Comma delimited list of Unique venue identifiers
in: query
name: venueIds
schema: {}
- description: Comma delimited list of unique primary keys
in: query
name: gamePks
schema: {}
- description: Number of results to return
in: query
name: limit
schema: {}
- description: "Comma delimited list of specific fields to be returned. Format:\
\ topLevelNode, childNode, attribute"
in: query
name: fields
schema: {}
- description: "True to show play first milestones, like first HR, first Save,\
\ etc"
in: query
name: showFirsts
schema: {}
responses:
"200":
content: {}
description: OK
summary: View pending and achieved milestones.
tags:
- Milestones
/api/v1/milestoneTypes:
get:
operationId: milestoneTypes
responses:
"200":
content: {}
description: OK
summary: View available milestoneType options
tags:
- Milestones
/api/v1/milestoneStatistics:
get:
operationId: milestoneStatistics
responses:
"200":
content: {}
description: OK
summary: View available milestone statistics options
tags:
- Milestones
/api/v1/milestoneLookups:
get:
operationId: milestoneLookups
responses:
"200":
content: {}
description: OK
summary: View available milestoneLookup options
tags:
- Milestones
/api/v1/milestoneDurations:
get:
operationId: milestoneDurations
responses:
"200":
content: {}
description: OK
summary: View available milestoneDurations options
tags:
- Milestones
/api/v1/metrics:
get:
operationId: metrics
responses:
"200":
content: {}
description: OK
summary: List all possible metrics
tags:
- Misc
/api/v1/mediaState:
get:
operationId: mediaStateTypes
responses:
"200":
content: {}
description: OK
summary: View media state options
tags:
- Misc
/api/v1/lookup/values/all:
get:
operationId: getLookupValues
responses:
"200":
content: {}
description: OK
summary: View all lookup values
tags:
- Misc
/api/v1/logicalEvents:
get:
operationId: logicalEvents
parameters:
- description: "Comma delimited list of specific fields to be returned. Format:\
\ topLevelNode, childNode, attribute"
in: query
name: fields
schema: {}
responses:
"200":
content: {}
description: OK
summary: List all logical event types
tags:
- Misc
/api/v1/leagueLeaderTypes:
get:
operationId: leagueLeaderTypes
responses:
"200":
content: {}
description: OK
summary: List all possible player league leader types
tags:
- Misc
/api/v1/league/{leagueId}/allStarWriteIns:
get:
operationId: allStarWriteIns
parameters:
- description: Unique League Identifier
in: path
name: leagueId
required: true
schema: {}
- description: Season of play
in: query
name: season
schema: {}
- description: "Comma delimited list of specific fields to be returned. Format:\
\ topLevelNode, childNode, attribute"
in: query
name: fields
schema: {}
responses:
"200":
content: {}
description: OK
summary: View all star write ins info
tags:
- League
/api/v1/leagues/{leagueId}/allStarWriteIns:
get:
operationId: allStarWriteIns_1
parameters:
- description: Unique League Identifier
in: path
name: leagueId
required: true
schema: {}
- description: Season of play
in: query
name: season
schema: {}
- description: "Comma delimited list of specific fields to be returned. Format:\
\ topLevelNode, childNode, attribute"
in: query
name: fields
schema: {}
responses:
"200":
content: {}
description: OK
summary: View all star write ins info
tags:
- League
/api/v1/league/{leagueId}/allStarFinalVote:
get:
operationId: allStarFinalVote
parameters:
- description: Unique League Identifier
in: path
name: leagueId
required: true
schema: {}
- description: Season of play
in: query
name: season
schema: {}
- description: "Comma delimited list of specific fields to be returned. Format:\
\ topLevelNode, childNode, attribute"
in: query
name: fields
schema: {}
responses:
"200":
content: {}
description: OK
summary: View all star final vote info
tags:
- League
/api/v1/leagues/{leagueId}/allStarFinalVote:
get:
operationId: allStarFinalVote_1
parameters:
- description: Unique League Identifier
in: path
name: leagueId
required: true
schema: {}
- description: Season of play
in: query
name: season
schema: {}
- description: "Comma delimited list of specific fields to be returned. Format:\
\ topLevelNode, childNode, attribute"
in: query
name: fields
schema: {}
responses:
"200":
content: {}
description: OK
summary: View all star final vote info
tags:
- League
/api/v1/league/allStarBallot:
get:
operationId: allStarBallot
parameters:
- description: Unique League Identifier
in: path
name: leagueId
required: true
schema: {}
- description: Comma delimited list of Unique league identifiers
in: query
name: leagueIds
schema: {}
- description: Season of play
in: query
name: season
schema: {}
- description: "Comma delimited list of specific fields to be returned. Format:\
\ topLevelNode, childNode, attribute"
in: query
name: fields
schema: {}
responses:
"200":
content: {}
description: OK
summary: View al star ballot info
tags:
- League
/api/v1/league/{leagueId}/allStarBallot:
get:
operationId: allStarBallot_1
parameters:
- description: Unique League Identifier
in: path
name: leagueId
required: true
schema: {}
- description: Comma delimited list of Unique league identifiers
in: query
name: leagueIds
schema: {}
- description: Season of play
in: query
name: season
schema: {}
- description: "Comma delimited list of specific fields to be returned. Format:\
\ topLevelNode, childNode, attribute"
in: query
name: fields
schema: {}
responses:
"200":
content: {}
description: OK
summary: View al star ballot info
tags:
- League
/api/v1/leagues/allStarBallot:
get:
operationId: allStarBallot_2
parameters:
- description: Unique League Identifier
in: path
name: leagueId
required: true
schema: {}
- description: Comma delimited list of Unique league identifiers
in: query
name: leagueIds
schema: {}
- description: Season of play
in: query
name: season
schema: {}
- description: "Comma delimited list of specific fields to be returned. Format:\
\ topLevelNode, childNode, attribute"
in: query
name: fields
schema: {}
responses:
"200":
content: {}
description: OK
summary: View al star ballot info
tags:
- League
/api/v1/leagues/{leagueId}/allStarBallot:
get:
operationId: allStarBallot_3
parameters:
- description: Unique League Identifier
in: path
name: leagueId
required: true
schema: {}
- description: Comma delimited list of Unique league identifiers
in: query
name: leagueIds
schema: {}
- description: Season of play
in: query
name: season
schema: {}
- description: "Comma delimited list of specific fields to be returned. Format:\
\ topLevelNode, childNode, attribute"
in: query
name: fields
schema: {}
responses:
"200":
content: {}
description: OK
summary: View al star ballot info
tags:
- League
/api/v1/league:
get:
operationId: league
parameters:
- description: Unique League Identifier
in: path
name: leagueId
required: true
schema: {}
- description: Comma delimited list of Unique league identifiers
in: query
name: leagueIds
schema: {}
- description: Season of play
in: query
name: season
schema: {}
- description: Comma delimited list of Seasons of play
in: query
name: seasons
schema: {}
- description: "Comma delimited list of specific fields to be returned. Format:\
\ topLevelNode, childNode, attribute"
in: query
name: fields
schema: {}
- description: Top level organization of a sport
in: query
name: sportId
schema: {}
- description: "Flag for fetching leagues that are currently active (Y), inactive\
\ (N), pending (P), or all teams (B)"
in: query
name: activeStatus
schema: {}
responses:
"200":
content: {}
description: OK
summary: View league info
tags:
- League
/api/v1/league/{leagueId}:
get:
operationId: league_1
parameters:
- description: Unique League Identifier
in: path
name: leagueId
required: true
schema: {}
- description: Comma delimited list of Unique league identifiers
in: query
name: leagueIds
schema: {}
- description: Season of play
in: query
name: season
schema: {}
- description: Comma delimited list of Seasons of play
in: query
name: seasons
schema: {}
- description: "Comma delimited list of specific fields to be returned. Format:\
\ topLevelNode, childNode, attribute"
in: query
name: fields
schema: {}
- description: Top level organization of a sport
in: query
name: sportId
schema: {}
- description: "Flag for fetching leagues that are currently active (Y), inactive\
\ (N), pending (P), or all teams (B)"
in: query
name: activeStatus
schema: {}
responses:
"200":
content: {}
description: OK
summary: View league info
tags:
- League
/api/v1/leagues:
get:
operationId: league_2
parameters:
- description: Unique League Identifier
in: path
name: leagueId
required: true
schema: {}
- description: Comma delimited list of Unique league identifiers
in: query
name: leagueIds
schema: {}
- description: Season of play
in: query
name: season
schema: {}
- description: Comma delimited list of Seasons of play
in: query
name: seasons
schema: {}
- description: "Comma delimited list of specific fields to be returned. Format:\
\ topLevelNode, childNode, attribute"
in: query
name: fields
schema: {}
- description: Top level organization of a sport
in: query
name: sportId
schema: {}
- description: "Flag for fetching leagues that are currently active (Y), inactive\
\ (N), pending (P), or all teams (B)"
in: query
name: activeStatus
schema: {}
responses:
"200":
content: {}
description: OK
summary: View league info
tags:
- League
/api/v1/leagues/{leagueId}:
get:
operationId: league_3
parameters:
- description: Unique League Identifier
in: path
name: leagueId
required: true
schema: {}
- description: Comma delimited list of Unique league identifiers
in: query
name: leagueIds
schema: {}
- description: Season of play
in: query
name: season
schema: {}
- description: Comma delimited list of Seasons of play
in: query
name: seasons
schema: {}
- description: "Comma delimited list of specific fields to be returned. Format:\
\ topLevelNode, childNode, attribute"
in: query
name: fields
schema: {}
- description: Top level organization of a sport
in: query
name: sportId
schema: {}
- description: "Flag for fetching leagues that are currently active (Y), inactive\
\ (N), pending (P), or all teams (B)"
in: query
name: activeStatus
schema: {}
responses:
"200":
content: {}
description: OK
summary: View league info
tags:
- League
/api/v1/languages:
get:
operationId: languages
responses:
"200":
content: {}
description: OK
summary: List all support languages
tags:
- Misc
/api/v1/jobs:
get:
description: This endpoint allows you to pull teams
operationId: getJobsByType
parameters:
- description: "Job Type Identifier (ie. UMPR, etc..)"
in: query
name: jobType
required: true
schema: {}
- description: Top level organization of a sport
in: query
name: sportId
schema: {}
- description: "Date of Game. Format: YYYY-MM-DD"
in: query
name: date
schema: {}
- description: "Comma delimited list of specific fields to be returned. Format:\
\ topLevelNode, childNode, attribute"
in: query
name: fields
schema: {}
responses:
"200":
content: {}
description: OK
summary: Get jobs by type
tags:
- Job
/api/v1/jobs/umpires:
get:
description: This endpoint allows you to pull teams
operationId: umpires
parameters:
- description: Top level organization of a sport
in: query
name: sportId
schema: {}
- description: "Date of Game. Format: YYYY-MM-DD"
in: query
name: date
schema: {}
- description: "Comma delimited list of specific fields to be returned. Format:\
\ topLevelNode, childNode, attribute"
in: query
name: fields
schema: {}
- description: Season of play
in: query
name: season
schema: {}
responses:
"200":
content: {}
description: OK
summary: Get umpires
tags:
- Job
/api/v1/jobs/umpires/games/{umpireId}:
get:
description: This endpoint allows you to pull teams
operationId: umpireSchedule
parameters:
- description: A unique identifier for an umpire
in: path
name: umpireId
required: true
schema: {}
- description: Season of play
in: query
name: season
required: true
schema: {}
- description: "Comma delimited list of specific fields to be returned. Format:\
\ topLevelNode, childNode, attribute"
in: query
name: fields
schema: {}
responses:
"200":
content: {}
description: OK
security:
- basicAuth: []
- bearerAuth: []
summary: Get umpires and associated game for umpireId
tags:
- Job
/api/v1/jobs/officialScorers:
get:
description: This endpoint allows you to pull teams
operationId: officialScorers
parameters:
- description: Top level organization of a sport
in: query
name: sportId
schema: {}
- description: "Date of Game. Format: YYYY-MM-DD"
in: query
name: date
schema: {}
- description: "Comma delimited list of specific fields to be returned. Format:\
\ topLevelNode, childNode, attribute"
in: query
name: fields
schema: {}
responses:
"200":
content: {}
description: OK
summary: Get official scorers
tags:
- Job
/api/v1/jobs/datacasters:
get:
description: Get datacaster jobs
operationId: datacasters
parameters:
- description: Top level organization of a sport
in: query
name: sportId
schema: {}
- description: "Date of Game. Format: YYYY-MM-DD"
in: query
name: date
schema: {}
- description: "Comma delimited list of specific fields to be returned. Format:\
\ topLevelNode, childNode, attribute"
in: query
name: fields
schema: {}
responses:
"200":
content: {}
description: OK
summary: Get datacaster jobs
tags:
- Job
/api/v1/homeRunDerby/{gamePk}/pool:
get:
description: This endpoint allows you to pull home run derby information
operationId: homeRunDerbyPool
parameters:
- description: Unique Primary Key Representing a Game
in: path
name: gamePk
required: true
schema: {}
- description: "Comma delimited list of specific fields to be returned. Format:\
\ topLevelNode, childNode, attribute"
in: query
name: fields
schema: {}
responses:
"200":
content: {}
description: OK
summary: View home run derby pool
tags:
- Homerun Derby
/api/v1/homeRunDerby/pool:
get:
description: This endpoint allows you to pull home run derby information
operationId: homeRunDerbyPool_1
parameters:
- description: Unique Primary Key Representing a Game
in: path
name: gamePk
required: true
schema: {}
- description: "Comma delimited list of specific fields to be returned. Format:\
\ topLevelNode, childNode, attribute"
in: query
name: fields
schema: {}
responses:
"200":
content: {}
description: OK
summary: View home run derby pool
tags:
- Homerun Derby
/api/v1/homeRunDerby/{gamePk}/mixed:
get:
description: This endpoint allows you to pull home run derby information
operationId: homeRunDerbyMixedMode
parameters:
- description: Unique Primary Key Representing a Game
in: path
name: gamePk
required: true
schema: {}
- description: "Comma delimited list of specific fields to be returned. Format:\
\ topLevelNode, childNode, attribute"
in: query
name: fields
schema: {}
responses:
"200":
content: {}
description: OK
summary: View home run derby mixed mode (Bracket/Pool combo)
tags:
- Homerun Derby
/api/v1/homeRunDerby/mixed:
get:
description: This endpoint allows you to pull home run derby information
operationId: homeRunDerbyMixedMode_1
parameters:
- description: Unique Primary Key Representing a Game
in: path
name: gamePk
required: true
schema: {}
- description: "Comma delimited list of specific fields to be returned. Format:\
\ topLevelNode, childNode, attribute"
in: query
name: fields
schema: {}
responses:
"200":
content: {}
description: OK
summary: View home run derby mixed mode (Bracket/Pool combo)
tags:
- Homerun Derby
/api/v1/homeRunDerby/{gamePk}:
get:
description: This endpoint allows you to pull home run derby information
operationId: homeRunDerbyBracket
parameters:
- description: Unique Primary Key Representing a Game
in: path
name: gamePk
required: true
schema: {}
- description: "Comma delimited list of specific fields to be returned. Format:\
\ topLevelNode, childNode, attribute"
in: query
name: fields
schema: {}
responses:
"200":
content: {}
description: OK
summary: View a home run derby object
tags:
- Homerun Derby
/api/v1/homeRunDerby:
get:
description: This endpoint allows you to pull home run derby information
operationId: homeRunDerbyBracket_1
parameters:
- description: Unique Primary Key Representing a Game
in: path
name: gamePk
required: true
schema: {}
- description: "Comma delimited list of specific fields to be returned. Format:\
\ topLevelNode, childNode, attribute"
in: query
name: fields
schema: {}
responses:
"200":
content: {}
description: OK
summary: View a home run derby object
tags:
- Homerun Derby
/api/v1/homeRunDerby/{gamePk}/bracket:
get:
description: This endpoint allows you to pull home run derby information
operationId: homeRunDerbyBracket_2
parameters:
- description: Unique Primary Key Representing a Game
in: path
name: gamePk
required: true
schema: {}
- description: "Comma delimited list of specific fields to be returned. Format:\
\ topLevelNode, childNode, attribute"
in: query
name: fields
schema: {}
responses:
"200":
content: {}
description: OK
summary: View a home run derby object
tags:
- Homerun Derby
/api/v1/homeRunDerby/bracket:
get:
description: This endpoint allows you to pull home run derby information
operationId: homeRunDerbyBracket_3
parameters:
- description: Unique Primary Key Representing a Game
in: path
name: gamePk
required: true
schema: {}
- description: "Comma delimited list of specific fields to be returned. Format:\
\ topLevelNode, childNode, attribute"
in: query
name: fields
schema: {}
responses:
"200":
content: {}
description: OK
summary: View a home run derby object
tags:
- Homerun Derby
/api/v1/hitTrajectories:
get:
operationId: hitTrajectories
parameters:
- description: "Comma delimited list of specific fields to be returned. Format:\
\ topLevelNode, childNode, attribute"
in: query
name: fields
schema: {}
responses:
"200":
content: {}
description: OK
summary: List all hit trajectories
tags:
- Misc
/api/v1/highLow/{highLowType}:
get:
operationId: highLow
parameters:
- description: "Type of high/low stats ('player', 'team', 'game')"
in: path
name: highLowType
required: true
schema: {}
- description: Comma delimited list of categories of statistic to return. Available
types in /api/v1/statGroups
in: query
name: statGroup
schema: {}
- description: Comma delimited list of baseball stats to sort splits by.
in: query
name: sortStat
schema: {}
- description: Comma delimited list of Seasons of play
in: query
name: season
schema: {}
- description: Comma delimited list of type of Game. Available types in /api/v1/gameTypes
in: query
name: gameType
schema: {}
- description: "Unique Team Identifier. Format: 141, 147, etc"
in: query
name: teamId
schema: {}
- description: Unique League Identifier
in: query
name: leagueId
schema: {}
- description: Top level organization of a sport
in: query
name: sportId
schema: {}
- description: The pointer to start for a return set; used for pagination
in: query
name: offset
schema: {}
- description: Number of results to return
in: query
name: limit
schema: {}
- description: "Comma delimited list of specific fields to be returned. Format:\
\ topLevelNode, childNode, attribute"
in: query
name: fields
schema: {}
responses:
"200":
content: {}
description: OK
summary: View high/low stats by player or team
tags:
- High/Low
/api/v1/highLow/types:
get:
operationId: highLowStats
responses:
"200":
content: {}
description: OK
summary: View high/low stat types
tags:
- High/Low
/api/v1/groupByTypes:
get:
operationId: groupByTypes
responses:
"200":
content: {}
description: OK
summary: List groupBy types
tags:
- Misc
/api/v1/gamedayTypes:
get:
operationId: gamedayTypes
parameters:
- description: "Comma delimited list of specific fields to be returned. Format:\
\ topLevelNode, childNode, attribute"
in: query
name: fields
schema: {}
responses:
"200":
content: {}
description: OK
summary: List all gameday types
tags:
- Misc
/api/v1/gameTypes:
get:
operationId: gameTypes
parameters:
- description: Top level organization of a sport
in: query
name: sportId
schema: {}
- description: Unique League Identifier
in: query
name: leagueId
schema: {}
- description: Season of play
in: query
name: season
schema: {}
responses:
"200":
content: {}
description: OK
summary: List all game types
tags:
- Misc
/api/v1/gamePace:
get:
operationId: gamePace
parameters:
- description: Season of play
in: query
name: season
schema: {}
- description: "Unique Team Identifier. Format: 141, 147, etc"
in: query
name: teamId
schema: {}
- description: Comma delimited list of Unique Team identifiers
in: query
name: teamIds
schema: {}
- description: Unique League Identifier
in: query
name: leagueId
schema: {}
- description: Comma delimited list of Unique league identifiers
in: query
name: leagueIds
schema: {}
- description: Unique League List Identifier
in: query
name: leagueListId
schema: {}
- description: Top level organization of a sport
in: query
name: sportId
schema: {}
- description: Comma delimited list of top level organizations of a sport
in: query
name: sportIds
schema: {}
- description: Type of Game. Available types in /api/v1/gameTypes
in: query
name: gameType
schema: {}
- description: "Start date for range of data (must be used with end date). Format:\
\ MM/DD/YYYY"
in: query
name: startDate
schema: {}
- description: "End date for range of data (must be used with start date). Format:\
\ MM/DD/YYYY"
in: query
name: endDate
schema: {}
- description: Comma delimited list of Unique venue identifiers
in: query
name: venueIds
schema: {}
- description: Comma delimited list of Unique venue identifiers
in: query
name: excludeVenueIds
schema: {}
- description: Comma delimited list of unique primary keys
in: query
name: excludeGamePks
schema: {}
- description: "Organization level. Format: T(Team), L(League), S(Sport)"
in: query
name: orgType
schema: {}
- description: Determines weather to include results from an organization's
children (ex. a sport would also include results for the teams and leagues)
in: query
name: includeChildren
schema: {}
- description: "Comma delimited list of specific fields to be returned. Format:\
\ topLevelNode, childNode, attribute"
in: query
name: fields
schema: {}
responses:
"200":
content: {}
description: OK
summary: View time of game info
tags:
- Game Pace
/api/v1/game/{game_pk}/playByPlay:
get:
description: This endpoint allows you to pull the play by play of a game
operationId: playByPlay
parameters:
- description: Unique Primary Key Representing a Game
in: path
name: game_pk
required: true
schema: {}
- description: "Use this parameter to return a snapshot of the data at the specified\
\ time. Format: YYYYMMDD_HHMMSS"
in: query
name: timecode
schema: {}
- description: "Comma delimited list of specific fields to be returned. Format:\
\ topLevelNode, childNode, attribute"
in: query
name: fields
schema: {}
- description: True to include plays that happen before or at the specified
timecode
in: query
name: inclusiveTimecode
schema: {}
- description: Boolean value to specify wanting a person's name with accents
or without
in: query
name: accent
schema: {}
responses:
"200":
content: {}
description: OK
summary: Get game play By Play
tags:
- Game
/api/v1/game/{game_pk}/linescore:
get:
description: This endpoint allows you to pull the linescore for a game
operationId: linescore
parameters:
- description: Unique Primary Key Representing a Game
in: path
name: game_pk
required: true
schema: {}
- description: "Use this parameter to return a snapshot of the data at the specified\
\ time. Format: YYYYMMDD_HHMMSS"
in: query
name: timecode
schema: {}
- description: "Comma delimited list of specific fields to be returned. Format:\
\ topLevelNode, childNode, attribute"
in: query
name: fields
schema: {}
- description: True to include plays that happen before or at the specified
timecode
in: query
name: inclusiveTimecode
schema: {}
responses:
"200":
content: {}
description: OK
summary: Get game linescore
tags:
- Game
/api/v1/game/{game_pk}/feed/color:
get:
description: "This API can return very large payloads. It is STRONGLY recommended\
\ that clients ask for diffs and use \"Accept-Encoding: gzip\" header."
operationId: colorFeed
parameters:
- description: Unique Primary Key Representing a Game
in: path
name: game_pk
required: true
schema: {}
- description: "Use this parameter to return a snapshot of the data at the specified\
\ time. Format: YYYYMMDD_HHMMSS"
in: query
name: timecode
schema: {}
- description: "Comma delimited list of specific fields to be returned. Format:\
\ topLevelNode, childNode, attribute"
in: query
name: fields
schema: {}
responses:
"200":
content: {}
description: OK
summary: Get game color feed.
tags:
- Game
/api/v1/game/{game_pk}/feed/color/timestamps:
get:
description: "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"
operationId: colorTimestamps
parameters:
- description: Unique Primary Key Representing a Game
in: path
name: game_pk
required: true
schema: {}
responses:
"200":
content: {}
description: OK
summary: Retrieve all of the color timestamps for a game.
tags:
- Game
/api/v1/game/{game_pk}/content:
get:
operationId: content
parameters:
- in: path
name: game_pk
required: true
schema: {}
- description: Number of results to return
in: query
name: highlightLimit
schema: {}
responses:
"200":
content: {}
description: OK
summary: Retrieve all content for a game.
tags:
- Game
/api/v1/game/{game_pk}/boxscore:
get:
description: This endpoint allows you to pull a boxscore
operationId: boxscore
parameters:
- description: Unique Primary Key Representing a Game
in: path
name: game_pk
required: true
schema: {}
- description: "Use this parameter to return a snapshot of the data at the specified\
\ time. Format: YYYYMMDD_HHMMSS"
in: query
name: timecode
schema: {}
- description: "Comma delimited list of specific fields to be returned. Format:\
\ topLevelNode, childNode, attribute"
in: query
name: fields
schema: {}
- description: True to include plays that happen before or at the specified
timecode
in: query
name: inclusiveTimecode
schema: {}
- description: Number of top player game scores to show. Default is 3.
in: query
name: numPlayers
schema: {}
- description: "If set to false, will show all players tied for the last spot\
\ in the game scores list."
in: query
name: noTies
schema: {}
- description: Boolean value to specify wanting a person's name with accents
or without
in: query
name: accent
schema: {}
responses:
"200":
content: {}
description: OK
summary: Get game boxscore.
tags:
- Game
/api/v1/game/{gamePk}/{playId}/analytics/skeletalData/files:
get:
description: This endpoint allows you to pull chunked skeletal tracking data
by gameId and playId
operationId: skeletalDataFileNames
parameters:
- description: Unique Primary Key Representing a Game
in: path
name: gamePk
required: true
schema: {}
- description: Unique play identifier
in: path
name: playId
required: true
schema: {}
- description: "Comma delimited list of specific fields to be returned. Format:\
\ topLevelNode, childNode, attribute"
in: query
name: fields
schema: {}
responses:
"200":
content: {}
description: OK
security:
- basicAuth: []
- bearerAuth: []
summary: View Skeletal Data by playId and gameId files
tags:
- Skeletal
/api/v1/game/{gamePk}/{playId}/analytics/skeletalData/chunked:
get:
description: This endpoint allows you to pull chunked skeletal tracking data
by gameId and playId
operationId: skeletalChunked
parameters:
- description: Unique Primary Key Representing a Game
in: path
name: gamePk
required: true
schema: {}
- description: Unique play identifier
in: path
name: playId
required: true
schema: {}
- description: Skeletal chunked file name
in: query
name: fileName
required: true
schema: {}
- description: "Comma delimited list of specific fields to be returned. Format:\
\ topLevelNode, childNode, attribute"
in: query
name: fields
schema: {}
responses:
"200":
content: {}
description: OK
security:
- basicAuth: []
- bearerAuth: []
summary: View Skeletal Data by playId and gameId chunked
tags:
- Skeletal
/api/v1/game/{gamePk}/{playId}/analytics/biomechanics/{positionId}:
get:
description: This endpoint allows you to pull biomechanical tracking data by
gameId and playId filtered by player positionId
operationId: biomechanical
parameters:
- description: Unique Primary Key Representing a Game
in: path
name: gamePk
required: true
schema: {}
- description: Unique play identifier
in: path
name: playId
required: true
schema: {}
- description: "Position number. Format: 1, 2, 3, etc"
in: path
name: positionId
required: true
schema: {}
- description: "Comma delimited list of specific fields to be returned. Format:\
\ topLevelNode, childNode, attribute"
in: query
name: fields
schema: {}
responses:
"200":
content: {}
description: OK
security:
- basicAuth: []
- bearerAuth: []
summary: View Biomechanical data by playId and gameId filtered by player positionId
tags:
- Biomechanics
/api/v1/game/{gamePk}/{guid}/homeRunBallparks:
get:
description: "Returns a json file containing raw coordinate data and refined\
\ calculated metrics.<br/><br/>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."
operationId: homeRunBallparks
parameters:
- description: Unique Primary Key Representing a Game
in: path
name: gamePk
required: true
schema: {}
- description: Unique identifier for a play within a game
in: path
name: guid
required: true
schema: {}
- in: query
name: isHomeRunParks
required: true
schema: {}
- description: "Comma delimited list of specific fields to be returned. Format:\
\ topLevelNode, childNode, attribute"
in: query
name: fields
schema: {}
responses:
"200":
content: {}
description: OK
summary: Get if the play is a home run is each park for a specific play.
tags:
- analytics
/api/v1/game/{gamePk}/{guid}/contextMetrics:
get:
description: "Returns a json file containing raw coordinate data and refined\
\ calculated metrics.<br/><br/>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."
operationId: contextMetrics
parameters:
- description: Unique Primary Key Representing a Game
in: path
name: gamePk
required: true
schema: {}
- description: Unique identifier for a play within a game
in: path
name: guid
required: true
schema: {}
- description: "Comma delimited list of specific fields to be returned. Format:\
\ topLevelNode, childNode, attribute"
in: query
name: fields
schema: {}
responses:
"200":
content: {}
description: OK
security:
- basicAuth: []
- bearerAuth: []
summary: Get context metrics for a specific gamePk.
tags:
- analytics
/api/v1/game/{gamePk}/{guid}/analytics:
get:
description: "Returns a json file containing raw coordinate data and refined\
\ calculated metrics.<br/><br/>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."
operationId: parsedJsonFormattedAnalytics
parameters:
- description: Unique Primary Key Representing a Game
in: path
name: gamePk
required: true
schema: {}
- description: Unique identifier for a play within a game
in: path
name: guid
required: true
schema: {}
- description: "Comma delimited list of specific fields to be returned. Format:\
\ topLevelNode, childNode, attribute"
in: query
name: fields
schema: {}
responses:
"200":
content: {}
description: OK
security:
- basicAuth: []
- bearerAuth: []
summary: Get Statcast data for a specific play.
tags:
- analytics
/api/v1/game/{gamePk}/withMetrics:
get:
operationId: getGameWithMetrics
parameters:
- description: Unique Primary Key Representing a Game
in: path
name: gamePk
required: true
schema: {}
- description: "Use this parameter to return a snapshot of the data at the specified\
\ time. Format: YYYYMMDD_HHMMSS"
in: query
name: timecode
schema: {}
- description: True to include plays that happen before or at the specified
timecode
in: query
name: inclusiveTimecode
schema: {}
- description: "Comma delimited list of specific fields to be returned. Format:\
\ topLevelNode, childNode, attribute"
in: query
name: fields
schema: {}
- description: Boolean value to specify wanting a person's name with accents
or without
in: query
name: accent
schema: {}
responses:
"200":
content: {}
description: OK
summary: Get game info with metrics
tags:
- Game
/api/v1/game/{gamePk}/winProbability:
get:
operationId: getWinProbability
parameters:
- description: Unique Primary Key Representing a Game
in: path
name: gamePk
required: true
schema: {}
- description: "Use this parameter to return a snapshot of the data at the specified\
\ time. Format: YYYYMMDD_HHMMSS"
in: query
name: timecode
schema: {}
- description: "Comma delimited list of specific fields to be returned. Format:\
\ topLevelNode, childNode, attribute"
in: query
name: fields
schema: {}
- description: True to include plays that happen before or at the specified
timecode
in: query
name: inclusiveTimecode
schema: {}
- description: Boolean value to specify wanting a person's name with accents
or without
in: query
name: accent
schema: {}
responses:
"200":
content: {}
description: OK
summary: Get the win probability for this game
tags:
- Game
/api/v1/game/{gamePk}/guids:
get:
operationId: gameGuids
parameters:
- description: Unique Primary Key Representing a Game
in: path
name: gamePk
required: true
schema: {}
- description: "Comma delimited list of specific fields to be returned. Format:\
\ topLevelNode, childNode, attribute"
in: query
name: fields
schema: {}
- description: "Statcast game mode. Format: 0 = Batting Practive, 1 = Warmup\
\ 2 = Live"
in: query
name: gameModeId
schema: {}
- description: If there was a pitch
in: query
name: isPitch
schema: {}
- description: If there was a hit ball tracked
in: query
name: isHit
schema: {}
- description: If there was a pickoff
in: query
name: isPickoff
schema: {}
- description: True if updated by an auditor
in: query
name: hasUpdates
schema: {}
- description: "Returns all data that was created after the specified timestamp.\
\ Format: YYYY-MM-DDTHH:MM:SSZ"
in: query
name: since
schema: {}
- description: "Return data updated since a specified date. Format: YYYY-MM-DDTHH:MM:SSZ"
in: query
name: updatedSince
schema: {}
- description: "Returns all data that was created after the specified timestamp.\
\ Format: YYYY-MM-DDTHH:MM:SSZ"
in: query
name: lastPlayTime
schema: {}
- description: "Return data updated since a specified date. Format: YYYY-MM-DDTHH:MM:SSZ"
in: query
name: lastUpdatedTime
schema: {}
- description: "Return data updated since a specified date. Format: YYYY-MM-DDTHH:MM:SSZ"
in: query
name: lastMetricsUpdatedTime
schema: {}
- description: "Return data updated since a specified date. Format: YYYY-MM-DDTHH:MM:SSZ"
in: query
name: lastAuditUpdatedTime
schema: {}
- description: The last time SportyBot video was updated
in: query
name: lastVideoUpdatedTime
schema: {}
responses:
"200":
content: {}
description: OK
security:
- basicAuth: []
- bearerAuth: []
summary: 'Get the GUIDs (plays) for a specific game. '
tags:
- analytics
/api/v1/game/{gamePk}/contextMetrics:
get:
operationId: getGameContextMetrics
parameters:
- description: Unique Primary Key Representing a Game
in: path
name: gamePk
required: true
schema: {}
- description: "Use this parameter to return a snapshot of the data at the specified\
\ time. Format: YYYYMMDD_HHMMSS"
in: query
name: timecode
schema: {}
- description: "Comma delimited list of specific fields to be returned. Format:\
\ topLevelNode, childNode, attribute"
in: query
name: fields
schema: {}
responses:
"200":
content: {}
description: OK
summary: Get the context metrics for this game based on its current state
tags:
- Game
/api/v1/game/lastPitch:
get:
operationId: gameLastPitch
parameters:
- description: Unique Primary Key Representing a Game
in: query
name: gamePks
required: true
schema: {}
- description: "Comma delimited list of specific fields to be returned. Format:\
\ topLevelNode, childNode, attribute"
in: query
name: fields
schema: {}
responses:
"200":
content: {}
description: OK
security:
- basicAuth: []
- bearerAuth: []
summary: Get the last pitch for a list of games
tags:
- analytics
/api/v1/game/changes:
get:
operationId: currentGameStats_1
parameters:
- description: "Format: YYYY-MM-DDTHH:MM:SSZ"
in: query
name: updatedSince
schema: {}
- description: Top level organization of a sport
in: query
name: sportId
schema: {}
- description: Comma delimited list of top level organizations of a sport
in: query
name: sportIds
schema: {}
- description: Type of Game. Available types in /api/v1/gameTypes
in: query
name: gameType
schema: {}
- description: Comma delimited list of type of Game. Available types in /api/v1/gameTypes
in: query
name: gameTypes
schema: {}
- description: Season of play
in: query
name: season
schema: {}
- description: Comma delimited list of unique primary keys
in: query
name: gamePks
schema: {}
- description: Number of results to return
in: query
name: limit
schema: {}
- description: The pointer to start for a return set; used for pagination
in: query
name: offset
schema: {}
- description: "Comma delimited list of specific fields to be returned. Format:\
\ topLevelNode, childNode, attribute"
in: query
name: fields
schema: {}
responses:
"200":
content: {}
description: OK
summary: View a game change log
tags:
- Game
/api/v1/freeGameTypes:
get:
operationId: freeGameTypes
responses:
"200":
content: {}
description: OK
summary: View free game types
tags:
- Misc
/api/v1/fielderDetailTypes:
get:
operationId: fielderDetailTypes
responses:
"200":
content: {}
description: OK
summary: List fielder detail types
tags:
- Misc
/api/v1/eventTypes:
get:
operationId: eventTypes
parameters:
- description: "Comma delimited list of specific fields to be returned. Format:\
\ topLevelNode, childNode, attribute"
in: query
name: fields
schema: {}
responses:
"200":
content: {}
description: OK
summary: List all event types
tags:
- Misc
/api/v1/eventStatus:
get:
operationId: eventStatus
responses:
"200":
content: {}
description: OK
summary: List all possible event status types
tags:
- Misc
/api/v1/draft/{year}/latest:
get:
operationId: latestDraftPicks
parameters:
- description: "Year the player was drafted. Format: 2000"
in: path
name: year
required: true
schema: {}
- description: "Comma delimited list of specific fields to be returned. Format:\
\ topLevelNode, childNode, attribute"
in: query
name: fields
schema: {}
responses:
"200":
content: {}
description: OK
summary: Get the last drafted player and the next 5 teams up to pick
tags:
- Draft
/api/v1/draft/prospects:
get:
operationId: draftProspects
parameters:
- description: "Year the player was drafted. Format: 2000"
in: path
name: year
required: true
schema: {}
- description: Number of results to return
in: query
name: limit
schema: {}
- description: The pointer to start for a return set; used for pagination
in: query
name: offset
schema: {}
- description: "Comma delimited list of specific fields to be returned. Format:\
\ topLevelNode, childNode, attribute"
in: query
name: fields
schema: {}
- description: "The order of sorting, ascending or descending"
in: query
name: order
schema: {}
- description: Sort the set of data by the specified field
in: query
name: sortBy
schema: {}
- description: Whether or not the players been drafted
in: query
name: drafted
schema: {}
- description: Round in which a player was drafted
in: query
name: round
schema: {}
- description: Filter players by the first letter of their name using using
the specific character
in: query
name: name
schema: {}
- description: Filter players by the first letter of their school using using
the specific character
in: query
name: school
schema: {}
- description: "Position number. Format: 1, 2, 3, etc"
in: query
name: position
schema: {}
- description: "Unique Team Code. Format: tor, nya, etc"
in: query
name: team
schema: {}
- description: "Unique Team Identifier. Format: 141, 147, etc"
in: query
name: teamId
schema: {}
- description: "State where the venue is located. Format: Ohio"
in: query
name: state
schema: {}
- description: Filter players by their home country
in: query
name: country
schema: {}
- description: A unique identifier for a player
in: query
name: playerId
schema: {}
- description: A unique identifier for a player in the EBIS system
in: query
name: bisPlayerId
schema: {}
responses:
"200":
content: {}
description: OK
summary: View MLB Draft Prospects
tags:
- Draft
/api/v1/draft/prospects/{year}:
get:
operationId: draftProspects_1
parameters:
- description: "Year the player was drafted. Format: 2000"
in: path
name: year
required: true
schema: {}
- description: Number of results to return
in: query
name: limit
schema: {}
- description: The pointer to start for a return set; used for pagination
in: query
name: offset
schema: {}
- description: "Comma delimited list of specific fields to be returned. Format:\
\ topLevelNode, childNode, attribute"
in: query
name: fields
schema: {}
- description: "The order of sorting, ascending or descending"
in: query
name: order
schema: {}
- description: Sort the set of data by the specified field
in: query
name: sortBy
schema: {}
- description: Whether or not the players been drafted
in: query
name: drafted
schema: {}
- description: Round in which a player was drafted
in: query
name: round
schema: {}
- description: Filter players by the first letter of their name using using
the specific character
in: query
name: name
schema: {}
- description: Filter players by the first letter of their school using using
the specific character
in: query
name: school
schema: {}
- description: "Position number. Format: 1, 2, 3, etc"
in: query
name: position
schema: {}
- description: "Unique Team Code. Format: tor, nya, etc"
in: query
name: team
schema: {}
- description: "Unique Team Identifier. Format: 141, 147, etc"
in: query
name: teamId
schema: {}
- description: "State where the venue is located. Format: Ohio"
in: query
name: state
schema: {}
- description: Filter players by their home country
in: query
name: country
schema: {}
- description: A unique identifier for a player
in: query
name: playerId
schema: {}
- description: A unique identifier for a player in the EBIS system
in: query
name: bisPlayerId
schema: {}
responses:
"200":
content: {}
description: OK
summary: View MLB Draft Prospects
tags:
- Draft
/api/v1/draft:
get:
operationId: draftPicks
parameters:
- description: "Year the player was drafted. Format: 2000"
in: path
name: year
required: true
schema: {}
- description: Number of results to return
in: query
name: limit
schema: {}
- description: The pointer to start for a return set; used for pagination
in: query
name: offset
schema: {}
- description: "Comma delimited list of specific fields to be returned. Format:\
\ topLevelNode, childNode, attribute"
in: query
name: fields
schema: {}
- description: "The order of sorting, ascending or descending"
in: query
name: order
schema: {}
- description: Sort the set of data by the specified field
in: query
name: sortBy
schema: {}
- description: Whether or not the players been drafted
in: query
name: drafted
schema: {}
- description: Round in which a player was drafted
in: query
name: round
schema: {}
- description: Filter players by the first letter of their name using using
the specific character
in: query
name: name
schema: {}
- description: Filter players by the first letter of their school using using
the specific character
in: query
name: school
schema: {}
- description: "Position number. Format: 1, 2, 3, etc"
in: query
name: position
schema: {}
- description: "Unique Team Code. Format: tor, nya, etc"
in: query
name: team
schema: {}
- description: "Unique Team Identifier. Format: 141, 147, etc"
in: query
name: teamId
schema: {}
- description: "State where the venue is located. Format: Ohio"
in: query
name: state
schema: {}
- description: Filter players by their home country
in: query
name: country
schema: {}
- description: A unique identifier for a player
in: query
name: playerId
schema: {}
- description: A unique identifier for a player in the EBIS system
in: query
name: bisPlayerId
schema: {}
responses:
"200":
content: {}
description: OK
summary: View MLB Drafted Players
tags:
- Draft
/api/v1/draft/{year}:
get:
operationId: draftPicks_1
parameters:
- description: "Year the player was drafted. Format: 2000"
in: path
name: year
required: true
schema: {}
- description: Number of results to return
in: query
name: limit
schema: {}
- description: The pointer to start for a return set; used for pagination
in: query
name: offset
schema: {}
- description: "Comma delimited list of specific fields to be returned. Format:\
\ topLevelNode, childNode, attribute"
in: query
name: fields
schema: {}
- description: "The order of sorting, ascending or descending"
in: query
name: order
schema: {}
- description: Sort the set of data by the specified field
in: query
name: sortBy
schema: {}
- description: Whether or not the players been drafted
in: query
name: drafted
schema: {}
- description: Round in which a player was drafted
in: query
name: round
schema: {}
- description: Filter players by the first letter of their name using using
the specific character
in: query
name: name
schema: {}
- description: Filter players by the first letter of their school using using
the specific character
in: query
name: school
schema: {}
- description: "Position number. Format: 1, 2, 3, etc"
in: query
name: position
schema: {}
- description: "Unique Team Code. Format: tor, nya, etc"
in: query
name: team
schema: {}
- description: "Unique Team Identifier. Format: 141, 147, etc"
in: query
name: teamId
schema: {}
- description: "State where the venue is located. Format: Ohio"
in: query
name: state
schema: {}
- description: Filter players by their home country
in: query
name: country
schema: {}
- description: A unique identifier for a player
in: query
name: playerId
schema: {}
- description: A unique identifier for a player in the EBIS system
in: query
name: bisPlayerId
schema: {}
responses:
"200":
content: {}
description: OK
summary: View MLB Drafted Players
tags:
- Draft
/api/v1/divisions:
get:
description: This endpoint allows you to pull divisions
operationId: divisions
parameters:
- description: Unique Division Identifier
in: path
name: divisionId
required: true
schema: {}
- description: Whether or not to include inactive
in: query
name: includeInactive
schema: {}
- description: Unique League Identifier
in: query
name: leagueId
schema: {}
- description: Top level organization of a sport
in: query
name: sportId
schema: {}
- description: Season of play
in: query
name: season
schema: {}
- description: "Comma delimited list of specific fields to be returned. Format:\
\ topLevelNode, childNode, attribute"
in: query
name: fields
schema: {}
responses:
"200":
content: {}
description: OK
summary: Get division information
tags:
- Division
/api/v1/divisions/{divisionId}:
get:
description: This endpoint allows you to pull divisions
operationId: divisions_1
parameters:
- description: Unique Division Identifier
in: path
name: divisionId
required: true
schema: {}
- description: Whether or not to include inactive
in: query
name: includeInactive
schema: {}
- description: Unique League Identifier
in: query
name: leagueId
schema: {}
- description: Top level organization of a sport
in: query
name: sportId
schema: {}
- description: Season of play
in: query
name: season
schema: {}
- description: "Comma delimited list of specific fields to be returned. Format:\
\ topLevelNode, childNode, attribute"
in: query
name: fields
schema: {}
responses:
"200":
content: {}
description: OK
summary: Get division information
tags:
- Division
/api/v1/conferences:
get:
operationId: conferences
parameters:
- in: path
name: conferenceId
required: true
schema: {}
- description: Season of play
in: query
name: season
schema: {}
- in: query
name: includeInactive
schema: {}
- description: "Comma delimited list of specific fields to be returned. Format:\
\ topLevelNode, childNode, attribute"
in: query
name: fields
schema: {}
responses:
"200":
content: {}
description: OK
summary: View conference info
tags:
- Conference
/api/v1/conferences/{conferenceId}:
get:
operationId: conferences_1
parameters:
- in: path
name: conferenceId
required: true
schema: {}
- description: Season of play
in: query
name: season
schema: {}
- in: query
name: includeInactive
schema: {}
- description: "Comma delimited list of specific fields to be returned. Format:\
\ topLevelNode, childNode, attribute"
in: query
name: fields
schema: {}
responses:
"200":
content: {}
description: OK
summary: View conference info
tags:
- Conference
/api/v1/coachingVideoTypes:
get:
operationId: coachingVideoTypes
responses:
"200":
content: {}
description: OK
summary: List all coaching video types
tags:
- Misc
/api/v1/broadcasters:
get:
operationId: getAllBroadcasters
parameters:
- description: "Current status of the broadcaster. Format: Active = y, inactive\
\ = n, both = b"
in: query
name: activeStatus
schema: {}
- description: "Comma delimited list of specific fields to be returned. Format:\
\ topLevelNode, childNode, attribute"
in: query
name: fields
schema: {}
responses:
"200":
content: {}
description: OK
summary: Get All Active Broadcasters
tags:
- Broadcast
/api/v1/broadcast:
get:
operationId: getBroadcasts
parameters:
- description: All of the broadcast details
in: query
name: broadcasterIds
required: true
schema: {}
- description: "Comma delimited list of specific fields to be returned. Format:\
\ topLevelNode, childNode, attribute"
in: query
name: fields
schema: {}
responses:
"200":
content: {}
description: OK
summary: Get Broadcasters
tags:
- Broadcast
/api/v1/broadcastAvailability:
get:
operationId: broadcastAvailabilityTypes
responses:
"200":
content: {}
description: OK
summary: View broadcast availability options
tags:
- Misc
/api/v1/batTracking/game/{gamePk}/{playId}:
get:
description: This endpoint allows you to pull bat tracking data by gameId and
playId
operationId: batTracking
parameters:
- description: Unique Primary Key Representing a Game
in: path
name: gamePk
required: true
schema: {}
- description: Unique play identifier
in: path
name: playId
required: true
schema: {}
- description: "Comma delimited list of specific fields to be returned. Format:\
\ topLevelNode, childNode, attribute"
in: query
name: fields
schema: {}
responses:
"200":
content: {}
description: OK
security:
- basicAuth: []
- bearerAuth: []
summary: View Bat Tracking Data by playId and gameId
tags:
- Bat Tracking
/api/v1/baseballStats:
get:
operationId: baseballStats
responses:
"200":
content: {}
description: OK
summary: List all baseball stats
tags:
- Misc
/api/v1/awards/{awardId}/recipients:
get:
operationId: awardRecipients
parameters:
- description: Unique Award Identifier. Available awards in /api/v1/awards
in: path
name: awardId
required: true
schema: {}
- description: Season of play
in: query
name: season
schema: {}
- description: Top level organization of a sport
in: query
name: sportId
schema: {}
- description: Comma delimited list of Unique league identifiers
in: query
name: leagueId
schema: {}
- in: query
name: fields
schema: {}
responses:
"200":
content: {}
description: OK
summary: View recipients of an award
tags:
- Awards
/api/v1/awards:
get:
operationId: awards
parameters:
- description: Unique Award Identifier. Available awards in /api/v1/awards
in: path
name: awardId
required: true
schema: {}
- description: Comma delimited list of top level organizations of a sport
in: query
name: orgId
schema: {}
- description: "Comma delimited list of specific fields to be returned. Format:\
\ topLevelNode, childNode, attribute"
in: query
name: fields
schema: {}
responses:
"200":
content: {}
description: OK
summary: View awards info
tags:
- Awards
/api/v1/awards/{awardId}:
get:
operationId: awards_1
parameters:
- description: Unique Award Identifier. Available awards in /api/v1/awards
in: path
name: awardId
required: true
schema: {}
- description: Comma delimited list of top level organizations of a sport
in: query
name: orgId
schema: {}
- description: "Comma delimited list of specific fields to be returned. Format:\
\ topLevelNode, childNode, attribute"
in: query
name: fields
schema: {}
responses:
"200":
content: {}
description: OK
summary: View awards info
tags:
- Awards
/api/v1/attendance:
get:
operationId: getTeamAttendance
parameters:
- description: "Unique Team Identifier. Format: 141, 147, etc"
in: query
name: teamId
schema: {}
- description: Comma delimited list of Unique league identifiers
in: query
name: leagueId
schema: {}
- description: Comma delimited list of Seasons of play
in: query
name: season
schema: {}
- description: Unique League List Identifier
in: query
name: leagueListId
schema: {}
- description: Type of Game. Available types in /api/v1/gameTypes
in: query
name: gameType
schema: {}
- description: "Date of Game. Format: YYYY-MM-DD"
in: query
name: date
schema: {}
- description: "Start date for range of data (must be used with end date). Format:\
\ MM/DD/YYYY"
in: query
name: startDate
schema: {}
- description: "End date for range of data (must be used with start date). Format:\
\ MM/DD/YYYY"
in: query
name: endDate
schema: {}
- description: "Comma delimited list of specific fields to be returned. Format:\
\ topLevelNode, childNode, attribute"
in: query
name: fields
schema: {}
responses:
"200":
content: {}
description: OK
summary: Get team attendance
tags:
- Attendance
/api/v1/analytics/guids:
get:
operationId: gameGuidsFromPostgresRange
parameters:
- description: "Comma delimited list of specific fields to be returned. Format:\
\ topLevelNode, childNode, attribute"
in: query
name: fields
schema: {}
- description: "Statcast game mode. Format: 0 = Batting Practive, 1 = Warmup\
\ 2 = Live"
in: query
name: gameModeId
schema: {}
- description: If there was a pitch
in: query
name: isPitch
schema: {}
- description: If there was a hit ball tracked
in: query
name: isHit
schema: {}
- description: If there was a pickoff
in: query
name: isPickoff
schema: {}
- description: If non statcast games need to be included
in: query
name: isNonStatcast
schema: {}
- description: "Indicates the level of Gameday (tracking, play-by-play, linescore,\
\ etc...)"
in: query
name: gamedayType
schema: {}
- description: True if updated by an auditor
in: query
name: hasUpdates
schema: {}
- description: "Returns all data that was created after the specified timestamp.\
\ Format: YYYY-MM-DDTHH:MM:SSZ"
in: query
name: lastPlayTime
schema: {}
- description: "Return data updated since a specified date. Format: YYYY-MM-DDTHH:MM:SSZ"
in: query
name: lastUpdatedTime
schema: {}
- description: "Return data updated since a specified date. Format: YYYY-MM-DDTHH:MM:SSZ"
in: query
name: lastMetricsUpdatedTime
schema: {}
- description: "Return data updated since a specified date. Format: YYYY-MM-DDTHH:MM:SSZ"
in: query
name: lastAuditUpdatedTime
schema: {}
- description: The last time SportyBot video was updated
in: query
name: lastVideoUpdatedTime
schema: {}
- description: "Date of Game. Format: YYYY-MM-DD"
in: query
name: gameDate
schema: {}
- description: Top level organization of a sport
in: query
name: sportId
schema: {}
- description: Type of Game. Available types in /api/v1/gameTypes
in: query
name: gameType
schema: {}
- description: Owner of the tracking system
in: query
name: trackingSystemOwner
schema: {}
- description: Season of play
in: query
name: season
schema: {}
- description: Sort the set of data by the specified field
in: query
name: sortBy
schema: {}
- description: Number of results to return
in: query
name: limit
schema: {}
- description: The pointer to start for a return set; used for pagination
in: query
name: offset
schema: {}
responses:
"200":
content: {}
description: OK
security:
- basicAuth: []
- bearerAuth: []
summary: 'Get the GUIDs (plays) for a specific game. '
tags:
- analytics
/api/v1/analytics/game:
get:
operationId: gameGuidsFromPostgresRangeByGame
parameters:
- description: "Comma delimited list of specific fields to be returned. Format:\
\ topLevelNode, childNode, attribute"
in: query
name: fields
schema: {}
- description: "Statcast game mode. Format: 0 = Batting Practive, 1 = Warmup\
\ 2 = Live"
in: query
name: gameModeId
schema: {}
- description: If there was a pitch
in: query
name: isPitch
schema: {}
- description: If there was a hit ball tracked
in: query
name: isHit
schema: {}
- description: If there was a pickoff
in: query
name: isPickoff
schema: {}
- description: If non statcast games need to be included
in: query
name: isNonStatcast
schema: {}
- description: "Indicates the level of Gameday (tracking, play-by-play, linescore,\
\ etc...)"
in: query
name: gamedayType
schema: {}
- description: True if updated by an auditor
in: query
name: hasUpdates
schema: {}
- description: "Returns all data that was created after the specified timestamp.\
\ Format: YYYY-MM-DDTHH:MM:SSZ"
in: query
name: lastPlayTime
schema: {}
- description: The last time SportyBot video was updated
in: query
name: lastVideoUpdatedTime
schema: {}
- description: "Return data updated since a specified date. Format: YYYY-MM-DDTHH:MM:SSZ"
in: query
name: lastUpdatedTime
schema: {}
- description: "Return data updated since a specified date. Format: YYYY-MM-DDTHH:MM:SSZ"
in: query
name: lastMetricsUpdatedTime
schema: {}
- description: "Return data updated since a specified date. Format: YYYY-MM-DDTHH:MM:SSZ"
in: query
name: lastAuditUpdatedTime
schema: {}
- description: "Date of Game. Format: YYYY-MM-DD"
in: query
name: gameDate
schema: {}
- description: Top level organization of a sport
in: query
name: sportId
schema: {}
- description: Type of Game. Available types in /api/v1/gameTypes
in: query
name: gameType
schema: {}
- description: Season of play
in: query
name: season
schema: {}
- description: Owner of the tracking system
in: query
name: trackingSystemOwner
schema: {}
- description: Sort the set of data by the specified field
in: query
name: sortBy
schema: {}
- description: Number of results to return
in: query
name: limit
schema: {}
- description: The pointer to start for a return set; used for pagination
in: query
name: offset
schema: {}
- description: Comma delimited list of type of event types
in: query
name: scheduleEventTypes
schema: {}
responses:
"200":
content: {}
description: OK
security:
- basicAuth: []
- bearerAuth: []
summary: Get all games by updated date.
tags:
- analytics
/api/v1/achievementStatuses:
get:
operationId: achievementStatuses
responses:
"200":
content: {}
description: OK
summary: View available achievementStatus options
tags:
- Milestones
/api/v1.1/game/{game_pk}/feed/live:
get:
description: "This API can return very large payloads. It is STRONGLY recommended\
\ that clients ask for diffs and use \"Accept-Encoding: gzip\" header."
operationId: liveGameV1
parameters:
- description: Unique Primary Key Representing a Game
in: path
name: game_pk
required: true
schema: {}
- description: "Use this parameter to return a snapshot of the data at the specified\
\ time. Format: YYYYMMDD_HHMMSS"
in: query
name: timecode
schema: {}
- description: "Comma delimited list of specific fields to be returned. Format:\
\ topLevelNode, childNode, attribute"
in: query
name: fields
schema: {}
- description: True to include plays that happen before or at the specified
timecode
in: query
name: inclusiveTimecode
schema: {}
- description: Boolean value to specify wanting a person's name with accents
or without
in: query
name: accent
schema: {}
responses:
"200":
content: {}
description: OK
summary: Get live game status.
tags:
- Game
/api/v1.1/game/{game_pk}/feed/live/timestamps:
get:
description: "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"
operationId: liveTimestampv11
parameters:
- description: Unique Primary Key Representing a Game
in: path
name: game_pk
required: true
schema: {}
responses:
"200":
content: {}
description: OK
summary: Retrieve all of the play timestamps for a game.
tags:
- Game
/api/v1.1/game/{game_pk}/feed/live/diffPatch:
get:
description: "This endpoint allows comparison of game files and shows any differences/discrepancies\
\ between the two<br/><br/><b>Diff/Patch System:</b> startTimecode and endTimecode\
\ can be used for getting diffs.<br/>Expected usage: <br/> 1) Request full\
\ payload by not passing startTimecode or endTimecode. This will return the\
\ most recent game state.<br/> 2) Find the latest timecode in this response.\
\ <br/> 3) Wait X seconds<br/> 4) Use the timecode from 2 as the startTimecode.\
\ This will give you a diff of everything that has happened since startTimecode.\
\ <br/> 5) If no data is returned, wait X seconds and do the same request.\
\ <br/> 6) If data is returned, get a new timeStamp from the response, and\
\ use that for the next call as startTimecode."
operationId: liveGameDiffPatchV1
parameters:
- description: Unique Primary Key Representing a Game
in: path
name: game_pk
required: true
schema: {}
- description: "Start time code will give you everything since that time. Format:\
\ MMDDYYYY_HHMMSS"
in: query
name: startTimecode
schema: {}
- description: "End time code will give you a snapshot at that specific time.\
\ Format: MMDDYYYY_HHMMSS"
in: query
name: endTimecode
schema: {}
- description: Boolean value to specify wanting a person's name with accents
or without
in: query
name: accent
schema: {}
responses:
"200":
content: {}
description: OK
summary: Get live game status diffPatch.
tags:
- Game
components:
schemas: {}
x-original-swagger-version: 3.0.1
Reference in New Issue View Git Blame Copy Permalink