8194 lines
387 KiB
HTML
8194 lines
387 KiB
HTML
<!doctype html>
|
|
<html>
|
|
<head>
|
|
<title>Stats API Documentation</title>
|
|
<link rel="stylesheet" href="/styles/statsapi.css" />
|
|
</head>
|
|
<body>
|
|
<aside>
|
|
<p>This documentation was auto-generated based on an OpenAPI spec found <a href=https://github.com/MajorLeagueBaseball/google-cloud-mlb-hackathon>here</a>.</p>
|
|
|
|
<p>I have no affiliation with MLB. Content supplied by MLB's Stats API is
|
|
copyright MLB Advanced Media, L.P., and use of any content provided by
|
|
the API acknowledges agreement to the terms posted <a href=http://gdx.mlb.com/components/copyright.txt>here</a>.</p>
|
|
</aside>
|
|
<h1>Stats API Documentation</h1>
|
|
<div class="app-desc">Official API for Major League Baseball.</div>
|
|
<div class="app-desc">Version: 2.0.0</div>
|
|
<h2>Access</h2>
|
|
|
|
<h2><a name="__Methods">Methods</a></h2>
|
|
[ Jump to <a href="#__Models">Models</a> ]
|
|
|
|
<h3>Table of Contents </h3>
|
|
<div class="method-summary"></div>
|
|
<h4><a href="#Analytics">Analytics</a></h4>
|
|
<ul>
|
|
<li><a href="#contextMetrics"><code><span class="http-method">get</span> /api/v1/game/{gamePk}/{guid}/contextMetrics</code></a></li>
|
|
<li><a href="#contextMetricsWithAverages"><code><span class="http-method">get</span> /api/v1/game/{gamePk}/{guid}/contextMetricsAverages</code></a></li>
|
|
<li><a href="#contextMetricsWithAveragesPost"><code><span class="http-method">post</span> /api/v1/game/{gamePk}/{guid}/contextMetricsAverages</code></a></li>
|
|
<li><a href="#gameGuids"><code><span class="http-method">get</span> /api/v1/game/{gamePk}/guids</code></a></li>
|
|
<li><a href="#gameGuidsFromPostgresRange"><code><span class="http-method">get</span> /api/v1/analytics/guids</code></a></li>
|
|
<li><a href="#gameGuidsFromPostgresRangeByGame"><code><span class="http-method">get</span> /api/v1/analytics/game</code></a></li>
|
|
<li><a href="#gameLastPitch"><code><span class="http-method">get</span> /api/v1/game/lastPitch</code></a></li>
|
|
<li><a href="#homeRunBallparks"><code><span class="http-method">get</span> /api/v1/game/{gamePk}/{guid}/homeRunBallparks</code></a></li>
|
|
<li><a href="#parsedJsonFormattedAnalytics"><code><span class="http-method">get</span> /api/v1/game/{gamePk}/{guid}/analytics</code></a></li>
|
|
</ul>
|
|
<h4><a href="#Attendance">Attendance</a></h4>
|
|
<ul>
|
|
<li><a href="#getTeamAttendance"><code><span class="http-method">get</span> /api/v1/attendance</code></a></li>
|
|
</ul>
|
|
<h4><a href="#Awards">Awards</a></h4>
|
|
<ul>
|
|
<li><a href="#awardRecipients"><code><span class="http-method">get</span> /api/v1/awards/{awardId}/recipients</code></a></li>
|
|
<li><a href="#awards"><code><span class="http-method">get</span> /api/v1/awards</code></a></li>
|
|
<li><a href="#awards1"><code><span class="http-method">get</span> /api/v1/awards/{awardId}</code></a></li>
|
|
</ul>
|
|
<h4><a href="#BatTracking">BatTracking</a></h4>
|
|
<ul>
|
|
<li><a href="#batTracking"><code><span class="http-method">get</span> /api/v1/batTracking/game/{gamePk}/{playId}</code></a></li>
|
|
</ul>
|
|
<h4><a href="#Biomechanics">Biomechanics</a></h4>
|
|
<ul>
|
|
<li><a href="#biomechanical"><code><span class="http-method">get</span> /api/v1/game/{gamePk}/{playId}/analytics/biomechanics/{positionId}</code></a></li>
|
|
</ul>
|
|
<h4><a href="#Broadcast">Broadcast</a></h4>
|
|
<ul>
|
|
<li><a href="#getAllBroadcasters"><code><span class="http-method">get</span> /api/v1/broadcasters</code></a></li>
|
|
<li><a href="#getBroadcasts"><code><span class="http-method">get</span> /api/v1/broadcast</code></a></li>
|
|
</ul>
|
|
<h4><a href="#Conference">Conference</a></h4>
|
|
<ul>
|
|
<li><a href="#conferences"><code><span class="http-method">get</span> /api/v1/conferences</code></a></li>
|
|
<li><a href="#conferences1"><code><span class="http-method">get</span> /api/v1/conferences/{conferenceId}</code></a></li>
|
|
</ul>
|
|
<h4><a href="#Division">Division</a></h4>
|
|
<ul>
|
|
<li><a href="#divisions"><code><span class="http-method">get</span> /api/v1/divisions</code></a></li>
|
|
<li><a href="#divisions1"><code><span class="http-method">get</span> /api/v1/divisions/{divisionId}</code></a></li>
|
|
</ul>
|
|
<h4><a href="#Draft">Draft</a></h4>
|
|
<ul>
|
|
<li><a href="#draftPicks"><code><span class="http-method">get</span> /api/v1/draft</code></a></li>
|
|
<li><a href="#draftPicks1"><code><span class="http-method">get</span> /api/v1/draft/{year}</code></a></li>
|
|
<li><a href="#draftProspects"><code><span class="http-method">get</span> /api/v1/draft/prospects</code></a></li>
|
|
<li><a href="#draftProspects1"><code><span class="http-method">get</span> /api/v1/draft/prospects/{year}</code></a></li>
|
|
<li><a href="#latestDraftPicks"><code><span class="http-method">get</span> /api/v1/draft/{year}/latest</code></a></li>
|
|
</ul>
|
|
<h4><a href="#Game">Game</a></h4>
|
|
<ul>
|
|
<li><a href="#boxscore"><code><span class="http-method">get</span> /api/v1/game/{game_pk}/boxscore</code></a></li>
|
|
<li><a href="#colorFeed"><code><span class="http-method">get</span> /api/v1/game/{game_pk}/feed/color</code></a></li>
|
|
<li><a href="#colorTimestamps"><code><span class="http-method">get</span> /api/v1/game/{game_pk}/feed/color/timestamps</code></a></li>
|
|
<li><a href="#content"><code><span class="http-method">get</span> /api/v1/game/{game_pk}/content</code></a></li>
|
|
<li><a href="#currentGameStats1"><code><span class="http-method">get</span> /api/v1/game/changes</code></a></li>
|
|
<li><a href="#getGameContextMetrics"><code><span class="http-method">get</span> /api/v1/game/{gamePk}/contextMetrics</code></a></li>
|
|
<li><a href="#getGameWithMetrics"><code><span class="http-method">get</span> /api/v1/game/{gamePk}/withMetrics</code></a></li>
|
|
<li><a href="#getWinProbability"><code><span class="http-method">get</span> /api/v1/game/{gamePk}/winProbability</code></a></li>
|
|
<li><a href="#linescore"><code><span class="http-method">get</span> /api/v1/game/{game_pk}/linescore</code></a></li>
|
|
<li><a href="#liveGameDiffPatchV1"><code><span class="http-method">get</span> /api/v1.1/game/{game_pk}/feed/live/diffPatch</code></a></li>
|
|
<li><a href="#liveGameV1"><code><span class="http-method">get</span> /api/v1.1/game/{game_pk}/feed/live</code></a></li>
|
|
<li><a href="#liveTimestampv11"><code><span class="http-method">get</span> /api/v1.1/game/{game_pk}/feed/live/timestamps</code></a></li>
|
|
<li><a href="#playByPlay"><code><span class="http-method">get</span> /api/v1/game/{game_pk}/playByPlay</code></a></li>
|
|
</ul>
|
|
<h4><a href="#GamePace">GamePace</a></h4>
|
|
<ul>
|
|
<li><a href="#gamePace"><code><span class="http-method">get</span> /api/v1/gamePace</code></a></li>
|
|
</ul>
|
|
<h4><a href="#HighLow">HighLow</a></h4>
|
|
<ul>
|
|
<li><a href="#highLow"><code><span class="http-method">get</span> /api/v1/highLow/{highLowType}</code></a></li>
|
|
<li><a href="#highLowStats"><code><span class="http-method">get</span> /api/v1/highLow/types</code></a></li>
|
|
</ul>
|
|
<h4><a href="#HomerunDerby">HomerunDerby</a></h4>
|
|
<ul>
|
|
<li><a href="#homeRunDerbyBracket"><code><span class="http-method">get</span> /api/v1/homeRunDerby/{gamePk}</code></a></li>
|
|
<li><a href="#homeRunDerbyBracket1"><code><span class="http-method">get</span> /api/v1/homeRunDerby</code></a></li>
|
|
<li><a href="#homeRunDerbyBracket2"><code><span class="http-method">get</span> /api/v1/homeRunDerby/{gamePk}/bracket</code></a></li>
|
|
<li><a href="#homeRunDerbyBracket3"><code><span class="http-method">get</span> /api/v1/homeRunDerby/bracket</code></a></li>
|
|
<li><a href="#homeRunDerbyMixedMode"><code><span class="http-method">get</span> /api/v1/homeRunDerby/{gamePk}/mixed</code></a></li>
|
|
<li><a href="#homeRunDerbyMixedMode1"><code><span class="http-method">get</span> /api/v1/homeRunDerby/mixed</code></a></li>
|
|
<li><a href="#homeRunDerbyPool"><code><span class="http-method">get</span> /api/v1/homeRunDerby/{gamePk}/pool</code></a></li>
|
|
<li><a href="#homeRunDerbyPool1"><code><span class="http-method">get</span> /api/v1/homeRunDerby/pool</code></a></li>
|
|
</ul>
|
|
<h4><a href="#Job">Job</a></h4>
|
|
<ul>
|
|
<li><a href="#datacasters"><code><span class="http-method">get</span> /api/v1/jobs/datacasters</code></a></li>
|
|
<li><a href="#getJobsByType"><code><span class="http-method">get</span> /api/v1/jobs</code></a></li>
|
|
<li><a href="#officialScorers"><code><span class="http-method">get</span> /api/v1/jobs/officialScorers</code></a></li>
|
|
<li><a href="#umpireSchedule"><code><span class="http-method">get</span> /api/v1/jobs/umpires/games/{umpireId}</code></a></li>
|
|
<li><a href="#umpires"><code><span class="http-method">get</span> /api/v1/jobs/umpires</code></a></li>
|
|
</ul>
|
|
<h4><a href="#League">League</a></h4>
|
|
<ul>
|
|
<li><a href="#allStarBallot"><code><span class="http-method">get</span> /api/v1/league/allStarBallot</code></a></li>
|
|
<li><a href="#allStarBallot1"><code><span class="http-method">get</span> /api/v1/league/{leagueId}/allStarBallot</code></a></li>
|
|
<li><a href="#allStarBallot2"><code><span class="http-method">get</span> /api/v1/leagues/allStarBallot</code></a></li>
|
|
<li><a href="#allStarBallot3"><code><span class="http-method">get</span> /api/v1/leagues/{leagueId}/allStarBallot</code></a></li>
|
|
<li><a href="#allStarFinalVote"><code><span class="http-method">get</span> /api/v1/league/{leagueId}/allStarFinalVote</code></a></li>
|
|
<li><a href="#allStarFinalVote1"><code><span class="http-method">get</span> /api/v1/leagues/{leagueId}/allStarFinalVote</code></a></li>
|
|
<li><a href="#allStarWriteIns"><code><span class="http-method">get</span> /api/v1/league/{leagueId}/allStarWriteIns</code></a></li>
|
|
<li><a href="#allStarWriteIns1"><code><span class="http-method">get</span> /api/v1/leagues/{leagueId}/allStarWriteIns</code></a></li>
|
|
<li><a href="#league"><code><span class="http-method">get</span> /api/v1/league</code></a></li>
|
|
<li><a href="#league1"><code><span class="http-method">get</span> /api/v1/league/{leagueId}</code></a></li>
|
|
<li><a href="#league2"><code><span class="http-method">get</span> /api/v1/leagues</code></a></li>
|
|
<li><a href="#league3"><code><span class="http-method">get</span> /api/v1/leagues/{leagueId}</code></a></li>
|
|
</ul>
|
|
<h4><a href="#Milestones">Milestones</a></h4>
|
|
<ul>
|
|
<li><a href="#achievementStatuses"><code><span class="http-method">get</span> /api/v1/achievementStatuses</code></a></li>
|
|
<li><a href="#milestoneDurations"><code><span class="http-method">get</span> /api/v1/milestoneDurations</code></a></li>
|
|
<li><a href="#milestoneLookups"><code><span class="http-method">get</span> /api/v1/milestoneLookups</code></a></li>
|
|
<li><a href="#milestoneStatistics"><code><span class="http-method">get</span> /api/v1/milestoneStatistics</code></a></li>
|
|
<li><a href="#milestoneTypes"><code><span class="http-method">get</span> /api/v1/milestoneTypes</code></a></li>
|
|
<li><a href="#milestones"><code><span class="http-method">get</span> /api/v1/milestones</code></a></li>
|
|
</ul>
|
|
<h4><a href="#Misc">Misc</a></h4>
|
|
<ul>
|
|
<li><a href="#aggregateSortEnum"><code><span class="http-method">get</span> /api/v1/sortModifiers</code></a></li>
|
|
<li><a href="#baseballStats"><code><span class="http-method">get</span> /api/v1/baseballStats</code></a></li>
|
|
<li><a href="#broadcastAvailabilityTypes"><code><span class="http-method">get</span> /api/v1/broadcastAvailability</code></a></li>
|
|
<li><a href="#coachingVideoTypes"><code><span class="http-method">get</span> /api/v1/coachingVideoTypes</code></a></li>
|
|
<li><a href="#eventStatus"><code><span class="http-method">get</span> /api/v1/eventStatus</code></a></li>
|
|
<li><a href="#eventTypes"><code><span class="http-method">get</span> /api/v1/eventTypes</code></a></li>
|
|
<li><a href="#fielderDetailTypes"><code><span class="http-method">get</span> /api/v1/fielderDetailTypes</code></a></li>
|
|
<li><a href="#freeGameTypes"><code><span class="http-method">get</span> /api/v1/freeGameTypes</code></a></li>
|
|
<li><a href="#gameStatus"><code><span class="http-method">get</span> /api/v1/gameStatus</code></a></li>
|
|
<li><a href="#gameTypes"><code><span class="http-method">get</span> /api/v1/gameTypes</code></a></li>
|
|
<li><a href="#gamedayTypes"><code><span class="http-method">get</span> /api/v1/gamedayTypes</code></a></li>
|
|
<li><a href="#getLookupValues"><code><span class="http-method">get</span> /api/v1/lookup/values/all</code></a></li>
|
|
<li><a href="#groupByTypes"><code><span class="http-method">get</span> /api/v1/groupByTypes</code></a></li>
|
|
<li><a href="#hitTrajectories"><code><span class="http-method">get</span> /api/v1/hitTrajectories</code></a></li>
|
|
<li><a href="#jobTypes"><code><span class="http-method">get</span> /api/v1/jobTypes</code></a></li>
|
|
<li><a href="#languages"><code><span class="http-method">get</span> /api/v1/languages</code></a></li>
|
|
<li><a href="#leagueLeaderTypes"><code><span class="http-method">get</span> /api/v1/leagueLeaderTypes</code></a></li>
|
|
<li><a href="#logicalEvents"><code><span class="http-method">get</span> /api/v1/logicalEvents</code></a></li>
|
|
<li><a href="#mediaStateTypes"><code><span class="http-method">get</span> /api/v1/mediaState</code></a></li>
|
|
<li><a href="#metrics"><code><span class="http-method">get</span> /api/v1/metrics</code></a></li>
|
|
<li><a href="#moundVisitTypes"><code><span class="http-method">get</span> /api/v1/moundVisitTypes</code></a></li>
|
|
<li><a href="#performerTypes"><code><span class="http-method">get</span> /api/v1/performerTypes</code></a></li>
|
|
<li><a href="#pitchCodes"><code><span class="http-method">get</span> /api/v1/pitchCodes</code></a></li>
|
|
<li><a href="#pitchTypes"><code><span class="http-method">get</span> /api/v1/pitchTypes</code></a></li>
|
|
<li><a href="#platforms"><code><span class="http-method">get</span> /api/v1/platforms</code></a></li>
|
|
<li><a href="#playerStatusCodes"><code><span class="http-method">get</span> /api/v1/playerStatusCodes</code></a></li>
|
|
<li><a href="#positions"><code><span class="http-method">get</span> /api/v1/positions</code></a></li>
|
|
<li><a href="#reviewReasons"><code><span class="http-method">get</span> /api/v1/reviewReasons</code></a></li>
|
|
<li><a href="#roofTypes"><code><span class="http-method">get</span> /api/v1/roofTypes</code></a></li>
|
|
<li><a href="#rosterTypes"><code><span class="http-method">get</span> /api/v1/rosterTypes</code></a></li>
|
|
<li><a href="#ruleSettings"><code><span class="http-method">get</span> /api/v1/ruleSettings</code></a></li>
|
|
<li><a href="#runnerDetailTypes"><code><span class="http-method">get</span> /api/v1/runnerDetailTypes</code></a></li>
|
|
<li><a href="#scheduleEventTypes"><code><span class="http-method">get</span> /api/v1/scheduleEventTypes</code></a></li>
|
|
<li><a href="#scheduleTypes"><code><span class="http-method">get</span> /api/v1/scheduleTypes</code></a></li>
|
|
<li><a href="#sitCodes"><code><span class="http-method">get</span> /api/v1/situationCodes</code></a></li>
|
|
<li><a href="#sky"><code><span class="http-method">get</span> /api/v1/sky</code></a></li>
|
|
<li><a href="#standingsTypes"><code><span class="http-method">get</span> /api/v1/standingsTypes</code></a></li>
|
|
<li><a href="#statFields"><code><span class="http-method">get</span> /api/v1/statFields</code></a></li>
|
|
<li><a href="#statGroups"><code><span class="http-method">get</span> /api/v1/statGroups</code></a></li>
|
|
<li><a href="#statSearchConfig"><code><span class="http-method">get</span> /api/v1/stats/search/config</code></a></li>
|
|
<li><a href="#statSearchGroupByTypes"><code><span class="http-method">get</span> /api/v1/stats/search/groupByTypes</code></a></li>
|
|
<li><a href="#statSearchParams"><code><span class="http-method">get</span> /api/v1/stats/search/params</code></a></li>
|
|
<li><a href="#statSearchStats"><code><span class="http-method">get</span> /api/v1/stats/search/stats</code></a></li>
|
|
<li><a href="#statTypes"><code><span class="http-method">get</span> /api/v1/statTypes</code></a></li>
|
|
<li><a href="#statcastPositionTypes"><code><span class="http-method">get</span> /api/v1/statcastPositionTypes</code></a></li>
|
|
<li><a href="#trackingSoftwareVersions"><code><span class="http-method">get</span> /api/v1/trackingSoftwareVersions</code></a></li>
|
|
<li><a href="#trackingSystemOwners"><code><span class="http-method">get</span> /api/v1/trackingSystemOwners</code></a></li>
|
|
<li><a href="#trackingVendors"><code><span class="http-method">get</span> /api/v1/trackingVendors</code></a></li>
|
|
<li><a href="#trackingVersions"><code><span class="http-method">get</span> /api/v1/trackingVersions</code></a></li>
|
|
<li><a href="#transactionTypes"><code><span class="http-method">get</span> /api/v1/transactionTypes</code></a></li>
|
|
<li><a href="#updateGameStatuses"><code><span class="http-method">post</span> /api/v1/gameStatus</code></a></li>
|
|
<li><a href="#updateJobTypes"><code><span class="http-method">post</span> /api/v1/jobTypes</code></a></li>
|
|
<li><a href="#videoResolutionTypes"><code><span class="http-method">get</span> /api/v1/videoResolutionTypes</code></a></li>
|
|
<li><a href="#violationTypes"><code><span class="http-method">get</span> /api/v1/violationTypes</code></a></li>
|
|
<li><a href="#weatherTrajectoryConfidences"><code><span class="http-method">get</span> /api/v1/weatherTrajectoryConfidences</code></a></li>
|
|
<li><a href="#windDirection"><code><span class="http-method">get</span> /api/v1/windDirection</code></a></li>
|
|
</ul>
|
|
<h4><a href="#Person">Person</a></h4>
|
|
<ul>
|
|
<li><a href="#award"><code><span class="http-method">get</span> /api/v1/people/{personId}/awards</code></a></li>
|
|
<li><a href="#currentGameStats"><code><span class="http-method">get</span> /api/v1/people/changes</code></a></li>
|
|
<li><a href="#freeAgents"><code><span class="http-method">get</span> /api/v1/people/freeAgents</code></a></li>
|
|
<li><a href="#person"><code><span class="http-method">get</span> /api/v1/people/{personId}</code></a></li>
|
|
<li><a href="#person1"><code><span class="http-method">get</span> /api/v1/people</code></a></li>
|
|
<li><a href="#playerGameStats"><code><span class="http-method">get</span> /api/v1/people/{personId}/stats/game/{gamePk}</code></a></li>
|
|
<li><a href="#search"><code><span class="http-method">get</span> /api/v1/people/search</code></a></li>
|
|
<li><a href="#stats3"><code><span class="http-method">get</span> /api/v1/people/{personId}/stats</code></a></li>
|
|
<li><a href="#statsMetrics"><code><span class="http-method">get</span> /api/v1/people/{personId}/stats/metrics</code></a></li>
|
|
</ul>
|
|
<h4><a href="#Predictions">Predictions</a></h4>
|
|
<ul>
|
|
<li><a href="#getProps"><code><span class="http-method">get</span> /api/v1/props/play/predictions</code></a></li>
|
|
<li><a href="#getPropsAdjust"><code><span class="http-method">get</span> /api/v1/props/play/predictions/adjust</code></a></li>
|
|
</ul>
|
|
<h4><a href="#Reviews">Reviews</a></h4>
|
|
<ul>
|
|
<li><a href="#getReviewInfo"><code><span class="http-method">get</span> /api/v1/review</code></a></li>
|
|
</ul>
|
|
<h4><a href="#Schedule">Schedule</a></h4>
|
|
<ul>
|
|
<li><a href="#postseasonSchedule"><code><span class="http-method">get</span> /api/v1/schedule/postseason</code></a></li>
|
|
<li><a href="#postseasonScheduleSeries"><code><span class="http-method">get</span> /api/v1/schedule/postseason/series</code></a></li>
|
|
<li><a href="#schedule"><code><span class="http-method">get</span> /api/v1/schedule</code></a></li>
|
|
<li><a href="#schedule1"><code><span class="http-method">get</span> /api/v1/schedule/{scheduleType}</code></a></li>
|
|
<li><a href="#tieGames"><code><span class="http-method">get</span> /api/v1/schedule/games/tied</code></a></li>
|
|
<li><a href="#trackingEventsSchedule"><code><span class="http-method">get</span> /api/v1/schedule/trackingEvents</code></a></li>
|
|
<li><a href="#tuneIn"><code><span class="http-method">get</span> /api/v1/schedule/postseason/tuneIn</code></a></li>
|
|
</ul>
|
|
<h4><a href="#Season">Season</a></h4>
|
|
<ul>
|
|
<li><a href="#allSeasons"><code><span class="http-method">get</span> /api/v1/seasons/all</code></a></li>
|
|
<li><a href="#seasons"><code><span class="http-method">get</span> /api/v1/seasons</code></a></li>
|
|
<li><a href="#seasons1"><code><span class="http-method">get</span> /api/v1/seasons/{seasonId}</code></a></li>
|
|
</ul>
|
|
<h4><a href="#Skeletal">Skeletal</a></h4>
|
|
<ul>
|
|
<li><a href="#skeletalChunked"><code><span class="http-method">get</span> /api/v1/game/{gamePk}/{playId}/analytics/skeletalData/chunked</code></a></li>
|
|
<li><a href="#skeletalDataFileNames"><code><span class="http-method">get</span> /api/v1/game/{gamePk}/{playId}/analytics/skeletalData/files</code></a></li>
|
|
</ul>
|
|
<h4><a href="#Sports">Sports</a></h4>
|
|
<ul>
|
|
<li><a href="#allSportBallot"><code><span class="http-method">get</span> /api/v1/sports/{sportId}/allSportBallot</code></a></li>
|
|
<li><a href="#sportPlayers"><code><span class="http-method">get</span> /api/v1/sports/{sportId}/players</code></a></li>
|
|
<li><a href="#sports"><code><span class="http-method">get</span> /api/v1/sports</code></a></li>
|
|
<li><a href="#sports1"><code><span class="http-method">get</span> /api/v1/sports/{sportId}</code></a></li>
|
|
</ul>
|
|
<h4><a href="#Standings">Standings</a></h4>
|
|
<ul>
|
|
<li><a href="#standings"><code><span class="http-method">get</span> /api/v1/standings/{standingsType}</code></a></li>
|
|
<li><a href="#standings1"><code><span class="http-method">get</span> /api/v1/standings</code></a></li>
|
|
</ul>
|
|
<h4><a href="#Stats">Stats</a></h4>
|
|
<ul>
|
|
<li><a href="#beastStats"><code><span class="http-method">get</span> /api/v1/stats/search</code></a></li>
|
|
<li><a href="#getOutsAboveAverage"><code><span class="http-method">get</span> /api/v1/stats/analytics/outsAboveAverage</code></a></li>
|
|
<li><a href="#getSprayChart"><code><span class="http-method">get</span> /api/v1/stats/analytics/sprayChart</code></a></li>
|
|
<li><a href="#getStolenBaseProbability"><code><span class="http-method">get</span> /api/v1/stats/analytics/stolenBaseProbability</code></a></li>
|
|
<li><a href="#groupedStats"><code><span class="http-method">get</span> /api/v1/stats/grouped</code></a></li>
|
|
<li><a href="#leaders2"><code><span class="http-method">get</span> /api/v1/stats/leaders</code></a></li>
|
|
<li><a href="#metricStats"><code><span class="http-method">get</span> /api/v1/stats/metrics</code></a></li>
|
|
<li><a href="#stats2"><code><span class="http-method">get</span> /api/v1/stats</code></a></li>
|
|
</ul>
|
|
<h4><a href="#Streaks">Streaks</a></h4>
|
|
<ul>
|
|
<li><a href="#getStreaks"><code><span class="http-method">get</span> /api/v1/streaks</code></a></li>
|
|
<li><a href="#streakTypes"><code><span class="http-method">get</span> /api/v1/streaks/types</code></a></li>
|
|
</ul>
|
|
<h4><a href="#Teams">Teams</a></h4>
|
|
<ul>
|
|
<li><a href="#affiliates"><code><span class="http-method">get</span> /api/v1/teams/{teamId}/affiliates</code></a></li>
|
|
<li><a href="#affiliates1"><code><span class="http-method">get</span> /api/v1/teams/affiliates</code></a></li>
|
|
<li><a href="#allTeams"><code><span class="http-method">get</span> /api/v1/teams/{teamId}/history</code></a></li>
|
|
<li><a href="#allTeams1"><code><span class="http-method">get</span> /api/v1/teams/history</code></a></li>
|
|
<li><a href="#alumni"><code><span class="http-method">get</span> /api/v1/teams/{teamId}/alumni</code></a></li>
|
|
<li><a href="#coaches"><code><span class="http-method">get</span> /api/v1/teams/{teamId}/coaches</code></a></li>
|
|
<li><a href="#leaders"><code><span class="http-method">get</span> /api/v1/teams/{teamId}/leaders</code></a></li>
|
|
<li><a href="#leaders1"><code><span class="http-method">get</span> /api/v1/teams/stats/leaders</code></a></li>
|
|
<li><a href="#personnel"><code><span class="http-method">get</span> /api/v1/teams/{teamId}/personnel</code></a></li>
|
|
<li><a href="#roster"><code><span class="http-method">get</span> /api/v1/teams/{teamId}/roster</code></a></li>
|
|
<li><a href="#roster1"><code><span class="http-method">get</span> /api/v1/teams/{teamId}/roster/{rosterType}</code></a></li>
|
|
<li><a href="#stats"><code><span class="http-method">get</span> /api/v1/teams/{teamId}/stats</code></a></li>
|
|
<li><a href="#stats1"><code><span class="http-method">get</span> /api/v1/teams/stats</code></a></li>
|
|
<li><a href="#teams"><code><span class="http-method">get</span> /api/v1/teams</code></a></li>
|
|
<li><a href="#teams1"><code><span class="http-method">get</span> /api/v1/teams/{teamId}</code></a></li>
|
|
<li><a href="#updateAlumni"><code><span class="http-method">post</span> /api/v1/teams/{teamId}/alumni</code></a></li>
|
|
</ul>
|
|
<h4><a href="#Transactions">Transactions</a></h4>
|
|
<ul>
|
|
<li><a href="#transactions"><code><span class="http-method">get</span> /api/v1/transactions</code></a></li>
|
|
</ul>
|
|
<h4><a href="#Uniforms">Uniforms</a></h4>
|
|
<ul>
|
|
<li><a href="#uniformsByGame"><code><span class="http-method">get</span> /api/v1/uniforms/game</code></a></li>
|
|
<li><a href="#uniformsByTeam"><code><span class="http-method">get</span> /api/v1/uniforms/team</code></a></li>
|
|
</ul>
|
|
<h4><a href="#Venues">Venues</a></h4>
|
|
<ul>
|
|
<li><a href="#venues"><code><span class="http-method">get</span> /api/v1/venues</code></a></li>
|
|
<li><a href="#venues1"><code><span class="http-method">get</span> /api/v1/venues/{venueId}</code></a></li>
|
|
</ul>
|
|
<h4><a href="#Weather">Weather</a></h4>
|
|
<ul>
|
|
<li><a href="#weatherBasic"><code><span class="http-method">get</span> /api/v1/weather/venues/{venueId}/basic</code></a></li>
|
|
<li><a href="#weatherDataBasedOnPlay"><code><span class="http-method">get</span> /api/v1/weather/game/{gamePk}/{playId}</code></a></li>
|
|
<li><a href="#weatherForecast"><code><span class="http-method">get</span> /api/v1/weather/game/{gamePk}/forecast/{roofType}</code></a></li>
|
|
<li><a href="#weatherFull"><code><span class="http-method">get</span> /api/v1/weather/venues/{venueId}/full</code></a></li>
|
|
</ul>
|
|
|
|
<h1><a name="Analytics">Analytics</a></h1>
|
|
<div class="method"><a name="contextMetrics"/>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="get"><code class="huge"><span class="http-method">get</span> /api/v1/game/{gamePk}/{guid}/contextMetrics</code></pre></div>
|
|
<div class="method-summary">Get context metrics for a specific gamePk. (<span class="nickname">contextMetrics</span>)</div>
|
|
<div class="method-notes">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.</div>
|
|
|
|
<h3 class="field-label">Path parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">gamePk (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Path Parameter</span> — Unique Primary Key Representing a Game default: null </div><div class="param">guid (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Path Parameter</span> — Unique identifier for a play within a game default: null </div>
|
|
</div> <!-- field-items -->
|
|
|
|
|
|
|
|
|
|
<h3 class="field-label">Query parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">fields (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Comma delimited list of specific fields to be returned. Format: topLevelNode, childNode, attribute default: null </div>
|
|
</div> <!-- field-items -->
|
|
|
|
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
OK
|
|
<a href="#"></a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="contextMetricsWithAverages"/>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="get"><code class="huge"><span class="http-method">get</span> /api/v1/game/{gamePk}/{guid}/contextMetricsAverages</code></pre></div>
|
|
<div class="method-summary">Get a json file containing raw coordinate data and refined calculated metrics. (<span class="nickname">contextMetricsWithAverages</span>)</div>
|
|
<div class="method-notes">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.</div>
|
|
|
|
<h3 class="field-label">Path parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">gamePk (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Path Parameter</span> — Unique Primary Key Representing a Game default: null </div><div class="param">guid (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Path Parameter</span> — Unique identifier for a play within a game default: null </div>
|
|
</div> <!-- field-items -->
|
|
|
|
|
|
|
|
|
|
<h3 class="field-label">Query parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">fields (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Comma delimited list of specific fields to be returned. Format: topLevelNode, childNode, attribute default: null </div>
|
|
</div> <!-- field-items -->
|
|
|
|
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
OK
|
|
<a href="#"></a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="contextMetricsWithAveragesPost"/>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="post"><code class="huge"><span class="http-method">post</span> /api/v1/game/{gamePk}/{guid}/contextMetricsAverages</code></pre></div>
|
|
<div class="method-summary">Get a json file containing raw coordinate data and refined calculated metrics. (<span class="nickname">contextMetricsWithAveragesPost</span>)</div>
|
|
<div class="method-notes">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.</div>
|
|
|
|
<h3 class="field-label">Path parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">gamePk (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Path Parameter</span> — Unique Primary Key Representing a Game default: null </div><div class="param">guid (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Path Parameter</span> — Unique identifier for a play within a game default: null </div>
|
|
</div> <!-- field-items -->
|
|
|
|
|
|
|
|
|
|
<h3 class="field-label">Query parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">fields (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Comma delimited list of specific fields to be returned. Format: topLevelNode, childNode, attribute default: null </div>
|
|
</div> <!-- field-items -->
|
|
|
|
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
OK
|
|
<a href="#"></a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="gameGuids"/>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="get"><code class="huge"><span class="http-method">get</span> /api/v1/game/{gamePk}/guids</code></pre></div>
|
|
<div class="method-summary">Get the GUIDs (plays) for a specific game. (<span class="nickname">gameGuids</span>)</div>
|
|
<div class="method-notes"></div>
|
|
|
|
<h3 class="field-label">Path parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">gamePk (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Path Parameter</span> — Unique Primary Key Representing a Game default: null </div>
|
|
</div> <!-- field-items -->
|
|
|
|
|
|
|
|
|
|
<h3 class="field-label">Query parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">fields (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Comma delimited list of specific fields to be returned. Format: topLevelNode, childNode, attribute default: null </div><div class="param">gameModeId (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Statcast game mode. Format: 0 = Batting Practive, 1 = Warmup 2 = Live default: null </div><div class="param">isPitch (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — If there was a pitch default: null </div><div class="param">isHit (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — If there was a hit ball tracked default: null </div><div class="param">isPickoff (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — If there was a pickoff default: null </div><div class="param">hasUpdates (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — True if updated by an auditor default: null </div><div class="param">since (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Returns all data that was created after the specified timestamp. Format: YYYY-MM-DDTHH:MM:SSZ default: null </div><div class="param">updatedSince (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Return data updated since a specified date. Format: YYYY-MM-DDTHH:MM:SSZ default: null </div><div class="param">lastPlayTime (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Returns all data that was created after the specified timestamp. Format: YYYY-MM-DDTHH:MM:SSZ default: null </div><div class="param">lastUpdatedTime (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Return data updated since a specified date. Format: YYYY-MM-DDTHH:MM:SSZ default: null </div><div class="param">lastMetricsUpdatedTime (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Return data updated since a specified date. Format: YYYY-MM-DDTHH:MM:SSZ default: null </div><div class="param">lastAuditUpdatedTime (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Return data updated since a specified date. Format: YYYY-MM-DDTHH:MM:SSZ default: null </div><div class="param">lastVideoUpdatedTime (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — The last time SportyBot video was updated default: null </div>
|
|
</div> <!-- field-items -->
|
|
|
|
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
OK
|
|
<a href="#"></a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="gameGuidsFromPostgresRange"/>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="get"><code class="huge"><span class="http-method">get</span> /api/v1/analytics/guids</code></pre></div>
|
|
<div class="method-summary">Get the GUIDs (plays) for a specific game. (<span class="nickname">gameGuidsFromPostgresRange</span>)</div>
|
|
<div class="method-notes"></div>
|
|
|
|
|
|
|
|
|
|
|
|
<h3 class="field-label">Query parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">fields (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Comma delimited list of specific fields to be returned. Format: topLevelNode, childNode, attribute default: null </div><div class="param">gameModeId (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Statcast game mode. Format: 0 = Batting Practive, 1 = Warmup 2 = Live default: null </div><div class="param">isPitch (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — If there was a pitch default: null </div><div class="param">isHit (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — If there was a hit ball tracked default: null </div><div class="param">isPickoff (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — If there was a pickoff default: null </div><div class="param">isNonStatcast (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — If non statcast games need to be included default: null </div><div class="param">gamedayType (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Indicates the level of Gameday (tracking, play-by-play, linescore, etc...) default: null </div><div class="param">hasUpdates (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — True if updated by an auditor default: null </div><div class="param">lastPlayTime (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Returns all data that was created after the specified timestamp. Format: YYYY-MM-DDTHH:MM:SSZ default: null </div><div class="param">lastUpdatedTime (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Return data updated since a specified date. Format: YYYY-MM-DDTHH:MM:SSZ default: null </div><div class="param">lastMetricsUpdatedTime (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Return data updated since a specified date. Format: YYYY-MM-DDTHH:MM:SSZ default: null </div><div class="param">lastAuditUpdatedTime (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Return data updated since a specified date. Format: YYYY-MM-DDTHH:MM:SSZ default: null </div><div class="param">lastVideoUpdatedTime (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — The last time SportyBot video was updated default: null </div><div class="param">gameDate (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Date of Game. Format: YYYY-MM-DD default: null </div><div class="param">sportId (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Top level organization of a sport default: null </div><div class="param">gameType (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Type of Game. Available types in /api/v1/gameTypes default: null </div><div class="param">trackingSystemOwner (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Owner of the tracking system default: null </div><div class="param">season (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Season of play default: null </div><div class="param">sortBy (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Sort the set of data by the specified field default: null </div><div class="param">limit (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Number of results to return default: null </div><div class="param">offset (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — The pointer to start for a return set; used for pagination default: null </div>
|
|
</div> <!-- field-items -->
|
|
|
|
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
OK
|
|
<a href="#"></a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="gameGuidsFromPostgresRangeByGame"/>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="get"><code class="huge"><span class="http-method">get</span> /api/v1/analytics/game</code></pre></div>
|
|
<div class="method-summary">Get all games by updated date. (<span class="nickname">gameGuidsFromPostgresRangeByGame</span>)</div>
|
|
<div class="method-notes"></div>
|
|
|
|
|
|
|
|
|
|
|
|
<h3 class="field-label">Query parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">fields (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Comma delimited list of specific fields to be returned. Format: topLevelNode, childNode, attribute default: null </div><div class="param">gameModeId (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Statcast game mode. Format: 0 = Batting Practive, 1 = Warmup 2 = Live default: null </div><div class="param">isPitch (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — If there was a pitch default: null </div><div class="param">isHit (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — If there was a hit ball tracked default: null </div><div class="param">isPickoff (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — If there was a pickoff default: null </div><div class="param">isNonStatcast (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — If non statcast games need to be included default: null </div><div class="param">gamedayType (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Indicates the level of Gameday (tracking, play-by-play, linescore, etc...) default: null </div><div class="param">hasUpdates (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — True if updated by an auditor default: null </div><div class="param">lastPlayTime (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Returns all data that was created after the specified timestamp. Format: YYYY-MM-DDTHH:MM:SSZ default: null </div><div class="param">lastVideoUpdatedTime (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — The last time SportyBot video was updated default: null </div><div class="param">lastUpdatedTime (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Return data updated since a specified date. Format: YYYY-MM-DDTHH:MM:SSZ default: null </div><div class="param">lastMetricsUpdatedTime (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Return data updated since a specified date. Format: YYYY-MM-DDTHH:MM:SSZ default: null </div><div class="param">lastAuditUpdatedTime (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Return data updated since a specified date. Format: YYYY-MM-DDTHH:MM:SSZ default: null </div><div class="param">gameDate (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Date of Game. Format: YYYY-MM-DD default: null </div><div class="param">sportId (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Top level organization of a sport default: null </div><div class="param">gameType (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Type of Game. Available types in /api/v1/gameTypes default: null </div><div class="param">season (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Season of play default: null </div><div class="param">trackingSystemOwner (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Owner of the tracking system default: null </div><div class="param">sortBy (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Sort the set of data by the specified field default: null </div><div class="param">limit (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Number of results to return default: null </div><div class="param">offset (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — The pointer to start for a return set; used for pagination default: null </div><div class="param">scheduleEventTypes (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Comma delimited list of type of event types default: null </div>
|
|
</div> <!-- field-items -->
|
|
|
|
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
OK
|
|
<a href="#"></a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="gameLastPitch"/>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="get"><code class="huge"><span class="http-method">get</span> /api/v1/game/lastPitch</code></pre></div>
|
|
<div class="method-summary">Get the last pitch for a list of games (<span class="nickname">gameLastPitch</span>)</div>
|
|
<div class="method-notes"></div>
|
|
|
|
|
|
|
|
|
|
|
|
<h3 class="field-label">Query parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">gamePks (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Unique Primary Key Representing a Game default: null </div><div class="param">fields (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Comma delimited list of specific fields to be returned. Format: topLevelNode, childNode, attribute default: null </div>
|
|
</div> <!-- field-items -->
|
|
|
|
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
OK
|
|
<a href="#"></a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="homeRunBallparks"/>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="get"><code class="huge"><span class="http-method">get</span> /api/v1/game/{gamePk}/{guid}/homeRunBallparks</code></pre></div>
|
|
<div class="method-summary">Get if the play is a home run is each park for a specific play. (<span class="nickname">homeRunBallparks</span>)</div>
|
|
<div class="method-notes">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.</div>
|
|
|
|
<h3 class="field-label">Path parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">gamePk (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Path Parameter</span> — Unique Primary Key Representing a Game default: null </div><div class="param">guid (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Path Parameter</span> — Unique identifier for a play within a game default: null </div>
|
|
</div> <!-- field-items -->
|
|
|
|
|
|
|
|
|
|
<h3 class="field-label">Query parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">isHomeRunParks (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — default: null </div><div class="param">fields (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Comma delimited list of specific fields to be returned. Format: topLevelNode, childNode, attribute default: null </div>
|
|
</div> <!-- field-items -->
|
|
|
|
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
OK
|
|
<a href="#"></a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="parsedJsonFormattedAnalytics"/>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="get"><code class="huge"><span class="http-method">get</span> /api/v1/game/{gamePk}/{guid}/analytics</code></pre></div>
|
|
<div class="method-summary">Get Statcast data for a specific play. (<span class="nickname">parsedJsonFormattedAnalytics</span>)</div>
|
|
<div class="method-notes">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.</div>
|
|
|
|
<h3 class="field-label">Path parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">gamePk (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Path Parameter</span> — Unique Primary Key Representing a Game default: null </div><div class="param">guid (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Path Parameter</span> — Unique identifier for a play within a game default: null </div>
|
|
</div> <!-- field-items -->
|
|
|
|
|
|
|
|
|
|
<h3 class="field-label">Query parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">fields (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Comma delimited list of specific fields to be returned. Format: topLevelNode, childNode, attribute default: null </div>
|
|
</div> <!-- field-items -->
|
|
|
|
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
OK
|
|
<a href="#"></a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<h1><a name="Attendance">Attendance</a></h1>
|
|
<div class="method"><a name="getTeamAttendance"/>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="get"><code class="huge"><span class="http-method">get</span> /api/v1/attendance</code></pre></div>
|
|
<div class="method-summary">Get team attendance (<span class="nickname">getTeamAttendance</span>)</div>
|
|
<div class="method-notes"></div>
|
|
|
|
|
|
|
|
|
|
|
|
<h3 class="field-label">Query parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">teamId (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Unique Team Identifier. Format: 141, 147, etc default: null </div><div class="param">leagueId (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Comma delimited list of Unique league identifiers default: null </div><div class="param">season (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Comma delimited list of Seasons of play default: null </div><div class="param">leagueListId (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Unique League List Identifier default: null </div><div class="param">gameType (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Type of Game. Available types in /api/v1/gameTypes default: null </div><div class="param">date (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Date of Game. Format: YYYY-MM-DD default: null </div><div class="param">startDate (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Start date for range of data (must be used with end date). Format: MM/DD/YYYY default: null </div><div class="param">endDate (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — End date for range of data (must be used with start date). Format: MM/DD/YYYY default: null </div><div class="param">fields (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Comma delimited list of specific fields to be returned. Format: topLevelNode, childNode, attribute default: null </div>
|
|
</div> <!-- field-items -->
|
|
|
|
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
OK
|
|
<a href="#"></a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<h1><a name="Awards">Awards</a></h1>
|
|
<div class="method"><a name="awardRecipients"/>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="get"><code class="huge"><span class="http-method">get</span> /api/v1/awards/{awardId}/recipients</code></pre></div>
|
|
<div class="method-summary">View recipients of an award (<span class="nickname">awardRecipients</span>)</div>
|
|
<div class="method-notes"></div>
|
|
|
|
<h3 class="field-label">Path parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">awardId (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Path Parameter</span> — Unique Award Identifier. Available awards in /api/v1/awards default: null </div>
|
|
</div> <!-- field-items -->
|
|
|
|
|
|
|
|
|
|
<h3 class="field-label">Query parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">season (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Season of play default: null </div><div class="param">sportId (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Top level organization of a sport default: null </div><div class="param">leagueId (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Comma delimited list of Unique league identifiers default: null </div><div class="param">fields (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — default: null </div>
|
|
</div> <!-- field-items -->
|
|
|
|
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
OK
|
|
<a href="#"></a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="awards"/>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="get"><code class="huge"><span class="http-method">get</span> /api/v1/awards</code></pre></div>
|
|
<div class="method-summary">View awards info (<span class="nickname">awards</span>)</div>
|
|
<div class="method-notes"></div>
|
|
|
|
<h3 class="field-label">Path parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">awardId (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Path Parameter</span> — Unique Award Identifier. Available awards in /api/v1/awards default: null </div>
|
|
</div> <!-- field-items -->
|
|
|
|
|
|
|
|
|
|
<h3 class="field-label">Query parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">orgId (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Comma delimited list of top level organizations of a sport default: null </div><div class="param">fields (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Comma delimited list of specific fields to be returned. Format: topLevelNode, childNode, attribute default: null </div>
|
|
</div> <!-- field-items -->
|
|
|
|
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
OK
|
|
<a href="#"></a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="awards1"/>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="get"><code class="huge"><span class="http-method">get</span> /api/v1/awards/{awardId}</code></pre></div>
|
|
<div class="method-summary">View awards info (<span class="nickname">awards1</span>)</div>
|
|
<div class="method-notes"></div>
|
|
|
|
<h3 class="field-label">Path parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">awardId (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Path Parameter</span> — Unique Award Identifier. Available awards in /api/v1/awards default: null </div>
|
|
</div> <!-- field-items -->
|
|
|
|
|
|
|
|
|
|
<h3 class="field-label">Query parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">orgId (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Comma delimited list of top level organizations of a sport default: null </div><div class="param">fields (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Comma delimited list of specific fields to be returned. Format: topLevelNode, childNode, attribute default: null </div>
|
|
</div> <!-- field-items -->
|
|
|
|
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
OK
|
|
<a href="#"></a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<h1><a name="BatTracking">BatTracking</a></h1>
|
|
<div class="method"><a name="batTracking"/>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="get"><code class="huge"><span class="http-method">get</span> /api/v1/batTracking/game/{gamePk}/{playId}</code></pre></div>
|
|
<div class="method-summary">View Bat Tracking Data by playId and gameId (<span class="nickname">batTracking</span>)</div>
|
|
<div class="method-notes">This endpoint allows you to pull bat tracking data by gameId and playId</div>
|
|
|
|
<h3 class="field-label">Path parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">gamePk (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Path Parameter</span> — Unique Primary Key Representing a Game default: null </div><div class="param">playId (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Path Parameter</span> — Unique play identifier default: null </div>
|
|
</div> <!-- field-items -->
|
|
|
|
|
|
|
|
|
|
<h3 class="field-label">Query parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">fields (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Comma delimited list of specific fields to be returned. Format: topLevelNode, childNode, attribute default: null </div>
|
|
</div> <!-- field-items -->
|
|
|
|
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
OK
|
|
<a href="#"></a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<h1><a name="Biomechanics">Biomechanics</a></h1>
|
|
<div class="method"><a name="biomechanical"/>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="get"><code class="huge"><span class="http-method">get</span> /api/v1/game/{gamePk}/{playId}/analytics/biomechanics/{positionId}</code></pre></div>
|
|
<div class="method-summary">View Biomechanical data by playId and gameId filtered by player positionId (<span class="nickname">biomechanical</span>)</div>
|
|
<div class="method-notes">This endpoint allows you to pull biomechanical tracking data by gameId and playId filtered by player positionId</div>
|
|
|
|
<h3 class="field-label">Path parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">gamePk (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Path Parameter</span> — Unique Primary Key Representing a Game default: null </div><div class="param">playId (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Path Parameter</span> — Unique play identifier default: null </div><div class="param">positionId (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Path Parameter</span> — Position number. Format: 1, 2, 3, etc default: null </div>
|
|
</div> <!-- field-items -->
|
|
|
|
|
|
|
|
|
|
<h3 class="field-label">Query parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">fields (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Comma delimited list of specific fields to be returned. Format: topLevelNode, childNode, attribute default: null </div>
|
|
</div> <!-- field-items -->
|
|
|
|
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
OK
|
|
<a href="#"></a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<h1><a name="Broadcast">Broadcast</a></h1>
|
|
<div class="method"><a name="getAllBroadcasters"/>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="get"><code class="huge"><span class="http-method">get</span> /api/v1/broadcasters</code></pre></div>
|
|
<div class="method-summary">Get All Active Broadcasters (<span class="nickname">getAllBroadcasters</span>)</div>
|
|
<div class="method-notes"></div>
|
|
|
|
|
|
|
|
|
|
|
|
<h3 class="field-label">Query parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">activeStatus (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Current status of the broadcaster. Format: Active = y, inactive = n, both = b default: null </div><div class="param">fields (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Comma delimited list of specific fields to be returned. Format: topLevelNode, childNode, attribute default: null </div>
|
|
</div> <!-- field-items -->
|
|
|
|
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
OK
|
|
<a href="#"></a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="getBroadcasts"/>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="get"><code class="huge"><span class="http-method">get</span> /api/v1/broadcast</code></pre></div>
|
|
<div class="method-summary">Get Broadcasters (<span class="nickname">getBroadcasts</span>)</div>
|
|
<div class="method-notes"></div>
|
|
|
|
|
|
|
|
|
|
|
|
<h3 class="field-label">Query parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">broadcasterIds (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — All of the broadcast details default: null </div><div class="param">fields (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Comma delimited list of specific fields to be returned. Format: topLevelNode, childNode, attribute default: null </div>
|
|
</div> <!-- field-items -->
|
|
|
|
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
OK
|
|
<a href="#"></a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<h1><a name="Conference">Conference</a></h1>
|
|
<div class="method"><a name="conferences"/>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="get"><code class="huge"><span class="http-method">get</span> /api/v1/conferences</code></pre></div>
|
|
<div class="method-summary">View conference info (<span class="nickname">conferences</span>)</div>
|
|
<div class="method-notes"></div>
|
|
|
|
<h3 class="field-label">Path parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">conferenceId (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Path Parameter</span> — default: null </div>
|
|
</div> <!-- field-items -->
|
|
|
|
|
|
|
|
|
|
<h3 class="field-label">Query parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">season (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Season of play default: null </div><div class="param">includeInactive (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — default: null </div><div class="param">fields (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Comma delimited list of specific fields to be returned. Format: topLevelNode, childNode, attribute default: null </div>
|
|
</div> <!-- field-items -->
|
|
|
|
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
OK
|
|
<a href="#"></a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="conferences1"/>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="get"><code class="huge"><span class="http-method">get</span> /api/v1/conferences/{conferenceId}</code></pre></div>
|
|
<div class="method-summary">View conference info (<span class="nickname">conferences1</span>)</div>
|
|
<div class="method-notes"></div>
|
|
|
|
<h3 class="field-label">Path parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">conferenceId (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Path Parameter</span> — default: null </div>
|
|
</div> <!-- field-items -->
|
|
|
|
|
|
|
|
|
|
<h3 class="field-label">Query parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">season (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Season of play default: null </div><div class="param">includeInactive (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — default: null </div><div class="param">fields (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Comma delimited list of specific fields to be returned. Format: topLevelNode, childNode, attribute default: null </div>
|
|
</div> <!-- field-items -->
|
|
|
|
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
OK
|
|
<a href="#"></a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<h1><a name="Division">Division</a></h1>
|
|
<div class="method"><a name="divisions"/>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="get"><code class="huge"><span class="http-method">get</span> /api/v1/divisions</code></pre></div>
|
|
<div class="method-summary">Get division information (<span class="nickname">divisions</span>)</div>
|
|
<div class="method-notes">This endpoint allows you to pull divisions</div>
|
|
|
|
<h3 class="field-label">Path parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">divisionId (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Path Parameter</span> — Unique Division Identifier default: null </div>
|
|
</div> <!-- field-items -->
|
|
|
|
|
|
|
|
|
|
<h3 class="field-label">Query parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">includeInactive (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Whether or not to include inactive default: null </div><div class="param">leagueId (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Unique League Identifier default: null </div><div class="param">sportId (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Top level organization of a sport default: null </div><div class="param">season (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Season of play default: null </div><div class="param">fields (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Comma delimited list of specific fields to be returned. Format: topLevelNode, childNode, attribute default: null </div>
|
|
</div> <!-- field-items -->
|
|
|
|
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
OK
|
|
<a href="#"></a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="divisions1"/>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="get"><code class="huge"><span class="http-method">get</span> /api/v1/divisions/{divisionId}</code></pre></div>
|
|
<div class="method-summary">Get division information (<span class="nickname">divisions1</span>)</div>
|
|
<div class="method-notes">This endpoint allows you to pull divisions</div>
|
|
|
|
<h3 class="field-label">Path parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">divisionId (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Path Parameter</span> — Unique Division Identifier default: null </div>
|
|
</div> <!-- field-items -->
|
|
|
|
|
|
|
|
|
|
<h3 class="field-label">Query parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">includeInactive (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Whether or not to include inactive default: null </div><div class="param">leagueId (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Unique League Identifier default: null </div><div class="param">sportId (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Top level organization of a sport default: null </div><div class="param">season (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Season of play default: null </div><div class="param">fields (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Comma delimited list of specific fields to be returned. Format: topLevelNode, childNode, attribute default: null </div>
|
|
</div> <!-- field-items -->
|
|
|
|
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
OK
|
|
<a href="#"></a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<h1><a name="Draft">Draft</a></h1>
|
|
<div class="method"><a name="draftPicks"/>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="get"><code class="huge"><span class="http-method">get</span> /api/v1/draft</code></pre></div>
|
|
<div class="method-summary">View MLB Drafted Players (<span class="nickname">draftPicks</span>)</div>
|
|
<div class="method-notes"></div>
|
|
|
|
<h3 class="field-label">Path parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">year (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Path Parameter</span> — Year the player was drafted. Format: 2000 default: null </div>
|
|
</div> <!-- field-items -->
|
|
|
|
|
|
|
|
|
|
<h3 class="field-label">Query parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">limit (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Number of results to return default: null </div><div class="param">offset (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — The pointer to start for a return set; used for pagination default: null </div><div class="param">fields (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Comma delimited list of specific fields to be returned. Format: topLevelNode, childNode, attribute default: null </div><div class="param">order (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — The order of sorting, ascending or descending default: null </div><div class="param">sortBy (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Sort the set of data by the specified field default: null </div><div class="param">drafted (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Whether or not the players been drafted default: null </div><div class="param">round (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Round in which a player was drafted default: null </div><div class="param">name (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Filter players by the first letter of their name using using the specific character default: null </div><div class="param">school (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Filter players by the first letter of their school using using the specific character default: null </div><div class="param">position (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Position number. Format: 1, 2, 3, etc default: null </div><div class="param">team (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Unique Team Code. Format: tor, nya, etc default: null </div><div class="param">teamId (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Unique Team Identifier. Format: 141, 147, etc default: null </div><div class="param">state (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — State where the venue is located. Format: Ohio default: null </div><div class="param">country (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Filter players by their home country default: null </div><div class="param">playerId (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — A unique identifier for a player default: null </div><div class="param">bisPlayerId (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — A unique identifier for a player in the EBIS system default: null </div>
|
|
</div> <!-- field-items -->
|
|
|
|
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
OK
|
|
<a href="#"></a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="draftPicks1"/>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="get"><code class="huge"><span class="http-method">get</span> /api/v1/draft/{year}</code></pre></div>
|
|
<div class="method-summary">View MLB Drafted Players (<span class="nickname">draftPicks1</span>)</div>
|
|
<div class="method-notes"></div>
|
|
|
|
<h3 class="field-label">Path parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">year (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Path Parameter</span> — Year the player was drafted. Format: 2000 default: null </div>
|
|
</div> <!-- field-items -->
|
|
|
|
|
|
|
|
|
|
<h3 class="field-label">Query parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">limit (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Number of results to return default: null </div><div class="param">offset (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — The pointer to start for a return set; used for pagination default: null </div><div class="param">fields (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Comma delimited list of specific fields to be returned. Format: topLevelNode, childNode, attribute default: null </div><div class="param">order (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — The order of sorting, ascending or descending default: null </div><div class="param">sortBy (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Sort the set of data by the specified field default: null </div><div class="param">drafted (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Whether or not the players been drafted default: null </div><div class="param">round (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Round in which a player was drafted default: null </div><div class="param">name (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Filter players by the first letter of their name using using the specific character default: null </div><div class="param">school (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Filter players by the first letter of their school using using the specific character default: null </div><div class="param">position (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Position number. Format: 1, 2, 3, etc default: null </div><div class="param">team (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Unique Team Code. Format: tor, nya, etc default: null </div><div class="param">teamId (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Unique Team Identifier. Format: 141, 147, etc default: null </div><div class="param">state (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — State where the venue is located. Format: Ohio default: null </div><div class="param">country (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Filter players by their home country default: null </div><div class="param">playerId (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — A unique identifier for a player default: null </div><div class="param">bisPlayerId (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — A unique identifier for a player in the EBIS system default: null </div>
|
|
</div> <!-- field-items -->
|
|
|
|
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
OK
|
|
<a href="#"></a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="draftProspects"/>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="get"><code class="huge"><span class="http-method">get</span> /api/v1/draft/prospects</code></pre></div>
|
|
<div class="method-summary">View MLB Draft Prospects (<span class="nickname">draftProspects</span>)</div>
|
|
<div class="method-notes"></div>
|
|
|
|
<h3 class="field-label">Path parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">year (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Path Parameter</span> — Year the player was drafted. Format: 2000 default: null </div>
|
|
</div> <!-- field-items -->
|
|
|
|
|
|
|
|
|
|
<h3 class="field-label">Query parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">limit (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Number of results to return default: null </div><div class="param">offset (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — The pointer to start for a return set; used for pagination default: null </div><div class="param">fields (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Comma delimited list of specific fields to be returned. Format: topLevelNode, childNode, attribute default: null </div><div class="param">order (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — The order of sorting, ascending or descending default: null </div><div class="param">sortBy (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Sort the set of data by the specified field default: null </div><div class="param">drafted (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Whether or not the players been drafted default: null </div><div class="param">round (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Round in which a player was drafted default: null </div><div class="param">name (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Filter players by the first letter of their name using using the specific character default: null </div><div class="param">school (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Filter players by the first letter of their school using using the specific character default: null </div><div class="param">position (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Position number. Format: 1, 2, 3, etc default: null </div><div class="param">team (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Unique Team Code. Format: tor, nya, etc default: null </div><div class="param">teamId (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Unique Team Identifier. Format: 141, 147, etc default: null </div><div class="param">state (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — State where the venue is located. Format: Ohio default: null </div><div class="param">country (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Filter players by their home country default: null </div><div class="param">playerId (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — A unique identifier for a player default: null </div><div class="param">bisPlayerId (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — A unique identifier for a player in the EBIS system default: null </div>
|
|
</div> <!-- field-items -->
|
|
|
|
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
OK
|
|
<a href="#"></a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="draftProspects1"/>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="get"><code class="huge"><span class="http-method">get</span> /api/v1/draft/prospects/{year}</code></pre></div>
|
|
<div class="method-summary">View MLB Draft Prospects (<span class="nickname">draftProspects1</span>)</div>
|
|
<div class="method-notes"></div>
|
|
|
|
<h3 class="field-label">Path parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">year (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Path Parameter</span> — Year the player was drafted. Format: 2000 default: null </div>
|
|
</div> <!-- field-items -->
|
|
|
|
|
|
|
|
|
|
<h3 class="field-label">Query parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">limit (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Number of results to return default: null </div><div class="param">offset (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — The pointer to start for a return set; used for pagination default: null </div><div class="param">fields (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Comma delimited list of specific fields to be returned. Format: topLevelNode, childNode, attribute default: null </div><div class="param">order (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — The order of sorting, ascending or descending default: null </div><div class="param">sortBy (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Sort the set of data by the specified field default: null </div><div class="param">drafted (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Whether or not the players been drafted default: null </div><div class="param">round (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Round in which a player was drafted default: null </div><div class="param">name (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Filter players by the first letter of their name using using the specific character default: null </div><div class="param">school (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Filter players by the first letter of their school using using the specific character default: null </div><div class="param">position (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Position number. Format: 1, 2, 3, etc default: null </div><div class="param">team (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Unique Team Code. Format: tor, nya, etc default: null </div><div class="param">teamId (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Unique Team Identifier. Format: 141, 147, etc default: null </div><div class="param">state (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — State where the venue is located. Format: Ohio default: null </div><div class="param">country (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Filter players by their home country default: null </div><div class="param">playerId (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — A unique identifier for a player default: null </div><div class="param">bisPlayerId (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — A unique identifier for a player in the EBIS system default: null </div>
|
|
</div> <!-- field-items -->
|
|
|
|
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
OK
|
|
<a href="#"></a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="latestDraftPicks"/>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="get"><code class="huge"><span class="http-method">get</span> /api/v1/draft/{year}/latest</code></pre></div>
|
|
<div class="method-summary">Get the last drafted player and the next 5 teams up to pick (<span class="nickname">latestDraftPicks</span>)</div>
|
|
<div class="method-notes"></div>
|
|
|
|
<h3 class="field-label">Path parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">year (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Path Parameter</span> — Year the player was drafted. Format: 2000 default: null </div>
|
|
</div> <!-- field-items -->
|
|
|
|
|
|
|
|
|
|
<h3 class="field-label">Query parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">fields (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Comma delimited list of specific fields to be returned. Format: topLevelNode, childNode, attribute default: null </div>
|
|
</div> <!-- field-items -->
|
|
|
|
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
OK
|
|
<a href="#"></a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<h1><a name="Game">Game</a></h1>
|
|
<div class="method"><a name="boxscore"/>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="get"><code class="huge"><span class="http-method">get</span> /api/v1/game/{game_pk}/boxscore</code></pre></div>
|
|
<div class="method-summary">Get game boxscore. (<span class="nickname">boxscore</span>)</div>
|
|
<div class="method-notes">This endpoint allows you to pull a boxscore</div>
|
|
|
|
<h3 class="field-label">Path parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">game_pk (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Path Parameter</span> — Unique Primary Key Representing a Game default: null </div>
|
|
</div> <!-- field-items -->
|
|
|
|
|
|
|
|
|
|
<h3 class="field-label">Query parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">timecode (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Use this parameter to return a snapshot of the data at the specified time. Format: YYYYMMDD_HHMMSS default: null </div><div class="param">fields (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Comma delimited list of specific fields to be returned. Format: topLevelNode, childNode, attribute default: null </div><div class="param">inclusiveTimecode (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — True to include plays that happen before or at the specified timecode default: null </div><div class="param">numPlayers (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Number of top player game scores to show. Default is 3. default: null </div><div class="param">noTies (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — If set to false, will show all players tied for the last spot in the game scores list. default: null </div><div class="param">accent (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Boolean value to specify wanting a person's name with accents or without default: null </div>
|
|
</div> <!-- field-items -->
|
|
|
|
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
OK
|
|
<a href="#"></a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="colorFeed"/>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="get"><code class="huge"><span class="http-method">get</span> /api/v1/game/{game_pk}/feed/color</code></pre></div>
|
|
<div class="method-summary">Get game color feed. (<span class="nickname">colorFeed</span>)</div>
|
|
<div class="method-notes">This API can return very large payloads. It is STRONGLY recommended that clients ask for diffs and use "Accept-Encoding: gzip" header.</div>
|
|
|
|
<h3 class="field-label">Path parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">game_pk (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Path Parameter</span> — Unique Primary Key Representing a Game default: null </div>
|
|
</div> <!-- field-items -->
|
|
|
|
|
|
|
|
|
|
<h3 class="field-label">Query parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">timecode (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Use this parameter to return a snapshot of the data at the specified time. Format: YYYYMMDD_HHMMSS default: null </div><div class="param">fields (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Comma delimited list of specific fields to be returned. Format: topLevelNode, childNode, attribute default: null </div>
|
|
</div> <!-- field-items -->
|
|
|
|
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
OK
|
|
<a href="#"></a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="colorTimestamps"/>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="get"><code class="huge"><span class="http-method">get</span> /api/v1/game/{game_pk}/feed/color/timestamps</code></pre></div>
|
|
<div class="method-summary">Retrieve all of the color timestamps for a game. (<span class="nickname">colorTimestamps</span>)</div>
|
|
<div class="method-notes">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</div>
|
|
|
|
<h3 class="field-label">Path parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">game_pk (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Path Parameter</span> — Unique Primary Key Representing a Game default: null </div>
|
|
</div> <!-- field-items -->
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
OK
|
|
<a href="#"></a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="content"/>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="get"><code class="huge"><span class="http-method">get</span> /api/v1/game/{game_pk}/content</code></pre></div>
|
|
<div class="method-summary">Retrieve all content for a game. (<span class="nickname">content</span>)</div>
|
|
<div class="method-notes"></div>
|
|
|
|
<h3 class="field-label">Path parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">game_pk (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Path Parameter</span> — default: null </div>
|
|
</div> <!-- field-items -->
|
|
|
|
|
|
|
|
|
|
<h3 class="field-label">Query parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">highlightLimit (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Number of results to return default: null </div>
|
|
</div> <!-- field-items -->
|
|
|
|
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
OK
|
|
<a href="#"></a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="currentGameStats1"/>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="get"><code class="huge"><span class="http-method">get</span> /api/v1/game/changes</code></pre></div>
|
|
<div class="method-summary">View a game change log (<span class="nickname">currentGameStats1</span>)</div>
|
|
<div class="method-notes"></div>
|
|
|
|
|
|
|
|
|
|
|
|
<h3 class="field-label">Query parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">updatedSince (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Format: YYYY-MM-DDTHH:MM:SSZ default: null </div><div class="param">sportId (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Top level organization of a sport default: null </div><div class="param">sportIds (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Comma delimited list of top level organizations of a sport default: null </div><div class="param">gameType (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Type of Game. Available types in /api/v1/gameTypes default: null </div><div class="param">gameTypes (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Comma delimited list of type of Game. Available types in /api/v1/gameTypes default: null </div><div class="param">season (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Season of play default: null </div><div class="param">gamePks (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Comma delimited list of unique primary keys default: null </div><div class="param">limit (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Number of results to return default: null </div><div class="param">offset (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — The pointer to start for a return set; used for pagination default: null </div><div class="param">fields (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Comma delimited list of specific fields to be returned. Format: topLevelNode, childNode, attribute default: null </div>
|
|
</div> <!-- field-items -->
|
|
|
|
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
OK
|
|
<a href="#"></a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="getGameContextMetrics"/>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="get"><code class="huge"><span class="http-method">get</span> /api/v1/game/{gamePk}/contextMetrics</code></pre></div>
|
|
<div class="method-summary">Get the context metrics for this game based on its current state (<span class="nickname">getGameContextMetrics</span>)</div>
|
|
<div class="method-notes"></div>
|
|
|
|
<h3 class="field-label">Path parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">gamePk (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Path Parameter</span> — Unique Primary Key Representing a Game default: null </div>
|
|
</div> <!-- field-items -->
|
|
|
|
|
|
|
|
|
|
<h3 class="field-label">Query parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">timecode (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Use this parameter to return a snapshot of the data at the specified time. Format: YYYYMMDD_HHMMSS default: null </div><div class="param">fields (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Comma delimited list of specific fields to be returned. Format: topLevelNode, childNode, attribute default: null </div>
|
|
</div> <!-- field-items -->
|
|
|
|
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
OK
|
|
<a href="#"></a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="getGameWithMetrics"/>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="get"><code class="huge"><span class="http-method">get</span> /api/v1/game/{gamePk}/withMetrics</code></pre></div>
|
|
<div class="method-summary">Get game info with metrics (<span class="nickname">getGameWithMetrics</span>)</div>
|
|
<div class="method-notes"></div>
|
|
|
|
<h3 class="field-label">Path parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">gamePk (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Path Parameter</span> — Unique Primary Key Representing a Game default: null </div>
|
|
</div> <!-- field-items -->
|
|
|
|
|
|
|
|
|
|
<h3 class="field-label">Query parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">timecode (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Use this parameter to return a snapshot of the data at the specified time. Format: YYYYMMDD_HHMMSS default: null </div><div class="param">inclusiveTimecode (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — True to include plays that happen before or at the specified timecode default: null </div><div class="param">fields (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Comma delimited list of specific fields to be returned. Format: topLevelNode, childNode, attribute default: null </div><div class="param">accent (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Boolean value to specify wanting a person's name with accents or without default: null </div>
|
|
</div> <!-- field-items -->
|
|
|
|
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
OK
|
|
<a href="#"></a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="getWinProbability"/>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="get"><code class="huge"><span class="http-method">get</span> /api/v1/game/{gamePk}/winProbability</code></pre></div>
|
|
<div class="method-summary">Get the win probability for this game (<span class="nickname">getWinProbability</span>)</div>
|
|
<div class="method-notes"></div>
|
|
|
|
<h3 class="field-label">Path parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">gamePk (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Path Parameter</span> — Unique Primary Key Representing a Game default: null </div>
|
|
</div> <!-- field-items -->
|
|
|
|
|
|
|
|
|
|
<h3 class="field-label">Query parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">timecode (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Use this parameter to return a snapshot of the data at the specified time. Format: YYYYMMDD_HHMMSS default: null </div><div class="param">fields (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Comma delimited list of specific fields to be returned. Format: topLevelNode, childNode, attribute default: null </div><div class="param">inclusiveTimecode (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — True to include plays that happen before or at the specified timecode default: null </div><div class="param">accent (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Boolean value to specify wanting a person's name with accents or without default: null </div>
|
|
</div> <!-- field-items -->
|
|
|
|
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
OK
|
|
<a href="#"></a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="linescore"/>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="get"><code class="huge"><span class="http-method">get</span> /api/v1/game/{game_pk}/linescore</code></pre></div>
|
|
<div class="method-summary">Get game linescore (<span class="nickname">linescore</span>)</div>
|
|
<div class="method-notes">This endpoint allows you to pull the linescore for a game</div>
|
|
|
|
<h3 class="field-label">Path parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">game_pk (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Path Parameter</span> — Unique Primary Key Representing a Game default: null </div>
|
|
</div> <!-- field-items -->
|
|
|
|
|
|
|
|
|
|
<h3 class="field-label">Query parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">timecode (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Use this parameter to return a snapshot of the data at the specified time. Format: YYYYMMDD_HHMMSS default: null </div><div class="param">fields (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Comma delimited list of specific fields to be returned. Format: topLevelNode, childNode, attribute default: null </div><div class="param">inclusiveTimecode (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — True to include plays that happen before or at the specified timecode default: null </div>
|
|
</div> <!-- field-items -->
|
|
|
|
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
OK
|
|
<a href="#"></a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="liveGameDiffPatchV1"/>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="get"><code class="huge"><span class="http-method">get</span> /api/v1.1/game/{game_pk}/feed/live/diffPatch</code></pre></div>
|
|
<div class="method-summary">Get live game status diffPatch. (<span class="nickname">liveGameDiffPatchV1</span>)</div>
|
|
<div class="method-notes">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.</div>
|
|
|
|
<h3 class="field-label">Path parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">game_pk (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Path Parameter</span> — Unique Primary Key Representing a Game default: null </div>
|
|
</div> <!-- field-items -->
|
|
|
|
|
|
|
|
|
|
<h3 class="field-label">Query parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">startTimecode (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Start time code will give you everything since that time. Format: MMDDYYYY_HHMMSS default: null </div><div class="param">endTimecode (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — End time code will give you a snapshot at that specific time. Format: MMDDYYYY_HHMMSS default: null </div><div class="param">accent (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Boolean value to specify wanting a person's name with accents or without default: null </div>
|
|
</div> <!-- field-items -->
|
|
|
|
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
OK
|
|
<a href="#"></a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="liveGameV1"/>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="get"><code class="huge"><span class="http-method">get</span> /api/v1.1/game/{game_pk}/feed/live</code></pre></div>
|
|
<div class="method-summary">Get live game status. (<span class="nickname">liveGameV1</span>)</div>
|
|
<div class="method-notes">This API can return very large payloads. It is STRONGLY recommended that clients ask for diffs and use "Accept-Encoding: gzip" header.</div>
|
|
|
|
<h3 class="field-label">Path parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">game_pk (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Path Parameter</span> — Unique Primary Key Representing a Game default: null </div>
|
|
</div> <!-- field-items -->
|
|
|
|
|
|
|
|
|
|
<h3 class="field-label">Query parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">timecode (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Use this parameter to return a snapshot of the data at the specified time. Format: YYYYMMDD_HHMMSS default: null </div><div class="param">fields (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Comma delimited list of specific fields to be returned. Format: topLevelNode, childNode, attribute default: null </div><div class="param">inclusiveTimecode (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — True to include plays that happen before or at the specified timecode default: null </div><div class="param">accent (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Boolean value to specify wanting a person's name with accents or without default: null </div>
|
|
</div> <!-- field-items -->
|
|
|
|
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
OK
|
|
<a href="#"></a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="liveTimestampv11"/>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="get"><code class="huge"><span class="http-method">get</span> /api/v1.1/game/{game_pk}/feed/live/timestamps</code></pre></div>
|
|
<div class="method-summary">Retrieve all of the play timestamps for a game. (<span class="nickname">liveTimestampv11</span>)</div>
|
|
<div class="method-notes">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</div>
|
|
|
|
<h3 class="field-label">Path parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">game_pk (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Path Parameter</span> — Unique Primary Key Representing a Game default: null </div>
|
|
</div> <!-- field-items -->
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
OK
|
|
<a href="#"></a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="playByPlay"/>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="get"><code class="huge"><span class="http-method">get</span> /api/v1/game/{game_pk}/playByPlay</code></pre></div>
|
|
<div class="method-summary">Get game play By Play (<span class="nickname">playByPlay</span>)</div>
|
|
<div class="method-notes">This endpoint allows you to pull the play by play of a game</div>
|
|
|
|
<h3 class="field-label">Path parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">game_pk (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Path Parameter</span> — Unique Primary Key Representing a Game default: null </div>
|
|
</div> <!-- field-items -->
|
|
|
|
|
|
|
|
|
|
<h3 class="field-label">Query parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">timecode (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Use this parameter to return a snapshot of the data at the specified time. Format: YYYYMMDD_HHMMSS default: null </div><div class="param">fields (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Comma delimited list of specific fields to be returned. Format: topLevelNode, childNode, attribute default: null </div><div class="param">inclusiveTimecode (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — True to include plays that happen before or at the specified timecode default: null </div><div class="param">accent (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Boolean value to specify wanting a person's name with accents or without default: null </div>
|
|
</div> <!-- field-items -->
|
|
|
|
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
OK
|
|
<a href="#"></a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<h1><a name="GamePace">GamePace</a></h1>
|
|
<div class="method"><a name="gamePace"/>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="get"><code class="huge"><span class="http-method">get</span> /api/v1/gamePace</code></pre></div>
|
|
<div class="method-summary">View time of game info (<span class="nickname">gamePace</span>)</div>
|
|
<div class="method-notes"></div>
|
|
|
|
|
|
|
|
|
|
|
|
<h3 class="field-label">Query parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">season (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Season of play default: null </div><div class="param">teamId (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Unique Team Identifier. Format: 141, 147, etc default: null </div><div class="param">teamIds (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Comma delimited list of Unique Team identifiers default: null </div><div class="param">leagueId (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Unique League Identifier default: null </div><div class="param">leagueIds (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Comma delimited list of Unique league identifiers default: null </div><div class="param">leagueListId (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Unique League List Identifier default: null </div><div class="param">sportId (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Top level organization of a sport default: null </div><div class="param">sportIds (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Comma delimited list of top level organizations of a sport default: null </div><div class="param">gameType (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Type of Game. Available types in /api/v1/gameTypes default: null </div><div class="param">startDate (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Start date for range of data (must be used with end date). Format: MM/DD/YYYY default: null </div><div class="param">endDate (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — End date for range of data (must be used with start date). Format: MM/DD/YYYY default: null </div><div class="param">venueIds (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Comma delimited list of Unique venue identifiers default: null </div><div class="param">excludeVenueIds (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Comma delimited list of Unique venue identifiers default: null </div><div class="param">excludeGamePks (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Comma delimited list of unique primary keys default: null </div><div class="param">orgType (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Organization level. Format: T(Team), L(League), S(Sport) default: null </div><div class="param">includeChildren (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Determines weather to include results from an organization's children (ex. a sport would also include results for the teams and leagues) default: null </div><div class="param">fields (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Comma delimited list of specific fields to be returned. Format: topLevelNode, childNode, attribute default: null </div>
|
|
</div> <!-- field-items -->
|
|
|
|
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
OK
|
|
<a href="#"></a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<h1><a name="HighLow">HighLow</a></h1>
|
|
<div class="method"><a name="highLow"/>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="get"><code class="huge"><span class="http-method">get</span> /api/v1/highLow/{highLowType}</code></pre></div>
|
|
<div class="method-summary">View high/low stats by player or team (<span class="nickname">highLow</span>)</div>
|
|
<div class="method-notes"></div>
|
|
|
|
<h3 class="field-label">Path parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">highLowType (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Path Parameter</span> — Type of high/low stats ('player', 'team', 'game') default: null </div>
|
|
</div> <!-- field-items -->
|
|
|
|
|
|
|
|
|
|
<h3 class="field-label">Query parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">statGroup (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Comma delimited list of categories of statistic to return. Available types in /api/v1/statGroups default: null </div><div class="param">sortStat (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Comma delimited list of baseball stats to sort splits by. default: null </div><div class="param">season (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Comma delimited list of Seasons of play default: null </div><div class="param">gameType (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Comma delimited list of type of Game. Available types in /api/v1/gameTypes default: null </div><div class="param">teamId (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Unique Team Identifier. Format: 141, 147, etc default: null </div><div class="param">leagueId (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Unique League Identifier default: null </div><div class="param">sportId (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Top level organization of a sport default: null </div><div class="param">offset (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — The pointer to start for a return set; used for pagination default: null </div><div class="param">limit (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Number of results to return default: null </div><div class="param">fields (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Comma delimited list of specific fields to be returned. Format: topLevelNode, childNode, attribute default: null </div>
|
|
</div> <!-- field-items -->
|
|
|
|
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
OK
|
|
<a href="#"></a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="highLowStats"/>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="get"><code class="huge"><span class="http-method">get</span> /api/v1/highLow/types</code></pre></div>
|
|
<div class="method-summary">View high/low stat types (<span class="nickname">highLowStats</span>)</div>
|
|
<div class="method-notes"></div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
OK
|
|
<a href="#"></a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<h1><a name="HomerunDerby">HomerunDerby</a></h1>
|
|
<div class="method"><a name="homeRunDerbyBracket"/>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="get"><code class="huge"><span class="http-method">get</span> /api/v1/homeRunDerby/{gamePk}</code></pre></div>
|
|
<div class="method-summary">View a home run derby object (<span class="nickname">homeRunDerbyBracket</span>)</div>
|
|
<div class="method-notes">This endpoint allows you to pull home run derby information</div>
|
|
|
|
<h3 class="field-label">Path parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">gamePk (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Path Parameter</span> — Unique Primary Key Representing a Game default: null </div>
|
|
</div> <!-- field-items -->
|
|
|
|
|
|
|
|
|
|
<h3 class="field-label">Query parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">fields (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Comma delimited list of specific fields to be returned. Format: topLevelNode, childNode, attribute default: null </div>
|
|
</div> <!-- field-items -->
|
|
|
|
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
OK
|
|
<a href="#"></a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="homeRunDerbyBracket1"/>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="get"><code class="huge"><span class="http-method">get</span> /api/v1/homeRunDerby</code></pre></div>
|
|
<div class="method-summary">View a home run derby object (<span class="nickname">homeRunDerbyBracket1</span>)</div>
|
|
<div class="method-notes">This endpoint allows you to pull home run derby information</div>
|
|
|
|
<h3 class="field-label">Path parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">gamePk (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Path Parameter</span> — Unique Primary Key Representing a Game default: null </div>
|
|
</div> <!-- field-items -->
|
|
|
|
|
|
|
|
|
|
<h3 class="field-label">Query parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">fields (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Comma delimited list of specific fields to be returned. Format: topLevelNode, childNode, attribute default: null </div>
|
|
</div> <!-- field-items -->
|
|
|
|
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
OK
|
|
<a href="#"></a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="homeRunDerbyBracket2"/>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="get"><code class="huge"><span class="http-method">get</span> /api/v1/homeRunDerby/{gamePk}/bracket</code></pre></div>
|
|
<div class="method-summary">View a home run derby object (<span class="nickname">homeRunDerbyBracket2</span>)</div>
|
|
<div class="method-notes">This endpoint allows you to pull home run derby information</div>
|
|
|
|
<h3 class="field-label">Path parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">gamePk (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Path Parameter</span> — Unique Primary Key Representing a Game default: null </div>
|
|
</div> <!-- field-items -->
|
|
|
|
|
|
|
|
|
|
<h3 class="field-label">Query parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">fields (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Comma delimited list of specific fields to be returned. Format: topLevelNode, childNode, attribute default: null </div>
|
|
</div> <!-- field-items -->
|
|
|
|
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
OK
|
|
<a href="#"></a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="homeRunDerbyBracket3"/>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="get"><code class="huge"><span class="http-method">get</span> /api/v1/homeRunDerby/bracket</code></pre></div>
|
|
<div class="method-summary">View a home run derby object (<span class="nickname">homeRunDerbyBracket3</span>)</div>
|
|
<div class="method-notes">This endpoint allows you to pull home run derby information</div>
|
|
|
|
<h3 class="field-label">Path parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">gamePk (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Path Parameter</span> — Unique Primary Key Representing a Game default: null </div>
|
|
</div> <!-- field-items -->
|
|
|
|
|
|
|
|
|
|
<h3 class="field-label">Query parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">fields (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Comma delimited list of specific fields to be returned. Format: topLevelNode, childNode, attribute default: null </div>
|
|
</div> <!-- field-items -->
|
|
|
|
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
OK
|
|
<a href="#"></a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="homeRunDerbyMixedMode"/>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="get"><code class="huge"><span class="http-method">get</span> /api/v1/homeRunDerby/{gamePk}/mixed</code></pre></div>
|
|
<div class="method-summary">View home run derby mixed mode (Bracket/Pool combo) (<span class="nickname">homeRunDerbyMixedMode</span>)</div>
|
|
<div class="method-notes">This endpoint allows you to pull home run derby information</div>
|
|
|
|
<h3 class="field-label">Path parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">gamePk (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Path Parameter</span> — Unique Primary Key Representing a Game default: null </div>
|
|
</div> <!-- field-items -->
|
|
|
|
|
|
|
|
|
|
<h3 class="field-label">Query parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">fields (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Comma delimited list of specific fields to be returned. Format: topLevelNode, childNode, attribute default: null </div>
|
|
</div> <!-- field-items -->
|
|
|
|
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
OK
|
|
<a href="#"></a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="homeRunDerbyMixedMode1"/>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="get"><code class="huge"><span class="http-method">get</span> /api/v1/homeRunDerby/mixed</code></pre></div>
|
|
<div class="method-summary">View home run derby mixed mode (Bracket/Pool combo) (<span class="nickname">homeRunDerbyMixedMode1</span>)</div>
|
|
<div class="method-notes">This endpoint allows you to pull home run derby information</div>
|
|
|
|
<h3 class="field-label">Path parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">gamePk (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Path Parameter</span> — Unique Primary Key Representing a Game default: null </div>
|
|
</div> <!-- field-items -->
|
|
|
|
|
|
|
|
|
|
<h3 class="field-label">Query parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">fields (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Comma delimited list of specific fields to be returned. Format: topLevelNode, childNode, attribute default: null </div>
|
|
</div> <!-- field-items -->
|
|
|
|
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
OK
|
|
<a href="#"></a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="homeRunDerbyPool"/>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="get"><code class="huge"><span class="http-method">get</span> /api/v1/homeRunDerby/{gamePk}/pool</code></pre></div>
|
|
<div class="method-summary">View home run derby pool (<span class="nickname">homeRunDerbyPool</span>)</div>
|
|
<div class="method-notes">This endpoint allows you to pull home run derby information</div>
|
|
|
|
<h3 class="field-label">Path parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">gamePk (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Path Parameter</span> — Unique Primary Key Representing a Game default: null </div>
|
|
</div> <!-- field-items -->
|
|
|
|
|
|
|
|
|
|
<h3 class="field-label">Query parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">fields (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Comma delimited list of specific fields to be returned. Format: topLevelNode, childNode, attribute default: null </div>
|
|
</div> <!-- field-items -->
|
|
|
|
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
OK
|
|
<a href="#"></a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="homeRunDerbyPool1"/>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="get"><code class="huge"><span class="http-method">get</span> /api/v1/homeRunDerby/pool</code></pre></div>
|
|
<div class="method-summary">View home run derby pool (<span class="nickname">homeRunDerbyPool1</span>)</div>
|
|
<div class="method-notes">This endpoint allows you to pull home run derby information</div>
|
|
|
|
<h3 class="field-label">Path parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">gamePk (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Path Parameter</span> — Unique Primary Key Representing a Game default: null </div>
|
|
</div> <!-- field-items -->
|
|
|
|
|
|
|
|
|
|
<h3 class="field-label">Query parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">fields (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Comma delimited list of specific fields to be returned. Format: topLevelNode, childNode, attribute default: null </div>
|
|
</div> <!-- field-items -->
|
|
|
|
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
OK
|
|
<a href="#"></a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<h1><a name="Job">Job</a></h1>
|
|
<div class="method"><a name="datacasters"/>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="get"><code class="huge"><span class="http-method">get</span> /api/v1/jobs/datacasters</code></pre></div>
|
|
<div class="method-summary">Get datacaster jobs (<span class="nickname">datacasters</span>)</div>
|
|
<div class="method-notes">Get datacaster jobs</div>
|
|
|
|
|
|
|
|
|
|
|
|
<h3 class="field-label">Query parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">sportId (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Top level organization of a sport default: null </div><div class="param">date (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Date of Game. Format: YYYY-MM-DD default: null </div><div class="param">fields (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Comma delimited list of specific fields to be returned. Format: topLevelNode, childNode, attribute default: null </div>
|
|
</div> <!-- field-items -->
|
|
|
|
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
OK
|
|
<a href="#"></a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="getJobsByType"/>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="get"><code class="huge"><span class="http-method">get</span> /api/v1/jobs</code></pre></div>
|
|
<div class="method-summary">Get jobs by type (<span class="nickname">getJobsByType</span>)</div>
|
|
<div class="method-notes">This endpoint allows you to pull teams</div>
|
|
|
|
|
|
|
|
|
|
|
|
<h3 class="field-label">Query parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">jobType (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Job Type Identifier (ie. UMPR, etc..) default: null </div><div class="param">sportId (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Top level organization of a sport default: null </div><div class="param">date (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Date of Game. Format: YYYY-MM-DD default: null </div><div class="param">fields (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Comma delimited list of specific fields to be returned. Format: topLevelNode, childNode, attribute default: null </div>
|
|
</div> <!-- field-items -->
|
|
|
|
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
OK
|
|
<a href="#"></a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="officialScorers"/>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="get"><code class="huge"><span class="http-method">get</span> /api/v1/jobs/officialScorers</code></pre></div>
|
|
<div class="method-summary">Get official scorers (<span class="nickname">officialScorers</span>)</div>
|
|
<div class="method-notes">This endpoint allows you to pull teams</div>
|
|
|
|
|
|
|
|
|
|
|
|
<h3 class="field-label">Query parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">sportId (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Top level organization of a sport default: null </div><div class="param">date (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Date of Game. Format: YYYY-MM-DD default: null </div><div class="param">fields (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Comma delimited list of specific fields to be returned. Format: topLevelNode, childNode, attribute default: null </div>
|
|
</div> <!-- field-items -->
|
|
|
|
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
OK
|
|
<a href="#"></a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="umpireSchedule"/>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="get"><code class="huge"><span class="http-method">get</span> /api/v1/jobs/umpires/games/{umpireId}</code></pre></div>
|
|
<div class="method-summary">Get umpires and associated game for umpireId (<span class="nickname">umpireSchedule</span>)</div>
|
|
<div class="method-notes">This endpoint allows you to pull teams</div>
|
|
|
|
<h3 class="field-label">Path parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">umpireId (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Path Parameter</span> — A unique identifier for an umpire default: null </div>
|
|
</div> <!-- field-items -->
|
|
|
|
|
|
|
|
|
|
<h3 class="field-label">Query parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">season (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Season of play default: null </div><div class="param">fields (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Comma delimited list of specific fields to be returned. Format: topLevelNode, childNode, attribute default: null </div>
|
|
</div> <!-- field-items -->
|
|
|
|
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
OK
|
|
<a href="#"></a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="umpires"/>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="get"><code class="huge"><span class="http-method">get</span> /api/v1/jobs/umpires</code></pre></div>
|
|
<div class="method-summary">Get umpires (<span class="nickname">umpires</span>)</div>
|
|
<div class="method-notes">This endpoint allows you to pull teams</div>
|
|
|
|
|
|
|
|
|
|
|
|
<h3 class="field-label">Query parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">sportId (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Top level organization of a sport default: null </div><div class="param">date (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Date of Game. Format: YYYY-MM-DD default: null </div><div class="param">fields (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Comma delimited list of specific fields to be returned. Format: topLevelNode, childNode, attribute default: null </div><div class="param">season (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Season of play default: null </div>
|
|
</div> <!-- field-items -->
|
|
|
|
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
OK
|
|
<a href="#"></a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<h1><a name="League">League</a></h1>
|
|
<div class="method"><a name="allStarBallot"/>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="get"><code class="huge"><span class="http-method">get</span> /api/v1/league/allStarBallot</code></pre></div>
|
|
<div class="method-summary">View al star ballot info (<span class="nickname">allStarBallot</span>)</div>
|
|
<div class="method-notes"></div>
|
|
|
|
<h3 class="field-label">Path parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">leagueId (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Path Parameter</span> — Unique League Identifier default: null </div>
|
|
</div> <!-- field-items -->
|
|
|
|
|
|
|
|
|
|
<h3 class="field-label">Query parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">leagueIds (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Comma delimited list of Unique league identifiers default: null </div><div class="param">season (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Season of play default: null </div><div class="param">fields (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Comma delimited list of specific fields to be returned. Format: topLevelNode, childNode, attribute default: null </div>
|
|
</div> <!-- field-items -->
|
|
|
|
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
OK
|
|
<a href="#"></a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="allStarBallot1"/>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="get"><code class="huge"><span class="http-method">get</span> /api/v1/league/{leagueId}/allStarBallot</code></pre></div>
|
|
<div class="method-summary">View al star ballot info (<span class="nickname">allStarBallot1</span>)</div>
|
|
<div class="method-notes"></div>
|
|
|
|
<h3 class="field-label">Path parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">leagueId (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Path Parameter</span> — Unique League Identifier default: null </div>
|
|
</div> <!-- field-items -->
|
|
|
|
|
|
|
|
|
|
<h3 class="field-label">Query parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">leagueIds (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Comma delimited list of Unique league identifiers default: null </div><div class="param">season (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Season of play default: null </div><div class="param">fields (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Comma delimited list of specific fields to be returned. Format: topLevelNode, childNode, attribute default: null </div>
|
|
</div> <!-- field-items -->
|
|
|
|
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
OK
|
|
<a href="#"></a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="allStarBallot2"/>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="get"><code class="huge"><span class="http-method">get</span> /api/v1/leagues/allStarBallot</code></pre></div>
|
|
<div class="method-summary">View al star ballot info (<span class="nickname">allStarBallot2</span>)</div>
|
|
<div class="method-notes"></div>
|
|
|
|
<h3 class="field-label">Path parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">leagueId (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Path Parameter</span> — Unique League Identifier default: null </div>
|
|
</div> <!-- field-items -->
|
|
|
|
|
|
|
|
|
|
<h3 class="field-label">Query parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">leagueIds (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Comma delimited list of Unique league identifiers default: null </div><div class="param">season (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Season of play default: null </div><div class="param">fields (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Comma delimited list of specific fields to be returned. Format: topLevelNode, childNode, attribute default: null </div>
|
|
</div> <!-- field-items -->
|
|
|
|
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
OK
|
|
<a href="#"></a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="allStarBallot3"/>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="get"><code class="huge"><span class="http-method">get</span> /api/v1/leagues/{leagueId}/allStarBallot</code></pre></div>
|
|
<div class="method-summary">View al star ballot info (<span class="nickname">allStarBallot3</span>)</div>
|
|
<div class="method-notes"></div>
|
|
|
|
<h3 class="field-label">Path parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">leagueId (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Path Parameter</span> — Unique League Identifier default: null </div>
|
|
</div> <!-- field-items -->
|
|
|
|
|
|
|
|
|
|
<h3 class="field-label">Query parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">leagueIds (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Comma delimited list of Unique league identifiers default: null </div><div class="param">season (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Season of play default: null </div><div class="param">fields (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Comma delimited list of specific fields to be returned. Format: topLevelNode, childNode, attribute default: null </div>
|
|
</div> <!-- field-items -->
|
|
|
|
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
OK
|
|
<a href="#"></a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="allStarFinalVote"/>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="get"><code class="huge"><span class="http-method">get</span> /api/v1/league/{leagueId}/allStarFinalVote</code></pre></div>
|
|
<div class="method-summary">View all star final vote info (<span class="nickname">allStarFinalVote</span>)</div>
|
|
<div class="method-notes"></div>
|
|
|
|
<h3 class="field-label">Path parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">leagueId (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Path Parameter</span> — Unique League Identifier default: null </div>
|
|
</div> <!-- field-items -->
|
|
|
|
|
|
|
|
|
|
<h3 class="field-label">Query parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">season (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Season of play default: null </div><div class="param">fields (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Comma delimited list of specific fields to be returned. Format: topLevelNode, childNode, attribute default: null </div>
|
|
</div> <!-- field-items -->
|
|
|
|
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
OK
|
|
<a href="#"></a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="allStarFinalVote1"/>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="get"><code class="huge"><span class="http-method">get</span> /api/v1/leagues/{leagueId}/allStarFinalVote</code></pre></div>
|
|
<div class="method-summary">View all star final vote info (<span class="nickname">allStarFinalVote1</span>)</div>
|
|
<div class="method-notes"></div>
|
|
|
|
<h3 class="field-label">Path parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">leagueId (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Path Parameter</span> — Unique League Identifier default: null </div>
|
|
</div> <!-- field-items -->
|
|
|
|
|
|
|
|
|
|
<h3 class="field-label">Query parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">season (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Season of play default: null </div><div class="param">fields (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Comma delimited list of specific fields to be returned. Format: topLevelNode, childNode, attribute default: null </div>
|
|
</div> <!-- field-items -->
|
|
|
|
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
OK
|
|
<a href="#"></a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="allStarWriteIns"/>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="get"><code class="huge"><span class="http-method">get</span> /api/v1/league/{leagueId}/allStarWriteIns</code></pre></div>
|
|
<div class="method-summary">View all star write ins info (<span class="nickname">allStarWriteIns</span>)</div>
|
|
<div class="method-notes"></div>
|
|
|
|
<h3 class="field-label">Path parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">leagueId (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Path Parameter</span> — Unique League Identifier default: null </div>
|
|
</div> <!-- field-items -->
|
|
|
|
|
|
|
|
|
|
<h3 class="field-label">Query parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">season (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Season of play default: null </div><div class="param">fields (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Comma delimited list of specific fields to be returned. Format: topLevelNode, childNode, attribute default: null </div>
|
|
</div> <!-- field-items -->
|
|
|
|
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
OK
|
|
<a href="#"></a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="allStarWriteIns1"/>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="get"><code class="huge"><span class="http-method">get</span> /api/v1/leagues/{leagueId}/allStarWriteIns</code></pre></div>
|
|
<div class="method-summary">View all star write ins info (<span class="nickname">allStarWriteIns1</span>)</div>
|
|
<div class="method-notes"></div>
|
|
|
|
<h3 class="field-label">Path parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">leagueId (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Path Parameter</span> — Unique League Identifier default: null </div>
|
|
</div> <!-- field-items -->
|
|
|
|
|
|
|
|
|
|
<h3 class="field-label">Query parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">season (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Season of play default: null </div><div class="param">fields (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Comma delimited list of specific fields to be returned. Format: topLevelNode, childNode, attribute default: null </div>
|
|
</div> <!-- field-items -->
|
|
|
|
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
OK
|
|
<a href="#"></a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="league"/>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="get"><code class="huge"><span class="http-method">get</span> /api/v1/league</code></pre></div>
|
|
<div class="method-summary">View league info (<span class="nickname">league</span>)</div>
|
|
<div class="method-notes"></div>
|
|
|
|
<h3 class="field-label">Path parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">leagueId (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Path Parameter</span> — Unique League Identifier default: null </div>
|
|
</div> <!-- field-items -->
|
|
|
|
|
|
|
|
|
|
<h3 class="field-label">Query parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">leagueIds (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Comma delimited list of Unique league identifiers default: null </div><div class="param">season (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Season of play default: null </div><div class="param">seasons (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Comma delimited list of Seasons of play default: null </div><div class="param">fields (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Comma delimited list of specific fields to be returned. Format: topLevelNode, childNode, attribute default: null </div><div class="param">sportId (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Top level organization of a sport default: null </div><div class="param">activeStatus (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Flag for fetching leagues that are currently active (Y), inactive (N), pending (P), or all teams (B) default: null </div>
|
|
</div> <!-- field-items -->
|
|
|
|
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
OK
|
|
<a href="#"></a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="league1"/>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="get"><code class="huge"><span class="http-method">get</span> /api/v1/league/{leagueId}</code></pre></div>
|
|
<div class="method-summary">View league info (<span class="nickname">league1</span>)</div>
|
|
<div class="method-notes"></div>
|
|
|
|
<h3 class="field-label">Path parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">leagueId (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Path Parameter</span> — Unique League Identifier default: null </div>
|
|
</div> <!-- field-items -->
|
|
|
|
|
|
|
|
|
|
<h3 class="field-label">Query parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">leagueIds (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Comma delimited list of Unique league identifiers default: null </div><div class="param">season (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Season of play default: null </div><div class="param">seasons (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Comma delimited list of Seasons of play default: null </div><div class="param">fields (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Comma delimited list of specific fields to be returned. Format: topLevelNode, childNode, attribute default: null </div><div class="param">sportId (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Top level organization of a sport default: null </div><div class="param">activeStatus (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Flag for fetching leagues that are currently active (Y), inactive (N), pending (P), or all teams (B) default: null </div>
|
|
</div> <!-- field-items -->
|
|
|
|
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
OK
|
|
<a href="#"></a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="league2"/>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="get"><code class="huge"><span class="http-method">get</span> /api/v1/leagues</code></pre></div>
|
|
<div class="method-summary">View league info (<span class="nickname">league2</span>)</div>
|
|
<div class="method-notes"></div>
|
|
|
|
<h3 class="field-label">Path parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">leagueId (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Path Parameter</span> — Unique League Identifier default: null </div>
|
|
</div> <!-- field-items -->
|
|
|
|
|
|
|
|
|
|
<h3 class="field-label">Query parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">leagueIds (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Comma delimited list of Unique league identifiers default: null </div><div class="param">season (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Season of play default: null </div><div class="param">seasons (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Comma delimited list of Seasons of play default: null </div><div class="param">fields (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Comma delimited list of specific fields to be returned. Format: topLevelNode, childNode, attribute default: null </div><div class="param">sportId (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Top level organization of a sport default: null </div><div class="param">activeStatus (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Flag for fetching leagues that are currently active (Y), inactive (N), pending (P), or all teams (B) default: null </div>
|
|
</div> <!-- field-items -->
|
|
|
|
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
OK
|
|
<a href="#"></a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="league3"/>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="get"><code class="huge"><span class="http-method">get</span> /api/v1/leagues/{leagueId}</code></pre></div>
|
|
<div class="method-summary">View league info (<span class="nickname">league3</span>)</div>
|
|
<div class="method-notes"></div>
|
|
|
|
<h3 class="field-label">Path parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">leagueId (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Path Parameter</span> — Unique League Identifier default: null </div>
|
|
</div> <!-- field-items -->
|
|
|
|
|
|
|
|
|
|
<h3 class="field-label">Query parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">leagueIds (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Comma delimited list of Unique league identifiers default: null </div><div class="param">season (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Season of play default: null </div><div class="param">seasons (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Comma delimited list of Seasons of play default: null </div><div class="param">fields (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Comma delimited list of specific fields to be returned. Format: topLevelNode, childNode, attribute default: null </div><div class="param">sportId (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Top level organization of a sport default: null </div><div class="param">activeStatus (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Flag for fetching leagues that are currently active (Y), inactive (N), pending (P), or all teams (B) default: null </div>
|
|
</div> <!-- field-items -->
|
|
|
|
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
OK
|
|
<a href="#"></a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<h1><a name="Milestones">Milestones</a></h1>
|
|
<div class="method"><a name="achievementStatuses"/>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="get"><code class="huge"><span class="http-method">get</span> /api/v1/achievementStatuses</code></pre></div>
|
|
<div class="method-summary">View available achievementStatus options (<span class="nickname">achievementStatuses</span>)</div>
|
|
<div class="method-notes"></div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
OK
|
|
<a href="#"></a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="milestoneDurations"/>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="get"><code class="huge"><span class="http-method">get</span> /api/v1/milestoneDurations</code></pre></div>
|
|
<div class="method-summary">View available milestoneDurations options (<span class="nickname">milestoneDurations</span>)</div>
|
|
<div class="method-notes"></div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
OK
|
|
<a href="#"></a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="milestoneLookups"/>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="get"><code class="huge"><span class="http-method">get</span> /api/v1/milestoneLookups</code></pre></div>
|
|
<div class="method-summary">View available milestoneLookup options (<span class="nickname">milestoneLookups</span>)</div>
|
|
<div class="method-notes"></div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
OK
|
|
<a href="#"></a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="milestoneStatistics"/>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="get"><code class="huge"><span class="http-method">get</span> /api/v1/milestoneStatistics</code></pre></div>
|
|
<div class="method-summary">View available milestone statistics options (<span class="nickname">milestoneStatistics</span>)</div>
|
|
<div class="method-notes"></div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
OK
|
|
<a href="#"></a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="milestoneTypes"/>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="get"><code class="huge"><span class="http-method">get</span> /api/v1/milestoneTypes</code></pre></div>
|
|
<div class="method-summary">View available milestoneType options (<span class="nickname">milestoneTypes</span>)</div>
|
|
<div class="method-notes"></div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
OK
|
|
<a href="#"></a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="milestones"/>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="get"><code class="huge"><span class="http-method">get</span> /api/v1/milestones</code></pre></div>
|
|
<div class="method-summary">View pending and achieved milestones. (<span class="nickname">milestones</span>)</div>
|
|
<div class="method-notes"></div>
|
|
|
|
|
|
|
|
|
|
|
|
<h3 class="field-label">Query parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">orgType (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Organization level. Format: T(Team), L(League), S(Sport) default: null </div><div class="param">achievementStatuses (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Comma delimited list of milestone achievement types default: null </div><div class="param">milestoneTypes (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Comma delimited list of milestone types default: null </div><div class="param">isLastAchievement (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Filters out milestones that have already been surpassed. default: null </div><div class="param">milestoneStatistics (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Comma delimited list of milestone statistics default: null </div><div class="param">milestoneValues (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Comma delimited list of milestone values default: null </div><div class="param">playerIds (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — A unique identifier for players default: null </div><div class="param">teamIds (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Comma delimited list of Unique Team identifiers default: null </div><div class="param">leagueIds (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Comma delimited list of Unique league identifiers default: null </div><div class="param">statGroup (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Category of statistic to return. Available types in /api/v1/statGroups default: null </div><div class="param">season (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Season of play default: null </div><div class="param">seasons (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Comma delimited list of Seasons of play default: null </div><div class="param">venueIds (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Comma delimited list of Unique venue identifiers default: null </div><div class="param">gamePks (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Comma delimited list of unique primary keys default: null </div><div class="param">limit (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Number of results to return default: null </div><div class="param">fields (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Comma delimited list of specific fields to be returned. Format: topLevelNode, childNode, attribute default: null </div><div class="param">showFirsts (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — True to show play first milestones, like first HR, first Save, etc default: null </div>
|
|
</div> <!-- field-items -->
|
|
|
|
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
OK
|
|
<a href="#"></a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<h1><a name="Misc">Misc</a></h1>
|
|
<div class="method"><a name="aggregateSortEnum"/>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="get"><code class="huge"><span class="http-method">get</span> /api/v1/sortModifiers</code></pre></div>
|
|
<div class="method-summary">List all stat fields (<span class="nickname">aggregateSortEnum</span>)</div>
|
|
<div class="method-notes"></div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
OK
|
|
<a href="#"></a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="baseballStats"/>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="get"><code class="huge"><span class="http-method">get</span> /api/v1/baseballStats</code></pre></div>
|
|
<div class="method-summary">List all baseball stats (<span class="nickname">baseballStats</span>)</div>
|
|
<div class="method-notes"></div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
OK
|
|
<a href="#"></a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="broadcastAvailabilityTypes"/>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="get"><code class="huge"><span class="http-method">get</span> /api/v1/broadcastAvailability</code></pre></div>
|
|
<div class="method-summary">View broadcast availability options (<span class="nickname">broadcastAvailabilityTypes</span>)</div>
|
|
<div class="method-notes"></div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
OK
|
|
<a href="#"></a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="coachingVideoTypes"/>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="get"><code class="huge"><span class="http-method">get</span> /api/v1/coachingVideoTypes</code></pre></div>
|
|
<div class="method-summary">List all coaching video types (<span class="nickname">coachingVideoTypes</span>)</div>
|
|
<div class="method-notes"></div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
OK
|
|
<a href="#"></a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="eventStatus"/>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="get"><code class="huge"><span class="http-method">get</span> /api/v1/eventStatus</code></pre></div>
|
|
<div class="method-summary">List all possible event status types (<span class="nickname">eventStatus</span>)</div>
|
|
<div class="method-notes"></div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
OK
|
|
<a href="#"></a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="eventTypes"/>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="get"><code class="huge"><span class="http-method">get</span> /api/v1/eventTypes</code></pre></div>
|
|
<div class="method-summary">List all event types (<span class="nickname">eventTypes</span>)</div>
|
|
<div class="method-notes"></div>
|
|
|
|
|
|
|
|
|
|
|
|
<h3 class="field-label">Query parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">fields (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Comma delimited list of specific fields to be returned. Format: topLevelNode, childNode, attribute default: null </div>
|
|
</div> <!-- field-items -->
|
|
|
|
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
OK
|
|
<a href="#"></a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="fielderDetailTypes"/>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="get"><code class="huge"><span class="http-method">get</span> /api/v1/fielderDetailTypes</code></pre></div>
|
|
<div class="method-summary">List fielder detail types (<span class="nickname">fielderDetailTypes</span>)</div>
|
|
<div class="method-notes"></div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
OK
|
|
<a href="#"></a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="freeGameTypes"/>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="get"><code class="huge"><span class="http-method">get</span> /api/v1/freeGameTypes</code></pre></div>
|
|
<div class="method-summary">View free game types (<span class="nickname">freeGameTypes</span>)</div>
|
|
<div class="method-notes"></div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
OK
|
|
<a href="#"></a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="gameStatus"/>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="get"><code class="huge"><span class="http-method">get</span> /api/v1/gameStatus</code></pre></div>
|
|
<div class="method-summary">List all status types (<span class="nickname">gameStatus</span>)</div>
|
|
<div class="method-notes"></div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
OK
|
|
<a href="#"></a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="gameTypes"/>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="get"><code class="huge"><span class="http-method">get</span> /api/v1/gameTypes</code></pre></div>
|
|
<div class="method-summary">List all game types (<span class="nickname">gameTypes</span>)</div>
|
|
<div class="method-notes"></div>
|
|
|
|
|
|
|
|
|
|
|
|
<h3 class="field-label">Query parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">sportId (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Top level organization of a sport default: null </div><div class="param">leagueId (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Unique League Identifier default: null </div><div class="param">season (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Season of play default: null </div>
|
|
</div> <!-- field-items -->
|
|
|
|
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
OK
|
|
<a href="#"></a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="gamedayTypes"/>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="get"><code class="huge"><span class="http-method">get</span> /api/v1/gamedayTypes</code></pre></div>
|
|
<div class="method-summary">List all gameday types (<span class="nickname">gamedayTypes</span>)</div>
|
|
<div class="method-notes"></div>
|
|
|
|
|
|
|
|
|
|
|
|
<h3 class="field-label">Query parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">fields (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Comma delimited list of specific fields to be returned. Format: topLevelNode, childNode, attribute default: null </div>
|
|
</div> <!-- field-items -->
|
|
|
|
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
OK
|
|
<a href="#"></a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="getLookupValues"/>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="get"><code class="huge"><span class="http-method">get</span> /api/v1/lookup/values/all</code></pre></div>
|
|
<div class="method-summary">View all lookup values (<span class="nickname">getLookupValues</span>)</div>
|
|
<div class="method-notes"></div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
OK
|
|
<a href="#"></a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="groupByTypes"/>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="get"><code class="huge"><span class="http-method">get</span> /api/v1/groupByTypes</code></pre></div>
|
|
<div class="method-summary">List groupBy types (<span class="nickname">groupByTypes</span>)</div>
|
|
<div class="method-notes"></div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
OK
|
|
<a href="#"></a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="hitTrajectories"/>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="get"><code class="huge"><span class="http-method">get</span> /api/v1/hitTrajectories</code></pre></div>
|
|
<div class="method-summary">List all hit trajectories (<span class="nickname">hitTrajectories</span>)</div>
|
|
<div class="method-notes"></div>
|
|
|
|
|
|
|
|
|
|
|
|
<h3 class="field-label">Query parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">fields (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Comma delimited list of specific fields to be returned. Format: topLevelNode, childNode, attribute default: null </div>
|
|
</div> <!-- field-items -->
|
|
|
|
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
OK
|
|
<a href="#"></a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="jobTypes"/>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="get"><code class="huge"><span class="http-method">get</span> /api/v1/jobTypes</code></pre></div>
|
|
<div class="method-summary">List all job types (<span class="nickname">jobTypes</span>)</div>
|
|
<div class="method-notes"></div>
|
|
|
|
|
|
|
|
|
|
|
|
<h3 class="field-label">Query parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">fields (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Comma delimited list of specific fields to be returned. Format: topLevelNode, childNode, attribute default: null </div>
|
|
</div> <!-- field-items -->
|
|
|
|
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
OK
|
|
<a href="#"></a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="languages"/>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="get"><code class="huge"><span class="http-method">get</span> /api/v1/languages</code></pre></div>
|
|
<div class="method-summary">List all support languages (<span class="nickname">languages</span>)</div>
|
|
<div class="method-notes"></div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
OK
|
|
<a href="#"></a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="leagueLeaderTypes"/>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="get"><code class="huge"><span class="http-method">get</span> /api/v1/leagueLeaderTypes</code></pre></div>
|
|
<div class="method-summary">List all possible player league leader types (<span class="nickname">leagueLeaderTypes</span>)</div>
|
|
<div class="method-notes"></div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
OK
|
|
<a href="#"></a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="logicalEvents"/>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="get"><code class="huge"><span class="http-method">get</span> /api/v1/logicalEvents</code></pre></div>
|
|
<div class="method-summary">List all logical event types (<span class="nickname">logicalEvents</span>)</div>
|
|
<div class="method-notes"></div>
|
|
|
|
|
|
|
|
|
|
|
|
<h3 class="field-label">Query parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">fields (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Comma delimited list of specific fields to be returned. Format: topLevelNode, childNode, attribute default: null </div>
|
|
</div> <!-- field-items -->
|
|
|
|
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
OK
|
|
<a href="#"></a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="mediaStateTypes"/>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="get"><code class="huge"><span class="http-method">get</span> /api/v1/mediaState</code></pre></div>
|
|
<div class="method-summary">View media state options (<span class="nickname">mediaStateTypes</span>)</div>
|
|
<div class="method-notes"></div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
OK
|
|
<a href="#"></a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="metrics"/>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="get"><code class="huge"><span class="http-method">get</span> /api/v1/metrics</code></pre></div>
|
|
<div class="method-summary">List all possible metrics (<span class="nickname">metrics</span>)</div>
|
|
<div class="method-notes"></div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
OK
|
|
<a href="#"></a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="moundVisitTypes"/>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="get"><code class="huge"><span class="http-method">get</span> /api/v1/moundVisitTypes</code></pre></div>
|
|
<div class="method-summary">List all mound visit types (<span class="nickname">moundVisitTypes</span>)</div>
|
|
<div class="method-notes"></div>
|
|
|
|
|
|
|
|
|
|
|
|
<h3 class="field-label">Query parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">fields (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Comma delimited list of specific fields to be returned. Format: topLevelNode, childNode, attribute default: null </div>
|
|
</div> <!-- field-items -->
|
|
|
|
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
OK
|
|
<a href="#"></a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="performerTypes"/>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="get"><code class="huge"><span class="http-method">get</span> /api/v1/performerTypes</code></pre></div>
|
|
<div class="method-summary">List all possible performer types (<span class="nickname">performerTypes</span>)</div>
|
|
<div class="method-notes"></div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
OK
|
|
<a href="#"></a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="pitchCodes"/>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="get"><code class="huge"><span class="http-method">get</span> /api/v1/pitchCodes</code></pre></div>
|
|
<div class="method-summary">List all pitch codes (<span class="nickname">pitchCodes</span>)</div>
|
|
<div class="method-notes"></div>
|
|
|
|
|
|
|
|
|
|
|
|
<h3 class="field-label">Query parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">fields (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Comma delimited list of specific fields to be returned. Format: topLevelNode, childNode, attribute default: null </div>
|
|
</div> <!-- field-items -->
|
|
|
|
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
OK
|
|
<a href="#"></a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="pitchTypes"/>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="get"><code class="huge"><span class="http-method">get</span> /api/v1/pitchTypes</code></pre></div>
|
|
<div class="method-summary">List all pitch classification types (<span class="nickname">pitchTypes</span>)</div>
|
|
<div class="method-notes"></div>
|
|
|
|
|
|
|
|
|
|
|
|
<h3 class="field-label">Query parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">fields (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Comma delimited list of specific fields to be returned. Format: topLevelNode, childNode, attribute default: null </div>
|
|
</div> <!-- field-items -->
|
|
|
|
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
OK
|
|
<a href="#"></a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="platforms"/>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="get"><code class="huge"><span class="http-method">get</span> /api/v1/platforms</code></pre></div>
|
|
<div class="method-summary">List all possible platforms (<span class="nickname">platforms</span>)</div>
|
|
<div class="method-notes"></div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
OK
|
|
<a href="#"></a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="playerStatusCodes"/>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="get"><code class="huge"><span class="http-method">get</span> /api/v1/playerStatusCodes</code></pre></div>
|
|
<div class="method-summary">List all player status codes (<span class="nickname">playerStatusCodes</span>)</div>
|
|
<div class="method-notes"></div>
|
|
|
|
|
|
|
|
|
|
|
|
<h3 class="field-label">Query parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">fields (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Comma delimited list of specific fields to be returned. Format: topLevelNode, childNode, attribute default: null </div>
|
|
</div> <!-- field-items -->
|
|
|
|
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
OK
|
|
<a href="#"></a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="positions"/>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="get"><code class="huge"><span class="http-method">get</span> /api/v1/positions</code></pre></div>
|
|
<div class="method-summary">List all possible positions (<span class="nickname">positions</span>)</div>
|
|
<div class="method-notes"></div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
OK
|
|
<a href="#"></a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="reviewReasons"/>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="get"><code class="huge"><span class="http-method">get</span> /api/v1/reviewReasons</code></pre></div>
|
|
<div class="method-summary">List all replay review reasons (<span class="nickname">reviewReasons</span>)</div>
|
|
<div class="method-notes"></div>
|
|
|
|
|
|
|
|
|
|
|
|
<h3 class="field-label">Query parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">fields (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Comma delimited list of specific fields to be returned. Format: topLevelNode, childNode, attribute default: null </div>
|
|
</div> <!-- field-items -->
|
|
|
|
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
OK
|
|
<a href="#"></a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="roofTypes"/>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="get"><code class="huge"><span class="http-method">get</span> /api/v1/roofTypes</code></pre></div>
|
|
<div class="method-summary">List all roof types (<span class="nickname">roofTypes</span>)</div>
|
|
<div class="method-notes"></div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
OK
|
|
<a href="#"></a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="rosterTypes"/>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="get"><code class="huge"><span class="http-method">get</span> /api/v1/rosterTypes</code></pre></div>
|
|
<div class="method-summary">List all possible roster types (<span class="nickname">rosterTypes</span>)</div>
|
|
<div class="method-notes"></div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
OK
|
|
<a href="#"></a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="ruleSettings"/>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="get"><code class="huge"><span class="http-method">get</span> /api/v1/ruleSettings</code></pre></div>
|
|
<div class="method-summary">List all ruleSettings (<span class="nickname">ruleSettings</span>)</div>
|
|
<div class="method-notes"></div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
OK
|
|
<a href="#"></a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="runnerDetailTypes"/>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="get"><code class="huge"><span class="http-method">get</span> /api/v1/runnerDetailTypes</code></pre></div>
|
|
<div class="method-summary">List runner detail types (<span class="nickname">runnerDetailTypes</span>)</div>
|
|
<div class="method-notes"></div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
OK
|
|
<a href="#"></a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="scheduleEventTypes"/>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="get"><code class="huge"><span class="http-method">get</span> /api/v1/scheduleEventTypes</code></pre></div>
|
|
<div class="method-summary">List all schedule event types (<span class="nickname">scheduleEventTypes</span>)</div>
|
|
<div class="method-notes"></div>
|
|
|
|
|
|
|
|
|
|
|
|
<h3 class="field-label">Query parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">fields (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Comma delimited list of specific fields to be returned. Format: topLevelNode, childNode, attribute default: null </div>
|
|
</div> <!-- field-items -->
|
|
|
|
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
OK
|
|
<a href="#"></a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="scheduleTypes"/>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="get"><code class="huge"><span class="http-method">get</span> /api/v1/scheduleTypes</code></pre></div>
|
|
<div class="method-summary">List all possible schedule types (<span class="nickname">scheduleTypes</span>)</div>
|
|
<div class="method-notes"></div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
OK
|
|
<a href="#"></a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="sitCodes"/>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="get"><code class="huge"><span class="http-method">get</span> /api/v1/situationCodes</code></pre></div>
|
|
<div class="method-summary">List all situation codes (<span class="nickname">sitCodes</span>)</div>
|
|
<div class="method-notes"></div>
|
|
|
|
|
|
|
|
|
|
|
|
<h3 class="field-label">Query parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">fields (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Comma delimited list of specific fields to be returned. Format: topLevelNode, childNode, attribute default: null </div><div class="param">season (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Season of play default: null </div><div class="param">statGroup (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Category of statistic to return. Available types in /api/v1/statGroups default: null </div>
|
|
</div> <!-- field-items -->
|
|
|
|
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
OK
|
|
<a href="#"></a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="sky"/>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="get"><code class="huge"><span class="http-method">get</span> /api/v1/sky</code></pre></div>
|
|
<div class="method-summary">List all sky options (<span class="nickname">sky</span>)</div>
|
|
<div class="method-notes"></div>
|
|
|
|
|
|
|
|
|
|
|
|
<h3 class="field-label">Query parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">fields (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Comma delimited list of specific fields to be returned. Format: topLevelNode, childNode, attribute default: null </div>
|
|
</div> <!-- field-items -->
|
|
|
|
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
OK
|
|
<a href="#"></a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="standingsTypes"/>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="get"><code class="huge"><span class="http-method">get</span> /api/v1/standingsTypes</code></pre></div>
|
|
<div class="method-summary">List all standings types (<span class="nickname">standingsTypes</span>)</div>
|
|
<div class="method-notes"></div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
OK
|
|
<a href="#"></a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="statFields"/>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="get"><code class="huge"><span class="http-method">get</span> /api/v1/statFields</code></pre></div>
|
|
<div class="method-summary">List all stat fields (<span class="nickname">statFields</span>)</div>
|
|
<div class="method-notes"></div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
OK
|
|
<a href="#"></a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="statGroups"/>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="get"><code class="huge"><span class="http-method">get</span> /api/v1/statGroups</code></pre></div>
|
|
<div class="method-summary">List all stat groups (<span class="nickname">statGroups</span>)</div>
|
|
<div class="method-notes"></div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
OK
|
|
<a href="#"></a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="statSearchConfig"/>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="get"><code class="huge"><span class="http-method">get</span> /api/v1/stats/search/config</code></pre></div>
|
|
<div class="method-summary">Stats Search Config Endpoint (<span class="nickname">statSearchConfig</span>)</div>
|
|
<div class="method-notes"></div>
|
|
|
|
|
|
|
|
|
|
|
|
<h3 class="field-label">Query parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">filterLevel (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Categories of filters for stat search default: null </div><div class="param">group (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Category of statistic to return. Available types in /api/v1/statGroups default: null </div>
|
|
</div> <!-- field-items -->
|
|
|
|
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
OK
|
|
<a href="#"></a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="statSearchGroupByTypes"/>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="get"><code class="huge"><span class="http-method">get</span> /api/v1/stats/search/groupByTypes</code></pre></div>
|
|
<div class="method-summary">List groupBy types (<span class="nickname">statSearchGroupByTypes</span>)</div>
|
|
<div class="method-notes"></div>
|
|
|
|
|
|
|
|
|
|
|
|
<h3 class="field-label">Query parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">filterLevel (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Categories of filters for stat search default: null </div>
|
|
</div> <!-- field-items -->
|
|
|
|
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
OK
|
|
<a href="#"></a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="statSearchParams"/>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="get"><code class="huge"><span class="http-method">get</span> /api/v1/stats/search/params</code></pre></div>
|
|
<div class="method-summary">List stat search parameters (<span class="nickname">statSearchParams</span>)</div>
|
|
<div class="method-notes"></div>
|
|
|
|
|
|
|
|
|
|
|
|
<h3 class="field-label">Query parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">filterLevel (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Categories of filters for stat search default: null </div>
|
|
</div> <!-- field-items -->
|
|
|
|
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
OK
|
|
<a href="#"></a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="statSearchStats"/>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="get"><code class="huge"><span class="http-method">get</span> /api/v1/stats/search/stats</code></pre></div>
|
|
<div class="method-summary">List stat search stats (<span class="nickname">statSearchStats</span>)</div>
|
|
<div class="method-notes"></div>
|
|
|
|
|
|
|
|
|
|
|
|
<h3 class="field-label">Query parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">filterLevel (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Categories of filters for stat search default: null </div>
|
|
</div> <!-- field-items -->
|
|
|
|
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
OK
|
|
<a href="#"></a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="statTypes"/>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="get"><code class="huge"><span class="http-method">get</span> /api/v1/statTypes</code></pre></div>
|
|
<div class="method-summary">List all stat types (<span class="nickname">statTypes</span>)</div>
|
|
<div class="method-notes"></div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
OK
|
|
<a href="#"></a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="statcastPositionTypes"/>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="get"><code class="huge"><span class="http-method">get</span> /api/v1/statcastPositionTypes</code></pre></div>
|
|
<div class="method-summary">List all statcast position types (<span class="nickname">statcastPositionTypes</span>)</div>
|
|
<div class="method-notes"></div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
OK
|
|
<a href="#"></a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="trackingSoftwareVersions"/>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="get"><code class="huge"><span class="http-method">get</span> /api/v1/trackingSoftwareVersions</code></pre></div>
|
|
<div class="method-summary">List the tracking software versions and notes (<span class="nickname">trackingSoftwareVersions</span>)</div>
|
|
<div class="method-notes"></div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
OK
|
|
<a href="#"></a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="trackingSystemOwners"/>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="get"><code class="huge"><span class="http-method">get</span> /api/v1/trackingSystemOwners</code></pre></div>
|
|
<div class="method-summary">List all tracking system owners (<span class="nickname">trackingSystemOwners</span>)</div>
|
|
<div class="method-notes"></div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
OK
|
|
<a href="#"></a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="trackingVendors"/>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="get"><code class="huge"><span class="http-method">get</span> /api/v1/trackingVendors</code></pre></div>
|
|
<div class="method-summary">List all tracking vendors (<span class="nickname">trackingVendors</span>)</div>
|
|
<div class="method-notes"></div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
OK
|
|
<a href="#"></a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="trackingVersions"/>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="get"><code class="huge"><span class="http-method">get</span> /api/v1/trackingVersions</code></pre></div>
|
|
<div class="method-summary">List all tracking versions (<span class="nickname">trackingVersions</span>)</div>
|
|
<div class="method-notes"></div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
OK
|
|
<a href="#"></a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="transactionTypes"/>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="get"><code class="huge"><span class="http-method">get</span> /api/v1/transactionTypes</code></pre></div>
|
|
<div class="method-summary">List all transaction types (<span class="nickname">transactionTypes</span>)</div>
|
|
<div class="method-notes"></div>
|
|
|
|
|
|
|
|
|
|
|
|
<h3 class="field-label">Query parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">fields (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Comma delimited list of specific fields to be returned. Format: topLevelNode, childNode, attribute default: null </div>
|
|
</div> <!-- field-items -->
|
|
|
|
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
OK
|
|
<a href="#"></a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="updateGameStatuses"/>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="post"><code class="huge"><span class="http-method">post</span> /api/v1/gameStatus</code></pre></div>
|
|
<div class="method-summary">Clear all status types (<span class="nickname">updateGameStatuses</span>)</div>
|
|
<div class="method-notes"></div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
OK
|
|
<a href="#"></a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="updateJobTypes"/>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="post"><code class="huge"><span class="http-method">post</span> /api/v1/jobTypes</code></pre></div>
|
|
<div class="method-summary"> (<span class="nickname">updateJobTypes</span>)</div>
|
|
<div class="method-notes"></div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
OK
|
|
<a href="#"></a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="videoResolutionTypes"/>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="get"><code class="huge"><span class="http-method">get</span> /api/v1/videoResolutionTypes</code></pre></div>
|
|
<div class="method-summary">View video resolution options (<span class="nickname">videoResolutionTypes</span>)</div>
|
|
<div class="method-notes"></div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
OK
|
|
<a href="#"></a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="violationTypes"/>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="get"><code class="huge"><span class="http-method">get</span> /api/v1/violationTypes</code></pre></div>
|
|
<div class="method-summary">View available violationType options (<span class="nickname">violationTypes</span>)</div>
|
|
<div class="method-notes"></div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
OK
|
|
<a href="#"></a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="weatherTrajectoryConfidences"/>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="get"><code class="huge"><span class="http-method">get</span> /api/v1/weatherTrajectoryConfidences</code></pre></div>
|
|
<div class="method-summary">List all weather trajectories (<span class="nickname">weatherTrajectoryConfidences</span>)</div>
|
|
<div class="method-notes"></div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
OK
|
|
<a href="#"></a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="windDirection"/>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="get"><code class="huge"><span class="http-method">get</span> /api/v1/windDirection</code></pre></div>
|
|
<div class="method-summary">List all wind direction options (<span class="nickname">windDirection</span>)</div>
|
|
<div class="method-notes"></div>
|
|
|
|
|
|
|
|
|
|
|
|
<h3 class="field-label">Query parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">fields (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Comma delimited list of specific fields to be returned. Format: topLevelNode, childNode, attribute default: null </div>
|
|
</div> <!-- field-items -->
|
|
|
|
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
OK
|
|
<a href="#"></a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<h1><a name="Person">Person</a></h1>
|
|
<div class="method"><a name="award"/>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="get"><code class="huge"><span class="http-method">get</span> /api/v1/people/{personId}/awards</code></pre></div>
|
|
<div class="method-summary">View a player's awards (<span class="nickname">award</span>)</div>
|
|
<div class="method-notes"></div>
|
|
|
|
<h3 class="field-label">Path parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">personId (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Path Parameter</span> — Unique Player Identifier. Format: 434538, 429665, etc default: null </div>
|
|
</div> <!-- field-items -->
|
|
|
|
|
|
|
|
|
|
<h3 class="field-label">Query parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">fields (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Comma delimited list of specific fields to be returned. Format: topLevelNode, childNode, attribute default: null </div>
|
|
</div> <!-- field-items -->
|
|
|
|
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
OK
|
|
<a href="#"></a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="currentGameStats"/>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="get"><code class="huge"><span class="http-method">get</span> /api/v1/people/changes</code></pre></div>
|
|
<div class="method-summary">View a player's change log (<span class="nickname">currentGameStats</span>)</div>
|
|
<div class="method-notes"></div>
|
|
|
|
|
|
|
|
|
|
|
|
<h3 class="field-label">Query parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">updatedSince (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Format: YYYY-MM-DDTHH:MM:SSZ default: null </div><div class="param">limit (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Number of results to return default: null </div><div class="param">offset (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — The pointer to start for a return set; used for pagination default: null </div><div class="param">accent (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Boolean value to specify wanting a person's name with accents or without default: null </div><div class="param">fields (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Comma delimited list of specific fields to be returned. Format: topLevelNode, childNode, attribute default: null </div>
|
|
</div> <!-- field-items -->
|
|
|
|
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
OK
|
|
<a href="#"></a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="freeAgents"/>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="get"><code class="huge"><span class="http-method">get</span> /api/v1/people/freeAgents</code></pre></div>
|
|
<div class="method-summary">Get free agents (<span class="nickname">freeAgents</span>)</div>
|
|
<div class="method-notes"></div>
|
|
|
|
|
|
|
|
|
|
|
|
<h3 class="field-label">Query parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">season (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Season of play default: null </div><div class="param">order (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — The order of sorting, ascending or descending default: null </div><div class="param">accent (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Boolean value to specify wanting a person's name with accents or without default: null </div><div class="param">fields (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — default: null </div>
|
|
</div> <!-- field-items -->
|
|
|
|
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
OK
|
|
<a href="#"></a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="person"/>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="get"><code class="huge"><span class="http-method">get</span> /api/v1/people/{personId}</code></pre></div>
|
|
<div class="method-summary">View a player (<span class="nickname">person</span>)</div>
|
|
<div class="method-notes">This endpoint allows you to pull the information of players</div>
|
|
|
|
<h3 class="field-label">Path parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">personId (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Path Parameter</span> — Unique Player Identifier. Format: 434538, 429665, etc default: null </div>
|
|
</div> <!-- field-items -->
|
|
|
|
|
|
|
|
|
|
<h3 class="field-label">Query parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">personIds (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Comma delimited list of person ID. Format: 1234, 2345 default: null </div><div class="param">accent (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Boolean value to specify wanting a person's name with accents or without default: null </div><div class="param">season (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Season of play default: null </div><div class="param">group (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Category of statistic to return. Available types in /api/v1/statGroups default: null </div><div class="param">fields (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Comma delimited list of specific fields to be returned. Format: topLevelNode, childNode, attribute default: null </div>
|
|
</div> <!-- field-items -->
|
|
|
|
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
OK
|
|
<a href="#"></a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="person1"/>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="get"><code class="huge"><span class="http-method">get</span> /api/v1/people</code></pre></div>
|
|
<div class="method-summary">View a player (<span class="nickname">person1</span>)</div>
|
|
<div class="method-notes">This endpoint allows you to pull the information of players</div>
|
|
|
|
<h3 class="field-label">Path parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">personId (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Path Parameter</span> — Unique Player Identifier. Format: 434538, 429665, etc default: null </div>
|
|
</div> <!-- field-items -->
|
|
|
|
|
|
|
|
|
|
<h3 class="field-label">Query parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">personIds (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Comma delimited list of person ID. Format: 1234, 2345 default: null </div><div class="param">accent (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Boolean value to specify wanting a person's name with accents or without default: null </div><div class="param">season (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Season of play default: null </div><div class="param">group (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Category of statistic to return. Available types in /api/v1/statGroups default: null </div><div class="param">fields (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Comma delimited list of specific fields to be returned. Format: topLevelNode, childNode, attribute default: null </div>
|
|
</div> <!-- field-items -->
|
|
|
|
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
OK
|
|
<a href="#"></a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="playerGameStats"/>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="get"><code class="huge"><span class="http-method">get</span> /api/v1/people/{personId}/stats/game/{gamePk}</code></pre></div>
|
|
<div class="method-summary">View a player's game stats (<span class="nickname">playerGameStats</span>)</div>
|
|
<div class="method-notes"></div>
|
|
|
|
<h3 class="field-label">Path parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">personId (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Path Parameter</span> — Unique Player Identifier. Format: 434538, 429665, etc default: null </div><div class="param">gamePk (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Path Parameter</span> — Unique Primary Key Representing a Game default: null </div>
|
|
</div> <!-- field-items -->
|
|
|
|
|
|
|
|
|
|
<h3 class="field-label">Query parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">group (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Category of statistic to return. Available types in /api/v1/statGroups default: null </div><div class="param">fields (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Comma delimited list of specific fields to be returned. Format: topLevelNode, childNode, attribute default: null </div>
|
|
</div> <!-- field-items -->
|
|
|
|
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
OK
|
|
<a href="#"></a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="search"/>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="get"><code class="huge"><span class="http-method">get</span> /api/v1/people/search</code></pre></div>
|
|
<div class="method-summary">Search for a player by name (<span class="nickname">search</span>)</div>
|
|
<div class="method-notes"></div>
|
|
|
|
|
|
|
|
|
|
|
|
<h3 class="field-label">Query parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">names (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Name a player uses default: null </div><div class="param">personIds (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Comma delimited list of person ID. Format: 1234, 2345 default: null </div><div class="param">sportIds (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Comma delimited list of top level organizations of a sport default: null </div><div class="param">leagueIds (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Comma delimited list of Unique league identifiers default: null </div><div class="param">teamIds (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Comma delimited list of Unique Team identifiers default: null </div><div class="param">leagueListId (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Unique League List Identifier default: null </div><div class="param">active (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Whether or not a player is active default: null </div><div class="param">verified (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Complete and confirmed all biographical data default: null </div><div class="param">rookie (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Whether or not a player is a rookie default: null </div><div class="param">seasons (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Comma delimited list of Seasons of play default: null </div><div class="param">fields (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Comma delimited list of specific fields to be returned. Format: topLevelNode, childNode, attribute default: null </div><div class="param">accent (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Boolean value to specify wanting a person's name with accents or without default: null </div><div class="param">limit (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Number of results to return default: null </div>
|
|
</div> <!-- field-items -->
|
|
|
|
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
OK
|
|
<a href="#"></a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="stats3"/>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="get"><code class="huge"><span class="http-method">get</span> /api/v1/people/{personId}/stats</code></pre></div>
|
|
<div class="method-summary">View a players stats (<span class="nickname">stats3</span>)</div>
|
|
<div class="method-notes"></div>
|
|
|
|
<h3 class="field-label">Path parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">personId (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Path Parameter</span> — Unique Player Identifier. Format: 434538, 429665, etc default: null </div>
|
|
</div> <!-- field-items -->
|
|
|
|
|
|
|
|
|
|
<h3 class="field-label">Query parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">stats (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Type of statistics. Format: Individual, Team, Career, etc. Available types in /api/v1/statTypes default: null </div><div class="param">group (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Category of statistic to return. Available types in /api/v1/statGroups default: null </div><div class="param">season (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Season of play default: null </div><div class="param">seasons (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Comma delimited list of Seasons of play default: null </div><div class="param">sportId (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Top level organization of a sport default: null </div><div class="param">opposingTeamId (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — A unique identifier for the opposing team. Must be used with Team ID default: null </div><div class="param">opposingPlayerId (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — A unique identifier for the opposing team default: null </div><div class="param">metrics (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Name of metric(s) for metric log stats. Available metrics in /api/v1/metrics default: null </div><div class="param">leagueId (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Unique League Identifier default: null </div><div class="param">leagueListId (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Unique League List Identifier default: null </div><div class="param">sitCodes (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Situation code for a given stat split. default: null </div><div class="param">combineSits (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — If true, gathers stats where all of the situational criteria are met. If false, returns stats where any of the situational criteria are met. Default: false default: null </div><div class="param">startDate (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Start date for range of data (must be used with end date). Format: MM/DD/YYYY default: null </div><div class="param">endDate (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — End date for range of data (must be used with start date). Format: MM/DD/YYYY default: null </div><div class="param">daysBack (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Returns results from the last 'X' days (Starting from yesterday). default: null </div><div class="param">gamesBack (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Returns results from the last 'X' games played. default: null </div><div class="param">limit (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Number of results to return default: null </div><div class="param">eventType (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Type of event default: null </div><div class="param">pitchType (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Classification of pitch (fastball, curveball, etc...) default: null </div><div class="param">hitTrajectory (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Trajectory of hit (line drive, fly ball, etc...) default: null </div><div class="param">batSide (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Bat side of hitter default: null </div><div class="param">gameType (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Type of Game. Available types in /api/v1/gameTypes default: null </div><div class="param">groupBy (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Group stats by PLAYER, TEAM, SEASON, VENUE, SPORT or STAT_GROUP default: null </div><div class="param">accent (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Boolean value to specify wanting a person's name with accents or without default: null </div><div class="param">fields (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Comma delimited list of specific fields to be returned. Format: topLevelNode, childNode, attribute default: null </div>
|
|
</div> <!-- field-items -->
|
|
|
|
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
OK
|
|
<a href="#"></a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="statsMetrics"/>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="get"><code class="huge"><span class="http-method">get</span> /api/v1/people/{personId}/stats/metrics</code></pre></div>
|
|
<div class="method-summary">View a player's stat metrics (<span class="nickname">statsMetrics</span>)</div>
|
|
<div class="method-notes"></div>
|
|
|
|
<h3 class="field-label">Path parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">personId (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Path Parameter</span> — Unique Player Identifier. Format: 434538, 429665, etc default: null </div>
|
|
</div> <!-- field-items -->
|
|
|
|
|
|
|
|
|
|
<h3 class="field-label">Query parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">stats (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Type of statistics. Format: Individual, Team, Career, etc. Available types in /api/v1/statTypes default: null </div><div class="param">group (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Category of statistic to return. Available types in /api/v1/statGroups default: null </div><div class="param">season (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Season of play default: null </div><div class="param">seasons (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Comma delimited list of Seasons of play default: null </div><div class="param">sportId (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Top level organization of a sport default: null </div><div class="param">opposingTeamId (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — A unique identifier for the opposing team. Must be used with Team ID default: null </div><div class="param">opposingPlayerId (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — A unique identifier for the opposing team default: null </div><div class="param">metrics (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Name of metric(s) for metric log stats. Available metrics in /api/v1/metrics default: null </div><div class="param">leagueId (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Unique League Identifier default: null </div><div class="param">leagueListId (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Unique League List Identifier default: null </div><div class="param">sitCodes (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Situation code for a given stat split. default: null </div><div class="param">combineSits (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — If true, gathers stats where all of the situational criteria are met. If false, returns stats where any of the situational criteria are met. Default: false default: null </div><div class="param">startDate (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Start date for range of data (must be used with end date). Format: MM/DD/YYYY default: null </div><div class="param">endDate (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — End date for range of data (must be used with start date). Format: MM/DD/YYYY default: null </div><div class="param">daysBack (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Returns results from the last 'X' days (Starting from yesterday). default: null </div><div class="param">gamesBack (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Returns results from the last 'X' games played. default: null </div><div class="param">limit (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Number of results to return default: null </div><div class="param">eventType (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Type of event default: null </div><div class="param">pitchType (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Classification of pitch (fastball, curveball, etc...) default: null </div><div class="param">hitTrajectory (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Trajectory of hit (line drive, fly ball, etc...) default: null </div><div class="param">batSide (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Bat side of hitter default: null </div><div class="param">gameType (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Type of Game. Available types in /api/v1/gameTypes default: null </div><div class="param">groupBy (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Group stats by PLAYER, TEAM, SEASON, VENUE, SPORT or STAT_GROUP default: null </div><div class="param">accent (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Boolean value to specify wanting a person's name with accents or without default: null </div><div class="param">fields (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Comma delimited list of specific fields to be returned. Format: topLevelNode, childNode, attribute default: null </div>
|
|
</div> <!-- field-items -->
|
|
|
|
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
OK
|
|
<a href="#"></a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<h1><a name="Predictions">Predictions</a></h1>
|
|
<div class="method"><a name="getProps"/>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="get"><code class="huge"><span class="http-method">get</span> /api/v1/props/play/predictions</code></pre></div>
|
|
<div class="method-summary">Get play-level predictions based on input scenarios (<span class="nickname">getProps</span>)</div>
|
|
<div class="method-notes">This endpoint allows you to get play-level predictions based on input scenarios</div>
|
|
|
|
|
|
|
|
|
|
|
|
<h3 class="field-label">Query parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">batterId (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Unique Player Identifier. Format: 434538, 429665, etc default: null </div><div class="param">pitcherId (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Unique Player Identifier. Format: 434538, 429665, etc default: null </div><div class="param">venueId (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Unique Venue Identifier default: null </div><div class="param">batSide (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Bat side of hitter default: null </div><div class="param">pitchHand (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Handedness of pitcher default: null </div><div class="param">batterPosition (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Position abbreviation. Format: SS, P, 1B, etc default: null </div><div class="param">pitcherPosition (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Position abbreviation. Format: SS, P, 1B, etc default: null </div>
|
|
</div> <!-- field-items -->
|
|
|
|
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
OK
|
|
<a href="#"></a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="getPropsAdjust"/>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="get"><code class="huge"><span class="http-method">get</span> /api/v1/props/play/predictions/adjust</code></pre></div>
|
|
<div class="method-summary">Get play-level predictions based on input scenarios (<span class="nickname">getPropsAdjust</span>)</div>
|
|
<div class="method-notes">This endpoint allows you to get play-level predictions based on input scenarios</div>
|
|
|
|
|
|
|
|
|
|
|
|
<h3 class="field-label">Query parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">gamePk (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Unique Primary Key Representing a Game default: null </div>
|
|
</div> <!-- field-items -->
|
|
|
|
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
OK
|
|
<a href="#"></a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<h1><a name="Reviews">Reviews</a></h1>
|
|
<div class="method"><a name="getReviewInfo"/>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="get"><code class="huge"><span class="http-method">get</span> /api/v1/review</code></pre></div>
|
|
<div class="method-summary">Get review info (<span class="nickname">getReviewInfo</span>)</div>
|
|
<div class="method-notes"></div>
|
|
|
|
|
|
|
|
|
|
|
|
<h3 class="field-label">Query parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">sportId (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Unique Team Identifier. Format: 141, 147, etc default: null </div><div class="param">season (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Comma delimited list of Seasons of play default: null </div><div class="param">gameType (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Type of Game. Available types in /api/v1/gameTypes default: null </div><div class="param">fields (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Comma delimited list of specific fields to be returned. Format: topLevelNode, childNode, attribute default: null </div>
|
|
</div> <!-- field-items -->
|
|
|
|
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
OK
|
|
<a href="#"></a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<h1><a name="Schedule">Schedule</a></h1>
|
|
<div class="method"><a name="postseasonSchedule"/>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="get"><code class="huge"><span class="http-method">get</span> /api/v1/schedule/postseason</code></pre></div>
|
|
<div class="method-summary">Get postseason schedule (<span class="nickname">postseasonSchedule</span>)</div>
|
|
<div class="method-notes">This endpoint allows you to pull postseason schedules</div>
|
|
|
|
|
|
|
|
|
|
|
|
<h3 class="field-label">Query parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">gameTypes (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Comma delimited list of type of Game. Available types in /api/v1/gameTypes default: null </div><div class="param">seriesNumber (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — default: null </div><div class="param">teamId (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Unique Team Identifier. Format: 141, 147, etc default: null </div><div class="param">sportId (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Unique League Identifier default: null </div><div class="param">useLatestGames (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — default: null </div><div class="param">useFeaturedGame (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — default: null </div><div class="param">season (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — default: null </div><div class="param">publicFacing (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Return public, non-public or all games. Format: Public Facing = 'Y', Non-Public Facing = 'N', All = 'A' default: null </div><div class="param">fields (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Comma delimited list of specific fields to be returned. Format: topLevelNode, childNode, attribute default: null </div>
|
|
</div> <!-- field-items -->
|
|
|
|
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
OK
|
|
<a href="#"></a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="postseasonScheduleSeries"/>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="get"><code class="huge"><span class="http-method">get</span> /api/v1/schedule/postseason/series</code></pre></div>
|
|
<div class="method-summary">Get postseason series schedules (<span class="nickname">postseasonScheduleSeries</span>)</div>
|
|
<div class="method-notes">This endpoint allows you to pull postseason schedules</div>
|
|
|
|
|
|
|
|
|
|
|
|
<h3 class="field-label">Query parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">gameTypes (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Comma delimited list of type of Game. Available types in /api/v1/gameTypes default: null </div><div class="param">seriesNumber (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — default: null </div><div class="param">teamId (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Unique Team Identifier. Format: 141, 147, etc default: null </div><div class="param">sportId (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Unique League Identifier default: null </div><div class="param">date (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Date of Game. Format: YYYY-MM-DD default: null </div><div class="param">startDate (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Start date for range of data (must be used with end date). Format: MM/DD/YYYY default: null </div><div class="param">endDate (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — End date for range of data (must be used with start date). Format: MM/DD/YYYY default: null </div><div class="param">useLatestGames (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — default: null </div><div class="param">useFeaturedGame (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — default: null </div><div class="param">season (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — default: null </div><div class="param">fields (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Comma delimited list of specific fields to be returned. Format: topLevelNode, childNode, attribute default: null </div>
|
|
</div> <!-- field-items -->
|
|
|
|
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
OK
|
|
<a href="#"></a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="schedule"/>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="get"><code class="huge"><span class="http-method">get</span> /api/v1/schedule</code></pre></div>
|
|
<div class="method-summary">View schedule info based on scheduleType. (<span class="nickname">schedule</span>)</div>
|
|
<div class="method-notes">View schedule info. This endpoint allows you to pull schedules</div>
|
|
|
|
|
|
|
|
|
|
|
|
<h3 class="field-label">Query parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">calendarTypes (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Comma delimited list of type of calendar types default: null </div><div class="param">eventTypes (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Comma delimited list of type of events. <b>Note: Don't Use. This will be deprecated in favor of calendarTypes</b> default: null </div><div class="param">scheduleEventTypes (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Comma delimited list of type of event types default: null </div><div class="param">teamId (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Unique Team Identifier. Format: 141, 147, etc default: null </div><div class="param">leagueId (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Unique League Identifier default: null </div><div class="param">sportId (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Top level organization of a sport default: null </div><div class="param">gamePk (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Unique Primary Key Representing a Game default: null </div><div class="param">gamePks (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Comma delimited list of unique primary keys default: null </div><div class="param">eventIds (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — A unique identifier for non-game event default: null </div><div class="param">venueIds (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Unique Venue Identifier default: null </div><div class="param">performerIds (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — A unique identifier for non-team event performers default: null </div><div class="param">gameTypes (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Comma delimited list of type of Game. Available types in /api/v1/gameTypes default: null </div><div class="param">gameType (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Type of Game. Available types in /api/v1/gameTypes default: null </div><div class="param">season (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Season of play default: null </div><div class="param">seasons (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Comma delimited list of Seasons of play default: null </div><div class="param">date (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Date of Game. Format: YYYY-MM-DD default: null </div><div class="param">startDate (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Start date for range of data (must be used with end date). Format: MM/DD/YYYY default: null </div><div class="param">endDate (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — End date for range of data (must be used with start date). Format: MM/DD/YYYY default: null </div><div class="param">timecode (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Use this parameter to return a snapshot of the data at the specified time. Format: YYYYMMDD_HHMMSS default: null </div><div class="param">useLatestGames (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — default: null </div><div class="param">opponentId (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — A unique identifier for the opposing team. Must be used with Team ID default: null </div><div class="param">publicFacing (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Return public, non-public or all games. Format: Public Facing = 'Y', Non-Public Facing = 'N', All = 'A' default: null </div><div class="param">fields (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Comma delimited list of specific fields to be returned. Format: topLevelNode, childNode, attribute default: null </div><div class="param">usingPrivateEndpoint (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — default: null </div>
|
|
</div> <!-- field-items -->
|
|
|
|
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
OK
|
|
<a href="#"></a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="schedule1"/>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="get"><code class="huge"><span class="http-method">get</span> /api/v1/schedule/{scheduleType}</code></pre></div>
|
|
<div class="method-summary">View schedule info based on scheduleType. (<span class="nickname">schedule1</span>)</div>
|
|
<div class="method-notes">View schedule info. This endpoint allows you to pull schedules</div>
|
|
|
|
|
|
|
|
|
|
|
|
<h3 class="field-label">Query parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">calendarTypes (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Comma delimited list of type of calendar types default: null </div><div class="param">eventTypes (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Comma delimited list of type of events. <b>Note: Don't Use. This will be deprecated in favor of calendarTypes</b> default: null </div><div class="param">scheduleEventTypes (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Comma delimited list of type of event types default: null </div><div class="param">teamId (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Unique Team Identifier. Format: 141, 147, etc default: null </div><div class="param">leagueId (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Unique League Identifier default: null </div><div class="param">sportId (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Top level organization of a sport default: null </div><div class="param">gamePk (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Unique Primary Key Representing a Game default: null </div><div class="param">gamePks (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Comma delimited list of unique primary keys default: null </div><div class="param">eventIds (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — A unique identifier for non-game event default: null </div><div class="param">venueIds (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Unique Venue Identifier default: null </div><div class="param">performerIds (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — A unique identifier for non-team event performers default: null </div><div class="param">gameTypes (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Comma delimited list of type of Game. Available types in /api/v1/gameTypes default: null </div><div class="param">gameType (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Type of Game. Available types in /api/v1/gameTypes default: null </div><div class="param">season (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Season of play default: null </div><div class="param">seasons (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Comma delimited list of Seasons of play default: null </div><div class="param">date (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Date of Game. Format: YYYY-MM-DD default: null </div><div class="param">startDate (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Start date for range of data (must be used with end date). Format: MM/DD/YYYY default: null </div><div class="param">endDate (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — End date for range of data (must be used with start date). Format: MM/DD/YYYY default: null </div><div class="param">timecode (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Use this parameter to return a snapshot of the data at the specified time. Format: YYYYMMDD_HHMMSS default: null </div><div class="param">useLatestGames (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — default: null </div><div class="param">opponentId (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — A unique identifier for the opposing team. Must be used with Team ID default: null </div><div class="param">publicFacing (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Return public, non-public or all games. Format: Public Facing = 'Y', Non-Public Facing = 'N', All = 'A' default: null </div><div class="param">fields (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Comma delimited list of specific fields to be returned. Format: topLevelNode, childNode, attribute default: null </div><div class="param">usingPrivateEndpoint (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — default: null </div>
|
|
</div> <!-- field-items -->
|
|
|
|
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
OK
|
|
<a href="#"></a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="tieGames"/>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="get"><code class="huge"><span class="http-method">get</span> /api/v1/schedule/games/tied</code></pre></div>
|
|
<div class="method-summary">Get tied game schedules (<span class="nickname">tieGames</span>)</div>
|
|
<div class="method-notes">This endpoint allows you to pull tie game schedules for the given season</div>
|
|
|
|
|
|
|
|
|
|
|
|
<h3 class="field-label">Query parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">sportId (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Top level organization of a sport default: null </div><div class="param">gameTypes (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Comma delimited list of type of Game. Available types in /api/v1/gameTypes default: null </div><div class="param">season (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Season of play default: null </div><div class="param">fields (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Comma delimited list of specific fields to be returned. Format: topLevelNode, childNode, attribute default: null </div>
|
|
</div> <!-- field-items -->
|
|
|
|
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
OK
|
|
<a href="#"></a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="trackingEventsSchedule"/>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="get"><code class="huge"><span class="http-method">get</span> /api/v1/schedule/trackingEvents</code></pre></div>
|
|
<div class="method-summary">Get tracking event schedules (<span class="nickname">trackingEventsSchedule</span>)</div>
|
|
<div class="method-notes">This endpoint allows you to pull schedules for tracking events</div>
|
|
|
|
|
|
|
|
|
|
|
|
<h3 class="field-label">Query parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">calendarTypes (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Comma delimited list of type of calendar types default: null </div><div class="param">eventTypes (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Comma delimited list of type of events. <b>Note: Don't Use. This will be deprecated in favor of calendarTypes</b> default: null </div><div class="param">teamId (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Unique Team Identifier. Format: 141, 147, etc default: null </div><div class="param">leagueId (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Unique League Identifier default: null </div><div class="param">sportId (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Top level organization of a sport default: null </div><div class="param">gamePk (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Unique Primary Key Representing a Game default: null </div><div class="param">gamePks (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Comma delimited list of unique primary keys default: null </div><div class="param">eventIds (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — A unique identifier for non-game event default: null </div><div class="param">venueIds (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Unique Venue Identifier default: null </div><div class="param">performerIds (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — A unique identifier for non-team event performers default: null </div><div class="param">gameTypes (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Comma delimited list of type of Game. Available types in /api/v1/gameTypes default: null </div><div class="param">gameType (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Type of Game. Available types in /api/v1/gameTypes default: null </div><div class="param">season (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Season of play default: null </div><div class="param">seasons (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Comma delimited list of Seasons of play default: null </div><div class="param">date (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Date of Game. Format: YYYY-MM-DD default: null </div><div class="param">startDate (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Start date for range of data (must be used with end date). Format: MM/DD/YYYY default: null </div><div class="param">endDate (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — End date for range of data (must be used with start date). Format: MM/DD/YYYY default: null </div><div class="param">timecode (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Use this parameter to return a snapshot of the data at the specified time. Format: YYYYMMDD_HHMMSS default: null </div><div class="param">useLatestGames (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — default: null </div><div class="param">opponentId (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — A unique identifier for the opposing team. Must be used with Team ID default: null </div><div class="param">publicFacing (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Return public, non-public or all games. Format: Public Facing = 'Y', Non-Public Facing = 'N', All = 'A' default: null </div><div class="param">fields (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Comma delimited list of specific fields to be returned. Format: topLevelNode, childNode, attribute default: null </div>
|
|
</div> <!-- field-items -->
|
|
|
|
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
OK
|
|
<a href="#"></a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="tuneIn"/>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="get"><code class="huge"><span class="http-method">get</span> /api/v1/schedule/postseason/tuneIn</code></pre></div>
|
|
<div class="method-summary">Get postseason TuneIn schedules (<span class="nickname">tuneIn</span>)</div>
|
|
<div class="method-notes">This endpoint allows you to pull postseason schedules</div>
|
|
|
|
|
|
|
|
|
|
|
|
<h3 class="field-label">Query parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">teamId (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Unique Team Identifier. Format: 141, 147, etc default: null </div><div class="param">sportId (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Unique League Identifier default: null </div><div class="param">season (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Unique Primary Key Representing a Game default: null </div><div class="param">fields (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Comma delimited list of specific fields to be returned. Format: topLevelNode, childNode, attribute default: null </div>
|
|
</div> <!-- field-items -->
|
|
|
|
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
OK
|
|
<a href="#"></a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<h1><a name="Season">Season</a></h1>
|
|
<div class="method"><a name="allSeasons"/>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="get"><code class="huge"><span class="http-method">get</span> /api/v1/seasons/all</code></pre></div>
|
|
<div class="method-summary">View all seasons (<span class="nickname">allSeasons</span>)</div>
|
|
<div class="method-notes">This endpoint allows you to view all seasons for a given Division, League or Sport</div>
|
|
|
|
|
|
|
|
|
|
|
|
<h3 class="field-label">Query parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">divisionId (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Unique Division Identifier default: null </div><div class="param">leagueId (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Unique League Identifier default: null </div><div class="param">sportId (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Top level organization of a sport default: null </div><div class="param">withGameTypeDates (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Retrieve dates for each game type default: null </div><div class="param">fields (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Comma delimited list of specific fields to be returned. Format: topLevelNode, childNode, attribute default: null </div>
|
|
</div> <!-- field-items -->
|
|
|
|
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
OK
|
|
<a href="#"></a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="seasons"/>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="get"><code class="huge"><span class="http-method">get</span> /api/v1/seasons</code></pre></div>
|
|
<div class="method-summary">View season info (<span class="nickname">seasons</span>)</div>
|
|
<div class="method-notes">This endpoint allows you to pull seasons</div>
|
|
|
|
<h3 class="field-label">Path parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">seasonId (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Path Parameter</span> — Season of play default: null </div>
|
|
</div> <!-- field-items -->
|
|
|
|
|
|
|
|
|
|
<h3 class="field-label">Query parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">season (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Season of play default: null </div><div class="param">sportId (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Top level organization of a sport default: null </div><div class="param">withGameTypeDates (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Retrieve dates for each game type default: null </div><div class="param">fields (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Comma delimited list of specific fields to be returned. Format: topLevelNode, childNode, attribute default: null </div>
|
|
</div> <!-- field-items -->
|
|
|
|
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
OK
|
|
<a href="#"></a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="seasons1"/>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="get"><code class="huge"><span class="http-method">get</span> /api/v1/seasons/{seasonId}</code></pre></div>
|
|
<div class="method-summary">View season info (<span class="nickname">seasons1</span>)</div>
|
|
<div class="method-notes">This endpoint allows you to pull seasons</div>
|
|
|
|
<h3 class="field-label">Path parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">seasonId (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Path Parameter</span> — Season of play default: null </div>
|
|
</div> <!-- field-items -->
|
|
|
|
|
|
|
|
|
|
<h3 class="field-label">Query parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">season (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Season of play default: null </div><div class="param">sportId (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Top level organization of a sport default: null </div><div class="param">withGameTypeDates (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Retrieve dates for each game type default: null </div><div class="param">fields (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Comma delimited list of specific fields to be returned. Format: topLevelNode, childNode, attribute default: null </div>
|
|
</div> <!-- field-items -->
|
|
|
|
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
OK
|
|
<a href="#"></a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<h1><a name="Skeletal">Skeletal</a></h1>
|
|
<div class="method"><a name="skeletalChunked"/>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="get"><code class="huge"><span class="http-method">get</span> /api/v1/game/{gamePk}/{playId}/analytics/skeletalData/chunked</code></pre></div>
|
|
<div class="method-summary">View Skeletal Data by playId and gameId chunked (<span class="nickname">skeletalChunked</span>)</div>
|
|
<div class="method-notes">This endpoint allows you to pull chunked skeletal tracking data by gameId and playId</div>
|
|
|
|
<h3 class="field-label">Path parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">gamePk (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Path Parameter</span> — Unique Primary Key Representing a Game default: null </div><div class="param">playId (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Path Parameter</span> — Unique play identifier default: null </div>
|
|
</div> <!-- field-items -->
|
|
|
|
|
|
|
|
|
|
<h3 class="field-label">Query parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">fileName (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Skeletal chunked file name default: null </div><div class="param">fields (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Comma delimited list of specific fields to be returned. Format: topLevelNode, childNode, attribute default: null </div>
|
|
</div> <!-- field-items -->
|
|
|
|
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
OK
|
|
<a href="#"></a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="skeletalDataFileNames"/>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="get"><code class="huge"><span class="http-method">get</span> /api/v1/game/{gamePk}/{playId}/analytics/skeletalData/files</code></pre></div>
|
|
<div class="method-summary">View Skeletal Data by playId and gameId files (<span class="nickname">skeletalDataFileNames</span>)</div>
|
|
<div class="method-notes">This endpoint allows you to pull chunked skeletal tracking data by gameId and playId</div>
|
|
|
|
<h3 class="field-label">Path parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">gamePk (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Path Parameter</span> — Unique Primary Key Representing a Game default: null </div><div class="param">playId (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Path Parameter</span> — Unique play identifier default: null </div>
|
|
</div> <!-- field-items -->
|
|
|
|
|
|
|
|
|
|
<h3 class="field-label">Query parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">fields (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Comma delimited list of specific fields to be returned. Format: topLevelNode, childNode, attribute default: null </div>
|
|
</div> <!-- field-items -->
|
|
|
|
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
OK
|
|
<a href="#"></a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<h1><a name="Sports">Sports</a></h1>
|
|
<div class="method"><a name="allSportBallot"/>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="get"><code class="huge"><span class="http-method">get</span> /api/v1/sports/{sportId}/allSportBallot</code></pre></div>
|
|
<div class="method-summary">Get ALL MLB ballot for sport (<span class="nickname">allSportBallot</span>)</div>
|
|
<div class="method-notes">This endpoint allows you to get all players for MLB ballot</div>
|
|
|
|
<h3 class="field-label">Path parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">sportId (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Path Parameter</span> — Top level organization of a sport default: null </div>
|
|
</div> <!-- field-items -->
|
|
|
|
|
|
|
|
|
|
<h3 class="field-label">Query parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">season (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — season default: null </div><div class="param">fields (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — default: null </div>
|
|
</div> <!-- field-items -->
|
|
|
|
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
OK
|
|
<a href="#"></a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="sportPlayers"/>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="get"><code class="huge"><span class="http-method">get</span> /api/v1/sports/{sportId}/players</code></pre></div>
|
|
<div class="method-summary">Get all players for a sport level (<span class="nickname">sportPlayers</span>)</div>
|
|
<div class="method-notes">This endpoint allows you to pull all players for a given sport</div>
|
|
|
|
<h3 class="field-label">Path parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">sportId (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Path Parameter</span> — Top level organization of a sport default: null </div>
|
|
</div> <!-- field-items -->
|
|
|
|
|
|
|
|
|
|
<h3 class="field-label">Query parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">season (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Season of play default: null </div><div class="param">gameType (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Type of Game. Available types in /api/v1/gameTypes default: null </div><div class="param">hasStats (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Returns sports that have individual player stats default: null </div><div class="param">accent (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Boolean value to specify wanting a person's name with accents or without default: null </div><div class="param">fields (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Comma delimited list of specific fields to be returned. Format: topLevelNode, childNode, attribute default: null </div>
|
|
</div> <!-- field-items -->
|
|
|
|
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
OK
|
|
<a href="#"></a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="sports"/>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="get"><code class="huge"><span class="http-method">get</span> /api/v1/sports</code></pre></div>
|
|
<div class="method-summary">Get sports information (<span class="nickname">sports</span>)</div>
|
|
<div class="method-notes">This endpoint allows you to pull sports</div>
|
|
|
|
<h3 class="field-label">Path parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">sportId (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Path Parameter</span> — Top level organization of a sport default: null </div>
|
|
</div> <!-- field-items -->
|
|
|
|
|
|
|
|
|
|
<h3 class="field-label">Query parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">season (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Season of play default: null </div><div class="param">fields (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Comma delimited list of specific fields to be returned. Format: topLevelNode, childNode, attribute default: null </div><div class="param">hasStats (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Returns sports that have individual player stats default: null </div><div class="param">activeStatus (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Flag for fetching sports that are currently active (Y), inactive (N), pending (P), or all teams (B) default: null </div>
|
|
</div> <!-- field-items -->
|
|
|
|
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
OK
|
|
<a href="#"></a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="sports1"/>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="get"><code class="huge"><span class="http-method">get</span> /api/v1/sports/{sportId}</code></pre></div>
|
|
<div class="method-summary">Get sports information (<span class="nickname">sports1</span>)</div>
|
|
<div class="method-notes">This endpoint allows you to pull sports</div>
|
|
|
|
<h3 class="field-label">Path parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">sportId (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Path Parameter</span> — Top level organization of a sport default: null </div>
|
|
</div> <!-- field-items -->
|
|
|
|
|
|
|
|
|
|
<h3 class="field-label">Query parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">season (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Season of play default: null </div><div class="param">fields (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Comma delimited list of specific fields to be returned. Format: topLevelNode, childNode, attribute default: null </div><div class="param">hasStats (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Returns sports that have individual player stats default: null </div><div class="param">activeStatus (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Flag for fetching sports that are currently active (Y), inactive (N), pending (P), or all teams (B) default: null </div>
|
|
</div> <!-- field-items -->
|
|
|
|
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
OK
|
|
<a href="#"></a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<h1><a name="Standings">Standings</a></h1>
|
|
<div class="method"><a name="standings"/>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="get"><code class="huge"><span class="http-method">get</span> /api/v1/standings/{standingsType}</code></pre></div>
|
|
<div class="method-summary">View standings for a league (<span class="nickname">standings</span>)</div>
|
|
<div class="method-notes">This endpoint allows you to pull standings</div>
|
|
|
|
<h3 class="field-label">Path parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">standingsType (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Path Parameter</span> — Type of season. Available types in /api/v1/standingsTypes default: null </div>
|
|
</div> <!-- field-items -->
|
|
|
|
|
|
|
|
|
|
<h3 class="field-label">Query parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">leagueId (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Unique League Identifier default: null </div><div class="param">season (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Season of play default: null </div><div class="param">standingsTypes (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Type of season. Available types in /api/v1/standingsTypes default: null </div><div class="param">date (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Date of Game. Format: YYYY-MM-DD default: null </div><div class="param">teamId (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Unique Team Identifier. Format: 141, 147, etc default: null </div><div class="param">includeMLB (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Determines whether to include major league teams when using the 'BY_ORGANIZATION' standings type default: null </div><div class="param">fields (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Comma delimited list of specific fields to be returned. Format: topLevelNode, childNode, attribute default: null </div>
|
|
</div> <!-- field-items -->
|
|
|
|
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
OK
|
|
<a href="#"></a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="standings1"/>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="get"><code class="huge"><span class="http-method">get</span> /api/v1/standings</code></pre></div>
|
|
<div class="method-summary">View standings for a league (<span class="nickname">standings1</span>)</div>
|
|
<div class="method-notes">This endpoint allows you to pull standings</div>
|
|
|
|
<h3 class="field-label">Path parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">standingsType (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Path Parameter</span> — Type of season. Available types in /api/v1/standingsTypes default: null </div>
|
|
</div> <!-- field-items -->
|
|
|
|
|
|
|
|
|
|
<h3 class="field-label">Query parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">leagueId (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Unique League Identifier default: null </div><div class="param">season (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Season of play default: null </div><div class="param">standingsTypes (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Type of season. Available types in /api/v1/standingsTypes default: null </div><div class="param">date (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Date of Game. Format: YYYY-MM-DD default: null </div><div class="param">teamId (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Unique Team Identifier. Format: 141, 147, etc default: null </div><div class="param">includeMLB (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Determines whether to include major league teams when using the 'BY_ORGANIZATION' standings type default: null </div><div class="param">fields (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Comma delimited list of specific fields to be returned. Format: topLevelNode, childNode, attribute default: null </div>
|
|
</div> <!-- field-items -->
|
|
|
|
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
OK
|
|
<a href="#"></a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<h1><a name="Stats">Stats</a></h1>
|
|
<div class="method"><a name="beastStats"/>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="get"><code class="huge"><span class="http-method">get</span> /api/v1/stats/search</code></pre></div>
|
|
<div class="method-summary">View stats from search (<span class="nickname">beastStats</span>)</div>
|
|
<div class="method-notes"></div>
|
|
|
|
|
|
|
|
|
|
|
|
<h3 class="field-label">Query parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">group (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Category of statistic to return. Available types in /api/v1/statGroups default: null </div><div class="param">gamePks (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Comma delimited list of unique primary keys default: null </div><div class="param">playIds (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Comma delimited list of unique play identifiers default: null </div><div class="param">seasons (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Comma delimited list of Seasons of play default: null </div><div class="param">gameTypes (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Type of Game. Available types in /api/v1/gameTypes default: null </div><div class="param">date (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Date of Game. Format: YYYY-MM-DD default: null </div><div class="param">startDate (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Date of Game. Format: YYYY-MM-DD default: null </div><div class="param">endDate (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Date of Game. Format: YYYY-MM-DD default: null </div><div class="param">teamIds (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Unique Team Identifier. Format: 141, 147, etc default: null </div><div class="param">pitcherTeamIds (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Unique Team Identifier. Format: 141, 147, etc default: null </div><div class="param">batterTeamIds (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Unique Team Identifier. Format: 141, 147, etc default: null </div><div class="param">sportIds (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Comma delimited list of top level organizations of a sport default: null </div><div class="param">pitcherSportIds (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Comma delimited list of top level organizations of a sport default: null </div><div class="param">batterSportIds (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Comma delimited list of top level organizations of a sport default: null </div><div class="param">leagueIds (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Comma delimited list of Unique league identifiers default: null </div><div class="param">pitcherLeagueIds (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Comma delimited list of Unique league identifiers default: null </div><div class="param">batterLeagueIds (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Comma delimited list of Unique league identifiers default: null </div><div class="param">divisionIds (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Comma delimited list of Unique League Identifiers default: null </div><div class="param">pitcherDivisionIds (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Comma delimited list of Unique League Identifiers default: null </div><div class="param">batterDivisionIds (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Comma delimited list of Unique League Identifiers default: null </div><div class="param">pitchersOnTeamIds (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Unique Team Identifier. Format: 141, 147, etc default: null </div><div class="param">battersOnTeamIds (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Unique Team Identifier. Format: 141, 147, etc default: null </div><div class="param">playerIds (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — A unique identifier for a player default: null </div><div class="param">playerPool (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Return "ALL" or only "QUALIFIED" players based on plate appearances. default: null </div><div class="param">pitcherIds (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — A unique identifier for a player default: null </div><div class="param">batterIds (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — A unique identifier for a player default: null </div><div class="param">catcherIds (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — A unique identifier for a player default: null </div><div class="param">firstBasemanIds (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — A unique identifier for a player default: null </div><div class="param">secondBasemanIds (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — A unique identifier for a player default: null </div><div class="param">thirdBasemanIds (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — A unique identifier for a player default: null </div><div class="param">shortstopIds (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — A unique identifier for a player default: null </div><div class="param">leftFielderIds (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — A unique identifier for a player default: null </div><div class="param">centerFielderIds (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — A unique identifier for a player default: null </div><div class="param">rightFielderIds (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — A unique identifier for a player default: null </div><div class="param">runnerFirstIds (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — A unique identifier for a player default: null </div><div class="param">runnerSecondIds (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — A unique identifier for a player default: null </div><div class="param">runnerThirdIds (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — A unique identifier for a player default: null </div><div class="param">venueIds (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Unique Venue Identifier default: null </div><div class="param">pitchHand (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Handedness of pitcher default: null </div><div class="param">batSide (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Bat side of hitter default: null </div><div class="param">pitchTypes (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Classification of pitch (fastball, curveball, etc...) default: null </div><div class="param">pitchCodes (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Result of the pitch (ball, called strike, etc...) default: null </div><div class="param">eventTypes (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Type of event default: null </div><div class="param">positions (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — All of the details of a player's position default: null </div><div class="param">primaryPositions (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — All of the details of a player's position default: null </div><div class="param">minPitchSpeed (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Minimum value to filter on default: null </div><div class="param">maxPitchSpeed (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Maximum value to filter on default: null </div><div class="param">minSpinRate (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Minimum value to filter on default: null </div><div class="param">maxSpinRate (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Maximum value to filter on default: null </div><div class="param">minExtension (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Minimum value to filter on default: null </div><div class="param">maxExtension (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Maximum value to filter on default: null </div><div class="param">minExitVelocityAgainst (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Minimum value to filter on default: null </div><div class="param">maxExitVelocityAgainst (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Maximum value to filter on default: null </div><div class="param">minLaunchAngleAgainst (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Minimum value to filter on default: null </div><div class="param">maxLaunchAngleAgainst (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Maximum value to filter on default: null </div><div class="param">minExitVelocity (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Minimum value to filter on default: null </div><div class="param">maxExitVelocity (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Maximum value to filter on default: null </div><div class="param">minLaunchAngle (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Minimum value to filter on default: null </div><div class="param">maxLaunchAngle (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Maximum value to filter on default: null </div><div class="param">minHomeRunDistance (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Minimum value to filter on default: null </div><div class="param">maxHomeRunDistance (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Maximum value to filter on default: null </div><div class="param">minHitDistance (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Minimum value to filter on default: null </div><div class="param">maxHitDistance (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Maximum value to filter on default: null </div><div class="param">minHangTime (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Minimum value to filter on default: null </div><div class="param">maxHangTime (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Maximum value to filter on default: null </div><div class="param">minHitProbability (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Minimum value to filter on default: null </div><div class="param">maxHitProbability (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Maximum value to filter on default: null </div><div class="param">minCatchProbability (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Minimum value to filter on default: null </div><div class="param">maxCatchProbability (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Maximum value to filter on default: null </div><div class="param">minAttackAngle (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Minimum value to filter on default: null </div><div class="param">maxAttackAngle (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Maximum value to filter on default: null </div><div class="param">minBatSpeed (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Minimum value to filter on default: null </div><div class="param">maxBatSpeed (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Maximum value to filter on default: null </div><div class="param">minHomeRunXBallparks (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Minimum value to filter on default: null </div><div class="param">maxHomeRunXBallparks (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Maximum value to filter on default: null </div><div class="param">isBarrel (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Whether or not a play resulted in a barreled ball default: null </div><div class="param">hitTrajectories (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Trajectory of hit (line drive, fly ball, etc...) default: null </div><div class="param">limit (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Number of results to return default: null </div><div class="param">offset (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — The pointer to start for a return set; used for pagination default: null </div><div class="param">groupBy (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Group stats by PLAYER, TEAM, SEASON, VENUE, SPORT or STAT_GROUP default: null </div><div class="param">compareOver (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Group stats by PLAYER, TEAM, SEASON, VENUE, SPORT or STAT_GROUP default: null </div><div class="param">sortStat (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Baseball stat to sort splits by. default: null </div><div class="param">sortModifier (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — The prefix modifier for the sort stat. avg, min, max. I.E minExitVelocity, maxLaunchAngle, avgHitDistance default: null </div><div class="param">sortOrder (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — The order of sorting, ascending or descending default: null </div><div class="param">percentile (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Only return averages above this percentile. used for best effort plays default: null </div><div class="param">minOccurrences (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Minimum occurrences to filter upon default: null </div><div class="param">minPlateAppearances (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Minimum occurrences to filter upon default: null </div><div class="param">minInnings (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Minimum occurrences to filter upon default: null </div><div class="param">qualifierRate (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Minimum occurrences to filter upon default: null </div><div class="param">sitCodes (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Situation code for a given stat split. default: null </div><div class="param">showTotals (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Columns to return totals default: null </div><div class="param">includeNullMetrics (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Show events with null metrics default: null </div><div class="param">statFields (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Baseball stat fields to populate default: null </div><div class="param">atBatNumbers (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — The at bat number of a given game. Format: 1, 2, 3, etc default: null </div><div class="param">pitchNumbers (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — The pitch number of a given game. Format: 1, 2, 3, etc default: null </div><div class="param">fields (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Comma delimited list of specific fields to be returned. Format: topLevelNode, childNode, attribute default: null </div><div class="param">debug (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — default: null </div><div class="param">activeStatus (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Whether or not a player is active default: null </div>
|
|
</div> <!-- field-items -->
|
|
|
|
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
OK
|
|
<a href="#"></a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="getOutsAboveAverage"/>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="get"><code class="huge"><span class="http-method">get</span> /api/v1/stats/analytics/outsAboveAverage</code></pre></div>
|
|
<div class="method-summary">Get outs above average for the current batter (<span class="nickname">getOutsAboveAverage</span>)</div>
|
|
<div class="method-notes"></div>
|
|
|
|
|
|
|
|
|
|
|
|
<h3 class="field-label">Query parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">gamePk (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — default: null </div><div class="param">timecode (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — default: null </div><div class="param">fields (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Comma delimited list of specific fields to be returned. Format: topLevelNode, childNode, attribute default: null </div>
|
|
</div> <!-- field-items -->
|
|
|
|
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
OK
|
|
<a href="#"></a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="getSprayChart"/>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="get"><code class="huge"><span class="http-method">get</span> /api/v1/stats/analytics/sprayChart</code></pre></div>
|
|
<div class="method-summary">Get the spray chart info for the current batter (<span class="nickname">getSprayChart</span>)</div>
|
|
<div class="method-notes"></div>
|
|
|
|
|
|
|
|
|
|
|
|
<h3 class="field-label">Query parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">gamePk (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — default: null </div><div class="param">timecode (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — default: null </div><div class="param">fields (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Comma delimited list of specific fields to be returned. Format: topLevelNode, childNode, attribute default: null </div>
|
|
</div> <!-- field-items -->
|
|
|
|
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
OK
|
|
<a href="#"></a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="getStolenBaseProbability"/>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="get"><code class="huge"><span class="http-method">get</span> /api/v1/stats/analytics/stolenBaseProbability</code></pre></div>
|
|
<div class="method-summary">Get the probability of a hit for the given hit data (<span class="nickname">getStolenBaseProbability</span>)</div>
|
|
<div class="method-notes"></div>
|
|
|
|
|
|
|
|
|
|
|
|
<h3 class="field-label">Query parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">gamePk (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — default: null </div><div class="param">timecode (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — default: null </div>
|
|
</div> <!-- field-items -->
|
|
|
|
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
OK
|
|
<a href="#"></a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="groupedStats"/>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="get"><code class="huge"><span class="http-method">get</span> /api/v1/stats/grouped</code></pre></div>
|
|
<div class="method-summary">View grouped stats (<span class="nickname">groupedStats</span>)</div>
|
|
<div class="method-notes"></div>
|
|
|
|
|
|
|
|
|
|
|
|
<h3 class="field-label">Query parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">stats (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Type of statistics. Format: Individual, Team, Career, etc. Available types in /api/v1/statTypes default: null </div><div class="param">personId (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Unique Player Identifier. Format: 434538, 429665, etc default: null </div><div class="param">teamId (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Unique Team Identifier. Format: 141, 147, etc default: null </div><div class="param">teamIds (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Comma delimited list of Unique Team identifiers default: null </div><div class="param">group (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Category of statistic to return. Available types in /api/v1/statGroups default: null </div><div class="param">gameType (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Type of Game. Available types in /api/v1/gameTypes default: null </div><div class="param">season (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Season of play default: null </div><div class="param">seasons (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Comma delimited list of Seasons of play default: null </div><div class="param">sportId (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Top level organization of a sport default: null </div><div class="param">sportIds (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Comma delimited list of top level organizations of a sport default: null </div><div class="param">leagueId (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Unique League Identifier default: null </div><div class="param">leagueIds (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Comma delimited list of Unique league identifiers default: null </div><div class="param">leagueListId (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Unique League List Identifier default: null </div><div class="param">metrics (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Name of metric(s) for metric log stats. Available metrics in /api/v1/metrics default: null </div><div class="param">gamePk (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Unique Primary Key Representing a Game default: null </div><div class="param">batterTeamId (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — A unique identifier for the batter's team default: null </div><div class="param">pitcherTeamId (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — A unique identifier for the pitcher's team default: null </div><div class="param">batterId (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Unique Player Identifier. Format: 434538, 429665, etc default: null </div><div class="param">pitcherId (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Unique Player Identifier. Format: 434538, 429665, etc default: null </div><div class="param">sitCodes (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Situation code for a given stat split. default: null </div><div class="param">combineSits (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — If true, gathers stats where all of the situational criteria are met. If false, returns stats where any of the situational criteria are met. Default: false default: null </div><div class="param">opposingTeamId (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — A unique identifier for the opposing team. Must be used with Team ID default: null </div><div class="param">fields (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Comma delimited list of specific fields to be returned. Format: topLevelNode, childNode, attribute default: null </div><div class="param">sortStat (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Baseball stat to sort splits by. default: null </div><div class="param">order (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — The order of sorting, ascending or descending default: null </div><div class="param">playerPool (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Return "ALL" or only "QUALIFIED" players based on plate appearances. default: null </div><div class="param">position (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Position number. Format: 1, 2, 3, etc default: null </div><div class="param">startDate (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Start date for range of data (must be used with end date). Format: MM/DD/YYYY default: null </div><div class="param">endDate (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — End date for range of data (must be used with start date). Format: MM/DD/YYYY default: null </div><div class="param">daysBack (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Returns results from the last 'X' days (Starting from yesterday). default: null </div><div class="param">gamesBack (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Returns results from the last 'X' games played. default: null </div><div class="param">excludeTradedPlayers (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Excludes players who have since been traded from the input team default: null </div><div class="param">offset (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — The pointer to start for a return set; used for pagination default: null </div><div class="param">limit (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Number of results to return default: null </div><div class="param">statFields (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Baseball stat fields to populate default: null </div><div class="param">sortField (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Baseball statField to sort on. If no statField is given, sortField defaults to BASIC. If 1 statField is given, that is the default sortField. default: null </div>
|
|
</div> <!-- field-items -->
|
|
|
|
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
OK
|
|
<a href="#"></a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="leaders2"/>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="get"><code class="huge"><span class="http-method">get</span> /api/v1/stats/leaders</code></pre></div>
|
|
<div class="method-summary">Get leaders for a statistic (<span class="nickname">leaders2</span>)</div>
|
|
<div class="method-notes"></div>
|
|
|
|
|
|
|
|
|
|
|
|
<h3 class="field-label">Query parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">leaderCategories (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — default: null </div><div class="param">leaderGameTypes (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — default: null </div><div class="param">statGroup (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — default: null </div><div class="param">season (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — default: null </div><div class="param">expand (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — default: null </div><div class="param">sportId (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — default: null </div><div class="param">sportIds (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — default: null </div><div class="param">stats (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — default: null </div><div class="param">limit (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — default: null </div><div class="param">offset (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — default: null </div><div class="param">teamId (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — default: null </div><div class="param">teamIds (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — default: null </div><div class="param">leagueId (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — default: null </div><div class="param">leagueIds (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — default: null </div><div class="param">leagueListId (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — default: null </div><div class="param">playerPool (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — default: null </div><div class="param">statType (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — default: null </div><div class="param">playerActive (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — default: null </div><div class="param">position (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — default: null </div><div class="param">sitCodes (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — default: null </div><div class="param">opposingTeamId (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — default: null </div><div class="param">startDate (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — default: null </div><div class="param">endDate (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — default: null </div><div class="param">daysBack (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — default: null </div><div class="param">gamesBack (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — default: null </div><div class="param">groupBy (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — default: null </div><div class="param">fields (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — default: null </div>
|
|
</div> <!-- field-items -->
|
|
|
|
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
OK
|
|
<a href="#"></a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="metricStats"/>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="get"><code class="huge"><span class="http-method">get</span> /api/v1/stats/metrics</code></pre></div>
|
|
<div class="method-summary">View metric stats (<span class="nickname">metricStats</span>)</div>
|
|
<div class="method-notes"></div>
|
|
|
|
|
|
|
|
|
|
|
|
<h3 class="field-label">Query parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">personId (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Unique Player Identifier. Format: 434538, 429665, etc default: null </div><div class="param">personIds (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Unique Player Identifier. Format: 434538, 429665, etc default: null </div><div class="param">batterId (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Unique Player Identifier. Format: 434538, 429665, etc default: null </div><div class="param">pitcherId (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Unique Player Identifier. Format: 434538, 429665, etc default: null </div><div class="param">teamId (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Unique Team Identifier. Format: 141, 147, etc default: null </div><div class="param">stats (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Type of statistics. Format: Individual, Team, Career, etc. Available types in /api/v1/statTypes default: null </div><div class="param">group (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Category of statistic to return. Available types in /api/v1/statGroups default: null </div><div class="param">season (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Season of play default: null </div><div class="param">seasons (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Comma delimited list of Seasons of play default: null </div><div class="param">sportId (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Top level organization of a sport default: null </div><div class="param">opposingTeamId (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — A unique identifier for the opposing team. Must be used with Team ID default: null </div><div class="param">opposingPlayerId (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — A unique identifier for the opposing team default: null </div><div class="param">position (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — All of the details of a player's position default: null </div><div class="param">eventType (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Type of event default: null </div><div class="param">pitchType (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Classification of pitch (fastball, curveball, etc...) default: null </div><div class="param">hitTrajectory (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Trajectory of hit (line drive, fly ball, etc...) default: null </div><div class="param">batSide (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Bat side of hitter default: null </div><div class="param">pitchHand (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Handedness of pitcher default: null </div><div class="param">venueId (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — All of the details of a venue default: null </div><div class="param">metrics (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Name of metric(s) for metric log stats. Available metrics in /api/v1/metrics default: null </div><div class="param">gamePk (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Unique Primary Key Representing a Game default: null </div><div class="param">minValue (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Minimum value to filter on default: null </div><div class="param">maxValue (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Maximum value to filter on default: null </div><div class="param">percentile (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Only return averages above this percentile. used for best effort plays default: null </div><div class="param">minOccurrences (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Minimum occurrences to filter upon default: null </div><div class="param">offset (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — The pointer to start for a return set; used for pagination default: null </div><div class="param">limit (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Number of results to return default: null </div><div class="param">order (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — The order of sorting, ascending or descending default: null </div><div class="param">date (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Date of Game. Format: YYYY-MM-DD default: null </div><div class="param">startDate (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Start date for range of data (must be used with end date). Format: MM/DD/YYYY default: null </div><div class="param">endDate (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — End date for range of data (must be used with start date). Format: MM/DD/YYYY default: null </div><div class="param">gameType (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Type of Game. Available types in /api/v1/gameTypes default: null </div><div class="param">batterTeamId (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — A unique identifier for the batter's team default: null </div><div class="param">pitcherTeamId (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — A unique identifier for the pitcher's team default: null </div><div class="param">fields (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Comma delimited list of specific fields to be returned. Format: topLevelNode, childNode, attribute default: null </div><div class="param">debug (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — default: null </div>
|
|
</div> <!-- field-items -->
|
|
|
|
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
OK
|
|
<a href="#"></a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="stats2"/>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="get"><code class="huge"><span class="http-method">get</span> /api/v1/stats</code></pre></div>
|
|
<div class="method-summary">View stats (<span class="nickname">stats2</span>)</div>
|
|
<div class="method-notes"></div>
|
|
|
|
|
|
|
|
|
|
|
|
<h3 class="field-label">Query parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">stats (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Type of statistics. Format: Individual, Team, Career, etc. Available types in /api/v1/statTypes default: null </div><div class="param">personId (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Unique Player Identifier. Format: 434538, 429665, etc default: null </div><div class="param">teamId (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Unique Team Identifier. Format: 141, 147, etc default: null </div><div class="param">teamIds (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Comma delimited list of Unique Team identifiers default: null </div><div class="param">group (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Category of statistic to return. Available types in /api/v1/statGroups default: null </div><div class="param">gameType (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Type of Game. Available types in /api/v1/gameTypes default: null </div><div class="param">season (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Season of play default: null </div><div class="param">seasons (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Comma delimited list of Seasons of play default: null </div><div class="param">sportId (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Top level organization of a sport default: null </div><div class="param">sportIds (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Comma delimited list of top level organizations of a sport default: null </div><div class="param">leagueId (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Unique League Identifier default: null </div><div class="param">leagueIds (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Comma delimited list of Unique league identifiers default: null </div><div class="param">leagueListId (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Unique League List Identifier default: null </div><div class="param">metrics (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Name of metric(s) for metric log stats. Available metrics in /api/v1/metrics default: null </div><div class="param">gamePk (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Unique Primary Key Representing a Game default: null </div><div class="param">batterTeamId (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — A unique identifier for the batter's team default: null </div><div class="param">pitcherTeamId (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — A unique identifier for the pitcher's team default: null </div><div class="param">batterId (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Unique Player Identifier. Format: 434538, 429665, etc default: null </div><div class="param">pitcherId (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Unique Player Identifier. Format: 434538, 429665, etc default: null </div><div class="param">sitCodes (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Situation code for a given stat split. default: null </div><div class="param">combineSits (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — If true, gathers stats where all of the situational criteria are met. If false, returns stats where any of the situational criteria are met. Default: false default: null </div><div class="param">opposingTeamId (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — A unique identifier for the opposing team. Must be used with Team ID default: null </div><div class="param">fields (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — default: null </div><div class="param">sortStat (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Baseball stat to sort splits by. default: null </div><div class="param">order (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — The order of sorting, ascending or descending default: null </div><div class="param">playerPool (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Return "ALL" or only "QUALIFIED" players based on plate appearances. default: null </div><div class="param">position (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Position number. Format: 1, 2, 3, etc default: null </div><div class="param">startDate (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Start date for range of data (must be used with end date). Format: MM/DD/YYYY default: null </div><div class="param">endDate (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — End date for range of data (must be used with start date). Format: MM/DD/YYYY default: null </div><div class="param">daysBack (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Returns results from the last 'X' days (Starting from yesterday). default: null </div><div class="param">gamesBack (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Returns results from the last 'X' games played. default: null </div><div class="param">excludeTradedPlayers (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Excludes players who have since been traded from the input team default: null </div><div class="param">offset (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — The pointer to start for a return set; used for pagination default: null </div><div class="param">limit (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Number of results to return default: null </div>
|
|
</div> <!-- field-items -->
|
|
|
|
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
OK
|
|
<a href="#"></a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<h1><a name="Streaks">Streaks</a></h1>
|
|
<div class="method"><a name="getStreaks"/>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="get"><code class="huge"><span class="http-method">get</span> /api/v1/streaks</code></pre></div>
|
|
<div class="method-summary">View streaks (<span class="nickname">getStreaks</span>)</div>
|
|
<div class="method-notes"></div>
|
|
|
|
|
|
|
|
|
|
|
|
<h3 class="field-label">Query parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">streakOrg (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — default: null </div><div class="param">streakStat (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — default: null </div><div class="param">streakSpan (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — default: null </div><div class="param">streakLevel (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — default: null </div><div class="param">streakThreshold (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — default: null </div><div class="param">inverse (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — default: null </div><div class="param">startersOnly (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — default: null </div><div class="param">statGroup (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Category of statistic to return. Available types in /api/v1/statGroups default: null </div><div class="param">gameType (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Type of Game. Available types in /api/v1/gameTypes default: null </div><div class="param">season (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Season of play default: null </div><div class="param">teamId (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Unique Team Identifier. Format: 141, 147, etc default: null </div><div class="param">leagueId (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Unique League Identifier default: null </div><div class="param">sportId (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Top level organization of a sport default: null </div><div class="param">activeStreak (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Whether or not a player is active default: null </div><div class="param">limit (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Number of results to return default: null </div><div class="param">fields (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Comma delimited list of specific fields to be returned. Format: topLevelNode, childNode, attribute default: null </div><div class="param">playerId (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — A unique identifier for a player default: null </div>
|
|
</div> <!-- field-items -->
|
|
|
|
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
OK
|
|
<a href="#"></a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="streakTypes"/>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="get"><code class="huge"><span class="http-method">get</span> /api/v1/streaks/types</code></pre></div>
|
|
<div class="method-summary">View streaks parameter options (<span class="nickname">streakTypes</span>)</div>
|
|
<div class="method-notes"></div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
OK
|
|
<a href="#"></a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<h1><a name="Teams">Teams</a></h1>
|
|
<div class="method"><a name="affiliates"/>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="get"><code class="huge"><span class="http-method">get</span> /api/v1/teams/{teamId}/affiliates</code></pre></div>
|
|
<div class="method-summary">View team and affiliate teams (<span class="nickname">affiliates</span>)</div>
|
|
<div class="method-notes"></div>
|
|
|
|
<h3 class="field-label">Path parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">teamId (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Path Parameter</span> — Unique Team Identifier. Format: 141, 147, etc default: null </div>
|
|
</div> <!-- field-items -->
|
|
|
|
|
|
|
|
|
|
<h3 class="field-label">Query parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">teamIds (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Unique Team Identifier. Format: 141, 147, etc default: null </div><div class="param">sportId (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Top level organization of a sport default: null </div><div class="param">season (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Season of play default: null </div><div class="param">gameType (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Type of Game. Available types in /api/v1/gameTypes default: null </div><div class="param">fields (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Comma delimited list of specific fields to be returned. Format: topLevelNode, childNode, attribute default: null </div>
|
|
</div> <!-- field-items -->
|
|
|
|
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
OK
|
|
<a href="#"></a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="affiliates1"/>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="get"><code class="huge"><span class="http-method">get</span> /api/v1/teams/affiliates</code></pre></div>
|
|
<div class="method-summary">View team and affiliate teams (<span class="nickname">affiliates1</span>)</div>
|
|
<div class="method-notes"></div>
|
|
|
|
<h3 class="field-label">Path parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">teamId (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Path Parameter</span> — Unique Team Identifier. Format: 141, 147, etc default: null </div>
|
|
</div> <!-- field-items -->
|
|
|
|
|
|
|
|
|
|
<h3 class="field-label">Query parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">teamIds (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Unique Team Identifier. Format: 141, 147, etc default: null </div><div class="param">sportId (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Top level organization of a sport default: null </div><div class="param">season (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Season of play default: null </div><div class="param">gameType (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Type of Game. Available types in /api/v1/gameTypes default: null </div><div class="param">fields (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Comma delimited list of specific fields to be returned. Format: topLevelNode, childNode, attribute default: null </div>
|
|
</div> <!-- field-items -->
|
|
|
|
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
OK
|
|
<a href="#"></a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="allTeams"/>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="get"><code class="huge"><span class="http-method">get</span> /api/v1/teams/{teamId}/history</code></pre></div>
|
|
<div class="method-summary">View historical records for a list of teams (<span class="nickname">allTeams</span>)</div>
|
|
<div class="method-notes"></div>
|
|
|
|
<h3 class="field-label">Path parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">teamId (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Path Parameter</span> — Unique Team Identifier. Format: 141, 147, etc default: null </div>
|
|
</div> <!-- field-items -->
|
|
|
|
|
|
|
|
|
|
<h3 class="field-label">Query parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">teamIds (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Comma delimited list of Unique Team identifiers default: null </div><div class="param">startSeason (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Start date for range of data (used with end date optionally). Example: '2018' or '2018.2' default: null </div><div class="param">endSeason (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — End date for range of data (used with start date optionally). Format: '2018' or '2018.2' default: null </div><div class="param">fields (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — default: null </div>
|
|
</div> <!-- field-items -->
|
|
|
|
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
OK
|
|
<a href="#"></a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="allTeams1"/>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="get"><code class="huge"><span class="http-method">get</span> /api/v1/teams/history</code></pre></div>
|
|
<div class="method-summary">View historical records for a list of teams (<span class="nickname">allTeams1</span>)</div>
|
|
<div class="method-notes"></div>
|
|
|
|
<h3 class="field-label">Path parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">teamId (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Path Parameter</span> — Unique Team Identifier. Format: 141, 147, etc default: null </div>
|
|
</div> <!-- field-items -->
|
|
|
|
|
|
|
|
|
|
<h3 class="field-label">Query parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">teamIds (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Comma delimited list of Unique Team identifiers default: null </div><div class="param">startSeason (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Start date for range of data (used with end date optionally). Example: '2018' or '2018.2' default: null </div><div class="param">endSeason (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — End date for range of data (used with start date optionally). Format: '2018' or '2018.2' default: null </div><div class="param">fields (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — default: null </div>
|
|
</div> <!-- field-items -->
|
|
|
|
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
OK
|
|
<a href="#"></a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="alumni"/>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="get"><code class="huge"><span class="http-method">get</span> /api/v1/teams/{teamId}/alumni</code></pre></div>
|
|
<div class="method-summary">View all team alumni (<span class="nickname">alumni</span>)</div>
|
|
<div class="method-notes"></div>
|
|
|
|
<h3 class="field-label">Path parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">teamId (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Path Parameter</span> — Unique Team Identifier. Format: 141, 147, etc default: null </div>
|
|
</div> <!-- field-items -->
|
|
|
|
|
|
|
|
|
|
<h3 class="field-label">Query parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">season (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Season of play default: null </div><div class="param">group (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Category of statistic to return. Available types in /api/v1/statGroups default: null </div><div class="param">fields (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — default: null </div>
|
|
</div> <!-- field-items -->
|
|
|
|
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
OK
|
|
<a href="#"></a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="coaches"/>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="get"><code class="huge"><span class="http-method">get</span> /api/v1/teams/{teamId}/coaches</code></pre></div>
|
|
<div class="method-summary">View all coaches for a team (<span class="nickname">coaches</span>)</div>
|
|
<div class="method-notes"></div>
|
|
|
|
<h3 class="field-label">Path parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">teamId (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Path Parameter</span> — Unique Team Identifier. Format: 141, 147, etc default: null </div>
|
|
</div> <!-- field-items -->
|
|
|
|
|
|
|
|
|
|
<h3 class="field-label">Query parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">season (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Season of play default: null </div><div class="param">date (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Date of Game. Format: YYYY-MM-DD default: null </div><div class="param">fields (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — default: null </div>
|
|
</div> <!-- field-items -->
|
|
|
|
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
OK
|
|
<a href="#"></a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="leaders"/>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="get"><code class="huge"><span class="http-method">get</span> /api/v1/teams/{teamId}/leaders</code></pre></div>
|
|
<div class="method-summary">View team stat leaders (<span class="nickname">leaders</span>)</div>
|
|
<div class="method-notes"></div>
|
|
|
|
<h3 class="field-label">Path parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">teamId (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Path Parameter</span> — default: null </div>
|
|
</div> <!-- field-items -->
|
|
|
|
|
|
|
|
|
|
<h3 class="field-label">Query parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">leaderCategories (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — default: null </div><div class="param">season (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — default: null </div><div class="param">leaderGameTypes (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — default: null </div><div class="param">expand (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — default: null </div><div class="param">limit (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — default: null </div><div class="param">offset (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — default: null </div><div class="param">playerPool (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — default: null </div><div class="param">fields (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — default: null </div>
|
|
</div> <!-- field-items -->
|
|
|
|
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
OK
|
|
<a href="#"></a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="leaders1"/>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="get"><code class="huge"><span class="http-method">get</span> /api/v1/teams/stats/leaders</code></pre></div>
|
|
<div class="method-summary">View leaders for team stats (<span class="nickname">leaders1</span>)</div>
|
|
<div class="method-notes"></div>
|
|
|
|
|
|
|
|
|
|
|
|
<h3 class="field-label">Query parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">leaderCategories (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — TBD default: null </div><div class="param">gameTypes (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Type of Game. Available types in /api/v1/gameTypes default: null </div><div class="param">stats (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Type of statistics. Format: Individual, Team, Career, etc. Available types in /api/v1/statTypes default: null </div><div class="param">statType (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — default: null </div><div class="param">sportId (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Top level organization of a sport default: null </div><div class="param">sportIds (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Comma delimited list of top level organizations of a sport default: null </div><div class="param">leagueId (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Unique League Identifier default: null </div><div class="param">leagueIds (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Comma delimited list of Unique league identifiers default: null </div><div class="param">season (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Season of play default: null </div><div class="param">statGroup (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Category of statistic to return. Available types in /api/v1/statGroups default: null </div><div class="param">group (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Category of statistic to return. Available types in /api/v1/statGroups default: null </div><div class="param">startDate (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Start date for range of data (must be used with end date). Format: MM/DD/YYYY default: null </div><div class="param">endDate (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — End date for range of data (must be used with start date). Format: MM/DD/YYYY default: null </div><div class="param">daysBack (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Returns results from the last 'X' days (Starting from yesterday). default: null </div><div class="param">sitCodes (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Situation code for a given stat split. default: null </div><div class="param">opposingTeamId (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — A unique identifier for the opposing team. Must be used with Team ID default: null </div><div class="param">limit (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Number of results to return default: null </div><div class="param">offset (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — The pointer to start for a return set; used for pagination default: null </div><div class="param">fields (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — default: null </div>
|
|
</div> <!-- field-items -->
|
|
|
|
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
OK
|
|
<a href="#"></a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="personnel"/>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="get"><code class="huge"><span class="http-method">get</span> /api/v1/teams/{teamId}/personnel</code></pre></div>
|
|
<div class="method-summary">View all coaches for a team (<span class="nickname">personnel</span>)</div>
|
|
<div class="method-notes"></div>
|
|
|
|
<h3 class="field-label">Path parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">teamId (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Path Parameter</span> — Unique Team Identifier. Format: 141, 147, etc default: null </div>
|
|
</div> <!-- field-items -->
|
|
|
|
|
|
|
|
|
|
<h3 class="field-label">Query parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">season (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Season of play default: null </div><div class="param">date (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Date of Game. Format: YYYY-MM-DD default: null </div><div class="param">fields (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — default: null </div>
|
|
</div> <!-- field-items -->
|
|
|
|
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
OK
|
|
<a href="#"></a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="roster"/>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="get"><code class="huge"><span class="http-method">get</span> /api/v1/teams/{teamId}/roster</code></pre></div>
|
|
<div class="method-summary">View a teams roster (<span class="nickname">roster</span>)</div>
|
|
<div class="method-notes">This endpoint allows you to pull teams</div>
|
|
|
|
<h3 class="field-label">Path parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">teamId (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Path Parameter</span> — Unique Team Identifier. Format: 141, 147, etc default: null </div><div class="param">rosterType (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Path Parameter</span> — Type of roster. Available types in /api/v1/rosterTypes default: null </div>
|
|
</div> <!-- field-items -->
|
|
|
|
|
|
|
|
|
|
<h3 class="field-label">Query parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">season (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Season of play default: null </div><div class="param">date (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Date of Game. Format: YYYY-MM-DD default: null </div><div class="param">gameType (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Type of Game. Available types in /api/v1/gameTypes default: null </div><div class="param">fields (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Comma delimited list of specific fields to be returned. Format: topLevelNode, childNode, attribute default: null </div>
|
|
</div> <!-- field-items -->
|
|
|
|
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
OK
|
|
<a href="#"></a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="roster1"/>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="get"><code class="huge"><span class="http-method">get</span> /api/v1/teams/{teamId}/roster/{rosterType}</code></pre></div>
|
|
<div class="method-summary">View a teams roster (<span class="nickname">roster1</span>)</div>
|
|
<div class="method-notes">This endpoint allows you to pull teams</div>
|
|
|
|
<h3 class="field-label">Path parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">teamId (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Path Parameter</span> — Unique Team Identifier. Format: 141, 147, etc default: null </div><div class="param">rosterType (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Path Parameter</span> — Type of roster. Available types in /api/v1/rosterTypes default: null </div>
|
|
</div> <!-- field-items -->
|
|
|
|
|
|
|
|
|
|
<h3 class="field-label">Query parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">season (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Season of play default: null </div><div class="param">date (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Date of Game. Format: YYYY-MM-DD default: null </div><div class="param">gameType (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Type of Game. Available types in /api/v1/gameTypes default: null </div><div class="param">fields (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Comma delimited list of specific fields to be returned. Format: topLevelNode, childNode, attribute default: null </div>
|
|
</div> <!-- field-items -->
|
|
|
|
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
OK
|
|
<a href="#"></a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="stats"/>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="get"><code class="huge"><span class="http-method">get</span> /api/v1/teams/{teamId}/stats</code></pre></div>
|
|
<div class="method-summary">View a teams stats (<span class="nickname">stats</span>)</div>
|
|
<div class="method-notes"></div>
|
|
|
|
<h3 class="field-label">Path parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">teamId (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Path Parameter</span> — Unique Team Identifier. Format: 141, 147, etc default: null </div>
|
|
</div> <!-- field-items -->
|
|
|
|
|
|
|
|
|
|
<h3 class="field-label">Query parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">sportId (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Top level organization of a sport default: null </div><div class="param">season (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Season of play default: null </div><div class="param">gameType (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Type of Game. Available types in /api/v1/gameTypes default: null </div><div class="param">stats (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Type of statistics. Format: Individual, Team, Career, etc. Available types in /api/v1/statTypes default: null </div><div class="param">group (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Category of statistic to return. Available types in /api/v1/statGroups default: null </div><div class="param">sortStat (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Baseball stat to sort splits by. default: null </div><div class="param">order (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — The order of sorting, ascending or descending default: null </div><div class="param">groupBy (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Group stats by PLAYER, TEAM, SEASON, VENUE, SPORT or STAT_GROUP default: null </div><div class="param">opposingTeamId (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — A unique identifier for the opposing team. Must be used with Team ID default: null </div><div class="param">opposingPlayerId (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — A unique identifier for the opposing team default: null </div><div class="param">sitCodes (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Situation code for a given stat split. default: null </div><div class="param">startDate (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Start date for range of data (must be used with end date). Format: MM/DD/YYYY default: null </div><div class="param">endDate (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — End date for range of data (must be used with start date). Format: MM/DD/YYYY default: null </div><div class="param">fields (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Comma delimited list of specific fields to be returned. Format: topLevelNode, childNode, attribute default: null </div>
|
|
</div> <!-- field-items -->
|
|
|
|
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
OK
|
|
<a href="#"></a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="stats1"/>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="get"><code class="huge"><span class="http-method">get</span> /api/v1/teams/stats</code></pre></div>
|
|
<div class="method-summary">View a teams stats (<span class="nickname">stats1</span>)</div>
|
|
<div class="method-notes"></div>
|
|
|
|
|
|
|
|
|
|
|
|
<h3 class="field-label">Query parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">gameType (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Type of Game. Available types in /api/v1/gameTypes default: null </div><div class="param">stats (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Type of statistics. Format: Individual, Team, Career, etc. Available types in /api/v1/statTypes default: null </div><div class="param">sportId (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Top level organization of a sport default: null </div><div class="param">sportIds (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Comma delimited list of top level organizations of a sport default: null </div><div class="param">leagueIds (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Comma delimited list of Unique league identifiers default: null </div><div class="param">season (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Season of play default: null </div><div class="param">group (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Category of statistic to return. Available types in /api/v1/statGroups default: null </div><div class="param">sortStat (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Baseball stat to sort splits by. default: null </div><div class="param">order (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — The order of sorting, ascending or descending default: null </div><div class="param">startDate (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Start date for range of data (must be used with end date). Format: MM/DD/YYYY default: null </div><div class="param">endDate (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — End date for range of data (must be used with start date). Format: MM/DD/YYYY default: null </div><div class="param">daysBack (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Returns results from the last 'X' days (Starting from yesterday). default: null </div><div class="param">sitCodes (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Situation code for a given stat split. default: null </div><div class="param">combineSits (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — If true, gathers stats where all of the situational criteria are met. If false, returns stats where any of the situational criteria are met. Default: false default: null </div><div class="param">opposingTeamId (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — A unique identifier for the opposing team. Must be used with Team ID default: null </div><div class="param">offset (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — The pointer to start for a return set; used for pagination default: null </div><div class="param">limit (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Number of results to return default: null </div><div class="param">fields (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — default: null </div>
|
|
</div> <!-- field-items -->
|
|
|
|
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
OK
|
|
<a href="#"></a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="teams"/>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="get"><code class="huge"><span class="http-method">get</span> /api/v1/teams</code></pre></div>
|
|
<div class="method-summary">View info for all teams (<span class="nickname">teams</span>)</div>
|
|
<div class="method-notes">This endpoint allows you to pull teams</div>
|
|
|
|
<h3 class="field-label">Path parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">teamId (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Path Parameter</span> — Unique Team Identifier. Format: 141, 147, etc default: null </div>
|
|
</div> <!-- field-items -->
|
|
|
|
|
|
|
|
|
|
<h3 class="field-label">Query parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">season (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Season of play default: null </div><div class="param">sportId (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Top level organization of a sport default: null </div><div class="param">divisionId (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Unique Division Identifier default: null </div><div class="param">gameType (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Type of Game. Available types in /api/v1/gameTypes default: null </div><div class="param">leagueIds (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Comma delimited list of Unique league identifiers default: null </div><div class="param">sportIds (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Comma delimited list of top level organizations of a sport default: null </div><div class="param">activeStatus (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Flag for fetching teams that are currently active (Y), inactive (N), pending (P), or all teams (B) default: null </div><div class="param">leagueListId (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Unique League List Identifier default: null </div><div class="param">allStarStatuses (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — default: null </div><div class="param">fields (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Comma delimited list of specific fields to be returned. Format: topLevelNode, childNode, attribute default: null </div>
|
|
</div> <!-- field-items -->
|
|
|
|
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
OK
|
|
<a href="#"></a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="teams1"/>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="get"><code class="huge"><span class="http-method">get</span> /api/v1/teams/{teamId}</code></pre></div>
|
|
<div class="method-summary">View info for all teams (<span class="nickname">teams1</span>)</div>
|
|
<div class="method-notes">This endpoint allows you to pull teams</div>
|
|
|
|
<h3 class="field-label">Path parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">teamId (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Path Parameter</span> — Unique Team Identifier. Format: 141, 147, etc default: null </div>
|
|
</div> <!-- field-items -->
|
|
|
|
|
|
|
|
|
|
<h3 class="field-label">Query parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">season (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Season of play default: null </div><div class="param">sportId (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Top level organization of a sport default: null </div><div class="param">divisionId (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Unique Division Identifier default: null </div><div class="param">gameType (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Type of Game. Available types in /api/v1/gameTypes default: null </div><div class="param">leagueIds (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Comma delimited list of Unique league identifiers default: null </div><div class="param">sportIds (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Comma delimited list of top level organizations of a sport default: null </div><div class="param">activeStatus (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Flag for fetching teams that are currently active (Y), inactive (N), pending (P), or all teams (B) default: null </div><div class="param">leagueListId (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Unique League List Identifier default: null </div><div class="param">allStarStatuses (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — default: null </div><div class="param">fields (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Comma delimited list of specific fields to be returned. Format: topLevelNode, childNode, attribute default: null </div>
|
|
</div> <!-- field-items -->
|
|
|
|
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
OK
|
|
<a href="#"></a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="updateAlumni"/>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="post"><code class="huge"><span class="http-method">post</span> /api/v1/teams/{teamId}/alumni</code></pre></div>
|
|
<div class="method-summary"> (<span class="nickname">updateAlumni</span>)</div>
|
|
<div class="method-notes"></div>
|
|
|
|
<h3 class="field-label">Path parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">teamId (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Path Parameter</span> — Unique Team Identifier. Format: 141, 147, etc default: null </div>
|
|
</div> <!-- field-items -->
|
|
|
|
|
|
|
|
|
|
<h3 class="field-label">Query parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">season (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Season of play default: null </div><div class="param">group (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Category of statistic to return. Available types in /api/v1/statGroups default: null </div><div class="param">fields (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — default: null </div>
|
|
</div> <!-- field-items -->
|
|
|
|
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
OK
|
|
<a href="#"></a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<h1><a name="Transactions">Transactions</a></h1>
|
|
<div class="method"><a name="transactions"/>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="get"><code class="huge"><span class="http-method">get</span> /api/v1/transactions</code></pre></div>
|
|
<div class="method-summary">View transaction info (<span class="nickname">transactions</span>)</div>
|
|
<div class="method-notes">This endpoint allows you to pull transactions.</div>
|
|
|
|
|
|
|
|
|
|
|
|
<h3 class="field-label">Query parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">leagueId (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Comma delimited list of Unique league identifiers default: null </div><div class="param">sportId (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Comma delimited list of top level organizations of a sport default: null </div><div class="param">teamId (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Comma delimited list of Unique Team identifiers default: null </div><div class="param">playerId (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — A unique identifier for a player default: null </div><div class="param">date (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Date of Game. Format: YYYY-MM-DD default: null </div><div class="param">startDate (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Start date for range of data (must be used with end date). Format: MM/DD/YYYY default: null </div><div class="param">endDate (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — End date for range of data (must be used with start date). Format: MM/DD/YYYY default: null </div><div class="param">transactionIds (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — default: null </div><div class="param">transactionTypes (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — default: null </div><div class="param">divisionIds (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — default: null </div><div class="param">order (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — default: null </div><div class="param">limit (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — default: null </div><div class="param">fields (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Comma delimited list of specific fields to be returned. Format: topLevelNode, childNode, attribute default: null </div>
|
|
</div> <!-- field-items -->
|
|
|
|
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
OK
|
|
<a href="#"></a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<h1><a name="Uniforms">Uniforms</a></h1>
|
|
<div class="method"><a name="uniformsByGame"/>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="get"><code class="huge"><span class="http-method">get</span> /api/v1/uniforms/game</code></pre></div>
|
|
<div class="method-summary">View Game Uniform info (<span class="nickname">uniformsByGame</span>)</div>
|
|
<div class="method-notes">This endpoint allows you to pull team uniform data for a game</div>
|
|
|
|
|
|
|
|
|
|
|
|
<h3 class="field-label">Query parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">gamePks (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Comma delimited list of unique primary keys default: null </div><div class="param">fields (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Comma delimited list of specific fields to be returned. Format: topLevelNode, childNode, attribute default: null </div>
|
|
</div> <!-- field-items -->
|
|
|
|
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
OK
|
|
<a href="#"></a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="uniformsByTeam"/>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="get"><code class="huge"><span class="http-method">get</span> /api/v1/uniforms/team</code></pre></div>
|
|
<div class="method-summary">View Team Uniform info (<span class="nickname">uniformsByTeam</span>)</div>
|
|
<div class="method-notes">This endpoint allows you to pull team uniform data for a season</div>
|
|
|
|
|
|
|
|
|
|
|
|
<h3 class="field-label">Query parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">teamIds (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — default: null </div><div class="param">season (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Season of play default: null </div><div class="param">fields (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Comma delimited list of specific fields to be returned. Format: topLevelNode, childNode, attribute default: null </div>
|
|
</div> <!-- field-items -->
|
|
|
|
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
OK
|
|
<a href="#"></a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<h1><a name="Venues">Venues</a></h1>
|
|
<div class="method"><a name="venues"/>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="get"><code class="huge"><span class="http-method">get</span> /api/v1/venues</code></pre></div>
|
|
<div class="method-summary">View venue info (<span class="nickname">venues</span>)</div>
|
|
<div class="method-notes">This endpoint allows you to pull venues</div>
|
|
|
|
<h3 class="field-label">Path parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">venueId (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Path Parameter</span> — Unique Venue Identifier default: null </div>
|
|
</div> <!-- field-items -->
|
|
|
|
|
|
|
|
|
|
<h3 class="field-label">Query parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">venueIds (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Comma delimited list of Unique venue identifiers default: null </div><div class="param">leagueId (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Unique League Identifier default: null </div><div class="param">leagueIds (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Comma delimited list of Unique league identifiers default: null </div><div class="param">gameType (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Type of Game. Available types in /api/v1/gameTypes default: null </div><div class="param">gameTypes (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Comma delimited list of type of Game. Available types in /api/v1/gameTypes default: null </div><div class="param">season (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Season of play default: null </div><div class="param">seasons (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Comma delimited list of Seasons of play default: null </div><div class="param">fields (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Comma delimited list of specific fields to be returned. Format: topLevelNode, childNode, attribute default: null </div><div class="param">active (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Whether or not a player is active default: null </div><div class="param">includeEvents (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — default: null </div><div class="param">sportId (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Top level organization of a sport default: null </div><div class="param">sportIds (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Comma delimited list of top level organizations of a sport default: null </div>
|
|
</div> <!-- field-items -->
|
|
|
|
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
OK
|
|
<a href="#"></a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="venues1"/>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="get"><code class="huge"><span class="http-method">get</span> /api/v1/venues/{venueId}</code></pre></div>
|
|
<div class="method-summary">View venue info (<span class="nickname">venues1</span>)</div>
|
|
<div class="method-notes">This endpoint allows you to pull venues</div>
|
|
|
|
<h3 class="field-label">Path parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">venueId (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Path Parameter</span> — Unique Venue Identifier default: null </div>
|
|
</div> <!-- field-items -->
|
|
|
|
|
|
|
|
|
|
<h3 class="field-label">Query parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">venueIds (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Comma delimited list of Unique venue identifiers default: null </div><div class="param">leagueId (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Unique League Identifier default: null </div><div class="param">leagueIds (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Comma delimited list of Unique league identifiers default: null </div><div class="param">gameType (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Type of Game. Available types in /api/v1/gameTypes default: null </div><div class="param">gameTypes (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Comma delimited list of type of Game. Available types in /api/v1/gameTypes default: null </div><div class="param">season (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Season of play default: null </div><div class="param">seasons (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Comma delimited list of Seasons of play default: null </div><div class="param">fields (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Comma delimited list of specific fields to be returned. Format: topLevelNode, childNode, attribute default: null </div><div class="param">active (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Whether or not a player is active default: null </div><div class="param">includeEvents (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — default: null </div><div class="param">sportId (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Top level organization of a sport default: null </div><div class="param">sportIds (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Comma delimited list of top level organizations of a sport default: null </div>
|
|
</div> <!-- field-items -->
|
|
|
|
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
OK
|
|
<a href="#"></a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<h1><a name="Weather">Weather</a></h1>
|
|
<div class="method"><a name="weatherBasic"/>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="get"><code class="huge"><span class="http-method">get</span> /api/v1/weather/venues/{venueId}/basic</code></pre></div>
|
|
<div class="method-summary">Get basic weather for a venue. (<span class="nickname">weatherBasic</span>)</div>
|
|
<div class="method-notes">Returns a json file containing basic weather for a specific venue.</div>
|
|
|
|
<h3 class="field-label">Path parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">venueId (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Path Parameter</span> — Unique Venue Identifier default: null </div>
|
|
</div> <!-- field-items -->
|
|
|
|
|
|
|
|
|
|
<h3 class="field-label">Query parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">fields (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Comma delimited list of specific fields to be returned. Format: topLevelNode, childNode, attribute default: null </div>
|
|
</div> <!-- field-items -->
|
|
|
|
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
OK
|
|
<a href="#"></a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="weatherDataBasedOnPlay"/>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="get"><code class="huge"><span class="http-method">get</span> /api/v1/weather/game/{gamePk}/{playId}</code></pre></div>
|
|
<div class="method-summary">Get the raw field weather data. (<span class="nickname">weatherDataBasedOnPlay</span>)</div>
|
|
<div class="method-notes">Returns a json file containing weather for the current play.</div>
|
|
|
|
<h3 class="field-label">Path parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">gamePk (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Path Parameter</span> — Unique Primary Key Representing a Game default: null </div><div class="param">playId (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Path Parameter</span> — Unique identifier for a play within a game default: null </div>
|
|
</div> <!-- field-items -->
|
|
|
|
|
|
|
|
|
|
<h3 class="field-label">Query parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">fields (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Comma delimited list of specific fields to be returned. Format: topLevelNode, childNode, attribute default: null </div>
|
|
</div> <!-- field-items -->
|
|
|
|
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
OK
|
|
<a href="#"></a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="weatherForecast"/>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="get"><code class="huge"><span class="http-method">get</span> /api/v1/weather/game/{gamePk}/forecast/{roofType}</code></pre></div>
|
|
<div class="method-summary">Get the weather forecast for a game. (<span class="nickname">weatherForecast</span>)</div>
|
|
<div class="method-notes">Returns a json file containing the weather forecast for a specific game.</div>
|
|
|
|
<h3 class="field-label">Path parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">gamePk (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Path Parameter</span> — Unique Primary Key Representing a Game default: null </div><div class="param">roofType (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Path Parameter</span> — Venue roof type default: null </div>
|
|
</div> <!-- field-items -->
|
|
|
|
|
|
|
|
|
|
<h3 class="field-label">Query parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">fields (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Comma delimited list of specific fields to be returned. Format: topLevelNode, childNode, attribute default: null </div>
|
|
</div> <!-- field-items -->
|
|
|
|
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
OK
|
|
<a href="#"></a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="weatherFull"/>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="get"><code class="huge"><span class="http-method">get</span> /api/v1/weather/venues/{venueId}/full</code></pre></div>
|
|
<div class="method-summary">Get full weather for a venue. (<span class="nickname">weatherFull</span>)</div>
|
|
<div class="method-notes">Returns a json file containing full weather for a specific venue.</div>
|
|
|
|
<h3 class="field-label">Path parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">venueId (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Path Parameter</span> — Unique Venue Identifier default: null </div>
|
|
</div> <!-- field-items -->
|
|
|
|
|
|
|
|
|
|
<h3 class="field-label">Query parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">fields (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Comma delimited list of specific fields to be returned. Format: topLevelNode, childNode, attribute default: null </div>
|
|
</div> <!-- field-items -->
|
|
|
|
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
OK
|
|
<a href="#"></a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
|
|
<h2><a name="__Models">Models</a></h2>
|
|
[ Jump to <a href="#__Methods">Methods</a> ]
|
|
|
|
<h3>Table of Contents</h3>
|
|
<ol>
|
|
</ol>
|
|
|
|
</body>
|
|
</html>
|