{"openapi":"3.1.0","info":{"title":"PuckAPI API","version":"1.0.0","description":"PuckAPI hockey data. Every tool is a POST to /v1/{tool} with a JSON body of its arguments and costs the credits in x-credits. Free accounts get credits every month: https://puckapi.com/signup. The same tools are an MCP server at https://mcp.puckapi.com/mcp.","termsOfService":"https://puckapi.com/terms","contact":{"name":"PuckAPI support","email":"support@puckapi.com","url":"https://puckapi.com/docs"}},"externalDocs":{"description":"Documentation","url":"https://puckapi.com/docs"},"servers":[{"url":"https://mcp.puckapi.com"}],"security":[{"apiKey":[]},{"bearer":[]}],"components":{"securitySchemes":{"apiKey":{"type":"apiKey","in":"header","name":"x-api-key"},"bearer":{"type":"http","scheme":"bearer","description":"The same API key as a bearer token."}}},"paths":{"/v1/get_standings":{"post":{"operationId":"get_standings","summary":"Standings","description":"Use when checking where teams rank in their division or conference. Returns points, wins, losses, OT losses, point%, goal differential, goals for/against per game, and 5v5 possession: Corsi%, Fenwick% and expected goals for and against. The possession columns are 5v5 only, so they will not match a goalie's expected goals against, which covers every strength. Defaults to the most recent season with standings. Costs 2 credits.","tags":["Basic lookup"],"x-credits":2,"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"conference":{"description":"Filter by conference","type":"string","enum":["Eastern","Western"]},"division":{"description":"Filter by division (e.g. Atlantic, Metropolitan, Central, Pacific)","type":"string"},"season":{"description":"Season ID, 8-digit (e.g. 20242025 for 2024-25). 2024-25 and 2024-2025 also accepted. Defaults to current season.","type":"string"},"league":{"description":"League. Defaults to nhl. One of: nhl, pwhl, ohl, whl, qmjhl, echl, ahl, ushl.","type":"string","enum":["nhl","pwhl","ohl","whl","qmjhl","echl","ahl","ushl"]}},"additionalProperties":false}}}},"responses":{"200":{"description":"The result, wrapped in data.","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"standings":{"type":"array","items":{"type":"object","properties":{"teamAbbrev":{"type":"string"},"teamName":{"type":"string"},"conference":{"type":"string"},"division":{"type":"string"},"rank":{"type":["number","null"]},"points":{"type":["number","null"]},"gamesPlayed":{"type":["number","null"]},"wins":{"type":["number","null"]},"losses":{"type":["number","null"]},"otLosses":{"type":["number","null"]},"pointPct":{"type":["number","null"]},"goalDiff":{"type":["number","null"]},"goalsForPerGame":{"type":["number","null"]},"goalsAgainstPerGame":{"type":["number","null"]},"corsiPct":{"type":["number","null"]},"fenwickPct":{"type":["number","null"]},"expectedGoalsFor":{"type":["number","null"]},"expectedGoalsAgainst":{"type":["number","null"]},"snapshotDate":{"type":["string","null"]}},"required":["teamAbbrev","teamName","conference","division","rank","points","gamesPlayed","wins","losses","otLosses","pointPct","goalDiff","goalsForPerGame","goalsAgainstPerGame","corsiPct","fenwickPct","expectedGoalsFor","expectedGoalsAgainst","snapshotDate"],"additionalProperties":false}},"snapshot_date":{"type":["string","null"]},"count":{"type":"number"}},"required":["standings","snapshot_date","count"],"additionalProperties":false}},"required":["data"]}}}},"400":{"description":"Invalid arguments.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}},"required":["error"]}}}},"401":{"description":"Missing or invalid API key.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}},"required":["error"]}}}},"402":{"description":"Not enough credits.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}},"required":["error"]}}}},"429":{"description":"Rate limited.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}},"required":["error"]}}}}}}},"/v1/get_team_stats":{"post":{"operationId":"get_team_stats","summary":"Team stats","description":"Use when you need full details for one team: record, goals for and against, league rank, and 5v5 possession (Corsi%, Fenwick%, expected goals for and against). Possession is 5v5 only. Requires a team abbreviation (use list_teams if unsure). Costs 5 credits.","tags":["Stats + aggregation"],"x-credits":5,"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"team":{"type":"string","description":"Team abbreviation (e.g. BUF, TOR, NYR)"},"season":{"description":"Season ID, 8-digit (e.g. 20242025 for 2024-25). 2024-25 and 2024-2025 also accepted. Defaults to current season.","type":"string"},"league":{"description":"League. Defaults to nhl. One of: nhl, pwhl, ohl, whl, qmjhl, echl, ahl, ushl.","type":"string","enum":["nhl","pwhl","ohl","whl","qmjhl","echl","ahl","ushl"]}},"required":["team"],"additionalProperties":false}}}},"responses":{"200":{"description":"The result, wrapped in data.","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"team":{},"current_stats":{"anyOf":[{},{"type":"null"}]},"season":{"type":["string","null"]}},"required":["team","current_stats","season"],"additionalProperties":false}},"required":["data"]}}}},"400":{"description":"Invalid arguments.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}},"required":["error"]}}}},"401":{"description":"Missing or invalid API key.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}},"required":["error"]}}}},"402":{"description":"Not enough credits.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}},"required":["error"]}}}},"429":{"description":"Rate limited.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}},"required":["error"]}}}}}}},"/v1/list_teams":{"post":{"operationId":"list_teams","summary":"List teams","description":"Use when you need team abbreviations, or to see all 32 active NHL teams with city, conference, division, and arena. Excludes historical franchises (ATL, ARI). Cheapest tool at 1 credit.","tags":["Static reference"],"x-credits":1,"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"conference":{"description":"Filter by conference","type":"string","enum":["Eastern","Western"]},"division":{"description":"Filter by division","type":"string"},"league":{"description":"League. Defaults to nhl. One of: nhl, pwhl, ohl, whl, qmjhl, echl, ahl, ushl.","type":"string","enum":["nhl","pwhl","ohl","whl","qmjhl","echl","ahl","ushl"]}},"additionalProperties":false}}}},"responses":{"200":{"description":"The result, wrapped in data.","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"teams":{"type":"array","items":{"type":"object","properties":{"abbrev":{"type":"string"},"name":{"type":"string"},"city":{"type":"string"},"conference":{"type":"string"},"division":{"type":"string"},"arena":{"type":"string"}},"required":["abbrev","name","conference","division"],"additionalProperties":false}},"count":{"type":"number"}},"required":["teams","count"],"additionalProperties":false}},"required":["data"]}}}},"400":{"description":"Invalid arguments.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}},"required":["error"]}}}},"401":{"description":"Missing or invalid API key.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}},"required":["error"]}}}},"402":{"description":"Not enough credits.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}},"required":["error"]}}}},"429":{"description":"Rate limited.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}},"required":["error"]}}}}}}},"/v1/get_games":{"post":{"operationId":"get_games","summary":"Games","description":"Use when querying past or future games with filters. Returns scores, teams, venue, and game metadata. For upcoming-only games, prefer get_schedule (2 cr) instead. Costs 5 credits.","tags":["Stats + aggregation"],"x-credits":5,"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"date_from":{"description":"Start date (YYYY-MM-DD)","type":"string"},"date_to":{"description":"End date (YYYY-MM-DD)","type":"string"},"team":{"description":"Team abbreviation to filter (home or away)","type":"string"},"season":{"description":"Season ID, 8-digit (e.g. 20242025 for 2024-25). 2024-25 and 2024-2025 also accepted.","type":"string"},"game_state":{"description":"Filter by game state. FINAL and OFF both mean finished and return the same games; FUT is scheduled, LIVE in progress.","type":"string","enum":["FUT","LIVE","FINAL","OFF"]},"game_type":{"description":"Filter by game type","type":"string","enum":["regular","playoff","preseason"]},"limit":{"description":"Max results (default 100)","type":"integer","minimum":1,"maximum":500},"league":{"description":"League. Defaults to nhl. One of: nhl, pwhl, ohl, whl, qmjhl, echl, ahl, ushl.","type":"string","enum":["nhl","pwhl","ohl","whl","qmjhl","echl","ahl","ushl"]}},"additionalProperties":false}}}},"responses":{"200":{"description":"The result, wrapped in data.","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"games":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"season":{"type":["string","null"]},"gameDate":{"type":["string","null"]},"startTime":{"type":["string","null"]},"homeTeam":{"type":"string"},"awayTeam":{"type":"string"},"homeScore":{"type":["number","null"]},"awayScore":{"type":["number","null"]},"gameState":{"type":["string","null"]},"gameType":{"type":["string","null"]},"venue":{"type":["string","null"]}},"required":["id","season","gameDate","startTime","homeTeam","awayTeam","homeScore","awayScore","gameState","gameType","venue"],"additionalProperties":false}},"count":{"type":"number"}},"required":["games","count"],"additionalProperties":false}},"required":["data"]}}}},"400":{"description":"Invalid arguments.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}},"required":["error"]}}}},"401":{"description":"Missing or invalid API key.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}},"required":["error"]}}}},"402":{"description":"Not enough credits.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}},"required":["error"]}}}},"429":{"description":"Rate limited.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}},"required":["error"]}}}}}}},"/v1/get_schedule":{"post":{"operationId":"get_schedule","summary":"Schedule","description":"Use when checking what games are coming up. Returns only unplayed future games for the next N days (default 7). For past games, use get_games instead. Costs 2 credits.","tags":["Basic lookup"],"x-credits":2,"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"team":{"description":"Team abbreviation to filter","type":"string"},"days":{"description":"Number of days ahead to look (default 7)","type":"integer","minimum":1,"maximum":30},"league":{"description":"League. Defaults to nhl. One of: nhl, pwhl, ohl, whl, qmjhl, echl, ahl, ushl.","type":"string","enum":["nhl","pwhl","ohl","whl","qmjhl","echl","ahl","ushl"]}},"additionalProperties":false}}}},"responses":{"200":{"description":"The result, wrapped in data.","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"upcoming_games":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"gameDate":{"type":["string","null"]},"startTime":{"type":["string","null"]},"homeTeam":{"type":"string"},"awayTeam":{"type":"string"},"homeTeamName":{"type":["string","null"]},"awayTeamName":{"type":["string","null"]},"venue":{"type":["string","null"]},"gameType":{"type":["string","null"]}},"required":["id","gameDate","startTime","homeTeam","awayTeam","homeTeamName","awayTeamName","venue","gameType"],"additionalProperties":false}},"count":{"type":"number"}},"required":["upcoming_games","count"],"additionalProperties":false}},"required":["data"]}}}},"400":{"description":"Invalid arguments.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}},"required":["error"]}}}},"401":{"description":"Missing or invalid API key.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}},"required":["error"]}}}},"402":{"description":"Not enough credits.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}},"required":["error"]}}}},"429":{"description":"Rate limited.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}},"required":["error"]}}}}}}},"/v1/get_game_detail":{"post":{"operationId":"get_game_detail","summary":"Game detail","description":"Use when you need everything about one game: both teams' full info, all betting odds, and the goalies who started, with their time on ice. Requires a game ID (get one from get_games or get_schedule). Odds for every game from 2019-20 on (and part of the 2019 playoffs). Goalie starts are derived from play-by-play, so they are available for played games, not upcoming ones. Costs 10 credits.","tags":["Multi-table"],"x-credits":10,"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"game_id":{"type":"string","description":"NHL game ID (e.g. 2025020887)"},"league":{"description":"League. Defaults to nhl. One of: nhl, pwhl, ohl, whl, qmjhl, echl, ahl, ushl.","type":"string","enum":["nhl","pwhl","ohl","whl","qmjhl","echl","ahl","ushl"]}},"required":["game_id"],"additionalProperties":false}}}},"responses":{"200":{"description":"The result, wrapped in data.","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"game":{},"home_team":{},"away_team":{},"odds":{"type":"array","items":{"type":"object","properties":{"bookmaker":{"type":"string"},"snapshotType":{"type":["string","null"]},"source":{"type":["string","null"]},"mlHome":{"type":["number","null"]},"mlAway":{"type":["number","null"]},"mlHomeProb":{"type":["number","null"]},"mlAwayProb":{"type":["number","null"]},"spreadHome":{"type":["number","null"]},"spreadHomeOdds":{"type":["number","null"]},"spreadAway":{"type":["number","null"]},"spreadAwayOdds":{"type":["number","null"]},"total":{"type":["number","null"]},"totalOverOdds":{"type":["number","null"]},"totalUnderOdds":{"type":["number","null"]},"capturedAt":{"type":["string","null"]}},"required":["bookmaker","snapshotType","source","mlHome","mlAway","mlHomeProb","mlAwayProb","spreadHome","spreadHomeOdds","spreadAway","spreadAwayOdds","total","totalOverOdds","totalUnderOdds","capturedAt"],"additionalProperties":false}},"goalie_starts":{"anyOf":[{},{"type":"null"}]}},"required":["game","home_team","away_team","odds","goalie_starts"],"additionalProperties":false}},"required":["data"]}}}},"400":{"description":"Invalid arguments.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}},"required":["error"]}}}},"401":{"description":"Missing or invalid API key.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}},"required":["error"]}}}},"402":{"description":"Not enough credits.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}},"required":["error"]}}}},"429":{"description":"Rate limited.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}},"required":["error"]}}}}}}},"/v1/get_head_to_head":{"post":{"operationId":"get_head_to_head","summary":"Head to head","description":"Use when comparing two teams' history. Returns recent matchups with win/loss record. Can filter by season or get all-time. Costs 10 credits.","tags":["Multi-table"],"x-credits":10,"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"team1":{"type":"string","description":"First team abbreviation (e.g. BUF)"},"team2":{"type":"string","description":"Second team abbreviation (e.g. TOR)"},"season":{"description":"Season ID, 8-digit (e.g. 20242025 for 2024-25). 2024-25 and 2024-2025 also accepted. Omit for all-time.","type":"string"},"limit":{"description":"Max games to return (default 20)","type":"integer","minimum":1,"maximum":100},"league":{"description":"League. Defaults to nhl. One of: nhl, pwhl, ohl, whl, qmjhl, echl, ahl, ushl.","type":"string","enum":["nhl","pwhl","ohl","whl","qmjhl","echl","ahl","ushl"]}},"required":["team1","team2"],"additionalProperties":false}}}},"responses":{"200":{"description":"The result, wrapped in data.","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"team1":{"type":"string"},"team2":{"type":"string"},"record":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"number"}},"total_games":{"type":"number"},"games":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"season":{"type":["string","null"]},"gameDate":{"type":["string","null"]},"startTime":{"type":["string","null"]},"homeTeam":{"type":"string"},"awayTeam":{"type":"string"},"homeScore":{"type":["number","null"]},"awayScore":{"type":["number","null"]},"gameState":{"type":["string","null"]},"gameType":{"type":["string","null"]},"venue":{"type":["string","null"]}},"required":["id","season","gameDate","startTime","homeTeam","awayTeam","homeScore","awayScore","gameState","gameType","venue"],"additionalProperties":false}}},"required":["team1","team2","record","total_games","games"],"additionalProperties":false}},"required":["data"]}}}},"400":{"description":"Invalid arguments.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}},"required":["error"]}}}},"401":{"description":"Missing or invalid API key.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}},"required":["error"]}}}},"402":{"description":"Not enough credits.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}},"required":["error"]}}}},"429":{"description":"Rate limited.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}},"required":["error"]}}}}}}},"/v1/search_players":{"post":{"operationId":"search_players","summary":"Search players","description":"Use when looking up a player by name. Searches 4,900+ players across every season since 2010-11. Returns active players by default; set active=false for retired/historical. Use the returned player ID with get_player_stats for full details. Costs 2 credits.","tags":["Basic lookup"],"x-credits":2,"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"query":{"type":"string","minLength":1,"description":"Player name to search for (partial match supported)"},"team":{"description":"Filter by team abbreviation","type":"string"},"position":{"description":"Filter by position","type":"string","enum":["G","D","C","LW","RW"]},"active":{"description":"Filter by active status (default: true). Set false to search active plus retired/historical players.","type":"boolean"},"limit":{"description":"Max results (default 10)","type":"integer","minimum":1,"maximum":50},"league":{"description":"League. Defaults to nhl. One of: nhl, pwhl, ohl, whl, qmjhl, echl, ahl, ushl.","type":"string","enum":["nhl","pwhl","ohl","whl","qmjhl","echl","ahl","ushl"]}},"required":["query"],"additionalProperties":false}}}},"responses":{"200":{"description":"The result, wrapped in data.","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"players":{"type":"array","items":{"type":"object","properties":{"id":{"type":"number"},"name":{"type":"string"},"firstName":{"type":["string","null"]},"lastName":{"type":["string","null"]},"team":{"type":["string","null"]},"teamName":{"type":["string","null"]},"position":{"type":["string","null"]},"positionType":{"type":["string","null"]},"jerseyNumber":{"type":["number","null"]},"birthCountry":{"type":["string","null"]},"active":{"type":["boolean","null"]}},"required":["id","name","firstName","lastName","team","teamName","position","positionType","jerseyNumber","birthCountry","active"],"additionalProperties":false}},"count":{"type":"number"},"included_inactive":{"type":"boolean"},"note":{"type":"string"}},"required":["players","count","included_inactive"],"additionalProperties":false}},"required":["data"]}}}},"400":{"description":"Invalid arguments.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}},"required":["error"]}}}},"401":{"description":"Missing or invalid API key.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}},"required":["error"]}}}},"402":{"description":"Not enough credits.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}},"required":["error"]}}}},"429":{"description":"Rate limited.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}},"required":["error"]}}}}}}},"/v1/get_player_stats":{"post":{"operationId":"get_player_stats","summary":"Player stats","description":"Use when you need full details for one player: bio, team, physical attributes, and headshot. For skaters, also returns the latest season line (games, goals, assists, points, +/-, PP/SH, shooting%, TOI). For goalies, save%, GAA, GSAX, and trend data. Requires player ID from search_players. Costs 5 credits.","tags":["Stats + aggregation"],"x-credits":5,"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"player_id":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"NHL player ID"},"league":{"description":"League. Defaults to nhl. One of: nhl, pwhl, ohl, whl, qmjhl, echl, ahl, ushl.","type":"string","enum":["nhl","pwhl","ohl","whl","qmjhl","echl","ahl","ushl"]}},"required":["player_id"],"additionalProperties":false}}}},"responses":{"200":{"description":"The result, wrapped in data.","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"player":{},"goalie_stats":{"anyOf":[{},{"type":"null"}]},"skater_stats":{"anyOf":[{},{"type":"null"}]}},"required":["player","goalie_stats","skater_stats"],"additionalProperties":false}},"required":["data"]}}}},"400":{"description":"Invalid arguments.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}},"required":["error"]}}}},"401":{"description":"Missing or invalid API key.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}},"required":["error"]}}}},"402":{"description":"Not enough credits.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}},"required":["error"]}}}},"429":{"description":"Rate limited.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}},"required":["error"]}}}}}}},"/v1/get_goalie_stats":{"post":{"operationId":"get_goalie_stats","summary":"Goalie stats","description":"Use when ranking goalies or comparing goalie performance. Returns a leaderboard sorted by save%, GAA, GSAX, or wins, with a games-played filter. Includes goals saved above expected, high-danger save%, rolling save% and GSAX over the last 10 appearances, form trend and rest days. Goalie expected goals cover every strength, unlike the 5v5-only team possession columns. Costs 5 credits.","tags":["Stats + aggregation"],"x-credits":5,"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"team":{"description":"Filter by team abbreviation","type":"string"},"season":{"description":"Season ID, 8-digit (e.g. 20242025 for 2024-25). 2024-25 and 2024-2025 also accepted. Defaults to the most recent season with stats, which is the current season once it is under way and the previous one before that. The season actually used is echoed in filters.season.","type":"string"},"min_games":{"description":"Minimum games played (default 10)","type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"sort_by":{"description":"Sort metric (default save_pct). gsax is goals saved above expected.","type":"string","enum":["save_pct","gaa","gsax","wins"]},"limit":{"description":"Max results (default 20)","type":"integer","minimum":1,"maximum":50},"league":{"description":"League. Defaults to nhl. One of: nhl, pwhl, ohl, whl, qmjhl, echl, ahl, ushl.","type":"string","enum":["nhl","pwhl","ohl","whl","qmjhl","echl","ahl","ushl"]}},"additionalProperties":false}}}},"responses":{"200":{"description":"The result, wrapped in data.","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"goalies":{"type":"array","items":{"type":"object","properties":{"playerId":{"type":"number"},"playerName":{"type":"string"},"team":{"type":["string","null"]},"teamName":{"type":["string","null"]},"gamesPlayed":{"type":["number","null"]},"wins":{"type":["number","null"]},"losses":{"type":["number","null"]},"otLosses":{"type":["number","null"]},"savePct":{"type":["number","null"]},"gaa":{"type":["number","null"]},"gsax":{"type":["number","null"]},"shutouts":{"type":["number","null"]},"highDangerSavePct":{"type":["number","null"]},"rollingSavePct":{"type":["number","null"]},"trend":{"type":["string","null"]},"restDays":{"type":["number","null"]},"snapshotDate":{"type":["string","null"]}},"required":["playerId","playerName","team","teamName","gamesPlayed","wins","losses","otLosses","savePct","gaa","gsax","shutouts","highDangerSavePct","rollingSavePct","trend","restDays","snapshotDate"],"additionalProperties":false}},"count":{"type":"number"},"filters":{"type":"object","properties":{"season":{"type":["string","null"]},"min_games":{"type":"number"},"sort_by":{"type":"string"}},"required":["season","min_games","sort_by"],"additionalProperties":false}},"required":["goalies","count","filters"],"additionalProperties":false}},"required":["data"]}}}},"400":{"description":"Invalid arguments.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}},"required":["error"]}}}},"401":{"description":"Missing or invalid API key.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}},"required":["error"]}}}},"402":{"description":"Not enough credits.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}},"required":["error"]}}}},"429":{"description":"Rate limited.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}},"required":["error"]}}}}}}},"/v1/get_skater_season_stats":{"post":{"operationId":"get_skater_season_stats","summary":"Skater season stats","description":"Use when ranking skaters or comparing scoring. Returns a leaderboard sorted by points, goals, assists, plus/minus, or shots, with a games-played filter. Includes power play and shorthanded production, shooting%, faceoff%, and average time on ice. Seasons from 2010-11 on. Costs 5 credits.","tags":["Stats + aggregation"],"x-credits":5,"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"team":{"description":"Filter by team abbreviation","type":"string"},"season":{"description":"Season ID, 8-digit (e.g. 20242025 for 2024-25). 2024-25 and 2024-2025 also accepted. Defaults to the most recent season with stats, which is the current season once it is under way and the previous one before that. The season actually used is echoed in filters.season.","type":"string"},"min_games":{"description":"Minimum games played (default 10)","type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"sort_by":{"description":"Sort metric (default points)","type":"string","enum":["points","goals","assists","plus_minus","shots"]},"limit":{"description":"Max results (default 20)","type":"integer","minimum":1,"maximum":50},"league":{"description":"League. Defaults to nhl. One of: nhl, pwhl, ohl, whl, qmjhl, echl, ahl, ushl.","type":"string","enum":["nhl","pwhl","ohl","whl","qmjhl","echl","ahl","ushl"]}},"additionalProperties":false}}}},"responses":{"200":{"description":"The result, wrapped in data.","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"skaters":{"type":"array","items":{"type":"object","properties":{"playerId":{"type":"number"},"playerName":{"type":"string"},"team":{"type":["string","null"]},"teamName":{"type":["string","null"]},"position":{"type":["string","null"]},"gamesPlayed":{"type":["number","null"]},"goals":{"type":["number","null"]},"assists":{"type":["number","null"]},"points":{"type":["number","null"]},"plusMinus":{"type":["number","null"]},"pim":{"type":["number","null"]},"powerPlayGoals":{"type":["number","null"]},"powerPlayPoints":{"type":["number","null"]},"shorthandedGoals":{"type":["number","null"]},"shorthandedPoints":{"type":["number","null"]},"gameWinningGoals":{"type":["number","null"]},"otGoals":{"type":["number","null"]},"shots":{"type":["number","null"]},"shootingPct":{"type":["number","null"]},"faceoffPct":{"type":["number","null"]},"avgToiPerGame":{"type":["number","null"]},"snapshotDate":{"type":["string","null"]}},"required":["playerId","playerName","team","teamName","position","gamesPlayed","goals","assists","points","plusMinus","pim","powerPlayGoals","powerPlayPoints","shorthandedGoals","shorthandedPoints","gameWinningGoals","otGoals","shots","shootingPct","faceoffPct","avgToiPerGame","snapshotDate"],"additionalProperties":false}},"count":{"type":"number"},"filters":{"type":"object","properties":{"season":{"type":["string","null"]},"min_games":{"type":"number"},"sort_by":{"type":"string"}},"required":["season","min_games","sort_by"],"additionalProperties":false}},"required":["skaters","count","filters"],"additionalProperties":false}},"required":["data"]}}}},"400":{"description":"Invalid arguments.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}},"required":["error"]}}}},"401":{"description":"Missing or invalid API key.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}},"required":["error"]}}}},"402":{"description":"Not enough credits.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}},"required":["error"]}}}},"429":{"description":"Rate limited.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}},"required":["error"]}}}}}}},"/v1/get_player_game_log":{"post":{"operationId":"get_player_game_log","summary":"Player game log","description":"Use when you need a player's game-by-game stat lines for a season, not a season total. For skaters: date, opponent, home/away, goals, assists, points, shots, PIM and power-play points for each game. For goalies: date, opponent, home/away, decision, shots against, saves, goals against and save% for each game. Built from play-by-play, so time on ice and plus/minus are not available and come back null; goalie time on ice is available only for games the goalie started. Requires player ID from search_players. Costs 5 credits.","tags":["Stats + aggregation"],"x-credits":5,"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"player_id":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"NHL player ID"},"season":{"description":"Season ID, 8-digit (e.g. 20242025 for 2024-25). 2024-25 and 2024-2025 also accepted. Defaults to the most recent season with stats for this player, which is the current season once it is under way and the previous one before that. The season actually used is echoed back in the response.","type":"string"},"game_type":{"description":"Which games to include: regular, playoff, preseason, or all. Defaults to regular, matching every other stats tool.","type":"string","enum":["regular","playoff","preseason","all"]},"limit":{"description":"Max games to return (default 100)","type":"integer","minimum":1,"maximum":200},"offset":{"description":"Pagination offset","type":"integer","minimum":0,"maximum":9007199254740991},"league":{"description":"League. Defaults to nhl. One of: nhl, pwhl, ohl, whl, qmjhl, echl, ahl, ushl.","type":"string","enum":["nhl","pwhl","ohl","whl","qmjhl","echl","ahl","ushl"]}},"required":["player_id"],"additionalProperties":false}}}},"responses":{"200":{"description":"The result, wrapped in data.","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"player":{"type":"object","properties":{"id":{"type":"number"},"name":{"type":"string"},"position":{"type":["string","null"]}},"required":["id","name","position"],"additionalProperties":false},"games":{"type":"array","items":{"type":"object","properties":{"gameId":{"type":"string"},"gameDate":{"type":["string","null"]},"gameType":{"type":["string","null"]},"team":{"type":["string","null"]},"opponent":{"type":["string","null"]},"homeAway":{"anyOf":[{"type":"string","enum":["home","away"]},{"type":"null"}]},"goals":{"type":["number","null"]},"assists":{"type":["number","null"]},"points":{"type":["number","null"]},"shots":{"type":["number","null"]},"pim":{"type":["number","null"]},"ppPoints":{"type":["number","null"]},"plusMinus":{"type":["number","null"]},"decision":{"anyOf":[{"type":"string","enum":["win","loss"]},{"type":"null"}]},"shotsAgainst":{"type":["number","null"]},"saves":{"type":["number","null"]},"goalsAgainst":{"type":["number","null"]},"savePct":{"type":["number","null"]},"timeOnIce":{"type":["number","null"]}},"required":["gameId","gameDate","gameType","team","opponent","homeAway","goals","assists","points","shots","pim","ppPoints","plusMinus","decision","shotsAgainst","saves","goalsAgainst","savePct","timeOnIce"],"additionalProperties":false}},"count":{"type":"number"},"season":{"type":["string","null"]},"game_type":{"type":"string"},"note":{"type":"string"},"next_offset":{"type":["number","null"]}},"required":["player","games","count","season","game_type","next_offset"],"additionalProperties":false}},"required":["data"]}}}},"400":{"description":"Invalid arguments.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}},"required":["error"]}}}},"401":{"description":"Missing or invalid API key.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}},"required":["error"]}}}},"402":{"description":"Not enough credits.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}},"required":["error"]}}}},"429":{"description":"Rate limited.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}},"required":["error"]}}}}}}},"/v1/get_odds":{"post":{"operationId":"get_odds","summary":"Odds","description":"Use when checking betting lines. Pass game_id for one game (10 credits): moneyline, puck line and total by bookmaker, opening and closing. Or pass season (optionally with team) for a whole season of closing lines in one call, with final scores, at 10 credits per game returned (a full season is ~13,700 credits, a team-season ~820), 100 games a page by default (up to 500). Each book's line is an array in the order given by columns. Set estimate_only to get the price without being charged. Every game from 2019-20 on (and part of the 2019 playoffs): about 16 to 18 books a game from 2020-21 to 2023-24, about 6 in 2019-20, 8 in 2024-25 and 2025-26 (60+ on about 300 games in 2025-26), with all_books; a season answer defaults to the four main books. A season those four do not carry (2019-20) returns every book it has. Each line says its source: the_odds_api (our Odds API pulls, from August 2020) or espn (ESPN's per-book lines); a season answer lists each game's sources.","tags":["Multi-table"],"x-credits":10,"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"game_id":{"description":"NHL game ID (e.g. 2025020887). Omit and pass season for a whole season.","type":"string"},"season":{"description":"Season for a whole season of lines, e.g. 2025-26 or 20252026. Used when game_id is not set.","type":"string"},"team":{"description":"With season: only this team's games (abbreviation, e.g. BUF).","type":"string"},"bookmaker":{"description":"Filter by bookmaker key (e.g. draftkings, fanduel, betmgm). Lowercase.","type":"string"},"snapshot_type":{"description":"opening (game-day morning; for a game not yet played, the latest morning line) or closing (final pre-game). Single game: default both. Season: default closing.","type":"string","enum":["opening","closing"]},"all_books":{"description":"With season: every book held (16 to 18 a game from 2020-21 to 2023-24, 8 in 2024-25, more than 60 on about 300 games in 2025-26) instead of DraftKings, FanDuel, BetMGM and ESPN BET.","type":"boolean"},"limit":{"description":"With season: games per page (default 100, max 500).","type":"integer","minimum":1,"maximum":500},"offset":{"description":"With season: page offset; use next_offset from the previous page.","type":"integer","minimum":0,"maximum":9007199254740991},"estimate_only":{"description":"Return what this call would cost, without charging or running it.","type":"boolean"}},"additionalProperties":false}}}},"responses":{"200":{"description":"The result, wrapped in data.","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"game_id":{"type":"string"},"home_team":{"type":"string"},"away_team":{"type":"string"},"game_date":{"type":["string","null"]},"odds":{"type":"array","items":{"type":"object","properties":{"bookmaker":{"type":"string"},"snapshotType":{"type":["string","null"]},"source":{"type":["string","null"]},"mlHome":{"type":["number","null"]},"mlAway":{"type":["number","null"]},"mlHomeProb":{"type":["number","null"]},"mlAwayProb":{"type":["number","null"]},"spreadHome":{"type":["number","null"]},"spreadHomeOdds":{"type":["number","null"]},"spreadAway":{"type":["number","null"]},"spreadAwayOdds":{"type":["number","null"]},"total":{"type":["number","null"]},"totalOverOdds":{"type":["number","null"]},"totalUnderOdds":{"type":["number","null"]},"capturedAt":{"type":["string","null"]}},"required":["bookmaker","snapshotType","source","mlHome","mlAway","mlHomeProb","mlAwayProb","spreadHome","spreadHomeOdds","spreadAway","spreadAwayOdds","total","totalOverOdds","totalUnderOdds","capturedAt"],"additionalProperties":false}},"bookmaker_count":{"type":"number"},"season":{"type":"string"},"games":{"type":"array","items":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}},"count":{"type":"number"},"total_games":{"type":"number"},"next_offset":{"type":["number","null"]},"credits_per_game":{"type":"number"},"snapshot_type":{"type":"string"},"columns":{"type":"array","items":{"type":"string"}},"estimate_only":{"type":"boolean"},"tool":{"type":"string"},"credits":{"type":"number"},"note":{"type":"string"}},"additionalProperties":false}},"required":["data"]}}}},"400":{"description":"Invalid arguments.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}},"required":["error"]}}}},"401":{"description":"Missing or invalid API key.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}},"required":["error"]}}}},"402":{"description":"Not enough credits.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}},"required":["error"]}}}},"429":{"description":"Rate limited.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}},"required":["error"]}}}}}}},"/v1/get_line_movement":{"post":{"operationId":"get_line_movement","summary":"Line movement","description":"Use when analyzing how betting lines moved over time. Returns time-series snapshots grouped by bookmaker. Most expensive tool (25 cr). If you only need current lines, use get_odds (10 cr) instead.","tags":["Time-series"],"x-credits":25,"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"game_id":{"type":"string","description":"NHL game ID"},"bookmaker":{"description":"Filter by specific bookmaker key (lowercase)","type":"string"}},"required":["game_id"],"additionalProperties":false}}}},"responses":{"200":{"description":"The result, wrapped in data.","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"game_id":{"type":"string"},"home_team":{"type":"string"},"away_team":{"type":"string"},"movement":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"array","items":{"type":"object","properties":{"bookmaker":{"type":"string"},"snapshotType":{"type":["string","null"]},"source":{"type":["string","null"]},"mlHome":{"type":["number","null"]},"mlAway":{"type":["number","null"]},"spreadHome":{"type":["number","null"]},"total":{"type":["number","null"]},"capturedAt":{"type":["string","null"]}},"required":["bookmaker","snapshotType","mlHome","mlAway","spreadHome","total","capturedAt"],"additionalProperties":false}}}},"required":["game_id","home_team","away_team","movement"],"additionalProperties":false}},"required":["data"]}}}},"400":{"description":"Invalid arguments.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}},"required":["error"]}}}},"401":{"description":"Missing or invalid API key.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}},"required":["error"]}}}},"402":{"description":"Not enough credits.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}},"required":["error"]}}}},"429":{"description":"Rate limited.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}},"required":["error"]}}}}}}},"/v1/get_player_props":{"post":{"operationId":"get_player_props","summary":"Player props","description":"Use for player prop lines by sportsbook: over/under on points, goals, assists, shots on goal, blocked shots, goalie saves and anytime goal scorer, from May 2023 (DraftKings, FanDuel, BetMGM, ESPN BET, Pinnacle and others). Pass game_id for every player's props in one game (10 credits), or player_id with from_date (and to_date) for one player across games (10 credits per game returned, up to 100). Returns the closing line by default (the last before the game starts) or the opening line, with each book's over and under prices. Set estimate_only to get the price without being charged.","tags":["Multi-table"],"x-credits":10,"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"game_id":{"description":"Game id: every player's props for that game.","type":"string"},"player_id":{"description":"Player id (e.g. 8478402) from search_players. With from_date: that player's props across games.","type":["number","string"]},"from_date":{"description":"With player_id: first date, YYYY-MM-DD (the game's date).","type":"string"},"to_date":{"description":"With player_id: last date (default: no end), YYYY-MM-DD (the game's date).","type":"string"},"market":{"description":"One market: player_points (points), player_goals (goals), player_assists (assists), player_shots_on_goal (shots on goal), player_blocked_shots (blocked shots), player_total_saves (goalie saves), player_goal_scorer_anytime (anytime goal scorer (over = scores))","type":"string","enum":["player_points","player_goals","player_assists","player_shots_on_goal","player_blocked_shots","player_total_saves","player_goal_scorer_anytime"]},"bookmaker":{"description":"Bookmaker key, e.g. draftkings, fanduel, pinnacle.","type":"string"},"snapshot_type":{"description":"closing (default): the last line before the game starts. opening: the first one captured.","type":"string","enum":["opening","closing"]},"estimate_only":{"description":"Return what this call would cost, without charging or running it.","type":"boolean"}},"additionalProperties":false}}}},"responses":{"200":{"description":"The result, wrapped in data.","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"snapshot_type":{"type":"string"},"games":{"type":"number"},"props":{"type":"array","items":{"type":"object","properties":{"game_id":{"type":"string"},"game_date":{"type":["string","null"]},"player_name":{"type":"string"},"player_id":{"type":["string","number","null"]},"market":{"type":"string"},"bookmaker":{"type":"string"},"line":{"type":["number","null"]},"over_odds":{"type":["number","null"]},"under_odds":{"type":["number","null"]},"captured_at":{"type":"string"},"source":{"type":"string"}},"required":["game_id","game_date","player_name","player_id","market","bookmaker","line","over_odds","under_odds","captured_at","source"],"additionalProperties":false}},"count":{"type":"number"},"credits_per_game":{"type":"number"},"next_from_date":{"type":["string","null"]},"note":{"type":"string"},"estimate_only":{"type":"boolean"},"tool":{"type":"string"},"credits":{"type":"number"}},"additionalProperties":false}},"required":["data"]}}}},"400":{"description":"Invalid arguments.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}},"required":["error"]}}}},"401":{"description":"Missing or invalid API key.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}},"required":["error"]}}}},"402":{"description":"Not enough credits.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}},"required":["error"]}}}},"429":{"description":"Rate limited.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}},"required":["error"]}}}}}}},"/v1/get_prop_history":{"post":{"operationId":"get_prop_history","summary":"Prop history","description":"Use to see how a player did against his prop line over time: for one market (points, goals, assists, shots on goal, blocked shots, goalie saves or anytime goal scorer), one row per game with the closing line (the median across books, or one book's), the opening line, the prices, what the player actually recorded from our box scores and the result against the line, plus the over rate. Costs 10 credits for up to 200 games.","tags":["Multi-table"],"x-credits":10,"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"player_id":{"description":"Player id (e.g. 8478402) from search_players.","type":["number","string"]},"market":{"type":"string","enum":["player_points","player_goals","player_assists","player_shots_on_goal","player_blocked_shots","player_total_saves","player_goal_scorer_anytime"],"description":"The market: player_points (points), player_goals (goals), player_assists (assists), player_shots_on_goal (shots on goal), player_blocked_shots (blocked shots), player_total_saves (goalie saves), player_goal_scorer_anytime (anytime goal scorer (over = scores))"},"from_date":{"description":"First date, YYYY-MM-DD (the game's date).","type":"string"},"to_date":{"description":"Last date, YYYY-MM-DD (the game's date).","type":"string"},"bookmaker":{"description":"One book's closing line instead of the median across books, e.g. draftkings.","type":"string"},"limit":{"description":"Games to return, oldest first (default 50, max 200). next_from_date says where to continue.","type":"integer","minimum":1,"maximum":200}},"required":["player_id","market"],"additionalProperties":false}}}},"responses":{"200":{"description":"The result, wrapped in data.","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"player_id":{"type":["string","number"]},"player_name":{"type":["string","null"]},"market":{"type":"string"},"stat":{"type":"string"},"bookmaker":{"type":["string","null"]},"games":{"type":"array","items":{"type":"object","properties":{"game_id":{"type":"string"},"game_date":{"type":["string","null"]},"line":{"type":["number","null"]},"open_line":{"type":["number","null"]},"over_odds":{"type":["number","null"]},"under_odds":{"type":["number","null"]},"books":{"type":"number"},"actual":{"type":["number","null"]},"result":{"anyOf":[{"type":"string","enum":["over","under","push"]},{"type":"null"}]},"margin":{"type":["number","null"]}},"required":["game_id","game_date","line","open_line","over_odds","under_odds","books","actual","result","margin"],"additionalProperties":false}},"count":{"type":"number"},"summary":{"type":"object","properties":{"games":{"type":"number"},"graded":{"type":"number"},"overs":{"type":"number"},"unders":{"type":"number"},"pushes":{"type":"number"},"over_rate":{"type":["number","null"]},"avg_line":{"type":["number","null"]},"avg_actual":{"type":["number","null"]}},"required":["games","graded","overs","unders","pushes","over_rate","avg_line","avg_actual"],"additionalProperties":false},"truncated":{"type":"boolean"},"next_from_date":{"type":["string","null"]},"note":{"type":"string"},"estimate_only":{"type":"boolean"},"tool":{"type":"string"},"credits":{"type":"number"}},"required":["player_id","player_name","market","stat","bookmaker","games","count","summary"],"additionalProperties":false}},"required":["data"]}}}},"400":{"description":"Invalid arguments.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}},"required":["error"]}}}},"401":{"description":"Missing or invalid API key.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}},"required":["error"]}}}},"402":{"description":"Not enough credits.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}},"required":["error"]}}}},"429":{"description":"Rate limited.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}},"required":["error"]}}}}}}},"/v1/get_plays":{"post":{"operationId":"get_plays","summary":"Plays","description":"Use for play-by-play events: goals, shots, misses, blocks, faceoffs, hits, giveaways, takeaways, penalties, with rink coordinates, strength state (5v5, 5v4), zone, and the players involved. Filter by game, season, team, player (any role), event type, strength, zone, or period. Requires at least one of game_id, season or player_id. Paginate with offset. Costs 10 credits.","tags":["Multi-table"],"x-credits":10,"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"game_id":{"description":"NHL game ID (e.g. 2025020887)","type":"string"},"season":{"description":"Season ID, 8-digit (e.g. 20242025).","type":"string"},"team":{"description":"Team abbreviation that owns the event (e.g. BUF)","type":"string"},"player_id":{"description":"NHL player ID; matches the player in any role on the event","type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"type":{"description":"Event type","type":"string","enum":["goal","shot-on-goal","missed-shot","blocked-shot","faceoff","hit","giveaway","takeaway","penalty","delayed-penalty","stoppage","period-start","period-end","game-end","shootout-complete","failed-shot-attempt"]},"strength":{"description":"Skater strength from the event owner's view, e.g. 5v5, 5v4, 4v5","type":"string"},"zone":{"description":"Zone: O offensive, N neutral, D defensive","type":"string","enum":["O","N","D"]},"period":{"description":"Period number (4+ is overtime)","type":"integer","minimum":1,"maximum":10},"shot_attempts_only":{"description":"Only goals, shots on goal, missed shots and blocked shots (Corsi events)","type":"boolean"},"limit":{"description":"Max events (default 200)","type":"integer","minimum":1,"maximum":1000},"offset":{"description":"Pagination offset","type":"integer","minimum":0,"maximum":9007199254740991},"league":{"description":"League. Defaults to nhl. One of: nhl, pwhl, ohl, whl, qmjhl, echl, ahl, ushl.","type":"string","enum":["nhl","pwhl","ohl","whl","qmjhl","echl","ahl","ushl"]}},"additionalProperties":false}}}},"responses":{"200":{"description":"The result, wrapped in data.","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"plays":{"type":"array","items":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}},"summary":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}},"count":{"type":"number"},"next_offset":{"type":["number","null"]}},"required":["plays","summary","count","next_offset"],"additionalProperties":false}},"required":["data"]}}}},"400":{"description":"Invalid arguments.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}},"required":["error"]}}}},"401":{"description":"Missing or invalid API key.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}},"required":["error"]}}}},"402":{"description":"Not enough credits.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}},"required":["error"]}}}},"429":{"description":"Rate limited.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}},"required":["error"]}}}}}}},"/v1/get_shot_map":{"post":{"operationId":"get_shot_map","summary":"Shot map","description":"Use when you want shot locations rather than a list of events: every shot attempt with rink coordinates, shot type, strength, shooter and goalie. Filter by game, or by season plus a team or player. Paginated: follow next_offset, since a season runs past one page and pages are chronological. Costs 10 credits.","tags":["Multi-table"],"x-credits":10,"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"game_id":{"description":"NHL game ID","type":"string"},"season":{"description":"Season ID, 8-digit (e.g. 20242025); use with team","type":"string"},"team":{"description":"Team abbreviation; use with season","type":"string"},"player_id":{"description":"NHL player ID of the shooter","type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"strength":{"description":"Strength filter, e.g. 5v5","type":"string"},"limit":{"description":"Max shots per page (default 1000)","type":"integer","minimum":1,"maximum":2000},"offset":{"description":"Pagination offset; follow next_offset for a full season","type":"integer","minimum":0,"maximum":9007199254740991},"league":{"description":"League. Defaults to nhl. One of: nhl, pwhl, ohl, qmjhl, echl, ahl.","type":"string","enum":["nhl","pwhl","ohl","qmjhl","echl","ahl"]}},"additionalProperties":false}}}},"responses":{"200":{"description":"The result, wrapped in data.","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"shots":{"type":"array","items":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}},"summary":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}},"count":{"type":"number"},"next_offset":{"type":["number","null"]}},"required":["shots","summary","count","next_offset"],"additionalProperties":false}},"required":["data"]}}}},"400":{"description":"Invalid arguments.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}},"required":["error"]}}}},"401":{"description":"Missing or invalid API key.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}},"required":["error"]}}}},"402":{"description":"Not enough credits.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}},"required":["error"]}}}},"429":{"description":"Rate limited.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}},"required":["error"]}}}}}}},"/v1/get_shifts":{"post":{"operationId":"get_shifts","summary":"Shifts","description":"Use for who was on the ice and when: every player's shifts in one NHL game, each with period, start and end (period clock and seconds from the opening faceoff) and duration, plus the official boxscore time on ice and plus/minus. Filter to one team or player. NHL games from 2010-11 on. Costs 10 credits.","tags":["Multi-table"],"x-credits":10,"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"game_id":{"type":"string","description":"NHL game ID, 10 digits (e.g. 2026020084)"},"team":{"description":"Only this team's players, by abbreviation (e.g. WSH)","type":"string"},"player_id":{"description":"Only this player, by NHL player ID","type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["game_id"],"additionalProperties":false}}}},"responses":{"200":{"description":"The result, wrapped in data.","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"game_id":{"type":"string"},"game_date":{"type":["string","null"]},"home_team":{"type":"string"},"away_team":{"type":"string"},"players":{"type":"array","items":{"type":"object","properties":{"player_id":{"type":"number"},"name":{"type":["string","null"]},"position":{"type":["string","null"]},"team":{"type":"string"},"home_away":{"type":"string","enum":["home","away"]},"goalie":{"type":"boolean"},"shift_count":{"type":"number"},"shift_seconds":{"type":"number"},"official_toi_seconds":{"type":["number","null"]},"plus_minus":{"type":["number","null"]},"shifts":{"type":"array","items":{"type":"object","properties":{"period":{"type":"number"},"start":{"type":"string"},"end":{"type":"string"},"start_seconds":{"type":"number"},"end_seconds":{"type":"number"},"duration_seconds":{"type":"number"}},"required":["period","start","end","start_seconds","end_seconds","duration_seconds"],"additionalProperties":false}}},"required":["player_id","name","position","team","home_away","goalie","shift_count","shift_seconds","official_toi_seconds","plus_minus","shifts"],"additionalProperties":false}},"count":{"type":"number"},"dropped_shifts":{"type":"number"},"source":{"type":["string","null"]},"note":{"type":"string"}},"required":["game_id","players","count"],"additionalProperties":false}},"required":["data"]}}}},"400":{"description":"Invalid arguments.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}},"required":["error"]}}}},"401":{"description":"Missing or invalid API key.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}},"required":["error"]}}}},"402":{"description":"Not enough credits.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}},"required":["error"]}}}},"429":{"description":"Rate limited.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}},"required":["error"]}}}}}}},"/v1/get_situation_time":{"post":{"operationId":"get_situation_time","summary":"Situation time","description":"Use for exact time at each strength: the seconds each team spent at 5v5, 5v4, 4v5, 4v4, 6v5 with the goalie pulled and every other on-ice state in an NHL game, split into regulation and overtime, from the shift charts. Also even / power-play / shorthanded totals, goalie-pulled seconds, period lengths and a completeness check against the play-by-play. include_players adds each skater's time by strength. One game by game_id (10 credits), or every game on a date (10 credits per game). NHL games from 2010-11 on.","tags":["Multi-table"],"x-credits":10,"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"game_id":{"description":"NHL game ID, 10 digits (e.g. 2026020084)","type":"string"},"date":{"description":"Every game played on this date, YYYY-MM-DD (instead of game_id)","type":"string"},"include_players":{"description":"Add each skater's seconds by strength (default false)","type":"boolean"}},"additionalProperties":false}}}},"responses":{"200":{"description":"The result, wrapped in data.","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"games":{"type":"array","items":{"type":"object","properties":{"game_id":{"type":"string"},"game_date":{"type":["string","null"]},"game_type":{"type":"string"},"home_team":{"type":"string"},"away_team":{"type":"string"},"teams":{"type":"array","items":{"type":"object","properties":{"team":{"type":"string"},"home_away":{"type":"string","enum":["home","away"]},"states":{"type":"array","items":{"type":"object","properties":{"strength":{"type":"string"},"skaters":{"type":"number"},"opponent_skaters":{"type":"number"},"goalie_in":{"type":"boolean"},"opponent_goalie_in":{"type":"boolean"},"regulation_seconds":{"type":"number"},"overtime_seconds":{"type":"number"}},"required":["strength","skaters","opponent_skaters","goalie_in","opponent_goalie_in","regulation_seconds","overtime_seconds"],"additionalProperties":false}},"even_seconds":{"type":"number"},"power_play_seconds":{"type":"number"},"shorthanded_seconds":{"type":"number"},"goalie_pulled_seconds":{"type":"number"},"opponent_goalie_pulled_seconds":{"type":"number"}},"required":["team","home_away","states","even_seconds","power_play_seconds","shorthanded_seconds","goalie_pulled_seconds","opponent_goalie_pulled_seconds"],"additionalProperties":false}},"periods":{"type":"array","items":{"type":"object","properties":{"period":{"type":"number"},"length_seconds":{"type":"number"},"unresolved_seconds":{"type":"number"}},"required":["period","length_seconds","unresolved_seconds"],"additionalProperties":false}},"completeness":{"type":"object","properties":{"unresolved_seconds":{"type":"number"},"dropped_shifts":{"type":"number"},"source":{"type":["string","null"]},"regulation_periods_full":{"type":"boolean"},"events_compared":{"type":"number"},"events_agreeing":{"type":"number"},"complete":{"type":"boolean"}},"required":["unresolved_seconds","dropped_shifts","source","regulation_periods_full","events_compared","events_agreeing","complete"],"additionalProperties":false},"players":{"type":"array","items":{"type":"object","properties":{"player_id":{"type":"number"},"name":{"type":["string","null"]},"team":{"type":"string"},"toi_seconds":{"type":"number"},"even_seconds":{"type":"number"},"power_play_seconds":{"type":"number"},"shorthanded_seconds":{"type":"number"},"unresolved_seconds":{"type":"number"},"by_strength":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"number"}}},"required":["player_id","name","team","toi_seconds"],"additionalProperties":false}}},"required":["game_id","game_date","game_type","home_team","away_team","teams","periods","completeness"],"additionalProperties":false}},"count":{"type":"number"},"credits_per_game":{"type":"number"},"note":{"type":"string"}},"required":["games","count"],"additionalProperties":false}},"required":["data"]}}}},"400":{"description":"Invalid arguments.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}},"required":["error"]}}}},"401":{"description":"Missing or invalid API key.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}},"required":["error"]}}}},"402":{"description":"Not enough credits.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}},"required":["error"]}}}},"429":{"description":"Rate limited.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}},"required":["error"]}}}}}}}}}