openapi: 3.1.0
info:
title: MLB MLB v3 Headshots NHL v3 Scores API
version: '1.0'
description: MLB API - OpenAPI 3.1 Specification
servers:
- url: https://api.sportsdata.io
description: Production server
security:
- apiKeyHeader: []
- apiKeyQuery: []
tags:
- name: NHL v3 Scores
paths:
/v3/nhl/scores/{format}/Players:
get:
description: Full player bio and details, including injury notes, for all active players.
operationId: nhl_v3_scores_player_details___by_active
summary: Player Details - by Active
parameters:
- name: format
in: path
description: Desired response format. Valid entries are <code>JSON</code> or <code>XML</code>.
required: true
schema:
type: string
enum:
- JSON
- XML
default: JSON
responses:
'200':
description: Success
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Player'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/Unauthorized'
tags:
- NHL v3 Scores
/v3/nhl/scores/{format}/teams:
get:
description: 'Full team information: team name and city, conference and division, and colors. Also contains basic fantasy info such as IDs as well as full stadium data. This endpoint returns the teams currently active in the league.'
operationId: nhl_v3_scores_team_profiles___by_active
summary: Team Profiles - by Active
parameters:
- name: format
in: path
description: Desired response format. Valid entries are <code>JSON</code> or <code>XML</code>.
required: true
schema:
type: string
enum:
- JSON
- XML
default: JSON
responses:
'200':
description: Success
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Team'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/Unauthorized'
tags:
- NHL v3 Scores
/v3/nhl/scores/{format}/AreAnyGamesInProgress:
get:
description: Returns <code>true</code> if there is at least one game being played at the time of the request or <code>false</code> if there are none.
operationId: nhl_v3_scores_are_games_in_progress
summary: Are Games In Progress
parameters:
- name: format
in: path
description: Desired response format. Valid entries are <code>JSON</code> or <code>XML</code>.
required: true
schema:
type: string
enum:
- JSON
- XML
default: JSON
responses:
'200':
description: Success
content:
application/json:
schema:
type: boolean
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/Unauthorized'
tags:
- NHL v3 Scores
/v3/nhl/scores/{format}/FreeAgents:
get:
description: Full player bio and details, including injury notes, for all available free agents unattached to a team.
operationId: nhl_v3_scores_player_details___by_free_agents
summary: Player Details - by Free Agents
parameters:
- name: format
in: path
description: Desired response format. Valid entries are <code>JSON</code> or <code>XML</code>.
required: true
schema:
type: string
enum:
- JSON
- XML
default: JSON
responses:
'200':
description: Success
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Player'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/Unauthorized'
tags:
- NHL v3 Scores
/v3/nhl/scores/{format}/GamesByDate/{date}:
get:
description: Full scores and gameday info delivered live and post-game. Live data includes half and score info. Gameday info includes TV channel etc
operationId: nhl_v3_scores_games___by_date__live___final
summary: Games - by Date [Live & Final]
parameters:
- name: format
in: path
description: Desired response format. Valid entries are <code>JSON</code> or <code>XML</code>.
required: true
schema:
type: string
enum:
- JSON
- XML
default: JSON
- name: date
in: path
description: "The date of the game(s).\n <br>Examples: <code>2018-JAN-31</code>, <code>2017-OCT-01</code>.\n "
required: true
schema:
type: string
responses:
'200':
description: Success
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Game'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/Unauthorized'
tags:
- NHL v3 Scores
/v3/nhl/scores/{format}/Games/{season}:
get:
description: Home and away teams, date and time, season type and week etc. are included. Also includes gameday information. This includes full stadium information (capacity, lat/long, surface etc.), top-line betting information (spread, moneyline, total), weather conditions, and broadcast information.
operationId: nhl_v3_scores_schedules
summary: Schedules
parameters:
- name: format
in: path
description: Desired response format. Valid entries are <code>JSON</code> or <code>XML</code>.
required: true
schema:
type: string
enum:
- JSON
- XML
default: JSON
- name: season
in: path
description: 'Year of the season (with optional season type).<br>Examples: <code>2018</code>, <code>2018PRE</code>, <code>2018POST</code>, <code>2018STAR</code>, <code>2019</code>, etc.'
required: true
schema:
type: string
responses:
'200':
description: Success
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Game'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/Unauthorized'
tags:
- NHL v3 Scores
/v3/nhl/scores/{format}/News:
get:
description: Basic RotoBaller news feed, with limited stories available.
operationId: nhl_v3_scores_news
summary: News
parameters:
- name: format
in: path
description: Desired response format. Valid entries are <code>JSON</code> or <code>XML</code>.
required: true
schema:
type: string
enum:
- JSON
- XML
default: JSON
responses:
'200':
description: Success
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/News'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/Unauthorized'
tags:
- NHL v3 Scores
/v3/nhl/scores/{format}/NewsByDate/{date}:
get:
description: Basic RotoBaller news feed, with limited stories available, called by date.
operationId: nhl_v3_scores_news___by_date
summary: News - by Date
parameters:
- name: format
in: path
description: Desired response format. Valid entries are <code>JSON</code> or <code>XML</code>.
required: true
schema:
type: string
enum:
- JSON
- XML
default: JSON
- name: date
in: path
description: "The date of the news.\n <br>Examples: <code>2018-JAN-31</code>, <code>2017-OCT-01</code>.\n "
required: true
schema:
type: string
responses:
'200':
description: Success
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/News'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/Unauthorized'
tags:
- NHL v3 Scores
/v3/nhl/scores/{format}/NewsByPlayerID/{playerid}:
get:
description: Basic RotoBaller news feed, with limited stories available, called by player.
operationId: nhl_v3_scores_news___by_player
summary: News - by Player
parameters:
- name: format
in: path
description: Desired response format. Valid entries are <code>JSON</code> or <code>XML</code>.
required: true
schema:
type: string
enum:
- JSON
- XML
default: JSON
- name: playerid
in: path
description: "Unique FantasyData Player ID.\n Example:<code>10000507</code>.\n "
required: true
schema:
type: string
responses:
'200':
description: Success
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/News'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/Unauthorized'
tags:
- NHL v3 Scores
/v3/nhl/scores/{format}/Players/{team}:
get:
description: Full player bio and details, including injury notes, for all players on a given team.
operationId: nhl_v3_scores_players_details___by_team
summary: Players Details - by Team
parameters:
- name: format
in: path
description: Desired response format. Valid entries are <code>JSON</code> or <code>XML</code>.
required: true
schema:
type: string
enum:
- JSON
- XML
default: JSON
- name: team
in: path
description: "The abbreviation of the requested team.\n <br>Examples: <code>SF</code>, <code>NYY</code>.\n "
required: true
schema:
type: string
responses:
'200':
description: Success
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Player'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/Unauthorized'
tags:
- NHL v3 Scores
/v3/nhl/scores/{format}/Stadiums:
get:
description: Returns all stadiums in the league with capacity, surface, latitude/longitude, city and state (and where applicable country.)
operationId: nhl_v3_scores_stadiums
summary: Stadiums
parameters:
- name: format
in: path
description: Desired response format. Valid entries are <code>JSON</code> or <code>XML</code>.
required: true
schema:
type: string
enum:
- JSON
- XML
default: JSON
responses:
'200':
description: Success
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Stadium'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/Unauthorized'
tags:
- NHL v3 Scores
/v3/nhl/scores/{format}/TeamGameStatsByDate/{date}:
get:
description: Returns the box score statistical record team-wide (aggregated from all players) for all games on a given date, both live and post-game.
operationId: nhl_v3_scores_team_game_stats___by_date__live___final
summary: Team Game Stats - by Date [Live & Final]
parameters:
- name: format
in: path
description: Desired response format. Valid entries are <code>JSON</code> or <code>XML</code>.
required: true
schema:
type: string
enum:
- JSON
- XML
default: JSON
- name: date
in: path
description: "The date of the game(s).\n <br>Examples: <code>2018-JAN-31</code>, <code>2017-OCT-01</code>.\n "
required: true
schema:
type: string
responses:
'200':
description: Success
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/TeamGame'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/Unauthorized'
tags:
- NHL v3 Scores
/v3/nhl/scores/{format}/TeamSeasonStats/{season}:
get:
description: Returns all season-long stats (i.e. the season total, not each individual game record) for all teams (aggregated from all players) for a given season.
operationId: nhl_v3_scores_team_season_stats
summary: Team Season Stats
parameters:
- name: format
in: path
description: Desired response format. Valid entries are <code>JSON</code> or <code>XML</code>.
required: true
schema:
type: string
enum:
- JSON
- XML
default: JSON
- name: season
in: path
description: "Year of the season.\n <br>Examples: <code>2016</code>, <code>2017</code>.\n "
required: true
schema:
type: string
responses:
'200':
description: Success
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/TeamSeason'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/Unauthorized'
tags:
- NHL v3 Scores
/v3/nhl/scores/{format}/CurrentSeason:
get:
description: Year of the current season. This value changes at the start of the new league year. For leagues that run over two years, this is the year the season starts, not ends.
operationId: nhl_v3_scores_season___current
summary: Season - Current
parameters:
- name: format
in: path
description: Desired response format. Valid entries are <code>JSON</code> or <code>XML</code>.
required: true
schema:
type: string
enum:
- JSON
- XML
default: JSON
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/Season'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/Unauthorized'
tags:
- NHL v3 Scores
/v3/nhl/scores/{format}/Standings/{season}:
get:
description: Includes regular season standings in division and conference, from which postseason seeding can be derived.
operationId: nhl_v3_scores_standings
summary: Standings
parameters:
- name: format
in: path
description: Desired response format. Valid entries are <code>JSON</code> or <code>XML</code>.
required: true
schema:
type: string
enum:
- JSON
- XML
default: JSON
- name: season
in: path
description: "Year of the season.\n <br>Examples: <code>2016</code>, <code>2017</code>.\n "
required: true
schema:
type: string
responses:
'200':
description: Success
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Standing'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/Unauthorized'
tags:
- NHL v3 Scores
/v3/nhl/scores/{format}/AllTeams:
get:
description: 'Full team information: team name and city, conference and division, and colors. Also contains basic fantasy info such as IDs as well as full stadium data. This endpoint returns all teams regardless of current active status.'
operationId: nhl_v3_scores_team_profiles___all
summary: Team Profiles - All
parameters:
- name: format
in: path
description: Desired response format. Valid entries are <code>JSON</code> or <code>XML</code>.
required: true
schema:
type: string
enum:
- JSON
- XML
default: JSON
responses:
'200':
description: Success
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Team'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/Unauthorized'
tags:
- NHL v3 Scores
/v3/nhl/scores/{format}/TeamGameStatsBySeason/{season}/{teamid}/{numberofgames}:
get:
description: Game-by-game log of total team statistics for a given season, split up by game (not aggregated into season totals.)
operationId: nhl_v3_scores_team_game_logs___by_season
summary: Team Game Logs - by Season
parameters:
- name: format
in: path
description: Desired response format. Valid entries are <code>JSON</code> or <code>XML</code>.
required: true
schema:
type: string
enum:
- JSON
- XML
default: JSON
- name: season
in: path
description: Season to get games from. Example <code>2019POST</code>, <code>2020</code>
required: true
schema:
type: string
- name: teamid
in: path
description: Unique ID of team. Example <code> 8 </code>
required: true
schema:
type: string
- name: numberofgames
in: path
description: How many games to return. Example <code>all</code>, <code>10</code>, <code>25</code>
required: true
schema:
type: string
responses:
'200':
description: Success
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/TeamGame'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/Unauthorized'
tags:
- NHL v3 Scores
/v3/nhl/scores/{format}/SchedulesBasic/{season}:
get:
description: A lightweight schedule endpoint without gameday information. Home and away teams, the date and time of the game, and season type, week etc. are included. Ideal for the most basic information required to build a schedule.
operationId: nhl_v3_scores_schedules__basic
summary: Schedules (Basic)
parameters:
- name: format
in: path
description: Desired response format. Valid entries are <code>JSON</code> or <code>XML</code>.
required: true
schema:
type: string
enum:
- JSON
- XML
default: JSON
- name: season
in: path
description: 'Year of the season (with optional season type).<br>Examples: <code>2018</code>, <code>2018PRE</code>, <code>2018POST</code>, <code>2018STAR</code>, <code>2019</code>, etc.'
required: true
schema:
type: string
responses:
'200':
description: Success
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/ScheduleBasic'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/Unauthorized'
tags:
- NHL v3 Scores
/v3/nhl/scores/{format}/ScoresBasic/{date}:
get:
description: This endpoint simply delivers period, clock, period score and total score live; no gameday info is included.
operationId: nhl_v3_scores_games__basic____by_date__live___final
summary: Games (Basic) - by Date [Live & Final]
parameters:
- name: format
in: path
description: Desired response format. Valid entries are <code>JSON</code> or <code>XML</code>.
required: true
schema:
type: string
enum:
- JSON
- XML
default: JSON
- name: date
in: path
description: "The date of the game(s).\n <br>Examples: <code>2018-JAN-31</code>, <code>2017-OCT-01</code>.\n "
required: true
schema:
type: string
responses:
'200':
description: Success
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/ScoreBasic'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/Unauthorized'
tags:
- NHL v3 Scores
/v3/nhl/scores/{format}/PlayersBasic/{team}:
get:
description: Roster information for a given team. Player profiles include basic biographical information, position, college, and current team (if attached to a team.) Specify a team tricode parameter to receive all players currently on that team.
operationId: nhl_v3_scores_players_profiles___by_team
summary: Players Profiles - by Team
parameters:
- name: format
in: path
description: Desired response format. Valid entries are <code>JSON</code> or <code>XML</code>.
required: true
schema:
type: string
enum:
- JSON
- XML
default: JSON
- name: team
in: path
description: "The abbreviation of the requested team.\n <br>Examples: <code>SF</code>, <code>NYY</code>.\n "
required: true
schema:
type: string
responses:
'200':
description: Success
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/PlayerBasic'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/Unauthorized'
tags:
- NHL v3 Scores
/v3/nhl/scores/{format}/PlayersByActive:
get:
description: Full player bio and details, including injury notes, for all active players.
operationId: nhl_v3_scores_player_details___by_active2
summary: Player Details - by Active
parameters:
- name: format
in: path
description: Desired response format. Valid entries are <code>JSON</code> or <code>XML</code>.
required: true
schema:
type: string
enum:
- JSON
- XML
default: JSON
responses:
'200':
description: Success
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/PlayerBasic'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/Unauthorized'
tags:
- NHL v3 Scores
/v3/nhl/scores/{format}/PlayersByFreeAgents:
get:
description: Full player bio and details, including injury notes, for all available free agents unattached to a team.
operationId: nhl_v3_scores_player_details___by_free_agents2
summary: Player Details - by Free Agents
parameters:
- name: format
in: path
description: Desired response format. Valid entries are <code>JSON</code> or <code>XML</code>.
required: true
schema:
type: string
enum:
- JSON
- XML
default: JSON
responses:
'200':
description: Success
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/PlayerBasic'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/Unauthorized'
tags:
- NHL v3 Scores
/v3/nhl/scores/{format}/GoalieDepthCharts:
get:
description: Returns the full list of NHL Goalies by Team organized into Depth Charts.
operationId: nhl_v3_scores_depth_charts___goalies
summary: Depth Charts - Goalies
parameters:
- name: format
in: path
description: Desired response format. Valid entries are <code>JSON</code> or <code>XML</code>.
required: true
schema:
type: string
enum:
- JSON
- XML
default: JSON
responses:
'200':
description: Success
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/TeamGoalieDepthChart'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/Unauthorized'
tags:
- NHL v3 Scores
/v3/nhl/scores/{format}/TransactionsByDate/{date}:
get:
description: Transactions, such as injuries and assignments and trades, are organized here by date.
operationId: nhl_v3_scores_transactions
summary: Transactions
parameters:
- name: format
in: path
description: Desired response format. Valid entries are <code>JSON</code> or <code>XML</code>.
required: true
schema:
type: string
enum:
- JSON
- XML
default: JSON
- name: date
in: path
description: "The date of the news.\n <br>Examples: <code>2018-JAN-31</code>, <code>2017-OCT-01</code>.\n "
required: true
schema:
type: string
responses:
'200':
description: Success
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Transaction'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/Unauthorized'
tags:
- NHL v3 Scores
/v3/nhl/scores/{format}/teams/{season}:
get:
description: 'Full team information: team name and city, conference and division, and colors. Also contains basic fantasy info such as IDs as well as full stadium data. This endpoint returns the active teams for a given season.'
operationId: nhl_v3_scores_team_profiles___by_season
summary: Team Profiles - by Season
parameters:
- name: format
in: path
description: Desired response format. Valid entries are <code>JSON</code> or <code>XML</code>.
required: true
schema:
type: string
enum:
- JSON
- XML
default: JSON
- name: season
in: path
description: "Year of the season and the season type. If no season type is provided, then the default is regular season.\n <br>Examples: <code>2015REG</code>, <code>2015PRE</code>, <code>2015POST</code>."
required: true
schema:
type: string
responses:
'200':
description: Success
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Team'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/Unauthorized'
tags:
- NHL v3 Scores
/v3/nhl/scores/{format}/GamesByDateFinal/{date}:
get:
description: Full scores and gameday info, including weather, referee, infotainment odds, as well as all of the period scores and full-time score, delivered as the game ends.
operationId: nhl_v3_scores_games___by_date__final
summary: Games - by Date [Final]
parameters:
- name: format
in: path
description: Desired response format. Valid entries are <code>JSON</code> or <code>XML</code>.
required: true
schema:
type: string
enum:
- JSON
- XML
default: JSON
- name: date
in: path
description: "The date of the game(s).\n <br>Examples: <code>2018-JAN-31</code>, <code>2017-OCT-01</code>.\n "
required: true
schema:
type: string
responses:
'200':
description: Success
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Game'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/Unauthorized'
tags:
- NHL v3 Scores
/v3/nhl/scores/{format}/ScoresBasicFinal/{date}:
get:
description: A slimmed-down score endpoint, giving just the period scores and final score, for simple applications.
operationId: nhl_v3_scores_games__basic____by_date__final
summary: Games (Basic) - by Date [Final]
parameters:
- name: format
in: path
description: Desired response format. Valid entries are <code>JSON</code> or <code>XML</code>.
required: true
schema:
type: string
enum:
- JSON
- XML
default: JSON
- name: date
in: path
description: "The date of the game(s).\n <br>Examples: <code>2018-JAN-31</code>, <code>2017-OCT-01</code>.\n "
required: true
schema:
type: string
responses:
'200':
description: Success
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/ScoreBasic'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/Unauthorized'
tags:
- NHL v3 Scores
/v3/nhl/scores/{format}/Referees:
get:
description: Returns the full list of NHL Referees.
operationId: nhl_v3_scores_referees
summary: Referees
# --- truncated at 32 KB (98 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/sportsdataio/refs/heads/main/openapi/sportsdataio-nhl-v3-scores-api-openapi.yml