{
"openapi": "3.1.0",
"info": {
"title": "NHL API",
"version": "1.0",
"description": "NHL API - OpenAPI 3.1 Specification"
},
"servers": [
{
"url": "https://api.sportsdata.io",
"description": "Production server"
}
],
"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 JSON or XML.",
"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 JSON or XML.",
"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 true if there is at least one game being played at the time of the request or false 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 JSON or XML.",
"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 JSON or XML.",
"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 JSON or XML.",
"required": true,
"schema": {
"type": "string",
"enum": [
"JSON",
"XML"
],
"default": "JSON"
}
},
{
"name": "date",
"in": "path",
"description": "The date of the game(s).\n
Examples: 2018-JAN-31, 2017-OCT-01.\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 JSON or XML.",
"required": true,
"schema": {
"type": "string",
"enum": [
"JSON",
"XML"
],
"default": "JSON"
}
},
{
"name": "season",
"in": "path",
"description": "Year of the season (with optional season type).
Examples: 2018, 2018PRE, 2018POST, 2018STAR, 2019, 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 JSON or XML.",
"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 JSON or XML.",
"required": true,
"schema": {
"type": "string",
"enum": [
"JSON",
"XML"
],
"default": "JSON"
}
},
{
"name": "date",
"in": "path",
"description": "The date of the news.\n
Examples: 2018-JAN-31, 2017-OCT-01.\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 JSON or XML.",
"required": true,
"schema": {
"type": "string",
"enum": [
"JSON",
"XML"
],
"default": "JSON"
}
},
{
"name": "playerid",
"in": "path",
"description": "Unique FantasyData Player ID.\n Example:10000507.\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 JSON or XML.",
"required": true,
"schema": {
"type": "string",
"enum": [
"JSON",
"XML"
],
"default": "JSON"
}
},
{
"name": "team",
"in": "path",
"description": "The abbreviation of the requested team.\n
Examples: SF, NYY.\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 JSON or XML.",
"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 JSON or XML.",
"required": true,
"schema": {
"type": "string",
"enum": [
"JSON",
"XML"
],
"default": "JSON"
}
},
{
"name": "date",
"in": "path",
"description": "The date of the game(s).\n
Examples: 2018-JAN-31, 2017-OCT-01.\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 JSON or XML.",
"required": true,
"schema": {
"type": "string",
"enum": [
"JSON",
"XML"
],
"default": "JSON"
}
},
{
"name": "season",
"in": "path",
"description": "Year of the season.\n
Examples: 2016, 2017.\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 JSON or XML.",
"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 JSON or XML.",
"required": true,
"schema": {
"type": "string",
"enum": [
"JSON",
"XML"
],
"default": "JSON"
}
},
{
"name": "season",
"in": "path",
"description": "Year of the season.\n
Examples: 2016, 2017.\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 JSON or XML.",
"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 JSON or XML.",
"required": true,
"schema": {
"type": "string",
"enum": [
"JSON",
"XML"
],
"default": "JSON"
}
},
{
"name": "season",
"in": "path",
"description": "Season to get games from. Example 2019POST, 2020",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "teamid",
"in": "path",
"description": "Unique ID of team. Example 8 ",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "numberofgames",
"in": "path",
"description": "How many games to return. Example all, 10, 25",
"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 JSON or XML.",
"required": true,
"schema": {
"type": "string",
"enum": [
"JSON",
"XML"
],
"default": "JSON"
}
},
{
"name": "season",
"in": "path",
"description": "Year of the season (with optional season type).
Examples: 2018, 2018PRE, 2018POST, 2018STAR, 2019, 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 JSON or XML.",
"required": true,
"schema": {
"type": "string",
"enum": [
"JSON",
"XML"
],
"default": "JSON"
}
},
{
"name": "date",
"in": "path",
"description": "The date of the game(s).\n
Examples: 2018-JAN-31, 2017-OCT-01.\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 JSON or XML.",
"required": true,
"schema": {
"type": "string",
"enum": [
"JSON",
"XML"
],
"default": "JSON"
}
},
{
"name": "team",
"in": "path",
"description": "The abbreviation of the requested team.\n
Examples: SF, NYY.\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 JSON or XML.",
"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 JSON or XML.",
"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 JSON or XML.",
"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 JSON or XML.",
"required": true,
"schema": {
"type": "string",
"enum": [
"JSON",
"XML"
],
"default": "JSON"
}
},
{
"name": "date",
"in": "path",
"description": "The date of the news.\n
Examples: 2018-JAN-31, 2017-OCT-01.\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 JSON or XML.",
"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
Examples: 2015REG, 2015PRE, 2015POST.",
"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 JSON or XML.",
"required": true,
"schema": {
"type": "string",
"enum": [
"JSON",
"XML"
],
"default": "JSON"
}
},
{
"name": "date",
"in": "path",
"description": "The date of the game(s).\n
Examples: 2018-JAN-31, 2017-OCT-01.\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 JSON or XML.",
"required": true,
"schema": {
"type": "string",
"enum": [
"JSON",
"XML"
],
"default": "JSON"
}
},
{
"name": "date",
"in": "path",
"description": "The date of the game(s).\n
Examples: 2018-JAN-31, 2017-OCT-01.\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",
"parameters": [
{
"name": "format",
"in": "path",
"description": "Desired response format. Valid entries are JSON or XML.",
"required": true,
"schema": {
"type": "string",
"enum": [
"JSON",
"XML"
],
"default": "JSON"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Referee"
}
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Unauthorized"
}
}
}
}
},
"tags": [
"NHL v3 Scores"
]
}
},
"/v3/nhl/projections/{format}/PlayerGameProjectionStatsByDate/{date}": {
"get": {
"description": "SportsDataIO's proprietary projections, including DFS salary information and injuries, for fantasy players, called by date.",
"operationId": "nhl_v3_projections_projected_player_game_stats___by_date",
"summary": "Projected Player Game Stats - by Date",
"parameters": [
{
"name": "format",
"in": "path",
"description": "Desired response format. Valid entries are JSON or XML.",
"required": true,
"schema": {
"type": "string",
"enum": [
"JSON",
"XML"
],
"default": "JSON"
}
},
{
"name": "date",
"in": "path",
"description": "The date of the game(s).\n
Examples: 2018-JAN-31, 2017-OCT-01.\n ",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PlayerGameProjection"
}
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Unauthorized"
}
}
}
}
},
"tags": [
"NHL v3 Projections"
]
}
},
"/v3/nhl/projections/{format}/DfsSlatesByDate/{date}": {
"get": {
"description": "Returns DFS Slates which have not yet started, with their player and salary information.",
"operationId": "nhl_v3_projections_dfs_slates___by_date",
"summary": "DFS Slates - by Date",
"parameters": [
{
"name": "format",
"in": "path",
"description": "Desired response format. Valid entries are JSON or XML.",
"required": true,
"schema": {
"type": "string",
"enum": [
"JSON",
"XML"
],
"default": "JSON"
}
},
{
"name": "date",
"in": "path",
"description": "The date of the game(s).\n
Examples: 2017-DEC-01, 2018-FEB-15.",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DfsSlate"
}
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Unauthorized"
}
}
}
}
},
"tags": [
"NHL v3 Projections"
]
}
},
"/v3/nhl/projections/{format}/StartingGoaltendersByDate/{date}": {
"get": {
"description": "This endpoint provides the projected and confirmed starting goaltenders for NHL games on a given date.",
"operationId": "nhl_v3_projections_starting_goaltenders___by_date",
"summary": "Starting Goaltenders - by Date",
"parameters": [
{
"name": "format",
"in": "path",
"description": "Desired response format. Valid entries are JSON or XML.",
"required": true,
"schema": {
"type": "string",
"enum": [
"JSON",
"XML"
],
"default": "JSON"
}
},
{
"name": "date",
"in": "path",
"description": "The date of the game(s).\n
Examples: 2021-OCT-12, 2021-DEC-09.",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/StartingGoaltenders"
}
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Unauthorized"
}
}
}
}
},
"tags": [
"NHL v3 Projections"
]
}
},
"/v3/nhl/projections/{format}/InjuredPlayers": {
"get": {
"description": "This endpoint provides all currently injured NHL players, along with injury details.",
"operationId": "nhl_v3_projections_player_details___by_injured",
"summary": "Player Details - by Injured",
"parameters": [
{
"name": "format",
"in": "path",
"description": "Desired response format. Valid entries are JSON or XML.",
"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 Projections"
]
}
},
"/v3/nhl/odds/{format}/GameOddsByDate/{date}": {
"get": {
"description": "Returns full game odds (spread, moneyline, total) for games on a given date. Only returns the most recently seen odds, not inclusive of line movement.",
"operationId": "nhl_v3_odds_pre_game_odds___by_date",
"summary": "Pre-Game Odds - by Date",
"parameters": [
{
"name": "format",
"in": "path",
"description": "Desired response format. Valid entries are JSON or XML.",
"required": true,
"schema": {
"type": "string",
"enum": [
"JSON",
"XML"
],
"default": "JSON"
}
},
{
"name": "date",
"in": "path",
"description": "The date of the game(s).
Examples: 2018-11-20, 2018-11-23.",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/GameInfo"
}
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Unauthorized"
}
}
}
}
},
"tags": [
"NHL v3 Odds"
]
}
},
"/v3/nhl/odds/{format}/GameOddsLineMovement/{gameid}": {
"get": {
"description": "Returns the non-full-game odds (spread, moneyline, total) for games on a given date. Non-full-game means 1st-half or 1st-quarter, for example, rather than full game. Returns the full line movement for the given game. This endpoint has a longer cache as it is meant for historical data/line movement rather than the most up to the second line.",
"operationId": "nhl_v3_odds_pre_game_odds_line_movement",
"summary": "Pre-Game Odds Line Movement",
"parameters": [
{
"name": "format",
"in": "path",
"description": "Desired response format. Valid entries are JSON or XML.",
"required": true,
"schema": {
"type": "string",
"enum": [
"JSON",
"XML"
],
"default": "JSON"
}
},
{
"name": "gameid",
"in": "path",
"description": "The GameID of an NHL game. GameIDs can be found in the Games API. Valid entries are 13096 or 13110",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/GameInfo"
}
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Unauthorized"
}
}
}
}
},
"tags": [
"NHL v3 Odds"
]
}
},
"/v3/nhl/odds/{format}/LiveGameOddsByDate/{date}": {
"get": {
"description": "Returns in-play game odds (spread, moneyline, total) for games on a given date. Only returns the most recently seen odds, not inclusive of line movement. As this is in-game, it will only return results while the game is in progress.",
"operationId": "nhl_v3_odds_in_game_odds___by_date",
"summary": "In-Game Odds - by Date",
"parameters": [
{
"name": "format",
"in": "path",
"description": "Desired response format. Valid entries are JSON or XML.",
"required": true,
"schema": {
"type": "string",
"enum": [
"JSON",
"XML"
],
"default": "JSON"
}
},
{
"name": "date",
"in": "path",
"description": "The date of the game(s).
Examples: 2018-11-20, 2018-11-23.",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/GameInfo"
}
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Unauthorized"
}
}
}
}
},
"tags": [
"NHL v3 Odds"
]
}
},
"/v3/nhl/odds/{format}/LiveGameOddsLineMovement/{gameid}": {
"get": {
"description": "Returns in-play game odds (spread, moneyline, total) for games on a given date. Returns the full line movement for the given game. This endpoint has a longer cache as it is meant for historical data/line movement rather than the most up to the second line.",
"operationId": "nhl_v3_odds_in_game_odds_line_movement",
"summary": "In-Game Odds Line Movement",
"parameters": [
{
"name": "format",
"in": "path",
"description": "Desired response format. Valid entries are JSON or XML.",
"required": true,
"schema": {
"type": "string",
"enum": [
"JSON",
"XML"
],
"default": "JSON"
}
},
{
"name": "gameid",
"in": "path",
"description": "The GameID of an NHL game. GameIDs can be found in the Games API. Valid entries are 13096 or 13110",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/GameInfo"
}
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Unauthorized"
}
}
}
}
},
"tags": [
"NHL v3 Odds"
]
}
},
"/v3/nhl/odds/{format}/AlternateMarketGameOddsByDate/{date}": {
"get": {
"description": "Returns the non-full-game odds (spread, moneyline, total) for games on a given date. Non-full-game means 1st-period or, for example, rather than full game. Only returns the most recently seen odds, not inclusive of line movement.",
"operationId": "nhl_v3_odds_period_game_odds___by_date",
"summary": "Period Game Odds - by Date",
"parameters": [
{
"name": "format",
"in": "path",
"description": "Desired response format. Valid entries are JSON or XML.",
"required": true,
"schema": {
"type": "string",
"enum": [
"JSON",
"XML"
],
"default": "JSON"
}
},
{
"name": "date",
"in": "path",
"description": "The date of the game(s).
Examples: 2018-11-20, 2018-11-23.",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/GameInfo"
}
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Unauthorized"
}
}
}
}
},
"tags": [
"NHL v3 Odds"
]
}
},
"/v3/nhl/odds/{format}/AlternateMarketGameOddsLineMovement/{gameid}": {
"get": {
"description": "Returns the non-full-game odds (spread, moneyline, total) for games on a given date. Non-full-game means 1st-period, for example, rather than full game. Returns the full line movement for the given game. This endpoint has a longer cache as it is meant for historical data/line movement rather than the most up to the second line.",
"operationId": "nhl_v3_odds_period_game_odds_line_movement",
"summary": "Period Game Odds Line Movement",
"parameters": [
{
"name": "format",
"in": "path",
"description": "Desired response format. Valid entries are JSON or XML.",
"required": true,
"schema": {
"type": "string",
"enum": [
"JSON",
"XML"
],
"default": "JSON"
}
},
{
"name": "gameid",
"in": "path",
"description": "The GameID of an NHL game. GameIDs can be found in the Games API. Valid entries are 13096 or 13110",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/GameInfo"
}
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Unauthorized"
}
}
}
}
},
"tags": [
"NHL v3 Odds"
]
}
},
"/v3/nhl/odds/{format}/TeamTrends/{team}": {
"get": {
"description": "Describes recent team trends and performance against betting data in recent sets of games.",
"operationId": "nhl_v3_odds_betting_trends___by_team",
"summary": "Betting Trends - by Team",
"parameters": [
{
"name": "format",
"in": "path",
"description": "Desired response format. Valid entries are JSON or XML.",
"required": true,
"schema": {
"type": "string",
"enum": [
"JSON",
"XML"
],
"default": "JSON"
}
},
{
"name": "team",
"in": "path",
"description": "The abbreviation of the requested team.
Examples: PHI, MIN, DET, etc.",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TeamTrends"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Unauthorized"
}
}
}
}
},
"tags": [
"NHL v3 Odds"
]
}
},
"/v3/nhl/odds/{format}/MatchupTrends/{team}/{opponent}": {
"get": {
"description": "Returns trends data for a given pairing of teams. Will return data even if the teams are not set to play this season. Intended for use on a specific game, though it will work for other comparisons if applicable.",
"operationId": "nhl_v3_odds_betting_trends___by_matchup",
"summary": "Betting Trends - by Matchup",
"parameters": [
{
"name": "format",
"in": "path",
"description": "Desired response format. Valid entries are JSON or XML.",
"required": true,
"schema": {
"type": "string",
"enum": [
"JSON",
"XML"
],
"default": "JSON"
}
},
{
"name": "team",
"in": "path",
"description": "The abbreviation of the requested team.
Examples: PHI, MIN, DET, etc.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "opponent",
"in": "path",
"description": "The abbreviation of the requested opponent.
Examples: PHI, MIN, DET, etc.",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MatchupTrends"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Unauthorized"
}
}
}
}
},
"tags": [
"NHL v3 Odds"
]
}
},
"/v3/nhl/odds/{format}/BettingEventsByDate/{date}": {
"get": {
"description": "The list of current BettingEvents for the given date, from which Betting Market data can be gathered via the Betting Markets by Event endpoint, for all available Betting Market types (e.g. Player Props, Team Props.)",
"operationId": "nhl_v3_odds_betting_events___by_date",
"summary": "Betting Events - by Date",
"parameters": [
{
"name": "format",
"in": "path",
"description": "Desired response format. Valid entries are JSON or XML.",
"required": true,
"schema": {
"type": "string",
"enum": [
"JSON",
"XML"
],
"default": "JSON"
}
},
{
"name": "date",
"in": "path",
"description": "The date of the game(s).
Examples: 2020-02-15, 2020-02-23.",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/BettingEvent"
}
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Unauthorized"
}
}
}
}
},
"tags": [
"NHL v3 Odds"
]
}
},
"/v3/nhl/odds/{format}/BettingMarkets/{eventId}": {
"get": {
"description": "Returns the markets of all available types (e.g. Player Props, Team Props) and available outcomes for a given BettingEventID.",
"operationId": "nhl_v3_odds_betting_markets___by_event",
"summary": "Betting Markets - by Event",
"parameters": [
{
"name": "format",
"in": "path",
"description": "Desired response format. Valid entries are JSON or XML.",
"required": true,
"schema": {
"type": "string",
"enum": [
"JSON",
"XML"
],
"default": "JSON"
}
},
{
"name": "eventId",
"in": "path",
"description": "The EventId of the desired event/game for which to pull all betting markets (includes outcomes/bets). Valid entries include: 134, 155, etc.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "include",
"in": "query",
"description": "This parameter indicates which BettingOutcome records to return in the payload. By default, this endpoint only returns available outcomes, excluding the unlisted bets.
Important Note: the default parameter of available is much faster and provides the best performance. Passing unlisted will return unlisted odds, but these are cached for much longer and may be several minutes old. For best performance, the default parameter is highly recommended.
Possible values include:
available - excludes any betting outcomes that have been removed/unlisted by the respective sportsbook. This is more lightweight and delivers odds much faster than using unlisted.
unlisted - includes the most recently available betting outcome per sportsbook, for each listed market, even those outcomes are expired/unlisted or otherwise unavailable from the respective sportsbook. This is a far heavier payload, and it's cached for much longer than available.
",
"schema": {
"type": "string",
"enum": [
"available",
"unlisted"
],
"default": "available"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/BettingMarket"
}
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Unauthorized"
}
}
}
}
},
"tags": [
"NHL v3 Odds"
]
}
},
"/v3/nhl/odds/{format}/BettingEvents/{season}": {
"get": {
"description": "The list of current BettingEvents for the given season, from which Betting Market data can be gathered via the Betting Markets by Event endpoint, for all available Betting Market types (e.g. Player Props, Team Props.)",
"operationId": "nhl_v3_odds_betting_events___by_season",
"summary": "Betting Events - by Season",
"parameters": [
{
"name": "format",
"in": "path",
"description": "Desired response format. Valid entries are JSON or XML.",
"required": true,
"schema": {
"type": "string",
"enum": [
"JSON",
"XML"
],
"default": "JSON"
}
},
{
"name": "season",
"in": "path",
"description": "Year of the season (with optional season type).
Examples: 2020, 2020PRE, 2020POST, 2020STAR, 2021, etc.",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/BettingEvent"
}
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Unauthorized"
}
}
}
}
},
"tags": [
"NHL v3 Odds"
]
}
},
"/v3/nhl/odds/{format}/BettingMarket/{marketId}": {
"get": {
"description": "Returns full line movement for a given BettingMarket. Due to the sheer size of the output and the level of detail, it is intended for historical data purposes and not for the most up-to-the-second lines.",
"operationId": "nhl_v3_odds_betting_market",
"summary": "Betting Market",
"parameters": [
{
"name": "format",
"in": "path",
"description": "Desired response format. Valid entries are JSON or XML.",
"required": true,
"schema": {
"type": "string",
"enum": [
"JSON",
"XML"
],
"default": "JSON"
}
},
{
"name": "marketId",
"in": "path",
"description": "The MarketId of the desired market for which to pull all outcomes/bets. Valid entries include: 421, 1041, etc.",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BettingMarket"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Unauthorized"
}
}
}
}
},
"tags": [
"NHL v3 Odds"
]
}
},
"/v3/nhl/odds/{format}/BettingMarketsByMarketType/{eventId}/{marketTypeID}": {
"get": {
"description": "Returns Markets and available outcomes for a given event and market type requested. A lighter call than by BettingEventID as it only includes markets tagged with the specific MarketType, a full list of which is available for each sport in its Betting Metadata endpoint.",
"operationId": "nhl_v3_odds_betting_markets___by_market_type",
"summary": "Betting Markets - by Market Type",
"parameters": [
{
"name": "format",
"in": "path",
"description": "Desired response format. Valid entries are JSON or XML.",
"required": true,
"schema": {
"type": "string",
"enum": [
"JSON",
"XML"
],
"default": "JSON"
}
},
{
"name": "eventId",
"in": "path",
"description": "The EventId of the desired event/game for which to pull all betting markets (includes outcomes/bets). Valid entries include: 134, 155, etc.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "marketTypeID",
"in": "path",
"description": "The Market Type ID of the desired MarketTypes to pull. Some common types include:\n1 for `Game Lines`\n2 for `Player Props`\n3 for `Team Props`\n6 for `Game Props`",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "include",
"in": "query",
"description": "This parameter indicates which BettingOutcome records to return in the payload. By default, this endpoint only returns available outcomes, excluding the unlisted bets.
Important Note: the default parameter of available is much faster and provides the best performance. Passing unlisted will return unlisted odds, but these are cached for much longer and may be several minutes old. For best performance, the default parameter is highly recommended.
Possible values include:
available - excludes any betting outcomes that have been removed/unlisted by the respective sportsbook. This is more lightweight and delivers odds much faster than using unlisted.
unlisted - includes the most recently available betting outcome per sportsbook, for each listed market, even those outcomes are expired/unlisted or otherwise unavailable from the respective sportsbook. This is a far heavier payload, and it's cached for much longer than available.
",
"schema": {
"type": "string",
"enum": [
"available",
"unlisted"
],
"default": "available"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/BettingMarket"
}
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Unauthorized"
}
}
}
}
},
"tags": [
"NHL v3 Odds"
]
}
},
"/v3/nhl/odds/{format}/BettingFuturesBySeason/{season}": {
"get": {
"description": "Returns available Futures markets for the given season. Does not include line movement.",
"operationId": "nhl_v3_odds_betting_futures___by_season",
"summary": "Betting Futures - by Season",
"parameters": [
{
"name": "format",
"in": "path",
"description": "Desired response format. Valid entries are JSON or XML.",
"required": true,
"schema": {
"type": "string",
"enum": [
"JSON",
"XML"
],
"default": "JSON"
}
},
{
"name": "season",
"in": "path",
"description": "Year of the season
Examples: 2020, 2021, etc",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/BettingEvent"
}
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Unauthorized"
}
}
}
}
},
"tags": [
"NHL v3 Odds"
]
}
},
"/v3/nhl/odds/{format}/BettingMarketsByGameID/{gameID}": {
"get": {
"description": "Returns the markets of all available types (e.g. Player Props, Team Props) and available outcomes for a given GameID.",
"operationId": "nhl_v3_odds_betting_markets___by_game",
"summary": "Betting Markets - by Game",
"parameters": [
{
"name": "format",
"in": "path",
"description": "Desired response format. Valid entries are JSON or XML.",
"required": true,
"schema": {
"type": "string",
"enum": [
"JSON",
"XML"
],
"default": "JSON"
}
},
{
"name": "gameID",
"in": "path",
"description": "The GameID of the desired game for which to pull all betting markets (includes outcomes/bets). Valid entries include: 14814",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "include",
"in": "query",
"description": "This parameter indicates which BettingOutcome records to return in the payload. By default, this endpoint only returns available outcomes, excluding the unlisted bets.
Important Note: the default parameter of available is much faster and provides the best performance. Passing unlisted will return unlisted odds, but these are cached for much longer and may be several minutes old. For best performance, the default parameter is highly recommended.
Possible values include:
available - excludes any betting outcomes that have been removed/unlisted by the respective sportsbook. This is more lightweight and delivers odds much faster than using unlisted.
unlisted - includes the most recently available betting outcome per sportsbook, for each listed market, even those outcomes are expired/unlisted or otherwise unavailable from the respective sportsbook. This is a far heavier payload, and it's cached for much longer than available.
",
"schema": {
"type": "string",
"enum": [
"available",
"unlisted"
],
"default": "available"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/BettingMarket"
}
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Unauthorized"
}
}
}
}
},
"tags": [
"NHL v3 Odds"
]
}
},
"/v3/nhl/odds/{format}/Bettingmetadata": {
"get": {
"description": "Returns the list of MarketTypes, BetTypes, PeriodTypes, OutcomeTypes, and ResultTypes to map the IDs to descriptive names. Also includes a list of the MarketType, BetType & PeriodType combinations which we will have resulting for.",
"operationId": "nhl_v3_odds_betting_metadata",
"summary": "Betting Metadata",
"parameters": [
{
"name": "format",
"in": "path",
"description": "Desired response format. Valid entries are JSON or XML.",
"required": true,
"schema": {
"type": "string",
"enum": [
"JSON",
"XML"
],
"default": "JSON"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BettingEntityMetadataCollection"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Unauthorized"
}
}
}
}
},
"tags": [
"NHL v3 Odds"
]
}
},
"/v3/nhl/odds/{format}/ActiveSportsbooks": {
"get": {
"description": "A list of all available sportsbooks with their associated unique IDs.",
"operationId": "nhl_v3_odds_sportsbooks___by_active",
"summary": "Sportsbooks - by Active",
"parameters": [
{
"name": "format",
"in": "path",
"description": "Desired response format. Valid entries are JSON or XML.",
"required": true,
"schema": {
"type": "string",
"enum": [
"JSON",
"XML"
],
"default": "JSON"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Sportsbook"
}
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Unauthorized"
}
}
}
}
},
"tags": [
"NHL v3 Odds"
]
}
},
"/v3/nhl/odds/{format}/BettingSplitsByMarketId/{marketId}": {
"get": {
"description": "List of Money and Bet Percentage splits for each outcome type available in this market. This specific endpoint will return the movement from this market as well as the most recent.",
"operationId": "nhl_v3_odds_betting_splits___by_betting_market",
"summary": "Betting Splits - by Betting Market",
"parameters": [
{
"name": "format",
"in": "path",
"description": "Desired response format. Valid entries are JSON or XML.",
"required": true,
"schema": {
"type": "string",
"enum": [
"JSON",
"XML"
],
"default": "JSON"
}
},
{
"name": "marketId",
"in": "path",
"description": "The MarketId of the desired market for which to pull splits. MarketIds are pulled from the Betting Markets endpoints.",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BettingMarketSplit"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Unauthorized"
}
}
}
}
},
"tags": [
"NHL v3 Odds"
]
}
},
"/v3/nhl/odds/{format}/BettingSplitsByGameId/{gameId}": {
"get": {
"description": "List of Money and Bet Percentage splits for each market and their respective outcome types available in this game. This specific endpoint will return current splits for each available market and no line movement.",
"operationId": "nhl_v3_odds_betting_splits___by_game",
"summary": "Betting Splits - by Game",
"parameters": [
{
"name": "format",
"in": "path",
"description": "Desired response format. Valid entries are JSON or XML.",
"required": true,
"schema": {
"type": "string",
"enum": [
"JSON",
"XML"
],
"default": "JSON"
}
},
{
"name": "gameId",
"in": "path",
"description": "The ID of the game for which you want to receive splits for. GameIds are pulled from the Schedules and Games by Date endpoints.",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GameBettingSplit"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Unauthorized"
}
}
}
}
},
"tags": [
"NHL v3 Odds"
]
}
},
"/v3/nhl/odds/{format}/BettingPlayerPropsByGameID/{gameId}": {
"get": {
"description": "This works in the same way as Betting Markets by Market Type but is prefiltered to the Player Props type only. Ideal if your application will only ever require Player Props, but if you also want Team Props etc. it is recommended to use the by Market Type endpoint.",
"operationId": "nhl_v3_odds_betting_player_props___by_game",
"summary": "Betting Player Props - by Game",
"parameters": [
{
"name": "format",
"in": "path",
"description": "Desired response format. Valid entries are JSON or XML.",
"required": true,
"schema": {
"type": "string",
"enum": [
"JSON",
"XML"
],
"default": "JSON"
}
},
{
"name": "gameId",
"in": "path",
"description": "The unique GameID of the game in question.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "include",
"in": "query",
"description": "This parameter indicates which BettingOutcome records to return in the payload. By default, this endpoint only returns available outcomes, excluding the unlisted bets.
Important Note: the default parameter of available is much faster and provides the best performance. Passing unlisted will return unlisted odds, but these are cached for much longer and may be several minutes old. For best performance, the default parameter is highly recommended.
Possible values include:
available - excludes any betting outcomes that have been removed/unlisted by the respective sportsbook. This is more lightweight and delivers odds much faster than using unlisted.
unlisted - includes the most recently available betting outcome per sportsbook, for each listed market, even those outcomes are expired/unlisted or otherwise unavailable from the respective sportsbook. This is a far heavier payload, and it's cached for much longer than available.
",
"schema": {
"type": "string",
"enum": [
"available",
"unlisted"
],
"default": "available"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/BettingMarket"
}
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Unauthorized"
}
}
}
}
},
"tags": [
"NHL v3 Odds"
]
}
},
"/v3/nhl/odds/{format}/BettingMarketResults/{marketId}": {
"get": {
"description": "Provide a market ID that supports resulting (i.e. has a ResultType) and this endpoint will return a result: for markets with a ResultType, each line will be graded and it will be determined whether the bet would have won or lost.",
"operationId": "nhl_v3_odds_betting_results___by_market",
"summary": "Betting Results - by Market",
"parameters": [
{
"name": "format",
"in": "path",
"description": "Desired response format. Valid entries are JSON or XML.",
"required": true,
"schema": {
"type": "string",
"enum": [
"JSON",
"XML"
],
"default": "JSON"
}
},
{
"name": "marketId",
"in": "path",
"description": "The MarketId of the desired market for which to pull all outcomes/bets.",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BettingMarketResult"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Unauthorized"
}
}
}
}
},
"tags": [
"NHL v3 Odds"
]
}
},
"/v3/nhl/odds/{format}/PreGameOddsByDate/{date}/{sportsbookgroup}": {
"get": {
"description": "Returns the full-game and non-full-game odds (spread, moneyline, total) for games in a given week and season. Only returns the most recently seen odds, not inclusive of line movement. A Sportsbook Group must be specified as a URL parameter.",
"operationId": "nhl_v3_odds_pre_game_and_period_game_odds___by_date__sportsbook_group",
"summary": "Pre-Game and Period Game Odds - by Date [Sportsbook Group]",
"parameters": [
{
"name": "format",
"in": "path",
"description": "Desired response format. Valid entries are JSON or XML.",
"required": true,
"schema": {
"type": "string",
"enum": [
"JSON",
"XML"
],
"default": "JSON"
}
},
{
"name": "date",
"in": "path",
"description": "The date of the game(s).
Examples: 2018-11-20, 2018-11-23.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "sportsbookgroup",
"in": "path",
"description": "The name of the Sportsbook grouping.\n
Examples: G1100",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/GameInfo"
}
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Unauthorized"
}
}
}
}
},
"tags": [
"NHL v3 Odds"
]
}
},
"/v3/nhl/odds/{format}/PreGameOddsLineMovement/{gameid}/{sportsbookgroup}": {
"get": {
"description": "Returns the game odds ( for games on a given date. In this endpoint both full-game and partial-game odds are included. Returns the full line movement for the given game. This endpoint has a longer cache as it is meant for historical data/line movement rather than the most up to the second line. A Sportsbook Group must be specified as a URL parameter.",
"operationId": "nhl_v3_odds_pre_game_and_period_game_odds_line_movement__sportsbook_group",
"summary": "Pre-Game and Period Game Odds Line Movement [Sportsbook Group]",
"parameters": [
{
"name": "format",
"in": "path",
"description": "Desired response format. Valid entries are JSON or XML.",
"required": true,
"schema": {
"type": "string",
"enum": [
"JSON",
"XML"
],
"default": "JSON"
}
},
{
"name": "gameid",
"in": "path",
"description": "The GameID of an NHL game. GameIDs can be found in the Games API. Valid entries are 13096 or 13110",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "sportsbookgroup",
"in": "path",
"description": "The name of the Sportsbook grouping.\n
Examples: G1100",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/GameInfo"
}
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Unauthorized"
}
}
}
}
},
"tags": [
"NHL v3 Odds"
]
}
},
"/v3/nhl/odds/{format}/InGameOddsByDate/{date}/{sportsbookgroup}": {
"get": {
"description": "Returns in-play game odds (spread, moneyline, total) for games on a given date. Only returns the most recently seen odds, not inclusive of line movement. As this is in-game, it will only return results while the game is in progress. A Sportsbook Group must be specified as a URL parameter.",
"operationId": "nhl_v3_odds_in_game_odds___by_date__sportsbook_group",
"summary": "In-Game Odds - by Date [Sportsbook Group]",
"parameters": [
{
"name": "format",
"in": "path",
"description": "Desired response format. Valid entries are JSON or XML.",
"required": true,
"schema": {
"type": "string",
"enum": [
"JSON",
"XML"
],
"default": "JSON"
}
},
{
"name": "date",
"in": "path",
"description": "The date of the game(s).
Examples: 2018-11-20, 2018-11-23.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "sportsbookgroup",
"in": "path",
"description": "The name of the Sportsbook grouping.\n
Examples: G1100",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/GameInfo"
}
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Unauthorized"
}
}
}
}
},
"tags": [
"NHL v3 Odds"
]
}
},
"/v3/nhl/odds/{format}/InGameLineMovement/{gameid}/{sportsbookgroup}": {
"get": {
"description": "Returns in-play game odds (spread, moneyline, total) for games on a given date. Returns the full line movement for the given game. This endpoint has a longer cache as it is meant for historical data/line movement rather than the most up to the second line. A Sportsbook Group must be specified as a URL parameter.",
"operationId": "nhl_v3_odds_in_game_odds_line_movement__sportsbook_group",
"summary": "In-Game Odds Line Movement [Sportsbook Group]",
"parameters": [
{
"name": "format",
"in": "path",
"description": "Desired response format. Valid entries are JSON or XML.",
"required": true,
"schema": {
"type": "string",
"enum": [
"JSON",
"XML"
],
"default": "JSON"
}
},
{
"name": "gameid",
"in": "path",
"description": "The GameID of an NHL game. GameIDs can be found in the Games API. Valid entries are 13096 or 13110",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "sportsbookgroup",
"in": "path",
"description": "The name of the Sportsbook grouping.\n
Examples: G1100",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/GameInfo"
}
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Unauthorized"
}
}
}
}
},
"tags": [
"NHL v3 Odds"
]
}
},
"/v3/nhl/odds/{format}/BettingPlayerPropsByGameID/{gameId}/{sportsbookgroup}": {
"get": {
"description": "This works in the same way as Betting Markets by Market Type but is prefiltered to the Player Props type only. Ideal if your application will only ever require Player Props, but if you also want Team Props etc. it is recommended to use the by Market Type endpoint. A Sportsbook Group must be specified as a URL parameter.",
"operationId": "nhl_v3_odds_betting_player_props___by_game__sportsbook_group",
"summary": "Betting Player Props - by Game [Sportsbook Group]",
"parameters": [
{
"name": "format",
"in": "path",
"description": "Desired response format. Valid entries are JSON or XML.",
"required": true,
"schema": {
"type": "string",
"enum": [
"JSON",
"XML"
],
"default": "JSON"
}
},
{
"name": "gameId",
"in": "path",
"description": "The unique GameID of the game in question.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "sportsbookgroup",
"in": "path",
"description": "The name of the Sportsbook grouping.\n
Examples: G1100",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "include",
"in": "query",
"description": "This parameter indicates which BettingOutcome records to return in the payload. By default, this endpoint only returns available outcomes, excluding the unlisted bets.
Important Note: the default parameter of available is much faster and provides the best performance. Passing unlisted will return unlisted odds, but these are cached for much longer and may be several minutes old. For best performance, the default parameter is highly recommended.
Possible values include:
available - excludes any betting outcomes that have been removed/unlisted by the respective sportsbook. This is more lightweight and delivers odds much faster than using unlisted.
unlisted - includes the most recently available betting outcome per sportsbook, for each listed market, even those outcomes are expired/unlisted or otherwise unavailable from the respective sportsbook. This is a far heavier payload, and it's cached for much longer than available.
",
"schema": {
"type": "string",
"enum": [
"available",
"unlisted"
],
"default": "available"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/BettingMarket"
}
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Unauthorized"
}
}
}
}
},
"tags": [
"NHL v3 Odds"
]
}
},
"/v3/nhl/odds/{format}/BettingMarketsByMarketType/{eventId}/{marketTypeID}/{sportsbookgroup}": {
"get": {
"description": "Returns Markets and available outcomes for a given event and market type requested. A lighter call than by BettingEventID as it only includes markets tagged with the specific MarketType, a full list of which is available for each sport in its Betting Metadata endpoint. A Sportsbook Group must be specified as a URL parameter.",
"operationId": "nhl_v3_odds_betting_markets___by_market_type__sportsbook_group",
"summary": "Betting Markets - by Market Type [Sportsbook Group]",
"parameters": [
{
"name": "format",
"in": "path",
"description": "Desired response format. Valid entries are JSON or XML.",
"required": true,
"schema": {
"type": "string",
"enum": [
"JSON",
"XML"
],
"default": "JSON"
}
},
{
"name": "eventId",
"in": "path",
"description": "The EventId of the desired event/game for which to pull all betting markets (includes outcomes/bets). Valid entries include: 134, 155, etc.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "marketTypeID",
"in": "path",
"description": "The Market Type ID of the desired MarketTypes to pull. Some common types include:\n1 for `Game Lines`\n2 for `Player Props`\n3 for `Team Props`\n6 for `Game Props`",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "sportsbookgroup",
"in": "path",
"description": "The name of the Sportsbook grouping.\n
Examples: G1100",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "include",
"in": "query",
"description": "This parameter indicates which BettingOutcome records to return in the payload. By default, this endpoint only returns available outcomes, excluding the unlisted bets.
Important Note: the default parameter of available is much faster and provides the best performance. Passing unlisted will return unlisted odds, but these are cached for much longer and may be several minutes old. For best performance, the default parameter is highly recommended.
Possible values include:
available - excludes any betting outcomes that have been removed/unlisted by the respective sportsbook. This is more lightweight and delivers odds much faster than using unlisted.
unlisted - includes the most recently available betting outcome per sportsbook, for each listed market, even those outcomes are expired/unlisted or otherwise unavailable from the respective sportsbook. This is a far heavier payload, and it's cached for much longer than available.
",
"schema": {
"type": "string",
"enum": [
"available",
"unlisted"
],
"default": "available"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/BettingMarket"
}
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Unauthorized"
}
}
}
}
},
"tags": [
"NHL v3 Odds"
]
}
},
"/v3/nhl/odds/{format}/BettingMarketsByGameID/{gameID}/{sportsbookgroup}": {
"get": {
"description": "Returns the markets of all available types (e.g. Player Props, Team Props) and available outcomes for a given GameID. A Sportsbook Group must be specified as a URL parameter.",
"operationId": "nhl_v3_odds_betting_markets___by_game__sportsbook_group",
"summary": "Betting Markets - by Game [Sportsbook Group]",
"parameters": [
{
"name": "format",
"in": "path",
"description": "Desired response format. Valid entries are JSON or XML.",
"required": true,
"schema": {
"type": "string",
"enum": [
"JSON",
"XML"
],
"default": "JSON"
}
},
{
"name": "gameID",
"in": "path",
"description": "The GameID of the desired game for which to pull all betting markets (includes outcomes/bets). Valid entries include: 14814",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "sportsbookgroup",
"in": "path",
"description": "The name of the Sportsbook grouping.\n
Examples: G1100",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "include",
"in": "query",
"description": "This parameter indicates which BettingOutcome records to return in the payload. By default, this endpoint only returns available outcomes, excluding the unlisted bets.
Important Note: the default parameter of available is much faster and provides the best performance. Passing unlisted will return unlisted odds, but these are cached for much longer and may be several minutes old. For best performance, the default parameter is highly recommended.
Possible values include:
available - excludes any betting outcomes that have been removed/unlisted by the respective sportsbook. This is more lightweight and delivers odds much faster than using unlisted.
unlisted - includes the most recently available betting outcome per sportsbook, for each listed market, even those outcomes are expired/unlisted or otherwise unavailable from the respective sportsbook. This is a far heavier payload, and it's cached for much longer than available.
",
"schema": {
"type": "string",
"enum": [
"available",
"unlisted"
],
"default": "available"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/BettingMarket"
}
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Unauthorized"
}
}
}
}
},
"tags": [
"NHL v3 Odds"
]
}
},
"/v3/nhl/odds/{format}/BettingMarketsByEvent/{eventId}/{sportsbookgroup}": {
"get": {
"description": "Returns the markets and available outcomes for a given BettingEventID. A Sportsbook Group must be specified as a URL parameter.",
"operationId": "nhl_v3_odds_betting_markets___by_event__sportsbook_group",
"summary": "Betting Markets - by Event [Sportsbook Group]",
"parameters": [
{
"name": "format",
"in": "path",
"description": "Desired response format. Valid entries are JSON or XML.",
"required": true,
"schema": {
"type": "string",
"enum": [
"JSON",
"XML"
],
"default": "JSON"
}
},
{
"name": "eventId",
"in": "path",
"description": "The EventId of the desired event/game for which to pull all betting markets (includes outcomes/bets). Valid entries include: 134, 155, etc.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "sportsbookgroup",
"in": "path",
"description": "The name of the Sportsbook grouping.\n
Examples: G1100",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "include",
"in": "query",
"description": "This parameter indicates which BettingOutcome records to return in the payload. By default, this endpoint only returns available outcomes, excluding the unlisted bets.
Important Note: the default parameter of available is much faster and provides the best performance. Passing unlisted will return unlisted odds, but these are cached for much longer and may be several minutes old. For best performance, the default parameter is highly recommended.
Possible values include:
available - excludes any betting outcomes that have been removed/unlisted by the respective sportsbook. This is more lightweight and delivers odds much faster than using unlisted.
unlisted - includes the most recently available betting outcome per sportsbook, for each listed market, even those outcomes are expired/unlisted or otherwise unavailable from the respective sportsbook. This is a far heavier payload, and it's cached for much longer than available.
",
"schema": {
"type": "string",
"enum": [
"available",
"unlisted"
],
"default": "available"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/BettingMarket"
}
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Unauthorized"
}
}
}
}
},
"tags": [
"NHL v3 Odds"
]
}
},
"/v3/nhl/odds/{format}/BettingMarket/{marketId}/{sportsbookgroup}": {
"get": {
"description": "Returns full line movement for a given BettingMarket. Due to the sheer size of the output and the level of detail, it is intended for historical data purposes and not for the most up-to-the-second lines. A Sportsbook Group must be specified as a URL parameter.",
"operationId": "nhl_v3_odds_betting_market__sportsbook_group",
"summary": "Betting Market [Sportsbook Group]",
"parameters": [
{
"name": "format",
"in": "path",
"description": "Desired response format. Valid entries are JSON or XML.",
"required": true,
"schema": {
"type": "string",
"enum": [
"JSON",
"XML"
],
"default": "JSON"
}
},
{
"name": "marketId",
"in": "path",
"description": "The MarketId of the desired market for which to pull all outcomes/bets. Valid entries include: 421, 1041, etc.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "sportsbookgroup",
"in": "path",
"description": "The name of the Sportsbook grouping.\n
Examples: G1100",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BettingMarket"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Unauthorized"
}
}
}
}
},
"tags": [
"NHL v3 Odds"
]
}
},
"/v3/nhl/odds/{format}/BettingResultsByMarket/{marketId}/{sportsbookgroup}": {
"get": {
"description": "Returns all outcomes under this market which have a result type associated. Will return empty list if resulting has not yet processed for the given game. Resulting processes shortly after game closing.",
"operationId": "nhl_v3_odds_betting_results___by_market__sportsbook_group",
"summary": "Betting Results - by Market [Sportsbook Group]",
"parameters": [
{
"name": "format",
"in": "path",
"description": "Desired response format. Valid entries are JSON or XML.",
"required": true,
"schema": {
"type": "string",
"enum": [
"JSON",
"XML"
],
"default": "JSON"
}
},
{
"name": "marketId",
"in": "path",
"description": "The MarketId of the desired market for which to pull all outcomes/bets.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "sportsbookgroup",
"in": "path",
"description": "The name of the Sportsbook grouping.\n
Examples: G1100",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BettingMarketResult"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Unauthorized"
}
}
}
}
},
"tags": [
"NHL v3 Odds"
]
}
},
"/v3/nhl/odds/{format}/BettingFuturesBySeason/{season}/{sportsbookgroup}": {
"get": {
"description": "Returns available Futures markets for the given season. Does not include line movement. A Sportsbook Group must be specified as a URL parameter.",
"operationId": "nhl_v3_odds_betting_futures___by_season__sportsbook_group",
"summary": "Betting Futures - by Season [Sportsbook Group]",
"parameters": [
{
"name": "format",
"in": "path",
"description": "Desired response format. Valid entries are JSON or XML.",
"required": true,
"schema": {
"type": "string",
"enum": [
"JSON",
"XML"
],
"default": "JSON"
}
},
{
"name": "season",
"in": "path",
"description": "Year of the season
Examples: 2020, 2021, etc",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "sportsbookgroup",
"in": "path",
"description": "The name of the Sportsbook grouping.\n
Examples: G1100",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/BettingEvent"
}
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Unauthorized"
}
}
}
}
},
"tags": [
"NHL v3 Odds"
]
}
},
"/v3/nhl/odds/{format}/InGameLineMovementWithResulting/{gameid}/{sportsbookgroup}": {
"get": {
"description": "Returns in-play game odds (spread, moneyline, total) for games on a given date. This also includes Resulting: for markets with a ResultType, each line will be graded and it will be determined whether the bet would have won or lost. Returns the full line movement for the given game. This endpoint has a longer cache as it is meant for historical data/line movement rather than the most up to the second line. A Sportsbook Group must be specified as a URL parameter.",
"operationId": "nhl_v3_odds_in_game_odds_line_movement_with_resulting__sportsbook_group",
"summary": "In-Game Odds Line Movement with Resulting [Sportsbook Group]",
"parameters": [
{
"name": "format",
"in": "path",
"description": "Desired response format. Valid entries are JSON or XML.",
"required": true,
"schema": {
"type": "string",
"enum": [
"JSON",
"XML"
],
"default": "JSON"
}
},
{
"name": "gameid",
"in": "path",
"description": "The GameID of an NHL game. GameIDs can be found in the Games API. Valid entries are 13096 or 13110",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "sportsbookgroup",
"in": "path",
"description": "The name of the Sportsbook grouping.\n
Examples: G1100",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/GameInfoResult"
}
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Unauthorized"
}
}
}
}
},
"tags": [
"NHL v3 Odds"
]
}
},
"/v3/nhl/odds/{format}/PreGameOddsLineMovementWithResulting/{gameid}/{sportsbookgroup}": {
"get": {
"description": "Returns the game odds ( for games on a given date. In this endpoint both full-game and partial-game odds are included. This also includes Resulting: for markets with a ResultType, each line will be graded and it will be determined whether the bet would have won or lost. Returns the full line movement for the given game. This endpoint has a longer cache as it is meant for historical data/line movement rather than the most up to the second line. A Sportsbook Group must be specified as a URL parameter.",
"operationId": "nhl_v3_odds_pre_game_and_period_game_odds_line_movement_with_resulting__sportsbook_group",
"summary": "Pre-Game and Period Game Odds Line Movement with Resulting [Sportsbook Group]",
"parameters": [
{
"name": "format",
"in": "path",
"description": "Desired response format. Valid entries are JSON or XML.",
"required": true,
"schema": {
"type": "string",
"enum": [
"JSON",
"XML"
],
"default": "JSON"
}
},
{
"name": "gameid",
"in": "path",
"description": "The GameID of an NHL game. GameIDs can be found in the Games API. Valid entries are 13096 or 13110",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "sportsbookgroup",
"in": "path",
"description": "The name of the Sportsbook grouping.\n
Examples: G1100",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/GameInfoResult"
}
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Unauthorized"
}
}
}
}
},
"tags": [
"NHL v3 Odds"
]
}
},
"/v3/nhl/stats/{format}/BoxScore/{gameid}": {
"get": {
"description": "Full statistical information for a specified game, down to the team and player stat level, delivered live during the game, called per individual game.",
"operationId": "nhl_v3_stats_box_score__live___final",
"summary": "Box Score [Live & Final]",
"parameters": [
{
"name": "format",
"in": "path",
"description": "Desired response format. Valid entries are JSON or XML.",
"required": true,
"schema": {
"type": "string",
"enum": [
"JSON",
"XML"
],
"default": "JSON"
}
},
{
"name": "gameid",
"in": "path",
"description": "The GameID of an NHL game. GameIDs can be found in the Games API. Valid entries are 14620 or 16905",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BoxScore"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Unauthorized"
}
}
}
}
},
"tags": [
"NHL v3 Stats"
]
}
},
"/v3/nhl/stats/{format}/BoxScores/{date}": {
"get": {
"description": "Full statistical information for a specified game, down to the team and player stat level, delivered live during the games, called for all games on a given date.",
"operationId": "nhl_v3_stats_box_scores___by_date__live___final",
"summary": "Box Scores - by Date [Live & Final]",
"parameters": [
{
"name": "format",
"in": "path",
"description": "Desired response format. Valid entries are JSON or XML.",
"required": true,
"schema": {
"type": "string",
"enum": [
"JSON",
"XML"
],
"default": "JSON"
}
},
{
"name": "date",
"in": "path",
"description": "The date of the game(s).\n
Examples: 2017-OCT-31, 2018-FEB-15.\n ",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/BoxScore"
}
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Unauthorized"
}
}
}
}
},
"tags": [
"NHL v3 Stats"
]
}
},
"/v3/nhl/stats/{format}/BoxScoresDelta/{date}/{minutes}": {
"get": {
"description": "This method returns all box scores for a given date, but only returns player stats that have changed in the last X minutes as specified in your API call. By definition this is a live endpoint, not final.",
"operationId": "nhl_v3_stats_box_scores_delta___by_date",
"summary": "Box Scores Delta - by Date",
"parameters": [
{
"name": "format",
"in": "path",
"description": "Desired response format. Valid entries are JSON or XML.",
"required": true,
"schema": {
"type": "string",
"enum": [
"JSON",
"XML"
],
"default": "JSON"
}
},
{
"name": "date",
"in": "path",
"description": "The date of the game(s).\n
Examples: 2017-OCT-31, 2018-FEB-15.\n ",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "minutes",
"in": "path",
"description": "Only returns player statistics that have changed in the last X minutes. You specify how many minutes in time to go back. Valid entries are:\n 1 or 2.\n ",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/BoxScore"
}
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Unauthorized"
}
}
}
}
},
"tags": [
"NHL v3 Stats"
]
}
},
"/v3/nhl/stats/{format}/PlayerGameStatsByDate/{date}": {
"get": {
"description": "Returns the box score statistical record for all involved players across a given date, updated live as the game takes place.",
"operationId": "nhl_v3_stats_player_game_stats___by_date__live___final",
"summary": "Player Game Stats - by Date [Live & Final]",
"parameters": [
{
"name": "format",
"in": "path",
"description": "Desired response format. Valid entries are JSON or XML.",
"required": true,
"schema": {
"type": "string",
"enum": [
"JSON",
"XML"
],
"default": "JSON"
}
},
{
"name": "date",
"in": "path",
"description": "The date of the game(s).\n
Examples: 2017-OCT-31, 2018-FEB-15.\n ",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PlayerGame"
}
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Unauthorized"
}
}
}
}
},
"tags": [
"NHL v3 Stats"
]
}
},
"/v3/nhl/stats/{format}/PlayerSeasonStats/{season}": {
"get": {
"description": "Returns all season-long stats (i.e. the season total, not each individual game record) for all players for a given season.",
"operationId": "nhl_v3_stats_player_season_stats",
"summary": "Player Season Stats",
"parameters": [
{
"name": "format",
"in": "path",
"description": "Desired response format. Valid entries are JSON or XML.",
"required": true,
"schema": {
"type": "string",
"enum": [
"JSON",
"XML"
],
"default": "JSON"
}
},
{
"name": "season",
"in": "path",
"description": "Year of the season.\n
Examples: 2016, 2017.\n ",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PlayerSeason"
}
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Unauthorized"
}
}
}
}
},
"tags": [
"NHL v3 Stats"
]
}
},
"/v3/nhl/stats/{format}/PlayerSeasonStatsByTeam/{season}/{team}": {
"get": {
"description": "Returns all season-long stats (i.e. the season total, not each individual game record) for a given team's players in a given season.",
"operationId": "nhl_v3_stats_player_season_stats___by_team",
"summary": "Player Season Stats - by Team",
"parameters": [
{
"name": "format",
"in": "path",
"description": "Desired response format. Valid entries are JSON or XML.",
"required": true,
"schema": {
"type": "string",
"enum": [
"JSON",
"XML"
],
"default": "JSON"
}
},
{
"name": "season",
"in": "path",
"description": "Year of the season.\n
Examples: 2016, 2017.\n ",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "team",
"in": "path",
"description": "The abbreviation of the requested team.\n
Examples: SF, NYY.\n ",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PlayerSeason"
}
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Unauthorized"
}
}
}
}
},
"tags": [
"NHL v3 Stats"
]
}
},
"/v3/nhl/stats/{format}/TeamStatsAllowedByPosition/{season}": {
"get": {
"description": "Aggregated season stats allowed by each team against a given position (e.g. C, LW.)",
"operationId": "nhl_v3_stats_team_stats_allowed___by_position",
"summary": "Team Stats Allowed - by Position",
"parameters": [
{
"name": "format",
"in": "path",
"description": "Desired response format. Valid entries are JSON or XML.",
"required": true,
"schema": {
"type": "string",
"enum": [
"JSON",
"XML"
],
"default": "JSON"
}
},
{
"name": "season",
"in": "path",
"description": "Year of the season.\n
Examples: 2016, 2017.\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 Stats"
]
}
},
"/v3/nhl/stats/{format}/LinesBySeason/{season}": {
"get": {
"description": "The line combinations - groups of skaters that play together - ordered and given by season.",
"operationId": "nhl_v3_stats_line_combinations___by_season",
"summary": "Line Combinations - by Season",
"parameters": [
{
"name": "format",
"in": "path",
"description": "Desired response format. Valid entries are JSON or XML.",
"required": true,
"schema": {
"type": "string",
"enum": [
"JSON",
"XML"
],
"default": "JSON"
}
},
{
"name": "season",
"in": "path",
"description": "Year of the season.\n
Examples: 2016, 2017.\n ",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TeamLine"
}
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Unauthorized"
}
}
}
}
},
"tags": [
"NHL v3 Stats"
]
}
},
"/v3/nhl/stats/{format}/PlayerGameStatsBySeason/{season}/{playerid}/{numberofgames}": {
"get": {
"description": "Specify a season, a player, and number of games (either an integer or all) to see all of their box score logs. Refreshed after their most recent game is complete.",
"operationId": "nhl_v3_stats_player_game_logs___by_season",
"summary": "Player Game Logs - by Season",
"parameters": [
{
"name": "format",
"in": "path",
"description": "Desired response format. Valid entries are JSON or XML.",
"required": true,
"schema": {
"type": "string",
"enum": [
"JSON",
"XML"
],
"default": "JSON"
}
},
{
"name": "season",
"in": "path",
"description": "Season to get games from. Example 2019POST, 2020",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "playerid",
"in": "path",
"description": "Unique SportsDataIO Player ID.\nExample:30000651.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "numberofgames",
"in": "path",
"description": "How many games to return. Example all, 10, 25",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PlayerGame"
}
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Unauthorized"
}
}
}
}
},
"tags": [
"NHL v3 Stats"
]
}
},
"/v3/nhl/stats/{format}/BoxScoreFinal/{gameid}": {
"get": {
"description": "Full statistical information for a specified game, down to the team and player stat level, delivered after the game is complete.",
"operationId": "nhl_v3_stats_box_score__final",
"summary": "Box Score [Final]",
"parameters": [
{
"name": "format",
"in": "path",
"description": "Desired response format. Valid entries are JSON or XML.",
"required": true,
"schema": {
"type": "string",
"enum": [
"JSON",
"XML"
],
"default": "JSON"
}
},
{
"name": "gameid",
"in": "path",
"description": "The GameID of an NHL game. GameIDs can be found in the Games API. Valid entries are 14620 or 16905",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BoxScore"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Unauthorized"
}
}
}
}
},
"tags": [
"NHL v3 Stats"
]
}
},
"/v3/nhl/stats/{format}/BoxScoresFinal/{date}": {
"get": {
"description": "Full statistical information for a specified date for each game that took place, down to the team and player stat level, delivered after the game is complete.",
"operationId": "nhl_v3_stats_box_scores___by_date__final",
"summary": "Box Scores - by Date [Final]",
"parameters": [
{
"name": "format",
"in": "path",
"description": "Desired response format. Valid entries are JSON or XML.",
"required": true,
"schema": {
"type": "string",
"enum": [
"JSON",
"XML"
],
"default": "JSON"
}
},
{
"name": "date",
"in": "path",
"description": "The date of the game(s).\n
Examples: 2017-OCT-31, 2018-FEB-15.\n ",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/BoxScore"
}
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Unauthorized"
}
}
}
}
},
"tags": [
"NHL v3 Stats"
]
}
},
"/v3/nhl/stats/{format}/TeamGameStatsByDateFinal/{date}": {
"get": {
"description": "Returns the box score statistical record team-wide (aggregated from all players) for a given team's game in a given week after the game has concluded.",
"operationId": "nhl_v3_stats_team_game_stats___by_date__final",
"summary": "Team Game Stats - by Date [Final]",
"parameters": [
{
"name": "format",
"in": "path",
"description": "Desired response format. Valid entries are JSON or XML.",
"required": true,
"schema": {
"type": "string",
"enum": [
"JSON",
"XML"
],
"default": "JSON"
}
},
{
"name": "date",
"in": "path",
"description": "The date of the game(s).\n
Examples: 2018-JAN-31, 2017-OCT-01.\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 Stats"
]
}
},
"/v3/nhl/stats/{format}/PlayerGameStatsByDateFinal/{date}": {
"get": {
"description": "Returns the box score statistical record for all involved players across all teams' games on a given date after each game has concluded.",
"operationId": "nhl_v3_stats_player_game_stats___by_date__final",
"summary": "Player Game Stats - by Date [Final]",
"parameters": [
{
"name": "format",
"in": "path",
"description": "Desired response format. Valid entries are JSON or XML.",
"required": true,
"schema": {
"type": "string",
"enum": [
"JSON",
"XML"
],
"default": "JSON"
}
},
{
"name": "date",
"in": "path",
"description": "The date of the game(s).\n
Examples: 2017-OCT-31, 2018-FEB-15.\n ",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PlayerGame"
}
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Unauthorized"
}
}
}
}
},
"tags": [
"NHL v3 Stats"
]
}
},
"/v3/nhl/stats/{format}/FantasyGameStatsByDate/{date}": {
"get": {
"description": "Simple fantasy points awarded to each player who took part in a game on a given date.",
"operationId": "nhl_v3_stats_fantasy_points___by_date",
"summary": "Fantasy Points - by Date",
"parameters": [
{
"name": "format",
"in": "path",
"description": "Desired response format. Valid entries are JSON or XML.",
"required": true,
"schema": {
"type": "string",
"enum": [
"JSON",
"XML"
],
"default": "JSON"
}
},
{
"name": "date",
"in": "path",
"description": "The date of the game(s).\n
Examples: 2017-OCT-31, 2018-FEB-15.\n ",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FantasyGame"
}
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Unauthorized"
}
}
}
}
},
"tags": [
"NHL v3 Stats"
]
}
},
"/v3/nhl/pbp/{format}/PlayByPlay/{gameid}": {
"get": {
"description": "Each invididual play, its type and outcome, complete with player and team stats down to the play level, delivered live in real-time, called by game.",
"operationId": "nhl_v3_pbp_play_by_play__live___final",
"summary": "Play By Play [Live & Final]",
"parameters": [
{
"name": "format",
"in": "path",
"description": "Desired response format. Valid entries are JSON or XML.",
"required": true,
"schema": {
"type": "string",
"enum": [
"JSON",
"XML"
],
"default": "JSON"
}
},
{
"name": "gameid",
"in": "path",
"description": "The GameID of an NHL game. GameIDs can be found in the Games API. Valid entries are 14620 or 16905",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PlayByPlay"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Unauthorized"
}
}
}
}
},
"tags": [
"NHL v3 Play-by-Play"
]
}
},
"/v3/nhl/pbp/{format}/PlayByPlayDelta/{date}/{minutes}": {
"get": {
"description": "This method returns all play-by-plays for a given season and week, but only returns plays that have changed in the last X minutes as specified in your API call. By definition this is a live endpoint, not final.",
"operationId": "nhl_v3_pbp_play_by_play_delta",
"summary": "Play By Play Delta",
"parameters": [
{
"name": "format",
"in": "path",
"description": "Desired response format. Valid entries are JSON or XML.",
"required": true,
"schema": {
"type": "string",
"enum": [
"JSON",
"XML"
],
"default": "JSON"
}
},
{
"name": "date",
"in": "path",
"description": "The date of the game(s).\n
Examples: 2018-JAN-31, 2017-OCT-01.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "minutes",
"in": "path",
"description": "Only returns plays that have changed in the last X minutes. You specify how many minutes in time to go back. Valid entries are:\n1, 2 ... all.",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PlayByPlay"
}
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Unauthorized"
}
}
}
}
},
"tags": [
"NHL v3 Play-by-Play"
]
}
},
"/v3/nhl/pbp/{format}/PlayByPlayFinal/{gameid}": {
"get": {
"description": "Each invididual play, its type and outcome, complete with player and team stats down to the play level, delivered final (after the game ends), called by game.",
"operationId": "nhl_v3_pbp_play_by_play__final",
"summary": "Play By Play [Final]",
"parameters": [
{
"name": "format",
"in": "path",
"description": "Desired response format. Valid entries are JSON or XML.",
"required": true,
"schema": {
"type": "string",
"enum": [
"JSON",
"XML"
],
"default": "JSON"
}
},
{
"name": "gameid",
"in": "path",
"description": "The GameID of an NHL game. GameIDs can be found in the Games API. Valid entries are 14620 or 16905",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PlayByPlay"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Unauthorized"
}
}
}
}
},
"tags": [
"NHL v3 Play-by-Play"
]
}
},
"/v3/nhl/headshots/{format}/Headshots": {
"get": {
"description": "Headshots",
"operationId": "nhl_v3_headshots_headshots",
"summary": "Headshots",
"parameters": [
{
"name": "format",
"in": "path",
"description": "Desired response format. Valid entries are JSON or XML.",
"required": true,
"schema": {
"type": "string",
"enum": [
"JSON",
"XML"
],
"default": "JSON"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Headshot"
}
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Unauthorized"
}
}
}
}
},
"tags": [
"NHL v3 Headshots"
]
}
},
"/v3/nhl/news-rotoballer/{format}/RotoBallerPremiumNews": {
"get": {
"description": "RotoBaller's Premium News feed, with the latest updated stories in greater detail.",
"operationId": "nhl_v3_news_rotoballer_premium_news",
"summary": "Premium News",
"parameters": [
{
"name": "format",
"in": "path",
"description": "Desired response format. Valid entries are JSON or XML.",
"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 RotoBaller Premium News"
]
}
},
"/v3/nhl/news-rotoballer/{format}/RotoBallerPremiumNewsByDate/{date}": {
"get": {
"description": "RotoBaller's Premium News feed, with the latest updated stories in greater detail called by date.",
"operationId": "nhl_v3_news_rotoballer_premium_news___by_date",
"summary": "Premium News - by Date",
"parameters": [
{
"name": "format",
"in": "path",
"description": "Desired response format. Valid entries are JSON or XML.",
"required": true,
"schema": {
"type": "string",
"enum": [
"JSON",
"XML"
],
"default": "JSON"
}
},
{
"name": "date",
"in": "path",
"description": "The date of the news.\n
Examples: 2021-JAN-06, 2021-JAN-31.",
"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 RotoBaller Premium News"
]
}
}
},
"components": {
"schemas": {
"Unauthorized": {
"properties": {
"HttpStatusCode": {
"type": "integer"
},
"Code": {
"type": "integer"
},
"Description": {
"type": "string"
},
"Help": {
"type": "string"
}
}
},
"Player": {
"properties": {
"PlayerID": {
"type": "integer",
"description": "\"The player's unique PlayerID as assigned by SportsDataIO. Note: this ID will stay with the player throughout their entire career\""
},
"FirstName": {
"type": [
"string",
"null"
],
"description": "The first name of the player"
},
"LastName": {
"type": [
"string",
"null"
],
"description": "The player's last name"
},
"Status": {
"type": [
"string",
"null"
],
"description": "The player's current status. Possible values include Active; Inactive; Injured Reserve; Minors; Suspended; Bereavement; Paternity"
},
"TeamID": {
"type": [
"integer",
"null"
],
"description": "The unique ID of the team"
},
"Team": {
"type": [
"string",
"null"
],
"description": "The abbreviation [Key] of the team this player is employed by"
},
"Position": {
"type": [
"string",
"null"
],
"description": "The player's primary position. Possible values: C, RW, LW, D, or G."
},
"Jersey": {
"type": [
"integer",
"null"
],
"description": "The player's jersey number"
},
"Catches": {
"type": [
"string",
"null"
],
"description": "The hand in which the player uses to catch the puck (Right or Left). Note: This field will be null for non-goaltenders"
},
"Shoots": {
"type": [
"string",
"null"
],
"description": "The hand the player shoots the puck with (right or left)"
},
"Height": {
"type": [
"integer",
"null"
],
"description": "The player's height in inches"
},
"Weight": {
"type": [
"integer",
"null"
],
"description": "The player's weight in pounds (lbs)."
},
"BirthDate": {
"type": [
"string",
"null"
],
"description": "The player's date of birth"
},
"BirthCity": {
"type": [
"string",
"null"
],
"description": "The city in which the player was born"
},
"BirthState": {
"type": [
"string",
"null"
],
"description": "The US state in which the player was born. NOTE: If a player was born outside of North America or Australia, this field will be null"
},
"PhotoUrl": {
"type": [
"string",
"null"
],
"description": "This field is deprecated. Photos are no longer available through it. Headshots are now delivered through IMAGN. Please see our Headshots products for further information."
},
"SportRadarPlayerID": {
"type": [
"string",
"null"
],
"description": "The player's cross reference PlayerID to the SportRadar API."
},
"RotoworldPlayerID": {
"type": [
"integer",
"null"
],
"description": "The player's cross reference PlayerID to the Rotoworld news feed"
},
"RotoWirePlayerID": {
"type": [
"integer",
"null"
],
"description": "The player's cross reference PlayerID to the RotoWire news feed"
},
"FantasyAlarmPlayerID": {
"type": [
"integer",
"null"
],
"description": "The player's cross reference PlayerID to the FantasyAlarm news feed"
},
"StatsPlayerID": {
"type": [
"integer",
"null"
],
"description": "The player's cross reference PlayerID to the STATS data feeds"
},
"SportsDirectPlayerID": {
"type": [
"integer",
"null"
],
"description": "The player's cross reference PlayerID to the SportsDirect data feeds, now part of Nielsen GraceNote."
},
"XmlTeamPlayerID": {
"type": [
"integer",
"null"
],
"description": "The player's cross reference PlayerID to the XML Team data feeds."
},
"InjuryStatus": {
"type": [
"string",
"null"
],
"description": "The player's current injury status; in the form of likelihood that player plays. Possible values: Probable; Questionable; Doubtful; Out"
},
"InjuryBodyPart": {
"type": [
"string",
"null"
],
"description": "The body part that is injured for the player (Knee; Groin; Calf; Upper-body; etc.)"
},
"InjuryStartDate": {
"type": [
"string",
"null"
],
"description": "The day that the injury started or was first discovered"
},
"InjuryNotes": {
"type": [
"string",
"null"
],
"description": "Brief description of the player's injury and expected availability"
},
"FanDuelPlayerID": {
"type": [
"integer",
"null"
],
"description": "The player's cross reference PlayerID to FanDuel"
},
"DraftKingsPlayerID": {
"type": [
"integer",
"null"
],
"description": "The player's cross reference PlayerID to DraftKings"
},
"YahooPlayerID": {
"type": [
"integer",
"null"
],
"description": "The player's cross reference PlayerID to Yahoo Daily Fantasy Sports Contests."
},
"FanDuelName": {
"type": [
"string",
"null"
],
"description": "The player's full name in FanDuel's daily fantasy sports platform"
},
"DraftKingsName": {
"type": [
"string",
"null"
],
"description": "The player's full name in DraftKings' daily fantasy sports platform"
},
"YahooName": {
"type": [
"string",
"null"
],
"description": "The player's full name in Yahoo's daily fantasy sports platform."
},
"DepthChartPosition": {
"type": [
"string",
"null"
],
"description": "The position of the player in the team's depth chart"
},
"DepthChartOrder": {
"type": [
"integer",
"null"
],
"description": "The order of the player in the team's depth chart"
},
"GlobalTeamID": {
"type": [
"integer",
"null"
],
"description": "A globally unique ID for this team. This value is guaranteed to be unique across all sports/leagues."
},
"FantasyDraftName": {
"type": [
"string",
"null"
],
"description": "The player's full name in FantasyDraft's daily fantasy sports platform"
},
"FantasyDraftPlayerID": {
"type": [
"integer",
"null"
],
"description": "The player's cross reference PlayerID to FantasyDraft"
},
"UsaTodayPlayerID": {
"type": [
"integer",
"null"
],
"description": "The player's cross reference PlayerID to USA Today headshot data feeds."
},
"UsaTodayHeadshotUrl": {
"type": [
"string",
"null"
],
"description": "The player's headshot URL as provided by USA Today. License from USA Today is required."
},
"UsaTodayHeadshotNoBackgroundUrl": {
"type": [
"string",
"null"
],
"description": "The player's transparent background headshot URL as provided by USA Today. License from USA Today is required."
},
"UsaTodayHeadshotUpdated": {
"type": [
"string",
"null"
],
"description": "The last updated date of the player's headshot as provided by USA Today. License from USA Today is required."
},
"UsaTodayHeadshotNoBackgroundUpdated": {
"type": [
"string",
"null"
],
"description": "The last updated date of the player's transparent background headshot as provided by USA Today. License from USA Today is required."
}
}
},
"Team": {
"properties": {
"TeamID": {
"type": "integer",
"description": "The unique ID of the team"
},
"Key": {
"type": [
"string",
"null"
],
"description": "Abbreviation of the team (e.g. LA, PHI, BOS, CHI, etc.)"
},
"Active": {
"type": "boolean",
"description": "Whether or not this team is active"
},
"City": {
"type": [
"string",
"null"
],
"description": "The city/location of the team (e.g. Los Angeles, Philadelphia, Boston, Chicago, etc.)"
},
"Name": {
"type": [
"string",
"null"
],
"description": "The mascot of the team (e.g. Kings, Flyers, Bruins, Blackhawks, etc.)"
},
"StadiumID": {
"type": [
"integer",
"null"
],
"description": "The unique ID of the team's current home arena"
},
"Conference": {
"type": [
"string",
"null"
],
"description": "The conference of the team (possible values: Eastern, Western)"
},
"Division": {
"type": [
"string",
"null"
],
"description": "The division of the team (e.g. Atlantic; Metropolitan; Central; or Pacific)"
},
"PrimaryColor": {
"type": [
"string",
"null"
],
"description": "The team's first color (This is not licensed for public or commercial use)"
},
"SecondaryColor": {
"type": [
"string",
"null"
],
"description": "The team's second color (This is not licensed for public or commercial use)"
},
"TertiaryColor": {
"type": [
"string",
"null"
],
"description": "The team's third color (This is not licensed for public or commercial use)"
},
"QuaternaryColor": {
"type": [
"string",
"null"
],
"description": "The team's fourth color (This is not licensed for public or commercial use)"
},
"WikipediaLogoUrl": {
"type": [
"string",
"null"
],
"description": "The link to the team's logo hosted on Wikipedia. (This is not licensed for public or commercial use)"
},
"WikipediaWordMarkUrl": {
"type": [
"string",
"null"
],
"description": "The link to the team's wordmark logo hosted on Wikipedia. (This is not licensed for public or commercial use)"
},
"GlobalTeamID": {
"type": "integer",
"description": "A globally unique ID for this team. This value is guaranteed to be unique across all sports/leagues."
},
"HeadCoach": {
"type": [
"string",
"null"
],
"description": "The current head coach of the team"
}
}
},
"Game": {
"properties": {
"GameID": {
"type": "integer",
"description": "The unique ID of this game"
},
"Season": {
"type": "integer",
"description": "The NHL season of the game"
},
"SeasonType": {
"type": "integer",
"description": "The type of season that this record corresponds to (1=Regular Season, 2=Preseason, 3=Postseason, 5=AllStar, 6=Exhibition)."
},
"Status": {
"type": [
"string",
"null"
],
"description": "Indicates the game's status. Possible values include: Scheduled, InProgress, Final, F/SO, F/OT, Suspended, Postponed, Delayed, Canceled, Forfeit, NotNecessary"
},
"Day": {
"type": [
"string",
"null"
],
"description": "The date of the game"
},
"DateTime": {
"type": [
"string",
"null"
],
"description": "The date and time of the game in US Eastern Time"
},
"Updated": {
"type": [
"string",
"null"
],
"description": "The timestamp of when the record was last updated (in US Eastern Time)."
},
"IsClosed": {
"type": [
"boolean",
"null"
],
"description": "Indicates whether the game is over and the final score has been verified and closed out. NOTE: it is recommend for bet resulting to use IsClosed = True rather than simply Final game status"
},
"AwayTeam": {
"type": [
"string",
"null"
],
"description": "The abbreviation [Key] of the away team"
},
"HomeTeam": {
"type": [
"string",
"null"
],
"description": "The abbreviation [Key] of the home team"
},
"AwayTeamID": {
"type": "integer",
"description": "The unique ID of the away team"
},
"HomeTeamID": {
"type": "integer",
"description": "The unique ID of the home team"
},
"StadiumID": {
"type": [
"integer",
"null"
],
"description": "The unique ID of the stadium"
},
"Channel": {
"type": [
"string",
"null"
],
"description": "The television station broadcasting the game"
},
"Attendance": {
"type": [
"integer",
"null"
],
"description": "The total number of people who attended the game"
},
"AwayTeamScore": {
"type": [
"integer",
"null"
],
"description": "Total number of goals scored by the away team in the game"
},
"HomeTeamScore": {
"type": [
"integer",
"null"
],
"description": "Total number of goals scored by the home team in the game"
},
"Period": {
"type": [
"string",
"null"
],
"description": "Indicates the current period of the game. Possible values include: 1; 2; 3; OT; SO; NULL"
},
"TimeRemainingMinutes": {
"type": [
"integer",
"null"
],
"description": "Number of minutes remaining in the current period"
},
"TimeRemainingSeconds": {
"type": [
"integer",
"null"
],
"description": "Number of seconds that have passed in the current period. NOTE: this field name might be misleading as it actually represents the game clock sconds which are the number of minutes that have already passed in the period."
},
"AwayTeamMoneyLine": {
"type": [
"integer",
"null"
],
"description": "Moneyline from the perspective of the away team"
},
"HomeTeamMoneyLine": {
"type": [
"integer",
"null"
],
"description": "Moneyline from the perspective of the home team"
},
"PointSpread": {
"type": [
"number",
"null"
],
"description": "The oddsmaker puck line at game start from the perspective of the HomeTeam (negative numbers indicate the HomeTeam is favored; positive numbers indicate the AwayTeam is favored)."
},
"OverUnder": {
"type": [
"number",
"null"
],
"description": "The sportsbook's total goals scored line (Over/Under) for the game"
},
"GlobalGameID": {
"type": "integer",
"description": "A globally unique ID for this game. This value is guaranteed to be unique across all sports/leagues."
},
"GlobalAwayTeamID": {
"type": "integer",
"description": "A globally unique ID for the away team. This value is guaranteed to be unique across all sports/leagues."
},
"GlobalHomeTeamID": {
"type": "integer",
"description": "A globally unique ID for the home team. This value is guaranteed to be unique across all sports/leagues."
},
"PointSpreadAwayTeamMoneyLine": {
"type": [
"integer",
"null"
],
"description": "The payout odds when betting on the away team with the puck line"
},
"PointSpreadHomeTeamMoneyLine": {
"type": [
"integer",
"null"
],
"description": "The payout odds when betting on the home team with the puck line"
},
"LastPlay": {
"type": [
"string",
"null"
],
"description": "The description of the most recent play/event of the game. This is for display purposes and does not include corresponding data points."
},
"Periods": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Period"
},
"description": "The details of the periods (including overtime if applicable) for this game."
},
"GameEndDateTime": {
"type": [
"string",
"null"
],
"description": "The date and time that the game ended in US Eastern Time"
},
"HomeRotationNumber": {
"type": [
"integer",
"null"
],
"description": "The rotation number of the home team for this game"
},
"AwayRotationNumber": {
"type": [
"integer",
"null"
],
"description": "The rotation number of the away team for a game"
},
"NeutralVenue": {
"type": [
"boolean",
"null"
],
"description": "Indicates whether this game is played in a neutral venue"
},
"OverPayout": {
"type": [
"integer",
"null"
],
"description": "The sportsbook's payout for the over"
},
"UnderPayout": {
"type": [
"integer",
"null"
],
"description": "The sportsbook's payout for the under"
},
"DateTimeUTC": {
"type": [
"string",
"null"
],
"description": "The date and time of the game in UTC"
},
"SeriesInfo": {
"$ref": "#/components/schemas/Series",
"description": "Contains relevant series data for playoff series only - HomeTeamWins, AwayTeamWins, GameNumber, and MaxLength"
},
"RescheduledFromGameID": {
"type": [
"integer",
"null"
],
"description": "The GameID of the originally scheduled, postponed game, that this game was rescheduled from. This only pertains to games that are scheduled as \"make up\" games."
},
"RescheduledGameID": {
"type": [
"integer",
"null"
],
"description": "The GameID of the game that was rescheduled from this game. This only pertains to postponed games that require rescheduling."
},
"Referee1ID": {
"type": [
"integer",
"null"
],
"description": "The unique ID of the main referee of this game"
},
"Referee2ID": {
"type": [
"integer",
"null"
],
"description": "The unique ID of the secondary referee of this game"
},
"Linesperson1ID": {
"type": [
"integer",
"null"
],
"description": "The unique ID of the main linesperson of this game"
},
"Linesperson2ID": {
"type": [
"integer",
"null"
],
"description": "The unique ID of the secondary linesperson of this game"
}
}
},
"Period": {
"properties": {
"PeriodID": {
"type": "integer",
"description": "The unique ID associated of this period"
},
"GameID": {
"type": "integer",
"description": "The unique ID of this game tied to this period"
},
"Name": {
"type": [
"string",
"null"
],
"description": "The name of the period (possible values: 1; 2; 3; SO; OT; OT2; OT3; OT4; etc)"
},
"AwayScore": {
"type": [
"integer",
"null"
],
"description": "Total goals scored by the away team in a given period"
},
"HomeScore": {
"type": [
"integer",
"null"
],
"description": "Total goals scored by the home team in the period"
},
"ScoringPlays": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ScoringPlay"
},
"description": "The details of the scoring plays that occurred during this period"
},
"Penalties": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Penalty"
},
"description": "The details of the penalties that occurred during this period"
}
}
},
"ScoringPlay": {
"properties": {
"ScoringPlayID": {
"type": "integer",
"description": "The unique ID of the scoring play"
},
"PeriodID": {
"type": "integer",
"description": "The unique ID associated of this period"
},
"Sequence": {
"type": [
"integer",
"null"
],
"description": "The sequence/order that this scoring play happened"
},
"TimeRemainingMinutes": {
"type": [
"integer",
"null"
],
"description": "Number of minutes that have passed in the current period. NOTE: this field name might be misleading as it actually represents the game clock minutes which are the number of minutes that have already passed in the period."
},
"TimeRemainingSeconds": {
"type": [
"integer",
"null"
],
"description": "Number of seconds that have passed in the current period. NOTE: this field name might be misleading as it actually represents the game clock sconds which are the number of minutes that have already passed in the period."
},
"ScoredByTeamID": {
"type": [
"integer",
"null"
],
"description": "The TeamID of the team that scored the goal"
},
"AllowedByTeamID": {
"type": [
"integer",
"null"
],
"description": "The TeamID of the team that allowed the goal"
},
"ScoredByPlayerID": {
"type": [
"integer",
"null"
],
"description": "The PlayerID of the player who scored the goal"
},
"AssistedByPlayerID1": {
"type": [
"integer",
"null"
],
"description": "The PlayerID of the FIRST player who assisted on the goal"
},
"AssistedByPlayerID2": {
"type": [
"integer",
"null"
],
"description": "The PlayerID of the SECOND player who assisted on the goal"
},
"PowerPlay": {
"type": [
"boolean",
"null"
],
"description": "Whether or not the goal was scored on the power play"
},
"ShortHanded": {
"type": [
"boolean",
"null"
],
"description": "Whether the goal was scored shorthanded"
},
"EmptyNet": {
"type": [
"boolean",
"null"
],
"description": "Whether the goal was an empty net goal or not"
},
"AwayTeamScore": {
"type": [
"integer",
"null"
],
"description": "The score of the away team after the conclusion of the scoring play"
},
"HomeTeamScore": {
"type": [
"integer",
"null"
],
"description": "The score of the home team after the conclusion of the scoring play"
}
}
},
"Penalty": {
"properties": {
"PenaltyID": {
"type": "integer",
"description": "The unique ID of this penalty"
},
"PeriodID": {
"type": "integer",
"description": "The unique ID of the period during which this penalty occurred"
},
"Sequence": {
"type": [
"integer",
"null"
],
"description": "The sequence/order that this penalty happened"
},
"TimeRemainingMinutes": {
"type": [
"integer",
"null"
],
"description": "Number of minutes that have passed in the current period. NOTE: this field name might be misleading as it actually represents the game clock minutes which are the number of minutes that have already passed in the period."
},
"TimeRemainingSeconds": {
"type": [
"integer",
"null"
],
"description": "Number of seconds that have passed in the current period. NOTE: this field name might be misleading as it actually represents the game clock seconds which are the number of minutes that have already passed in the period."
},
"Description": {
"type": [
"string",
"null"
],
"description": "The description of the penalty"
},
"PenaltyMinutes": {
"type": [
"integer",
"null"
],
"description": "Total minutes the penalty lasts"
},
"PenalizedTeamID": {
"type": [
"integer",
"null"
],
"description": "The TeamID of the team who committed the penalty"
},
"PenalizedPlayerID": {
"type": [
"integer",
"null"
],
"description": "The PlayerID of the player who committed the penalty"
},
"DrawnByTeamID": {
"type": [
"integer",
"null"
],
"description": "The TeamID of the player/team that drew the penalty"
},
"DrawnByPlayerID": {
"type": [
"integer",
"null"
],
"description": "The PlayerID of the player who drew the penalty"
},
"IsBenchPenalty": {
"type": [
"boolean",
"null"
],
"description": "Whether or not the penalty is a bench penalty"
},
"BenchPenaltyServedByPlayerID": {
"type": [
"integer",
"null"
],
"description": "The PlayerID of the player who served the bench penalty"
}
}
},
"Series": {
"properties": {
"HomeTeamWins": {
"type": "integer",
"description": "Total wins in the series by the home team"
},
"AwayTeamWins": {
"type": "integer",
"description": "Total wins in the series by the away team"
},
"GameNumber": {
"type": "integer",
"description": "The number of the game being played in the series"
},
"MaxLength": {
"type": "integer",
"description": "The maximum number of games that can be played in a postseason series"
}
}
},
"News": {
"properties": {
"NewsID": {
"type": "integer",
"description": "The unique ID of the news story"
},
"PlayerID": {
"type": [
"integer",
"null"
],
"description": "The player's unique PlayerID as assigned by SportsDataIO. Note: this ID will stay with the player throughout their entire career"
},
"TeamID": {
"type": [
"integer",
"null"
],
"description": "The unique ID of the team"
},
"Team": {
"type": [
"string",
"null"
],
"description": "The abbreviation [Key] of the team"
},
"Title": {
"type": [
"string",
"null"
],
"description": "The title of the news story"
},
"Content": {
"type": [
"string",
"null"
],
"description": "The full body content of the story"
},
"Url": {
"type": [
"string",
"null"
],
"description": "The URL of the full news story"
},
"Source": {
"type": [
"string",
"null"
],
"description": "The source of the story (RotoBaller, NBCSports.com, etc.)"
},
"TermsOfUse": {
"type": [
"string",
"null"
],
"description": "The terms of use with using this news item, credit must be given to the originator of the story when specified in the terms of use"
},
"Updated": {
"type": [
"string",
"null"
],
"description": "The timestamp of when the news story was last updated"
},
"TimeAgo": {
"type": [
"string",
"null"
],
"description": "A description of how long ago this content was published"
}
}
},
"Stadium": {
"properties": {
"StadiumID": {
"type": "integer",
"description": "The unique ID of the arena"
},
"Active": {
"type": "boolean",
"description": "Whether or not this stadium is the home venue for an active team"
},
"Name": {
"type": [
"string",
"null"
],
"description": "The full name of the arena"
},
"Address": {
"type": [
"string",
"null"
],
"description": "The address where the venue is located"
},
"City": {
"type": [
"string",
"null"
],
"description": "The city where the venue is located"
},
"State": {
"type": [
"string",
"null"
],
"description": "The US state where the arena is located (if arena is outside US, this value is NULL)"
},
"Zip": {
"type": [
"string",
"null"
],
"description": "The zip code of the arena"
},
"Country": {
"type": [
"string",
"null"
],
"description": "The country code where the arena is located"
},
"Capacity": {
"type": [
"integer",
"null"
],
"description": "The estimated seating capacity of the arena"
},
"GeoLat": {
"type": [
"number",
"null"
],
"description": "The geographic latitude coordinate of this venue."
},
"GeoLong": {
"type": [
"number",
"null"
],
"description": "The geographic longitude coordinate of this venue."
}
}
},
"TeamGame": {
"properties": {
"StatID": {
"type": "integer",
"description": "The unique ID of the stat"
},
"TeamID": {
"type": [
"integer",
"null"
],
"description": "The unique ID of the team"
},
"SeasonType": {
"type": [
"integer",
"null"
],
"description": "The type of season that this record corresponds to (1=Regular Season; 2=Preseason; 3=Postseason; 5=AllStar; 6=Exhibition)"
},
"Season": {
"type": [
"integer",
"null"
],
"description": "The NHL season of the game"
},
"Name": {
"type": [
"string",
"null"
],
"description": "The team's full name (ex. Minnesota Wild; New York Islanders)"
},
"Team": {
"type": [
"string",
"null"
],
"description": "The abbreviation [Key] of the team"
},
"Wins": {
"type": [
"integer",
"null"
],
"description": "Total number of wins by the team in the game. NOTE: this will be one for single game feeds"
},
"Losses": {
"type": [
"integer",
"null"
],
"description": "Total losses for the team in the game. NOTE: this will be a maximum of one for single game feeds"
},
"OvertimeLosses": {
"type": [
"integer",
"null"
],
"description": "Total overtime losses by the team in the game"
},
"GlobalTeamID": {
"type": [
"integer",
"null"
],
"description": "A globally unique ID for this team. This value is guaranteed to be unique across all sports/leagues"
},
"GameID": {
"type": [
"integer",
"null"
],
"description": "The unique ID of this game"
},
"OpponentID": {
"type": [
"integer",
"null"
],
"description": "The unique ID of the team's opponent"
},
"Opponent": {
"type": [
"string",
"null"
],
"description": "The name of the opponent "
},
"Day": {
"type": [
"string",
"null"
],
"description": "The day of the game"
},
"DateTime": {
"type": [
"string",
"null"
],
"description": "The date and time of the game"
},
"HomeOrAway": {
"type": [
"string",
"null"
],
"description": "Whether the team is home or away"
},
"IsGameOver": {
"type": "boolean",
"description": "Whether the game is over (true/false)"
},
"GlobalGameID": {
"type": [
"integer",
"null"
],
"description": "A globally unique ID for this game. This value is guaranteed to be unique across all sports/leagues."
},
"GlobalOpponentID": {
"type": [
"integer",
"null"
],
"description": "A globally unique ID for this opponent. This value is guaranteed to be unique across all sports/leagues."
},
"Updated": {
"type": [
"string",
"null"
],
"description": "The timestamp of when the record was last updated (US Eastern Time)."
},
"Games": {
"type": [
"integer",
"null"
],
"description": "The number of games played."
},
"FantasyPoints": {
"type": [
"number",
"null"
],
"description": "Total fantasy points"
},
"FantasyPointsFanDuel": {
"type": [
"number",
"null"
],
"description": "Total FanDuel daily fantasy points scored"
},
"FantasyPointsDraftKings": {
"type": [
"number",
"null"
],
"description": "Total DraftKings daily fantasy points scored"
},
"FantasyPointsYahoo": {
"type": [
"number",
"null"
],
"description": "Total Yahoo daily fantasy points scored"
},
"Minutes": {
"type": [
"integer",
"null"
],
"description": "Total number of minutes played"
},
"Seconds": {
"type": [
"integer",
"null"
],
"description": "Total number of seconds played"
},
"Goals": {
"type": [
"number",
"null"
],
"description": "Total number of goals scored"
},
"Assists": {
"type": [
"number",
"null"
],
"description": "Total number of assists"
},
"ShotsOnGoal": {
"type": [
"number",
"null"
],
"description": "Total number of shots on goal"
},
"PowerPlayGoals": {
"type": [
"number",
"null"
],
"description": "Total number of power play goals"
},
"ShortHandedGoals": {
"type": [
"number",
"null"
],
"description": "Total number of short handed goals"
},
"EmptyNetGoals": {
"type": [
"number",
"null"
],
"description": "Total number of empty net goals"
},
"PowerPlayAssists": {
"type": [
"number",
"null"
],
"description": "Total number of power play assists"
},
"ShortHandedAssists": {
"type": [
"number",
"null"
],
"description": "Total number of short handed assists"
},
"HatTricks": {
"type": [
"number",
"null"
],
"description": "Total number of hat tricks"
},
"ShootoutGoals": {
"type": [
"number",
"null"
],
"description": "Total number of shootout goals"
},
"PlusMinus": {
"type": [
"number",
"null"
],
"description": "Total plus minus"
},
"PenaltyMinutes": {
"type": [
"number",
"null"
],
"description": "Total pentalty minutes"
},
"Blocks": {
"type": [
"number",
"null"
],
"description": "Total blocked shots"
},
"Hits": {
"type": [
"number",
"null"
],
"description": "Total hits"
},
"Takeaways": {
"type": [
"number",
"null"
],
"description": "Total takeaways"
},
"Giveaways": {
"type": [
"number",
"null"
],
"description": "Total giveaways"
},
"FaceoffsWon": {
"type": [
"number",
"null"
],
"description": "Total faceoffs won"
},
"FaceoffsLost": {
"type": [
"number",
"null"
],
"description": "Total faceoffs lost"
},
"Shifts": {
"type": [
"number",
"null"
],
"description": "Total shifts"
},
"GoaltendingMinutes": {
"type": [
"integer",
"null"
],
"description": "Total goaltending minutes"
},
"GoaltendingSeconds": {
"type": [
"integer",
"null"
],
"description": "Total goaltending seconds"
},
"GoaltendingShotsAgainst": {
"type": [
"number",
"null"
],
"description": "Total goaltending shots against"
},
"GoaltendingGoalsAgainst": {
"type": [
"number",
"null"
],
"description": "Total goaltending goals against"
},
"GoaltendingSaves": {
"type": [
"number",
"null"
],
"description": "Total goaltending saves"
},
"GoaltendingWins": {
"type": [
"number",
"null"
],
"description": "Total goaltending wins"
},
"GoaltendingLosses": {
"type": [
"number",
"null"
],
"description": "Total goaltendings losses"
},
"GoaltendingShutouts": {
"type": [
"number",
"null"
],
"description": "Total goaltendings shutouts"
},
"Started": {
"type": [
"integer",
"null"
],
"description": "Total games started"
},
"BenchPenaltyMinutes": {
"type": [
"number",
"null"
],
"description": "Total bench pentalty minutes"
},
"GoaltendingOvertimeLosses": {
"type": [
"number",
"null"
],
"description": "Total goaltending overtime losses"
},
"FantasyPointsFantasyDraft": {
"type": [
"number",
"null"
],
"description": "Total FantasyDraft daily fantasy points scored"
}
}
},
"TeamSeason": {
"properties": {
"StatID": {
"type": "integer",
"description": "The unique ID of the stat"
},
"TeamID": {
"type": [
"integer",
"null"
],
"description": "The unique ID of the team"
},
"SeasonType": {
"type": [
"integer",
"null"
],
"description": "The type of season that this record corresponds to (1=Regular Season; 2=Preseason; 3=Postseason; 5=AllStar; 6=Exhibition)"
},
"Season": {
"type": [
"integer",
"null"
],
"description": "The NHL regular season for which these totals apply"
},
"Name": {
"type": [
"string",
"null"
],
"description": "The team's full name (ex. Minnesota Wild; New York Islanders)"
},
"Team": {
"type": [
"string",
"null"
],
"description": "The abbreviation [Key] of the team"
},
"Wins": {
"type": [
"integer",
"null"
],
"description": "Total number of wins by the team in the season"
},
"Losses": {
"type": [
"integer",
"null"
],
"description": "Total losses for the team in the season"
},
"OvertimeLosses": {
"type": [
"integer",
"null"
],
"description": "Total overtime losses by the team in the season"
},
"OpponentPosition": {
"type": [
"string",
"null"
],
"description": "Indicates which position is included in opponent stats that are aggregated together"
},
"GlobalTeamID": {
"type": [
"integer",
"null"
],
"description": "A globally unique ID for this team. This value is guaranteed to be unique across all sports/leagues"
},
"OpponentStat": {
"$ref": "#/components/schemas/OpponentSeason",
"description": "The aggregated season stats for this team's opponents"
},
"Updated": {
"type": [
"string",
"null"
],
"description": "The timestamp of when the record was last updated (US Eastern Time)."
},
"Games": {
"type": [
"integer",
"null"
],
"description": "The number of games played."
},
"FantasyPoints": {
"type": [
"number",
"null"
],
"description": "Total fantasy points"
},
"FantasyPointsFanDuel": {
"type": [
"number",
"null"
],
"description": "Total FanDuel daily fantasy points scored"
},
"FantasyPointsDraftKings": {
"type": [
"number",
"null"
],
"description": "Total DraftKings daily fantasy points scored"
},
"FantasyPointsYahoo": {
"type": [
"number",
"null"
],
"description": "Total Yahoo daily fantasy points scored"
},
"Minutes": {
"type": [
"integer",
"null"
],
"description": "Total number of minutes played"
},
"Seconds": {
"type": [
"integer",
"null"
],
"description": "Total number of seconds played"
},
"Goals": {
"type": [
"number",
"null"
],
"description": "Total number of goals scored"
},
"Assists": {
"type": [
"number",
"null"
],
"description": "Total number of assists"
},
"ShotsOnGoal": {
"type": [
"number",
"null"
],
"description": "Total number of shots on goal"
},
"PowerPlayGoals": {
"type": [
"number",
"null"
],
"description": "Total number of power play goals"
},
"ShortHandedGoals": {
"type": [
"number",
"null"
],
"description": "Total number of short handed goals"
},
"EmptyNetGoals": {
"type": [
"number",
"null"
],
"description": "Total number of empty net goals"
},
"PowerPlayAssists": {
"type": [
"number",
"null"
],
"description": "Total number of power play assists"
},
"ShortHandedAssists": {
"type": [
"number",
"null"
],
"description": "Total number of short handed assists"
},
"HatTricks": {
"type": [
"number",
"null"
],
"description": "Total number of hat tricks"
},
"ShootoutGoals": {
"type": [
"number",
"null"
],
"description": "Total number of shootout goals"
},
"PlusMinus": {
"type": [
"number",
"null"
],
"description": "Total plus minus"
},
"PenaltyMinutes": {
"type": [
"number",
"null"
],
"description": "Total pentalty minutes"
},
"Blocks": {
"type": [
"number",
"null"
],
"description": "Total blocked shots"
},
"Hits": {
"type": [
"number",
"null"
],
"description": "Total hits"
},
"Takeaways": {
"type": [
"number",
"null"
],
"description": "Total takeaways"
},
"Giveaways": {
"type": [
"number",
"null"
],
"description": "Total giveaways"
},
"FaceoffsWon": {
"type": [
"number",
"null"
],
"description": "Total faceoffs won"
},
"FaceoffsLost": {
"type": [
"number",
"null"
],
"description": "Total faceoffs lost"
},
"Shifts": {
"type": [
"number",
"null"
],
"description": "Total shifts"
},
"GoaltendingMinutes": {
"type": [
"integer",
"null"
],
"description": "Total goaltending minutes"
},
"GoaltendingSeconds": {
"type": [
"integer",
"null"
],
"description": "Total goaltending seconds"
},
"GoaltendingShotsAgainst": {
"type": [
"number",
"null"
],
"description": "Total goaltending shots against"
},
"GoaltendingGoalsAgainst": {
"type": [
"number",
"null"
],
"description": "Total goaltending goals against"
},
"GoaltendingSaves": {
"type": [
"number",
"null"
],
"description": "Total goaltending saves"
},
"GoaltendingWins": {
"type": [
"number",
"null"
],
"description": "Total goaltending wins"
},
"GoaltendingLosses": {
"type": [
"number",
"null"
],
"description": "Total goaltendings losses"
},
"GoaltendingShutouts": {
"type": [
"number",
"null"
],
"description": "Total goaltendings shutouts"
},
"Started": {
"type": [
"integer",
"null"
],
"description": "Total games started"
},
"BenchPenaltyMinutes": {
"type": [
"number",
"null"
],
"description": "Total bench pentalty minutes"
},
"GoaltendingOvertimeLosses": {
"type": [
"number",
"null"
],
"description": "Total goaltending overtime losses"
},
"FantasyPointsFantasyDraft": {
"type": [
"number",
"null"
],
"description": "Total FantasyDraft daily fantasy points scored"
}
}
},
"OpponentSeason": {
"properties": {
"StatID": {
"type": "integer",
"description": "The unique ID of the stat"
},
"TeamID": {
"type": [
"integer",
"null"
],
"description": "The unique ID of the team"
},
"SeasonType": {
"type": [
"integer",
"null"
],
"description": "The type of season that this record corresponds to (1=Regular Season; 2=Preseason; 3=Postseason; 5=AllStar; 6=Exhibition)"
},
"Season": {
"type": [
"integer",
"null"
],
"description": "The NHL regular season for which these totals apply"
},
"Name": {
"type": [
"string",
"null"
],
"description": "The team's full name (ex. Minnesota Wild; New York Islanders)"
},
"Team": {
"type": [
"string",
"null"
],
"description": "The abbreviation [Key] of the team"
},
"Wins": {
"type": [
"integer",
"null"
],
"description": "Total number of wins by the team in the season"
},
"Losses": {
"type": [
"integer",
"null"
],
"description": "Total losses for the team in the season"
},
"OvertimeLosses": {
"type": [
"integer",
"null"
],
"description": "Total overtime losses by the team in the season"
},
"OpponentPosition": {
"type": [
"string",
"null"
],
"description": "Indicates which position is included in opponent stats that are aggregated together"
},
"GlobalTeamID": {
"type": [
"integer",
"null"
],
"description": "A globally unique ID for this team. This value is guaranteed to be unique across all sports/leagues"
},
"Updated": {
"type": [
"string",
"null"
],
"description": "The timestamp of when the record was last updated (US Eastern Time)."
},
"Games": {
"type": [
"integer",
"null"
],
"description": "The number of games played."
},
"FantasyPoints": {
"type": [
"number",
"null"
],
"description": "Total fantasy points"
},
"FantasyPointsFanDuel": {
"type": [
"number",
"null"
],
"description": "Total FanDuel daily fantasy points scored"
},
"FantasyPointsDraftKings": {
"type": [
"number",
"null"
],
"description": "Total DraftKings daily fantasy points scored"
},
"FantasyPointsYahoo": {
"type": [
"number",
"null"
],
"description": "Total Yahoo daily fantasy points scored"
},
"Minutes": {
"type": [
"integer",
"null"
],
"description": "Total number of minutes played"
},
"Seconds": {
"type": [
"integer",
"null"
],
"description": "Total number of seconds played"
},
"Goals": {
"type": [
"number",
"null"
],
"description": "Total number of goals scored"
},
"Assists": {
"type": [
"number",
"null"
],
"description": "Total number of assists"
},
"ShotsOnGoal": {
"type": [
"number",
"null"
],
"description": "Total number of shots on goal"
},
"PowerPlayGoals": {
"type": [
"number",
"null"
],
"description": "Total number of power play goals"
},
"ShortHandedGoals": {
"type": [
"number",
"null"
],
"description": "Total number of short handed goals"
},
"EmptyNetGoals": {
"type": [
"number",
"null"
],
"description": "Total number of empty net goals"
},
"PowerPlayAssists": {
"type": [
"number",
"null"
],
"description": "Total number of power play assists"
},
"ShortHandedAssists": {
"type": [
"number",
"null"
],
"description": "Total number of short handed assists"
},
"HatTricks": {
"type": [
"number",
"null"
],
"description": "Total number of hat tricks"
},
"ShootoutGoals": {
"type": [
"number",
"null"
],
"description": "Total number of shootout goals"
},
"PlusMinus": {
"type": [
"number",
"null"
],
"description": "Total plus minus"
},
"PenaltyMinutes": {
"type": [
"number",
"null"
],
"description": "Total pentalty minutes"
},
"Blocks": {
"type": [
"number",
"null"
],
"description": "Total blocked shots"
},
"Hits": {
"type": [
"number",
"null"
],
"description": "Total hits"
},
"Takeaways": {
"type": [
"number",
"null"
],
"description": "Total takeaways"
},
"Giveaways": {
"type": [
"number",
"null"
],
"description": "Total giveaways"
},
"FaceoffsWon": {
"type": [
"number",
"null"
],
"description": "Total faceoffs won"
},
"FaceoffsLost": {
"type": [
"number",
"null"
],
"description": "Total faceoffs lost"
},
"Shifts": {
"type": [
"number",
"null"
],
"description": "Total shifts"
},
"GoaltendingMinutes": {
"type": [
"integer",
"null"
],
"description": "Total goaltending minutes"
},
"GoaltendingSeconds": {
"type": [
"integer",
"null"
],
"description": "Total goaltending seconds"
},
"GoaltendingShotsAgainst": {
"type": [
"number",
"null"
],
"description": "Total goaltending shots against"
},
"GoaltendingGoalsAgainst": {
"type": [
"number",
"null"
],
"description": "Total goaltending goals against"
},
"GoaltendingSaves": {
"type": [
"number",
"null"
],
"description": "Total goaltending saves"
},
"GoaltendingWins": {
"type": [
"number",
"null"
],
"description": "Total goaltending wins"
},
"GoaltendingLosses": {
"type": [
"number",
"null"
],
"description": "Total goaltendings losses"
},
"GoaltendingShutouts": {
"type": [
"number",
"null"
],
"description": "Total goaltendings shutouts"
},
"Started": {
"type": [
"integer",
"null"
],
"description": "Total games started"
},
"BenchPenaltyMinutes": {
"type": [
"number",
"null"
],
"description": "Total bench pentalty minutes"
},
"GoaltendingOvertimeLosses": {
"type": [
"number",
"null"
],
"description": "Total goaltending overtime losses"
},
"FantasyPointsFantasyDraft": {
"type": [
"number",
"null"
],
"description": "Total FantasyDraft daily fantasy points scored"
}
}
},
"Season": {
"properties": {
"Season": {
"type": "integer",
"description": "The NHL regular season for which these totals apply"
},
"StartYear": {
"type": "integer",
"description": "The year in which the season started"
},
"EndYear": {
"type": "integer",
"description": "The year in which the season ended"
},
"Description": {
"type": [
"string",
"null"
],
"description": "The description of the season for display purposes (possible values include: 2017-18, 2018-19, etc)"
},
"RegularSeasonStartDate": {
"type": [
"string",
"null"
],
"description": "The start date of the regular season"
},
"PostSeasonStartDate": {
"type": [
"string",
"null"
],
"description": "The start date of the postseason"
},
"SeasonType": {
"type": [
"string",
"null"
],
"description": "The type of season that this record corresponds to (1=Regular Season; 2=Preseason; 3=Postseason; 5=AllStar; 6=Exhibition)."
},
"ApiSeason": {
"type": [
"string",
"null"
],
"description": "The string to pass into subsequent API calls in the season parameter (e.g. 2025REG, 2025POST, etc.)"
}
}
},
"Standing": {
"properties": {
"Season": {
"type": "integer",
"description": "The NHL regular season for which these totals apply"
},
"SeasonType": {
"type": "integer",
"description": "The type of season that this record corresponds to (1=Regular Season; 2=Preseason; 3=Postseason; 5=AllStar; 6=Exhibition)."
},
"TeamID": {
"type": "integer",
"description": "The unique ID of the team"
},
"Key": {
"type": [
"string",
"null"
],
"description": "The abbreviation [Key] of the team associated with this market (Ex. BOS, EDM, LAK)"
},
"City": {
"type": [
"string",
"null"
],
"description": "The city/location of the team (e.g. Los Angeles; Philadelphia; Boston; Chicago; etc.)"
},
"Name": {
"type": [
"string",
"null"
],
"description": "The team's full name (ex. Minnesota Wild; New York Islanders)"
},
"Conference": {
"type": [
"string",
"null"
],
"description": "The conference of the team (possible values: Eastern; Western)"
},
"Division": {
"type": [
"string",
"null"
],
"description": "The division of the team (e.g. Atlantic; Metropolitan; Central; or Pacific)"
},
"Wins": {
"type": [
"integer",
"null"
],
"description": "Total number of wins by the team in the season"
},
"Losses": {
"type": [
"integer",
"null"
],
"description": "Total losses for a team in the regular season"
},
"OvertimeLosses": {
"type": [
"integer",
"null"
],
"description": "Total overtime losses by the team in the season"
},
"Percentage": {
"type": [
"number",
"null"
],
"description": "The team's winning percentage"
},
"ConferenceWins": {
"type": [
"integer",
"null"
],
"description": "Total number of conference wins for a team"
},
"ConferenceLosses": {
"type": [
"integer",
"null"
],
"description": "Total number of conference losses for a team"
},
"DivisionWins": {
"type": [
"integer",
"null"
],
"description": "Total number of division wins by the team"
},
"DivisionLosses": {
"type": [
"integer",
"null"
],
"description": "Total number of division losses by the team"
},
"ShutoutWins": {
"type": [
"integer",
"null"
],
"description": "Total regular season shutout wins by the team"
},
"ConferenceRank": {
"type": [
"integer",
"null"
],
"description": "Team rank at the conference level"
},
"DivisionRank": {
"type": [
"integer",
"null"
],
"description": "Team rank at the division level"
},
"GlobalTeamID": {
"type": [
"integer",
"null"
],
"description": "A globally unique ID for this team. This value is guaranteed to be unique across all sports/leagues."
},
"ClinchedDivision": {
"type": [
"boolean",
"null"
],
"description": "Returns TRUE if team has clinched their division; FALSE if not"
},
"ClinchedPlayoffBerth": {
"type": [
"boolean",
"null"
],
"description": "Returns TRUE if team has clinched a playoff spot; FALSE if not"
},
"ClinchedBestRecordInConference": {
"type": [
"boolean",
"null"
],
"description": "Returns TRUE if team has clinched the best record in their respective conference; FALSE if not"
},
"ClinchedPresidentsTrophy": {
"type": [
"boolean",
"null"
],
"description": "Returns TRUE if team has clinched best record in NHL (President's Trophy); FALSE if not"
},
"EliminatedFromPlayoffContention": {
"type": [
"boolean",
"null"
],
"description": "Returns TRUE if team has been eliminated from playoff contention; FALSE if not"
}
}
},
"ScheduleBasic": {
"properties": {
"GameID": {
"type": "integer",
"description": "The unique ID of this game"
},
"Season": {
"type": "integer",
"description": "The NHL season of the game"
},
"SeasonType": {
"type": "integer",
"description": "The type of season that this record corresponds to (1=Regular Season; 2=Preseason; 3=Postseason; 5=AllStar; 6=Exhibition)"
},
"Status": {
"type": [
"string",
"null"
],
"description": "Indicates the game's status. Possible values include: Scheduled, InProgress, Final, F/SO, F/OT, Suspended, Postponed, Delayed, Canceled, Forfeit, NotNecessary"
},
"Day": {
"type": [
"string",
"null"
],
"description": "The date of the game"
},
"DateTime": {
"type": [
"string",
"null"
],
"description": "The date and time of the game in US Eastern Time"
},
"Updated": {
"type": [
"string",
"null"
],
"description": "The timestamp of when the record was last updated (in US Eastern Time)"
},
"IsClosed": {
"type": [
"boolean",
"null"
],
"description": "Indicates whether the game is over and the final score has been verified and closed out. Note: it is recommend for bet resulting to use IsClosed = True rather than simply Final game status"
},
"AwayTeam": {
"type": [
"string",
"null"
],
"description": "The abbreviation [Key] of the away team"
},
"HomeTeam": {
"type": [
"string",
"null"
],
"description": "The abbreviation [Key] of the home team"
},
"StadiumID": {
"type": [
"integer",
"null"
],
"description": "The unique ID of the stadium"
},
"AwayTeamScore": {
"type": [
"integer",
"null"
],
"description": "Total number of goals scored by the away team in the game"
},
"HomeTeamScore": {
"type": [
"integer",
"null"
],
"description": "Total number of goals scored by the home team in the game"
},
"GlobalGameID": {
"type": "integer",
"description": "A globally unique ID for this game. This value is guaranteed to be unique across all sports/leagues."
},
"GlobalAwayTeamID": {
"type": "integer",
"description": "A globally unique ID for the away team. This value is guaranteed to be unique across all sports/leagues."
},
"GlobalHomeTeamID": {
"type": "integer",
"description": "A globally unique ID for the home team. This value is guaranteed to be unique across all sports/leagues."
},
"GameEndDateTime": {
"type": [
"string",
"null"
],
"description": "The date and time that the game ended in US Eastern Time"
},
"NeutralVenue": {
"type": [
"boolean",
"null"
],
"description": "Indicates whether this game is played in a neutral venue"
},
"DateTimeUTC": {
"type": [
"string",
"null"
],
"description": "The date and time of the game in UTC"
},
"SeriesInfo": {
"$ref": "#/components/schemas/Series",
"description": "Contains relevant series data for playoff series only - HomeTeamWins, AwayTeamWins, GameNumber, and MaxLength"
},
"AwayTeamID": {
"type": "integer",
"description": "The unique ID of the away team"
},
"HomeTeamID": {
"type": "integer",
"description": "The unique ID of the home team"
},
"RescheduledFromGameID": {
"type": [
"integer",
"null"
],
"description": "The GameID of the originally scheduled, postponed game, that this game was rescheduled from. This only pertains to games that are scheduled as \"make up\" games."
},
"RescheduledGameID": {
"type": [
"integer",
"null"
],
"description": "The GameID of the game that was rescheduled from this game. This only pertains to postponed games that require rescheduling."
}
}
},
"ScoreBasic": {
"properties": {
"GameID": {
"type": "integer",
"description": "The unique ID of this game"
},
"Season": {
"type": "integer",
"description": "The NHL season of the game"
},
"SeasonType": {
"type": "integer",
"description": "The type of season that this record corresponds to (1=Regular Season; 2=Preseason; 3=Postseason; 5=AllStar; 6=Exhibition)"
},
"Status": {
"type": [
"string",
"null"
],
"description": "Indicates the game's status. Possible values include: Scheduled, InProgress, Final, F/SO, F/OT, Suspended, Postponed, Delayed, Canceled, Forfeit, NotNecessary"
},
"Day": {
"type": [
"string",
"null"
],
"description": "The date of the game"
},
"DateTime": {
"type": [
"string",
"null"
],
"description": "The date and time of the game in US Eastern Time"
},
"Updated": {
"type": [
"string",
"null"
],
"description": "The timestamp of when the record was last updated (in US Eastern Time)"
},
"IsClosed": {
"type": [
"boolean",
"null"
],
"description": "Indicates whether the game is over and the final score has been verified and closed out Note: it is recommend for bet resulting to use IsClosed = True rather than simply Final game status"
},
"AwayTeam": {
"type": [
"string",
"null"
],
"description": "The abbreviation [Key] of the away team"
},
"HomeTeam": {
"type": [
"string",
"null"
],
"description": "The abbreviation [Key] of the home team"
},
"AwayTeamID": {
"type": "integer",
"description": "The unique ID of the away team"
},
"HomeTeamID": {
"type": "integer",
"description": "The unique ID of the home team"
},
"StadiumID": {
"type": [
"integer",
"null"
],
"description": "The unique ID of the stadium"
},
"AwayTeamScore": {
"type": [
"integer",
"null"
],
"description": "Total number of goals scored by the away team in the game"
},
"HomeTeamScore": {
"type": [
"integer",
"null"
],
"description": "Total number of goals scored by the home team in the game"
},
"GameEndDateTime": {
"type": [
"string",
"null"
],
"description": "The date and time that the game ended in US Eastern Time"
},
"DateTimeUTC": {
"type": [
"string",
"null"
],
"description": "The date and time of the game in UTC"
}
}
},
"PlayerBasic": {
"properties": {
"PlayerID": {
"type": "integer",
"description": "The player's unique PlayerID as assigned by SportsDataIO. Note: this ID will stay with the player throughout their entire career"
},
"FirstName": {
"type": [
"string",
"null"
],
"description": "The first name of the player"
},
"LastName": {
"type": [
"string",
"null"
],
"description": "The player's last name"
},
"Status": {
"type": [
"string",
"null"
],
"description": "The player's current status. Possible values include Active; Inactive; Injured Reserve; Minors; Suspended; Bereavement; Paternity"
},
"TeamID": {
"type": [
"integer",
"null"
],
"description": "The unique ID of the team"
},
"Team": {
"type": [
"string",
"null"
],
"description": "The abbreviation [Key] of the team this player is employed by"
},
"Position": {
"type": [
"string",
"null"
],
"description": "The player's primary position. Possible values: C, RW, LW, D, or G."
},
"Jersey": {
"type": [
"integer",
"null"
],
"description": "The player's jersey number"
},
"Height": {
"type": [
"integer",
"null"
],
"description": "The player's height in inches"
},
"Weight": {
"type": [
"integer",
"null"
],
"description": "The player's weight in pounds (lbs)"
},
"BirthDate": {
"type": [
"string",
"null"
],
"description": "The player's date of birth"
},
"BirthCity": {
"type": [
"string",
"null"
],
"description": "The city in which the player was born"
},
"BirthState": {
"type": [
"string",
"null"
],
"description": "The US state in which the player was born. NOTE: If a player was born outside of North America or Australia, this field will be null"
},
"GlobalTeamID": {
"type": [
"integer",
"null"
],
"description": "A globally unique ID for this team. This value is guaranteed to be unique across all sports/leagues."
}
}
},
"TeamGoalieDepthChart": {
"properties": {
"GoalieDepthCharts": {
"type": "array",
"items": {
"$ref": "#/components/schemas/GoalieDepthChart"
},
"description": "List of players that make up the goalie depth chart for each team"
},
"TeamID": {
"type": "integer",
"description": "The unique ID of the team"
}
}
},
"GoalieDepthChart": {
"properties": {
"TeamID": {
"type": "integer",
"description": "The unique ID of the team"
},
"Team": {
"type": [
"string",
"null"
],
"description": "The abbreviation [Key] of the team this player is employed by"
},
"PlayerID": {
"type": [
"integer",
"null"
],
"description": "The player's unique PlayerID as assigned by SportsDataIO. Note: this ID will stay with the player throughout their entire career"
},
"Name": {
"type": [
"string",
"null"
],
"description": "The full name of the goaltender"
},
"DepthType": {
"type": [
"string",
"null"
],
"description": "Indicates whether it is a goalie tandem or not for a goalie depth chart (returns Tandem; Regular)"
},
"DisplayType": {
"type": [
"string",
"null"
],
"description": "If the goalie depth chart is displayed as a Tandem or as Regular"
},
"DepthOrder": {
"type": [
"integer",
"null"
],
"description": "The order of the goalie in the team's depth chart"
},
"Created": {
"type": [
"string",
"null"
],
"description": "The timestamp of when this depth chart was last edited; based on US Eastern Time (EST/EDT)"
},
"Updated": {
"type": [
"string",
"null"
],
"description": "The timestamp of when the record was last updated (in US Eastern Time)"
}
}
},
"Transaction": {
"properties": {
"PlayerID": {
"type": "integer",
"description": "The player's unique PlayerID as assigned by SportsDataIO. Note: this ID will stay with the player throughout their entire career"
},
"Name": {
"type": [
"string",
"null"
],
"description": "The player's full name"
},
"FormerTeamID": {
"type": [
"integer",
"null"
],
"description": "The ID of the player's former team"
},
"FormerTeam": {
"type": [
"string",
"null"
],
"description": "The [Key] of the player's former team (e.g. BOS; PHI; DET; EDM, etc.)"
},
"TeamID": {
"type": [
"integer",
"null"
],
"description": "The unique ID of the team"
},
"Team": {
"type": [
"string",
"null"
],
"description": "The abbreviation [Key] of the team involved in the transaction"
},
"Type": {
"type": [
"string",
"null"
],
"description": "Type of transaction that occurred"
},
"Date": {
"type": [
"string",
"null"
],
"description": "The date this transaction was created"
},
"Note": {
"type": [
"string",
"null"
],
"description": "A summary of the transaction that occurred (e.g. \"Harris has signed with the Canucks.\")"
},
"Created": {
"type": [
"string",
"null"
],
"description": "The date and time this transaction was created"
},
"Updated": {
"type": [
"string",
"null"
],
"description": "The date and time this transaction was last updated (in US Eastern Time)"
}
}
},
"Referee": {
"properties": {
"RefereeID": {
"type": "integer",
"description": "Unique ID o Referee"
},
"Name": {
"type": [
"string",
"null"
],
"description": "The referee's full name"
},
"Number": {
"type": [
"integer",
"null"
],
"description": "The number of the referee"
},
"Position": {
"type": [
"string",
"null"
],
"description": "The position of the referee in the crew"
},
"College": {
"type": [
"string",
"null"
],
"description": "The college of the referee"
},
"Experience": {
"type": [
"integer",
"null"
],
"description": "The number of years of experience the referee has in the NHL"
}
}
},
"PlayerGameProjection": {
"properties": {
"StatID": {
"type": "integer",
"description": "The unique ID of the stat"
},
"TeamID": {
"type": [
"integer",
"null"
],
"description": "The unique ID of the team"
},
"PlayerID": {
"type": [
"integer",
"null"
],
"description": "The player's unique PlayerID as assigned by SportsDataIO. Note: this ID will stay with the player throughout their entire career"
},
"SeasonType": {
"type": [
"integer",
"null"
],
"description": "The type of season that this record corresponds to (1=Regular Season; 2=Preseason; 3=Postseason; 5=AllStar; 6=Exhibition)"
},
"Season": {
"type": [
"integer",
"null"
],
"description": "The NHL season of the game"
},
"Name": {
"type": [
"string",
"null"
],
"description": "The player's full name"
},
"Team": {
"type": [
"string",
"null"
],
"description": "The abbreviation [Key] of the team"
},
"Position": {
"type": [
"string",
"null"
],
"description": "The player's primary position. Possible values: C; RW; LW; D; or G"
},
"FantasyDataSalary": {
"type": [
"integer",
"null"
],
"description": "The player's salary as calculated by SportsDataIO (formerly known as FantasyData). Based on the same salary cap as DraftKings contests ($50,000)"
},
"FanDuelSalary": {
"type": [
"integer",
"null"
],
"description": "The player's salary for FanDuel daily fantasy contests"
},
"DraftKingsSalary": {
"type": [
"integer",
"null"
],
"description": "The player's salary for DraftKings daily fantasy contests"
},
"YahooSalary": {
"type": [
"integer",
"null"
],
"description": "The player's salary for Yahoo daily fantasy contests."
},
"InjuryStatus": {
"type": [
"string",
"null"
],
"description": "The player's current injury status; in the form of likelihood that player plays. Possible values: Probable; Questionable; Doubtful; Out"
},
"InjuryBodyPart": {
"type": [
"string",
"null"
],
"description": "The body part that is injured for the player (Knee; Groin; Calf; Upper-body; etc.)"
},
"InjuryStartDate": {
"type": [
"string",
"null"
],
"description": "The day that the injury started or was first discovered"
},
"InjuryNotes": {
"type": [
"string",
"null"
],
"description": "Brief description of the player's injury and expected availability"
},
"FanDuelPosition": {
"type": [
"string",
"null"
],
"description": "The player's eligible position in FanDuel's daily fantasy sports platform"
},
"DraftKingsPosition": {
"type": [
"string",
"null"
],
"description": "The player's eligible position in DraftKings' daily fantasy sports platform"
},
"YahooPosition": {
"type": [
"string",
"null"
],
"description": "The player's eligible position in Yahoo's daily fantasy sports platform."
},
"OpponentRank": {
"type": [
"integer",
"null"
],
"description": "The ranking of the player's opponent with regards to fantasy points allowed"
},
"OpponentPositionRank": {
"type": [
"integer",
"null"
],
"description": "The ranking of the player's opponent by position with regards to fantasy points allowed"
},
"GlobalTeamID": {
"type": [
"integer",
"null"
],
"description": "A globally unique ID for this team. This value is guaranteed to be unique across all sports/leagues"
},
"FantasyDraftSalary": {
"type": [
"integer",
"null"
],
"description": "The player's salary for FantasyDraft daily fantasy contests"
},
"FantasyDraftPosition": {
"type": [
"string",
"null"
],
"description": "The player's eligible position in Fantasy Drafts daily fantasy sports platform."
},
"EvenStrengthMinutes": {
"type": [
"integer",
"null"
],
"description": "The number of minutes played at even strength by the player in the game"
},
"EvenStrengthSeconds": {
"type": [
"integer",
"null"
],
"description": "The number of seconds played at even strength by the player in the game"
},
"PowerPlayMinutes": {
"type": [
"integer",
"null"
],
"description": "Total minutes played by the player on the power play in the game"
},
"PowerPlaySeconds": {
"type": [
"integer",
"null"
],
"description": "The number of seconds (remainder after minutes) played on a Power Play"
},
"ShortHandedMinutes": {
"type": [
"integer",
"null"
],
"description": "The number of minutes played short handed by the player in the game"
},
"ShortHandedSeconds": {
"type": [
"integer",
"null"
],
"description": "The number of seconds (remainder after minutes) played short handed by the player in the game"
},
"Points": {
"type": [
"number",
"null"
],
"description": "Total points for the player in the game. Note: points are calculated by adding up a player's goals and assists"
},
"GameID": {
"type": [
"integer",
"null"
],
"description": "The unique ID of this game"
},
"OpponentID": {
"type": [
"integer",
"null"
],
"description": "The unique ID of the team's opponent"
},
"Opponent": {
"type": [
"string",
"null"
],
"description": "The name of the opponent "
},
"Day": {
"type": [
"string",
"null"
],
"description": "The day of the game"
},
"DateTime": {
"type": [
"string",
"null"
],
"description": "The date and time of the game"
},
"HomeOrAway": {
"type": [
"string",
"null"
],
"description": "Whether the team is home or away"
},
"IsGameOver": {
"type": "boolean",
"description": "Whether the game is over (true/false)"
},
"GlobalGameID": {
"type": [
"integer",
"null"
],
"description": "A globally unique ID for this game. This value is guaranteed to be unique across all sports/leagues."
},
"GlobalOpponentID": {
"type": [
"integer",
"null"
],
"description": "A globally unique ID for this opponent. This value is guaranteed to be unique across all sports/leagues."
},
"Updated": {
"type": [
"string",
"null"
],
"description": "The timestamp of when the record was last updated (US Eastern Time)."
},
"Games": {
"type": [
"integer",
"null"
],
"description": "The number of games played."
},
"FantasyPoints": {
"type": [
"number",
"null"
],
"description": "Total fantasy points"
},
"FantasyPointsFanDuel": {
"type": [
"number",
"null"
],
"description": "Total FanDuel daily fantasy points scored"
},
"FantasyPointsDraftKings": {
"type": [
"number",
"null"
],
"description": "Total DraftKings daily fantasy points scored"
},
"FantasyPointsYahoo": {
"type": [
"number",
"null"
],
"description": "Total Yahoo daily fantasy points scored"
},
"Minutes": {
"type": [
"integer",
"null"
],
"description": "Total number of minutes played"
},
"Seconds": {
"type": [
"integer",
"null"
],
"description": "Total number of seconds played"
},
"Goals": {
"type": [
"number",
"null"
],
"description": "Total number of goals scored"
},
"Assists": {
"type": [
"number",
"null"
],
"description": "Total number of assists"
},
"ShotsOnGoal": {
"type": [
"number",
"null"
],
"description": "Total number of shots on goal"
},
"PowerPlayGoals": {
"type": [
"number",
"null"
],
"description": "Total number of power play goals"
},
"ShortHandedGoals": {
"type": [
"number",
"null"
],
"description": "Total number of short handed goals"
},
"EmptyNetGoals": {
"type": [
"number",
"null"
],
"description": "Total number of empty net goals"
},
"PowerPlayAssists": {
"type": [
"number",
"null"
],
"description": "Total number of power play assists"
},
"ShortHandedAssists": {
"type": [
"number",
"null"
],
"description": "Total number of short handed assists"
},
"HatTricks": {
"type": [
"number",
"null"
],
"description": "Total number of hat tricks"
},
"ShootoutGoals": {
"type": [
"number",
"null"
],
"description": "Total number of shootout goals"
},
"PlusMinus": {
"type": [
"number",
"null"
],
"description": "Total plus minus"
},
"PenaltyMinutes": {
"type": [
"number",
"null"
],
"description": "Total pentalty minutes"
},
"Blocks": {
"type": [
"number",
"null"
],
"description": "Total blocked shots"
},
"Hits": {
"type": [
"number",
"null"
],
"description": "Total hits"
},
"Takeaways": {
"type": [
"number",
"null"
],
"description": "Total takeaways"
},
"Giveaways": {
"type": [
"number",
"null"
],
"description": "Total giveaways"
},
"FaceoffsWon": {
"type": [
"number",
"null"
],
"description": "Total faceoffs won"
},
"FaceoffsLost": {
"type": [
"number",
"null"
],
"description": "Total faceoffs lost"
},
"Shifts": {
"type": [
"number",
"null"
],
"description": "Total shifts"
},
"GoaltendingMinutes": {
"type": [
"integer",
"null"
],
"description": "Total goaltending minutes"
},
"GoaltendingSeconds": {
"type": [
"integer",
"null"
],
"description": "Total goaltending seconds"
},
"GoaltendingShotsAgainst": {
"type": [
"number",
"null"
],
"description": "Total goaltending shots against"
},
"GoaltendingGoalsAgainst": {
"type": [
"number",
"null"
],
"description": "Total goaltending goals against"
},
"GoaltendingSaves": {
"type": [
"number",
"null"
],
"description": "Total goaltending saves"
},
"GoaltendingWins": {
"type": [
"number",
"null"
],
"description": "Total goaltending wins"
},
"GoaltendingLosses": {
"type": [
"number",
"null"
],
"description": "Total goaltendings losses"
},
"GoaltendingShutouts": {
"type": [
"number",
"null"
],
"description": "Total goaltendings shutouts"
},
"Started": {
"type": [
"integer",
"null"
],
"description": "Total games started"
},
"BenchPenaltyMinutes": {
"type": [
"number",
"null"
],
"description": "Total bench pentalty minutes"
},
"GoaltendingOvertimeLosses": {
"type": [
"number",
"null"
],
"description": "Total goaltending overtime losses"
},
"FantasyPointsFantasyDraft": {
"type": [
"number",
"null"
],
"description": "Total FantasyDraft daily fantasy points scored"
}
}
},
"DfsSlate": {
"properties": {
"SlateID": {
"type": "integer",
"description": "Unique ID of a Slate (assigned by SportsDataIO)."
},
"Operator": {
"type": [
"string",
"null"
],
"description": "The name of the operator who is running contests for this slate. (possible values: FanDuel; DraftKings; Yahoo; FantasyDraft; etc.)"
},
"OperatorSlateID": {
"type": [
"integer",
"null"
],
"description": "The unique ID of a slate as assigned by the operator"
},
"OperatorName": {
"type": [
"string",
"null"
],
"description": "The name of the slate (assigned by the operator) (possible values: Main; Express; Arcade; Late Night; etc.)"
},
"OperatorDay": {
"type": [
"string",
"null"
],
"description": "The day (in EST/EDT) that the slate begins (assigned by the operator)"
},
"OperatorStartTime": {
"type": [
"string",
"null"
],
"description": "The date & time (in EST/EDT) that the slate begins as assigned by the operator"
},
"NumberOfGames": {
"type": [
"integer",
"null"
],
"description": "The number of actual games that this slate covers"
},
"IsMultiDaySlate": {
"type": [
"boolean",
"null"
],
"description": "Whether this slate uses games that take place on different days"
},
"RemovedByOperator": {
"type": [
"boolean",
"null"
],
"description": "Indicates whether this slate was removed/deleted by the operator"
},
"OperatorGameType": {
"type": [
"string",
"null"
],
"description": "The game type of the slate. NOTE: will often be null as most operators only have one game type"
},
"DfsSlateGames": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DfsSlateGame"
},
"description": "The games that are included in this slate"
},
"DfsSlatePlayers": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DfsSlatePlayer"
},
"description": "The players that are included in this slate"
},
"SlateRosterSlots": {
"type": "array",
"items": {
"type": [
"string",
"null"
]
},
"description": "The positions that need to be filled for this particular slate"
},
"SalaryCap": {
"type": [
"integer",
"null"
],
"description": "The salary cap for the current slate (is null for slates with no salary cap such a Tiers gametypes)"
}
}
},
"DfsSlateGame": {
"properties": {
"SlateGameID": {
"type": "integer",
"description": "Unique ID of a SlateGame (assigned by SportsDataIO)."
},
"SlateID": {
"type": "integer",
"description": "The SlateID that this SlateGame refers to."
},
"GameID": {
"type": [
"integer",
"null"
],
"description": "The unique ID of the game tied to this SlateGame"
},
"Game": {
"$ref": "#/components/schemas/Game",
"description": "The details of the game that this SlateGame refers to"
},
"OperatorGameID": {
"type": [
"integer",
"null"
],
"description": "The unique ID of a SlateGame as assigned by the operator"
},
"RemovedByOperator": {
"type": [
"boolean",
"null"
],
"description": "Indicates whether this slate was removed/deleted by the operator"
}
}
},
"DfsSlatePlayer": {
"properties": {
"SlatePlayerID": {
"type": "integer",
"description": "Unique ID of a SlatePlayer (assigned by SportsDataIO)."
},
"SlateID": {
"type": "integer",
"description": "The SlateID that this SlatePlayer refers to."
},
"SlateGameID": {
"type": [
"integer",
"null"
],
"description": "The SlateGameID that this SlatePlayer refers to."
},
"PlayerID": {
"type": [
"integer",
"null"
],
"description": "The player's unique PlayerID as assigned by SportsDataIO. Note: this ID will stay with the player throughout their entire career"
},
"PlayerGameProjectionStatID": {
"type": [
"integer",
"null"
],
"description": "The SportsDataIO StatID that this SlatePlayer refers to. This points to data in the respective sports' projected player game stats feeds."
},
"OperatorPlayerID": {
"type": [
"string",
"null"
],
"description": "The unique ID of the player as assigned by the operator"
},
"OperatorSlatePlayerID": {
"type": [
"string",
"null"
],
"description": "The unique ID of the SlatePlayer as assigned by the operator"
},
"OperatorPlayerName": {
"type": [
"string",
"null"
],
"description": "The player's name as assigned by the operator"
},
"OperatorPosition": {
"type": [
"string",
"null"
],
"description": "The player's eligible positions for the contest assigned by the operator"
},
"OperatorSalary": {
"type": [
"integer",
"null"
],
"description": "The player's salary for the contest as assigned by the operator"
},
"OperatorRosterSlots": {
"type": "array",
"items": {
"type": [
"string",
"null"
]
},
"description": "The player's eligible positions to be played in the contest as assigned by the operator. NOTE: This would include UTIL; etc plays for those that are eligible"
},
"RemovedByOperator": {
"type": [
"boolean",
"null"
],
"description": "Indicates whether this slate was removed/deleted by the operator"
},
"Team": {
"type": [
"string",
"null"
],
"description": "The team the player plays for"
},
"TeamID": {
"type": [
"integer",
"null"
],
"description": "The unique ID of the team"
}
}
},
"StartingGoaltenders": {
"properties": {
"GameID": {
"type": "integer",
"description": "The unique ID of the game tied to the StartingGoaltenders"
},
"Season": {
"type": "integer",
"description": "The end year of season (2021-22 would be 2022)"
},
"SeasonType": {
"type": "integer",
"description": "The type of season that this record corresponds to (1=Regular Season; 2=Preseason; 3=Postseason; 5=AllStar; 6=Exhibition)."
},
"Day": {
"type": [
"string",
"null"
],
"description": "The date of the game"
},
"DateTime": {
"type": [
"string",
"null"
],
"description": "The date and time of the game in US Eastern Time"
},
"Status": {
"type": [
"string",
"null"
],
"description": "Indicates the game's status. Possible values include: Scheduled; InProgress; Final; F/SO; F/OT; Suspended; Postponed; Delayed; Canceled; Forfeit"
},
"HomeTeamID": {
"type": [
"integer",
"null"
],
"description": "The unique ID of the home team tied to these StartingGoaltenders"
},
"HomeTeam": {
"type": [
"string",
"null"
],
"description": "The abbreviation [Key] of the home team"
},
"AwayTeamID": {
"type": [
"integer",
"null"
],
"description": "The unique ID of the away team as it relates to the starting goaltenders"
},
"AwayTeam": {
"type": [
"string",
"null"
],
"description": "The abbreviation [Key] of the away team"
},
"HomeGoaltender": {
"$ref": "#/components/schemas/Goaltender",
"description": "The information of the home goaltender (PlayerID, TeamID, Team, First & Last Name, Jersey Number, Confirmed)"
},
"AwayGoaltender": {
"$ref": "#/components/schemas/Goaltender",
"description": "The information of the away goaltender (PlayerID, TeamID, Team, First & Last Name, Jersey Number, Confirmed)"
}
}
},
"Goaltender": {
"properties": {
"PlayerID": {
"type": "integer",
"description": "The player's unique PlayerID as assigned by SportsDataIO. Note: this ID will stay with the player throughout their entire career"
},
"TeamID": {
"type": "integer",
"description": "The unique ID of the team"
},
"Team": {
"type": [
"string",
"null"
],
"description": "The abbreviation [Key] of the team the goaltender belongs to"
},
"FirstName": {
"type": [
"string",
"null"
],
"description": "The first name of the goaltender"
},
"LastName": {
"type": [
"string",
"null"
],
"description": "The goaltender's last name"
},
"Jersey": {
"type": [
"integer",
"null"
],
"description": "The goaltender's jersey number"
},
"Confirmed": {
"type": "boolean",
"description": "Indicates whether the starting goaltender is projected or confirmed"
}
}
},
"GameInfo": {
"properties": {
"GameId": {
"type": "integer",
"description": "The unique ID of this game"
},
"Season": {
"type": "integer",
"description": "The NHL season of the game"
},
"SeasonType": {
"type": "integer",
"description": "The type of season that this record corresponds to (1=Regular Season; 2=Preseason; 3=Postseason; 5=AllStar; 6=Exhibition)."
},
"Day": {
"type": [
"string",
"null"
],
"description": "The day that the game is scheduled to be played"
},
"DateTime": {
"type": [
"string",
"null"
],
"description": "The date and time of the game in US Eastern Time"
},
"Status": {
"type": [
"string",
"null"
],
"description": "Indicates the game's status. Possible values include: Scheduled, InProgress, Final, F/SO, F/OT, Suspended, Postponed, Delayed, Canceled, Forfeit"
},
"AwayTeamId": {
"type": [
"integer",
"null"
],
"description": "The unique ID of the away team"
},
"HomeTeamId": {
"type": [
"integer",
"null"
],
"description": "The unique ID of the home team"
},
"AwayTeamName": {
"type": [
"string",
"null"
],
"description": "The name of the away team"
},
"HomeTeamName": {
"type": [
"string",
"null"
],
"description": "The name of the home team"
},
"GlobalGameId": {
"type": "integer",
"description": "A globally unique ID for this game. This value is guaranteed to be unique across all sports/leagues."
},
"GlobalAwayTeamId": {
"type": [
"integer",
"null"
],
"description": "A globally unique ID for the away team. This value is guaranteed to be unique across all sports/leagues."
},
"GlobalHomeTeamId": {
"type": [
"integer",
"null"
],
"description": "A globally unique ID for the home team. This value is guaranteed to be unique across all sports/leagues."
},
"PregameOdds": {
"type": "array",
"items": {
"$ref": "#/components/schemas/GameOdd"
},
"description": "List of Pregame GameOdds from different sportsbooks"
},
"LiveOdds": {
"type": "array",
"items": {
"$ref": "#/components/schemas/GameOdd"
},
"description": "List of live game odds from different sportsbooks"
},
"HomeTeamScore": {
"type": [
"integer",
"null"
],
"description": "Total number of goals the home team scored in the game (updated after game ends to allow for resolving bets)"
},
"AwayTeamScore": {
"type": [
"integer",
"null"
],
"description": "Total number of goals the away team scored in the game (updated after game ends to allow for resolving bets)"
},
"TotalScore": {
"type": [
"integer",
"null"
],
"description": "Total goals scored in the game (updated after game ends to allow for resolving bets)"
},
"HomeRotationNumber": {
"type": [
"integer",
"null"
],
"description": "The rotation number of the home team for this game"
},
"AwayRotationNumber": {
"type": [
"integer",
"null"
],
"description": "The rotation number of the away team for a game"
},
"AlternateMarketPregameOdds": {
"type": "array",
"items": {
"$ref": "#/components/schemas/GameOdd"
},
"description": "A list of Alternate Market Pregame GameOdds from different sportsbooks (e.g. 1st Period; 2nd Period; etc.)"
}
}
},
"GameOdd": {
"properties": {
"GameOddId": {
"type": "integer",
"description": "The unique ID of this odd"
},
"Sportsbook": {
"type": [
"string",
"null"
],
"description": "The name of the sportsbook"
},
"GameId": {
"type": "integer",
"description": "The unique ID of this game"
},
"Created": {
"type": [
"string",
"null"
],
"description": "The date and time of when these odds were first created; based on US Eatern Time (EST/EDT)"
},
"Updated": {
"type": [
"string",
"null"
],
"description": "The timestamp of when these odds were last updated (in US Eastern Time)"
},
"HomeMoneyLine": {
"type": [
"integer",
"null"
],
"description": "The sportsbook's moneyline for the home team"
},
"AwayMoneyLine": {
"type": [
"integer",
"null"
],
"description": "The sportsbook's moneyline for the away team"
},
"HomePointSpread": {
"type": [
"number",
"null"
],
"description": "The sportsbook's point spread for the home team"
},
"AwayPointSpread": {
"type": [
"number",
"null"
],
"description": "The sportsbook's point spread for the away team"
},
"HomePointSpreadPayout": {
"type": [
"integer",
"null"
],
"description": "The sportsbook's point spread payout for the home team"
},
"AwayPointSpreadPayout": {
"type": [
"integer",
"null"
],
"description": "The sportsbook's point spread payout for the away team"
},
"OverUnder": {
"type": [
"number",
"null"
],
"description": "The sportsbook's total goals scored over under for the game"
},
"OverPayout": {
"type": [
"integer",
"null"
],
"description": "The sportsbook's payout for the over"
},
"UnderPayout": {
"type": [
"integer",
"null"
],
"description": "The sportsbook's payout for the under"
},
"SportsbookId": {
"type": [
"integer",
"null"
],
"description": "The unique ID of the sportsbook"
},
"OddType": {
"type": [
"string",
"null"
],
"description": "The market type of the odd (ex: live, pregame, 1st-pd, etc)"
},
"SportsbookUrl": {
"type": [
"string",
"null"
],
"description": "The URL for sportsbook event"
},
"Unlisted": {
"type": [
"string",
"null"
],
"description": "The timestamp when these odds were no longer seen, based on US Eastern Time (EST/EDT)"
}
}
},
"TeamTrends": {
"properties": {
"Team": {
"type": [
"string",
"null"
],
"description": "The abbreviation [Key] of the team"
},
"TeamID": {
"type": [
"integer",
"null"
],
"description": "The unique ID of the team"
},
"UpcomingGame": {
"$ref": "#/components/schemas/Game",
"description": "Upcoming game for this team"
},
"TeamGameTrends": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TeamGameTrends"
},
"description": "The collection of Game Trends for this team"
}
}
},
"TeamGameTrends": {
"properties": {
"Scope": {
"type": [
"string",
"null"
],
"description": "The type of Trend (e.g. Last 5 games, Last 10 games, Last 5 home games, etc.)"
},
"TeamID": {
"type": "integer",
"description": "The unique ID of the team"
},
"Team": {
"type": [
"string",
"null"
],
"description": "The abbreviation [Key] of the team"
},
"OpponentID": {
"type": [
"integer",
"null"
],
"description": "The unique ID of the team's opponent"
},
"Opponent": {
"type": [
"string",
"null"
],
"description": "The abbreviation [Key] of the opponent team"
},
"Wins": {
"type": "integer",
"description": "Total number of wins relating to the scope (Examples of Scopes include: Last 3 Games; Last 5 Home Games; Last 10 Games as favorite, etc.)"
},
"Losses": {
"type": "integer",
"description": "Total losses by the team relating to the scope (Examples of Scopes include: Last 3 Games; Last 5 Home Games; Last 10 Games as favorite, etc.)"
},
"Ties": {
"type": "integer",
"description": "Ties relating to the scope (Examples of Scopes include: Last 3 Games; Last 5 Home Games; Last 10 Games as favorite, etc.)"
},
"WinsAgainstTheSpread": {
"type": [
"integer",
"null"
],
"description": "Total number of wins against the spread relating to the scope (Examples of Scopes include: Last 3 Games; Last 5 Home Games; Last 10 Games as favorite, etc.)"
},
"LossesAgainstTheSpread": {
"type": [
"integer",
"null"
],
"description": "Total losses against the puck line by the team relating to the scope (Examples of Scopes include: Last 3 Games; Last 5 Home Games; Last 10 Games as favorite, etc.)"
},
"PushesAgainstTheSpread": {
"type": [
"integer",
"null"
],
"description": "Pushes against the puck line relating to the scope (Examples of Scopes include: Last 3 Games; Last 5 Home Games; Last 10 Games as favorite, etc.)"
},
"Overs": {
"type": [
"integer",
"null"
],
"description": "Amount of times the total score goes over the total goals line"
},
"Unders": {
"type": [
"integer",
"null"
],
"description": "Amount of times the total score goes under the toal goals line"
},
"OverUnderPushes": {
"type": [
"integer",
"null"
],
"description": "Amount of times the total score pushes the total goals line"
},
"AverageScore": {
"type": [
"number",
"null"
],
"description": "The average goals per game scored by the team relating to the scope (Examples of Scopes include: Last 3 Games; Last 5 Home Games; Last 10 Games as favorite, etc.)"
},
"AverageOpponentScore": {
"type": [
"number",
"null"
],
"description": "The average goals per game scored by the opposing teams relating to the scope (Examples of Scopes include: Last 3 Games; Last 5 Home Games; Last 10 Games as favorite, etc.)"
}
}
},
"MatchupTrends": {
"properties": {
"UpcomingGame": {
"$ref": "#/components/schemas/Game",
"description": "Upcoming game between the team and the opponent"
},
"TeamTrends": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TeamTrends"
},
"description": "The collection of team trends between each team"
},
"TeamMatchupTrends": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TeamGameTrends"
},
"description": "The collection of team game trends against opponent"
},
"OpponentMatchupTrends": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TeamGameTrends"
},
"description": "The collection of opponent game trends against a specific team"
},
"PreviousGames": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Game"
},
"description": "The collection of last 10 game scores between each team"
}
}
},
"BettingEvent": {
"properties": {
"BettingEventID": {
"type": "integer",
"description": "The unique ID associated with the betting event"
},
"Name": {
"type": [
"string",
"null"
],
"description": "The name of this betting event"
},
"Season": {
"type": [
"integer",
"null"
],
"description": "The NHL season of the betting event"
},
"BettingEventTypeID": {
"type": "integer",
"description": "The ID associated with the type of betting event"
},
"BettingEventType": {
"type": [
"string",
"null"
],
"description": "Indicates the type of betting event - Game or Future"
},
"StartDate": {
"type": [
"string",
"null"
],
"description": "The furthest forward time any book has a market set to close for this betting event"
},
"Created": {
"type": [
"string",
"null"
],
"description": "The date and time when this betting event was created in US Eastern Time."
},
"Updated": {
"type": [
"string",
"null"
],
"description": "The timestamp of the last time this betting event was updated (in US Eastern Time)"
},
"GameID": {
"type": [
"integer",
"null"
],
"description": "The unique ID of the game tied to this BettingEvent"
},
"GlobalGameID": {
"type": [
"integer",
"null"
],
"description": "A globally unique ID for the game tied to this betting event. This value is guaranteed to be unique across all sports/leagues."
},
"GameStatus": {
"type": [
"string",
"null"
],
"description": "The status of the game tied to this event. A list of NHL game statuses can be found here."
},
"Quarter": {
"type": [
"string",
"null"
],
"description": "The quarter of the game tied to this event. Note: This field will be null unless the game is ongoing."
},
"AwayTeam": {
"type": [
"string",
"null"
],
"description": "The abbreviation [Key] of the away team"
},
"HomeTeam": {
"type": [
"string",
"null"
],
"description": "The abbreviation [Key] of the home team"
},
"AwayTeamID": {
"type": [
"integer",
"null"
],
"description": "The unique TeamID of the away team in the game tied to this betting event"
},
"HomeTeamID": {
"type": [
"integer",
"null"
],
"description": "The unique ID of the home team tied to this betting event"
},
"GlobalAwayTeamID": {
"type": [
"integer",
"null"
],
"description": "A globally unique ID for the away team tied to this betting event. This value is guaranteed to be unique across all sports/leagues."
},
"GlobalHomeTeamID": {
"type": [
"integer",
"null"
],
"description": "A globally unique ID for the home team tied to this betting event. This value is guaranteed to be unique across all sports/leagues."
},
"AwayTeamScore": {
"type": [
"integer",
"null"
],
"description": "Total number of goals the away team scored in the game tied to the event (post-game)"
},
"HomeTeamScore": {
"type": [
"integer",
"null"
],
"description": "Total number of points the home team scored in the game tied to the event (post-game)"
},
"TotalScore": {
"type": [
"integer",
"null"
],
"description": "Total goals scored in the game (post-game)"
},
"AwayRotationNumber": {
"type": [
"integer",
"null"
],
"description": "The rotation number of the away team for a game"
},
"HomeRotationNumber": {
"type": [
"integer",
"null"
],
"description": "The rotation number of the home team for this game"
},
"BettingMarkets": {
"type": "array",
"items": {
"$ref": "#/components/schemas/BettingMarket"
},
"description": "The list of betting markets for this event"
},
"GameStartTime": {
"type": [
"string",
"null"
],
"description": "The date and time that the game attached to the betting event started. Note: Time is in US Eastern Time"
}
}
},
"BettingMarket": {
"properties": {
"BettingMarketID": {
"type": "integer",
"description": "The unique ID of the betting market"
},
"BettingEventID": {
"type": "integer",
"description": "The unique ID assocated with the betting event"
},
"BettingMarketTypeID": {
"type": [
"integer",
"null"
],
"description": "The ID associated with the name of the market type within a market"
},
"BettingMarketType": {
"type": [
"string",
"null"
],
"description": "The name of the market type within a betting market (e.g. Player Prop, Team Prop, Game Prop, etc.)"
},
"BettingBetTypeID": {
"type": [
"integer",
"null"
],
"description": "The ID associated with the name of the bet type within a market"
},
"BettingBetType": {
"type": [
"string",
"null"
],
"description": "The name of the bet type within a market (e.g. Total Points, Moneyline, Puck Line, etc.)"
},
"BettingPeriodTypeID": {
"type": [
"integer",
"null"
],
"description": "The ID associated with the betting period type which we can result"
},
"BettingPeriodType": {
"type": [
"string",
"null"
],
"description": "The name of the period type of a market (e.g. Full Game; 1st Period; Overtime; Regular Season)"
},
"Name": {
"type": [
"string",
"null"
],
"description": "The generic name of this market"
},
"TeamID": {
"type": [
"integer",
"null"
],
"description": "The unique ID of the team"
},
"TeamKey": {
"type": [
"string",
"null"
],
"description": "The abbreviation [Key] of the team tied to this market result (if applicable)"
},
"PlayerID": {
"type": [
"integer",
"null"
],
"description": "The player's unique PlayerID as assigned by SportsDataIO. Note: this ID will stay with the player throughout their entire career"
},
"PlayerName": {
"type": [
"string",
"null"
],
"description": "The name of the player tied to this market (if applicable)"
},
"Created": {
"type": [
"string",
"null"
],
"description": "The date and time when this betting market was created in US Eastern Time."
},
"Updated": {
"type": [
"string",
"null"
],
"description": "The last updated date of this market"
},
"AvailableSportsbooks": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Sportsbook"
},
"description": "The sportsbooks that have had odds in this market"
},
"AnyBetsAvailable": {
"type": [
"boolean",
"null"
],
"description": "A field that returns \"True\" if there are any available bets to make within the market in question. If there are no bets available to make, the field returns \"False\""
},
"BettingOutcomes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/BettingOutcome"
},
"description": "The list of betting outcomes from each sportsbook in this market"
},
"ConsensusOutcomes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ConsensusOutcome"
},
"description": "The single set of consensus outcomes of this market"
},
"IsArchived": {
"type": "boolean",
"description": "Indicates if the BettingOutcomes have been moved to the archives"
},
"ArchiveLocation": {
"type": [
"string",
"null"
],
"description": "If IsArchived is true, this returns the URL that can be used to retrieve the archived BettingOutcomes. An API Key and Sportsbook Grouping will be required to retrieve this information. If IsArchived is false, this returns an emtpy string"
}
}
},
"Sportsbook": {
"properties": {
"SportsbookID": {
"type": "integer",
"description": "The unique ID of the sportsbook"
},
"Name": {
"type": [
"string",
"null"
],
"description": "The name of the sportsbook(s)"
}
}
},
"BettingOutcome": {
"properties": {
"BettingOutcomeID": {
"type": [
"integer",
"null"
],
"description": "The unique ID associated with this specific outcome"
},
"BettingMarketID": {
"type": [
"integer",
"null"
],
"description": "The unique ID of the betting market"
},
"SportsBook": {
"$ref": "#/components/schemas/Sportsbook",
"description": "The sportsbook offering this outcome for betting"
},
"BettingOutcomeTypeID": {
"type": [
"integer",
"null"
],
"description": "The ID associated with the betting outcome type"
},
"BettingOutcomeType": {
"type": [
"string",
"null"
],
"description": "The name of the betting outcome within a betting market (e.g. Home; Away; Under; Over)"
},
"PayoutAmerican": {
"type": [
"integer",
"null"
],
"description": "The american odds payout "
},
"PayoutDecimal": {
"type": [
"number",
"null"
],
"description": "The decimal odds payout"
},
"Value": {
"type": [
"number",
"null"
],
"description": "The number associated with the outcome (spread/total/etc)"
},
"Participant": {
"type": [
"string",
"null"
],
"description": "The name of the participant (typically team or player) associated with the outcome. NOTE: This is provided by the sportsbook. In the case of Player odds; we highly recommend using PlayerID as names of players can be inconsistent between sportsbooks"
},
"IsAvailable": {
"type": [
"boolean",
"null"
],
"description": "Is this outcome available for betting as of last update"
},
"IsAlternate": {
"type": [
"boolean",
"null"
],
"description": "Is this an alternate value or the core value"
},
"Created": {
"type": [
"string",
"null"
],
"description": "The date and time when this betting outcome was created in US Eastern Time."
},
"Updated": {
"type": [
"string",
"null"
],
"description": "The timestamp of the last time this betting outcome was updated (in US Eastern Time)"
},
"Unlisted": {
"type": [
"string",
"null"
],
"description": "The datetime the outcome was unlisted (no longer available for bets)"
},
"TeamID": {
"type": [
"integer",
"null"
],
"description": "The unique ID of the team"
},
"PlayerID": {
"type": [
"integer",
"null"
],
"description": "The player's unique PlayerID as assigned by SportsDataIO. Note: this ID will stay with the player throughout their entire career"
},
"GlobalTeamID": {
"type": [
"integer",
"null"
],
"description": "A globally unique ID for this team. This value is guaranteed to be unique across all sports/leagues."
},
"SportsbookUrl": {
"type": [
"string",
"null"
],
"description": "The URL for sportsbook event"
},
"IsInPlay": {
"type": [
"boolean",
"null"
],
"description": "Was this outcome created after the start time of the game (only applies when the betting event is of type game)"
},
"SportsbookMarketID": {
"type": [
"string",
"null"
],
"description": "The market ID of the given sportsbook when available for deep links"
},
"SportsbookOutcomeID": {
"type": [
"string",
"null"
],
"description": "The outcome ID of the given sportsbook when available for deep links"
}
}
},
"ConsensusOutcome": {
"properties": {
"NumberOfSportsbooks": {
"type": "integer",
"description": "The number of sportsbooks odds that went into creating this consensus outcome"
},
"BettingOutcomeID": {
"type": [
"integer",
"null"
],
"description": "The unique ID associated with this specific outcome"
},
"BettingMarketID": {
"type": [
"integer",
"null"
],
"description": "The unique ID of the betting market"
},
"SportsBook": {
"$ref": "#/components/schemas/Sportsbook",
"description": "The sportsbook offering this outcome for betting"
},
"BettingOutcomeTypeID": {
"type": [
"integer",
"null"
],
"description": "The ID associated with the betting outcome type"
},
"BettingOutcomeType": {
"type": [
"string",
"null"
],
"description": "The name of the betting outcome within a betting market (e.g. Home; Away; Under; Over)"
},
"PayoutAmerican": {
"type": [
"integer",
"null"
],
"description": "The american odds payout "
},
"PayoutDecimal": {
"type": [
"number",
"null"
],
"description": "The decimal odds payout"
},
"Value": {
"type": [
"number",
"null"
],
"description": "The number associated with the outcome (spread/total/etc)"
},
"Participant": {
"type": [
"string",
"null"
],
"description": "The name of the participant (typically team or player) associated with the outcome. NOTE: This is provided by the sportsbook. In the case of Player odds; we highly recommend using PlayerID as names of players can be inconsistent between sportsbooks"
},
"IsAvailable": {
"type": [
"boolean",
"null"
],
"description": "Is this outcome available for betting as of last update"
},
"IsAlternate": {
"type": [
"boolean",
"null"
],
"description": "Is this an alternate value or the core value"
},
"Created": {
"type": [
"string",
"null"
],
"description": "The date and time when this betting outcome was created in US Eastern Time."
},
"Updated": {
"type": [
"string",
"null"
],
"description": "The timestamp of the last time this betting outcome was updated (in US Eastern Time)"
},
"Unlisted": {
"type": [
"string",
"null"
],
"description": "The datetime the outcome was unlisted (no longer available for bets)"
},
"TeamID": {
"type": [
"integer",
"null"
],
"description": "The unique ID of the team"
},
"PlayerID": {
"type": [
"integer",
"null"
],
"description": "The player's unique PlayerID as assigned by SportsDataIO. Note: this ID will stay with the player throughout their entire career"
},
"GlobalTeamID": {
"type": [
"integer",
"null"
],
"description": "A globally unique ID for this team. This value is guaranteed to be unique across all sports/leagues."
},
"SportsbookUrl": {
"type": [
"string",
"null"
],
"description": "The URL for sportsbook event"
},
"IsInPlay": {
"type": [
"boolean",
"null"
],
"description": "Was this outcome created after the start time of the game (only applies when the betting event is of type game)"
},
"SportsbookMarketID": {
"type": [
"string",
"null"
],
"description": "The market ID of the given sportsbook when available for deep links"
},
"SportsbookOutcomeID": {
"type": [
"string",
"null"
],
"description": "The outcome ID of the given sportsbook when available for deep links"
}
}
},
"BettingEntityMetadataCollection": {
"properties": {
"BettingBetTypes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/BettingEntityMetadata"
},
"description": "The list of the bet types that can be found within a market"
},
"BettingMarketTypes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/BettingEntityMetadata"
},
"description": "A list of the possible market types within a Betting Event (e.g. Game Line, Team Prop, Player Future, etc.)"
},
"BettingPeriodTypes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/BettingEntityMetadata"
},
"description": "A list of the possible BettingPeriodTypes (e.g. Full Game; Regulation; 1st Period)"
},
"BettingEventTypes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/BettingEntityMetadata"
},
"description": "A list of the possible BettingEventTypes (e.g. Game, Future)"
},
"BettingOutcomeTypes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/BettingEntityMetadata"
},
"description": "A list of the possible BettingOutcomeTypes (e.g. Home; Away; Under; Over)"
},
"ResultedMarketMetaData": {
"type": "array",
"items": {
"$ref": "#/components/schemas/BettingResultingMetadata"
},
"description": "A list of the combinations of MarketType, BetType, & PeriodType which we willl provide automated resulting for"
},
"BettingResultTypes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/BettingEntityMetadata"
},
"description": "A list of the possible BettingResultTypes (e.g. Win; Loss; Push; Not Resulted; Incomplete)"
}
}
},
"BettingEntityMetadata": {
"properties": {
"RecordId": {
"type": "integer",
"description": "The unique ID of this record. Unique only within the same entity type (i.e. BettingMarketTypeIDs overlap with BettingBetTypeIDs)"
},
"Name": {
"type": [
"string",
"null"
],
"description": "A text value for the record (e.g. Moneyline; Player Prop; 3rd Quarter)"
},
"Active": {
"type": [
"boolean",
"null"
],
"description": "Whether or not this market is currently is use"
}
}
},
"BettingResultingMetadata": {
"properties": {
"BettingMarketTypeId": {
"type": "integer",
"description": "The ID associated with the name of the market type within a market"
},
"BettingBetTypeId": {
"type": "integer",
"description": "The ID associated with the name of the bet type within a market"
},
"BettingPeriodTypeId": {
"type": "integer",
"description": "The ID associated with the betting period type which we can result"
}
}
},
"BettingMarketSplit": {
"properties": {
"BettingMarketID": {
"type": "integer",
"description": "The unique ID of the betting market"
},
"BettingEventID": {
"type": "integer",
"description": "The unique ID of the betting event associated with this split"
},
"BettingMarketTypeID": {
"type": "integer",
"description": "The ID associated with the name of the market type within a market"
},
"BettingMarketType": {
"type": [
"string",
"null"
],
"description": "The name of the market type within a betting market (e.g. Player Prop, Team Prop, Game Prop, etc.)"
},
"BettingBetTypeID": {
"type": "integer",
"description": "The ID associated with the name of the bet type within a market"
},
"BettingBetType": {
"type": [
"string",
"null"
],
"description": "The name of the bet type within a market (e.g. Total Points, Moneyline, Puck Line, etc.)"
},
"BettingPeriodTypeID": {
"type": "integer",
"description": "The ID associated with the betting period type which we can result"
},
"BettingPeriodType": {
"type": [
"string",
"null"
],
"description": "The name of the period type of a market (e.g. Full Game; 1st Period; Overtime; Regular Season)"
},
"TeamID": {
"type": [
"integer",
"null"
],
"description": "The unique ID of the team"
},
"TeamKey": {
"type": [
"string",
"null"
],
"description": "The abbreviation [Key] of the team tied to this market split (if applicable)"
},
"PlayerID": {
"type": [
"integer",
"null"
],
"description": "The player's unique PlayerID as assigned by SportsDataIO. Note: this ID will stay with the player throughout their entire career"
},
"PlayerName": {
"type": [
"string",
"null"
],
"description": "The name of the player tied to this split (if applicable)"
},
"BettingSplits": {
"type": "array",
"items": {
"$ref": "#/components/schemas/BettingSplit"
},
"description": "A list of betting splits"
}
}
},
"BettingSplit": {
"properties": {
"BettingMarketSplitID": {
"type": "integer",
"description": "The unique ID of this betting split insatnce"
},
"BettingMarketID": {
"type": "integer",
"description": "The unique ID of the betting market"
},
"BettingOutcomeTypeID": {
"type": [
"integer",
"null"
],
"description": "The ID associated with the betting outcome type"
},
"BettingOutcomeType": {
"type": [
"string",
"null"
],
"description": "The name of the betting outcome within a betting market (e.g. Home; Away; Under; Over)"
},
"BetPercentage": {
"type": [
"integer",
"null"
],
"description": "Percentage of bets placed on a specific outcome"
},
"MoneyPercentage": {
"type": [
"integer",
"null"
],
"description": "The percent of money on this outcome"
},
"Created": {
"type": [
"string",
"null"
],
"description": "The date and time when this betting split was created in US Eastern Time"
},
"LastSeen": {
"type": [
"string",
"null"
],
"description": "When this split was last updated"
}
}
},
"GameBettingSplit": {
"properties": {
"GameID": {
"type": "integer",
"description": "The unique ID of the game tied to the BettingSplits Turn on screen reader support"
},
"SeasonType": {
"type": "integer",
"description": "The type of season that this record corresponds to (1=Regular Season; 2=Preseason; 3=Postseason; 5=AllStar; 6=Exhibition)."
},
"Season": {
"type": "integer",
"description": "The end year of season (2021-22 would be 2022)"
},
"Day": {
"type": [
"string",
"null"
],
"description": "The date of the game"
},
"AwayTeam": {
"type": [
"string",
"null"
],
"description": "The abbreviation [Key] of the away team"
},
"HomeTeam": {
"type": [
"string",
"null"
],
"description": "The abbreviation [Key] of the home team"
},
"BettingMarketSplits": {
"type": "array",
"items": {
"$ref": "#/components/schemas/BettingMarketSplit"
},
"description": "Shows the betting markets that have splits included for them in the game"
}
}
},
"BettingMarketResult": {
"properties": {
"BettingMarketID": {
"type": "integer",
"description": "The unique ID of the betting market"
},
"BettingMarketTypeID": {
"type": "integer",
"description": "The ID associated with the name of the market type within a market"
},
"BettingMarketType": {
"type": [
"string",
"null"
],
"description": "The name of the market type within a betting market (e.g. Player Prop, Team Prop, Game Prop, etc.)"
},
"BettingBetTypeID": {
"type": "integer",
"description": "The ID associated with the name of the bet type within a market"
},
"BettingBetType": {
"type": [
"string",
"null"
],
"description": "The name of the bet type within a market (e.g. Total Points, Moneyline, Puck Line, etc.)"
},
"BettingPeriodTypeID": {
"type": "integer",
"description": "The ID associated with the betting period type which we can result"
},
"BettingPeriodType": {
"type": [
"string",
"null"
],
"description": "The name of the period type of a market (e.g. Full Game; 1st Period; Overtime; Regular Season)"
},
"Name": {
"type": [
"string",
"null"
],
"description": "The generic name of this market"
},
"TeamID": {
"type": [
"integer",
"null"
],
"description": "The unique ID of the team"
},
"TeamKey": {
"type": [
"string",
"null"
],
"description": "The abbreviation [Key] of the team tied to this market result (if applicable)"
},
"PlayerID": {
"type": [
"integer",
"null"
],
"description": "The player's unique PlayerID as assigned by SportsDataIO. Note: this ID will stay with the player throughout their entire career"
},
"PlayerName": {
"type": [
"string",
"null"
],
"description": "The name of the player tied to this market (if applicable)"
},
"BettingOutcomeResults": {
"type": "array",
"items": {
"$ref": "#/components/schemas/BettingOutcomeResult"
},
"description": "The list of outcomes under this market with results"
},
"IsMarketResultingSupported": {
"type": "boolean",
"description": "Indicates whether resulting is supported for this kind of BettingMarket"
}
}
},
"BettingOutcomeResult": {
"properties": {
"BettingOutcomeID": {
"type": "integer",
"description": "The unique ID associated with this specific outcome"
},
"BettingResultTypeID": {
"type": [
"integer",
"null"
],
"description": "The ID associated with the betting result type of this outcome"
},
"BettingResultType": {
"type": [
"string",
"null"
],
"description": "The BettingResultType of this outcome"
},
"BettingOutcomeTypeID": {
"type": [
"integer",
"null"
],
"description": "The ID associated with the betting outcome type"
},
"BettingOutcomeType": {
"type": [
"string",
"null"
],
"description": "The name of the betting outcome within a betting market (e.g. Home; Away; Under; Over)"
},
"BetValue": {
"type": [
"number",
"null"
],
"description": "The offered betting line from a sportsbook for a game (i.e. If a team won a game by 2 and the spread was -1.5, the actual value would be 2 and the bet value would be -1.5)"
},
"ActualValue": {
"type": [
"number",
"null"
],
"description": "The value of the actual result that occured in game (i.e. If a team won a game by 2 and the spread was -1.5, the actual value would be 2 and the bet value would be -1.5)"
}
}
},
"GameInfoResult": {
"properties": {
"GameID": {
"type": "integer",
"description": "The unique ID of this game"
},
"Season": {
"type": "integer",
"description": "The NHL season of the game"
},
"SeasonType": {
"type": "integer",
"description": "The type of season that this record corresponds to (1=Regular Season; 2=Preseason; 3=Postseason; 5=AllStar; 6=Exhibition)."
},
"Day": {
"type": [
"string",
"null"
],
"description": "The day that the game is scheduled to be played"
},
"DateTime": {
"type": [
"string",
"null"
],
"description": "The date and time of the game in US Eastern Time"
},
"Status": {
"type": [
"string",
"null"
],
"description": "Indicates the game's status. Possible values include: Scheduled, InProgress, Final, F/SO, F/OT, Suspended, Postponed, Delayed, Canceled, Forfeit"
},
"AwayTeamID": {
"type": [
"integer",
"null"
],
"description": "The unique ID of the away team"
},
"HomeTeamID": {
"type": [
"integer",
"null"
],
"description": "The unique ID of the home team"
},
"AwayTeamName": {
"type": [
"string",
"null"
],
"description": "The name of the away team"
},
"HomeTeamName": {
"type": [
"string",
"null"
],
"description": "The name of the home team"
},
"GlobalGameID": {
"type": "integer",
"description": "A globally unique ID for this game. This value is guaranteed to be unique across all sports/leagues."
},
"GlobalAwayTeamID": {
"type": [
"integer",
"null"
],
"description": "A globally unique ID for the away team. This value is guaranteed to be unique across all sports/leagues."
},
"GlobalTeamHomeTeamID": {
"type": [
"integer",
"null"
],
"description": "A globally unique ID for the home team. This value is guaranteed to be unique across all sports/leagues."
},
"PregameOdds": {
"type": "array",
"items": {
"$ref": "#/components/schemas/GameOddResult"
},
"description": "List of Pregame GameOdds from different sportsbooks with results"
},
"HomeTeamScore": {
"type": [
"integer",
"null"
],
"description": "Total number of goals the home team scored in the game (updated after game ends to allow for resolving bets)"
},
"AwayTeamScore": {
"type": [
"integer",
"null"
],
"description": "Total number of goals the away team scored in the game (updated after game ends to allow for resolving bets)"
},
"TotalScore": {
"type": [
"integer",
"null"
],
"description": "Total goals scored in the game (updated after game ends to allow for resolving bets)"
},
"HomeRotationNumber": {
"type": [
"integer",
"null"
],
"description": "The rotation number of the home team for this game"
},
"AwayRotationNumber": {
"type": [
"integer",
"null"
],
"description": "The rotation number of the away team for this game"
},
"AlternateMarketPregameOdds": {
"type": "array",
"items": {
"$ref": "#/components/schemas/GameOddResult"
},
"description": "A list of Alternate Market Pregame GameOdds from different sportsbooks (e.g. 1st Period; 2nd Period; etc.)"
},
"Period": {
"type": [
"string",
"null"
],
"description": "Indicates the current period of the game. Possible values include: 1; 2; 3; OT; SO; NULL"
},
"TimeRemainingMinutes": {
"type": [
"integer",
"null"
],
"description": "Number of minutes that have passed in the current period. NOTE: this field name might be misleading as it actually represents the game clock minutes which are the number of minutes that have already passed in the period."
},
"TimeRemainingSeconds": {
"type": [
"integer",
"null"
],
"description": "Number of seconds that have passed in the current period. NOTE: this field name might be misleading as it actually represents the game clock sconds which are the number of minutes that have already passed in the period."
},
"Periods": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Period"
},
"description": "The details of the periods (including overtime if applicable) for this game"
},
"IsClosed": {
"type": [
"boolean",
"null"
],
"description": "Indicates whether the game is over and the final score has been verified and closed out. Note: it is recommend for bet resulting to use IsClosed = True rather than simply Final game status"
},
"LiveOdds": {
"type": "array",
"items": {
"$ref": "#/components/schemas/GameOddResult"
},
"description": "List of Live Odds from different sportsbooks with results"
}
}
},
"GameOddResult": {
"properties": {
"GameOddID": {
"type": "integer",
"description": "The unique ID of this odd"
},
"Sportsbook": {
"type": [
"string",
"null"
],
"description": "The name of the sportsbook"
},
"GameID": {
"type": "integer",
"description": "The unique ID of this game"
},
"Created": {
"type": [
"string",
"null"
],
"description": "The date and time of when these odds were first created; based on US Eatern Time (EST/EDT)"
},
"Updated": {
"type": [
"string",
"null"
],
"description": "The timestamp of when these odds were last updated (in US Eastern Time)"
},
"HomeMoneyLine": {
"type": [
"integer",
"null"
],
"description": "The sportsbook's moneyline for the home team"
},
"AwayMoneyLine": {
"type": [
"integer",
"null"
],
"description": "The sportsbook's moneyline for the away team"
},
"HomePointSpread": {
"type": [
"number",
"null"
],
"description": "The sportsbook's point spread for the home team"
},
"AwayPointSpread": {
"type": [
"number",
"null"
],
"description": "The sportsbook's point spread for the away team"
},
"HomePointSpreadPayout": {
"type": [
"integer",
"null"
],
"description": "The sportsbook's point spread payout for the home team"
},
"AwayPointSpreadPayout": {
"type": [
"integer",
"null"
],
"description": "The sportsbook's point spread payout for the away team"
},
"OverUnder": {
"type": [
"number",
"null"
],
"description": "The sportsbook's total goals scored over under for the game"
},
"OverPayout": {
"type": [
"integer",
"null"
],
"description": "The sportsbook's payout for the over"
},
"UnderPayout": {
"type": [
"integer",
"null"
],
"description": "The sportsbook's payout for the under"
},
"SportsbookID": {
"type": [
"integer",
"null"
],
"description": "The unique ID of the sportsbook"
},
"SportsbookUrl": {
"type": [
"string",
"null"
],
"description": "The URL for sportsbook event"
},
"OddType": {
"type": [
"string",
"null"
],
"description": "The market type of the odd (ex: live, pregame, 1st-pd, etc)"
},
"GameOddOutcomeResults": {
"type": "array",
"items": {
"$ref": "#/components/schemas/GameOddOutcome"
},
"description": "List of outcomes showing results of betting markets that were bet on for the given game"
}
}
},
"GameOddOutcome": {
"properties": {
"GameOddId": {
"type": "integer",
"description": "The unique ID of this odd"
},
"GameOddResultTypeId": {
"type": [
"integer",
"null"
],
"description": "The unique ID of this GameOddResultType"
},
"GameOddResultType": {
"type": [
"string",
"null"
],
"description": "The result/outcome of a bet (e.g. Won; Lost; Push; Not Resulted; Incomplete)"
},
"OddType": {
"type": [
"string",
"null"
],
"description": "The market type of the odd (ex: live; pregame; 1st-pd; etc)"
},
"GameOddType": {
"type": [
"string",
"null"
],
"description": "The GameOddOutcomeType of this outcome as a string"
},
"BetValue": {
"type": [
"number",
"null"
],
"description": "The offered betting line from a sportsbook for a game (i.e. If a team won a game by 2 and the spread was -1.5, the actual value would be 2 and the bet value would be -1.5)"
},
"ActualValue": {
"type": [
"number",
"null"
],
"description": "The value of the actual result that occured in game (i.e. If a team won a game by 2 and the spread was -1.5, the actual value would be 2 and the bet value would be -1.5)"
}
}
},
"BoxScore": {
"properties": {
"Game": {
"$ref": "#/components/schemas/Game",
"description": "The details of the game associated with this box score"
},
"Periods": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Period"
},
"description": "The details of the periods associated with this box score"
},
"TeamGames": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TeamGame"
},
"description": "The team game stats associated with this box score"
},
"PlayerGames": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PlayerGame"
},
"description": "The player game stats associated with this box score"
},
"ShootoutPlays": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Play"
},
"description": "The details of any shootout plays associated with this box score"
}
}
},
"PlayerGame": {
"properties": {
"StatID": {
"type": "integer",
"description": "The unique ID of the stat"
},
"TeamID": {
"type": [
"integer",
"null"
],
"description": "The unique ID of the team"
},
"PlayerID": {
"type": [
"integer",
"null"
],
"description": "The player's unique PlayerID as assigned by SportsDataIO. Note: this ID will stay with the player throughout their entire career"
},
"SeasonType": {
"type": [
"integer",
"null"
],
"description": "The type of season that this record corresponds to (1=Regular Season; 2=Preseason; 3=Postseason; 5=AllStar; 6=Exhibition)"
},
"Season": {
"type": [
"integer",
"null"
],
"description": "The NHL season of the game"
},
"Name": {
"type": [
"string",
"null"
],
"description": "The player's full name"
},
"Team": {
"type": [
"string",
"null"
],
"description": "The abbreviation [Key] of the team"
},
"Position": {
"type": [
"string",
"null"
],
"description": "The player's primary position. Possible values: C; RW; LW; D; or G"
},
"FantasyDataSalary": {
"type": [
"integer",
"null"
],
"description": "The player's salary as calculated by SportsDataIO (formerly known as FantasyData). Based on the same salary cap as DraftKings contests ($50,000)"
},
"FanDuelSalary": {
"type": [
"integer",
"null"
],
"description": "The player's salary for FanDuel daily fantasy contests"
},
"DraftKingsSalary": {
"type": [
"integer",
"null"
],
"description": "The player's salary for DraftKings daily fantasy contests"
},
"YahooSalary": {
"type": [
"integer",
"null"
],
"description": "The player's salary for Yahoo daily fantasy contests."
},
"InjuryStatus": {
"type": [
"string",
"null"
],
"description": "The player's current injury status; in the form of likelihood that player plays. Possible values: Probable; Questionable; Doubtful; Out"
},
"InjuryBodyPart": {
"type": [
"string",
"null"
],
"description": "The body part that is injured for the player (Knee; Groin; Calf; Upper-body; etc.)"
},
"InjuryStartDate": {
"type": [
"string",
"null"
],
"description": "The day that the injury started or was first discovered"
},
"InjuryNotes": {
"type": [
"string",
"null"
],
"description": "Brief description of the player's injury and expected availability"
},
"FanDuelPosition": {
"type": [
"string",
"null"
],
"description": "The player's eligible position in FanDuel's daily fantasy sports platform"
},
"DraftKingsPosition": {
"type": [
"string",
"null"
],
"description": "The player's eligible position in DraftKings' daily fantasy sports platform"
},
"YahooPosition": {
"type": [
"string",
"null"
],
"description": "The player's eligible position in Yahoo's daily fantasy sports platform."
},
"OpponentRank": {
"type": [
"integer",
"null"
],
"description": "The ranking of the player's opponent with regards to fantasy points allowed"
},
"OpponentPositionRank": {
"type": [
"integer",
"null"
],
"description": "The ranking of the player's opponent by position with regards to fantasy points allowed"
},
"GlobalTeamID": {
"type": [
"integer",
"null"
],
"description": "A globally unique ID for this team. This value is guaranteed to be unique across all sports/leagues"
},
"FantasyDraftSalary": {
"type": [
"integer",
"null"
],
"description": "The player's salary for FantasyDraft daily fantasy contests"
},
"FantasyDraftPosition": {
"type": [
"string",
"null"
],
"description": "The player's eligible position in Fantasy Drafts daily fantasy sports platform."
},
"EvenStrengthMinutes": {
"type": [
"integer",
"null"
],
"description": "The number of minutes played at even strength by the player in the game"
},
"EvenStrengthSeconds": {
"type": [
"integer",
"null"
],
"description": "The number of seconds played at even strength by the player in the game"
},
"PowerPlayMinutes": {
"type": [
"integer",
"null"
],
"description": "Total minutes played by the player on the power play in the game"
},
"PowerPlaySeconds": {
"type": [
"integer",
"null"
],
"description": "The number of seconds (remainder after minutes) played on a Power Play"
},
"ShortHandedMinutes": {
"type": [
"integer",
"null"
],
"description": "The number of minutes played short handed by the player in the game"
},
"ShortHandedSeconds": {
"type": [
"integer",
"null"
],
"description": "The number of seconds (remainder after minutes) played short handed by the player in the game"
},
"Points": {
"type": [
"number",
"null"
],
"description": "Total points for the player in the game. Note: points are calculated by adding up a player's goals and assists"
},
"GameID": {
"type": [
"integer",
"null"
],
"description": "The unique ID of this game"
},
"OpponentID": {
"type": [
"integer",
"null"
],
"description": "The unique ID of the team's opponent"
},
"Opponent": {
"type": [
"string",
"null"
],
"description": "The name of the opponent "
},
"Day": {
"type": [
"string",
"null"
],
"description": "The day of the game"
},
"DateTime": {
"type": [
"string",
"null"
],
"description": "The date and time of the game"
},
"HomeOrAway": {
"type": [
"string",
"null"
],
"description": "Whether the team is home or away"
},
"IsGameOver": {
"type": "boolean",
"description": "Whether the game is over (true/false)"
},
"GlobalGameID": {
"type": [
"integer",
"null"
],
"description": "A globally unique ID for this game. This value is guaranteed to be unique across all sports/leagues."
},
"GlobalOpponentID": {
"type": [
"integer",
"null"
],
"description": "A globally unique ID for this opponent. This value is guaranteed to be unique across all sports/leagues."
},
"Updated": {
"type": [
"string",
"null"
],
"description": "The timestamp of when the record was last updated (US Eastern Time)."
},
"Games": {
"type": [
"integer",
"null"
],
"description": "The number of games played."
},
"FantasyPoints": {
"type": [
"number",
"null"
],
"description": "Total fantasy points"
},
"FantasyPointsFanDuel": {
"type": [
"number",
"null"
],
"description": "Total FanDuel daily fantasy points scored"
},
"FantasyPointsDraftKings": {
"type": [
"number",
"null"
],
"description": "Total DraftKings daily fantasy points scored"
},
"FantasyPointsYahoo": {
"type": [
"number",
"null"
],
"description": "Total Yahoo daily fantasy points scored"
},
"Minutes": {
"type": [
"integer",
"null"
],
"description": "Total number of minutes played"
},
"Seconds": {
"type": [
"integer",
"null"
],
"description": "Total number of seconds played"
},
"Goals": {
"type": [
"number",
"null"
],
"description": "Total number of goals scored"
},
"Assists": {
"type": [
"number",
"null"
],
"description": "Total number of assists"
},
"ShotsOnGoal": {
"type": [
"number",
"null"
],
"description": "Total number of shots on goal"
},
"PowerPlayGoals": {
"type": [
"number",
"null"
],
"description": "Total number of power play goals"
},
"ShortHandedGoals": {
"type": [
"number",
"null"
],
"description": "Total number of short handed goals"
},
"EmptyNetGoals": {
"type": [
"number",
"null"
],
"description": "Total number of empty net goals"
},
"PowerPlayAssists": {
"type": [
"number",
"null"
],
"description": "Total number of power play assists"
},
"ShortHandedAssists": {
"type": [
"number",
"null"
],
"description": "Total number of short handed assists"
},
"HatTricks": {
"type": [
"number",
"null"
],
"description": "Total number of hat tricks"
},
"ShootoutGoals": {
"type": [
"number",
"null"
],
"description": "Total number of shootout goals"
},
"PlusMinus": {
"type": [
"number",
"null"
],
"description": "Total plus minus"
},
"PenaltyMinutes": {
"type": [
"number",
"null"
],
"description": "Total pentalty minutes"
},
"Blocks": {
"type": [
"number",
"null"
],
"description": "Total blocked shots"
},
"Hits": {
"type": [
"number",
"null"
],
"description": "Total hits"
},
"Takeaways": {
"type": [
"number",
"null"
],
"description": "Total takeaways"
},
"Giveaways": {
"type": [
"number",
"null"
],
"description": "Total giveaways"
},
"FaceoffsWon": {
"type": [
"number",
"null"
],
"description": "Total faceoffs won"
},
"FaceoffsLost": {
"type": [
"number",
"null"
],
"description": "Total faceoffs lost"
},
"Shifts": {
"type": [
"number",
"null"
],
"description": "Total shifts"
},
"GoaltendingMinutes": {
"type": [
"integer",
"null"
],
"description": "Total goaltending minutes"
},
"GoaltendingSeconds": {
"type": [
"integer",
"null"
],
"description": "Total goaltending seconds"
},
"GoaltendingShotsAgainst": {
"type": [
"number",
"null"
],
"description": "Total goaltending shots against"
},
"GoaltendingGoalsAgainst": {
"type": [
"number",
"null"
],
"description": "Total goaltending goals against"
},
"GoaltendingSaves": {
"type": [
"number",
"null"
],
"description": "Total goaltending saves"
},
"GoaltendingWins": {
"type": [
"number",
"null"
],
"description": "Total goaltending wins"
},
"GoaltendingLosses": {
"type": [
"number",
"null"
],
"description": "Total goaltendings losses"
},
"GoaltendingShutouts": {
"type": [
"number",
"null"
],
"description": "Total goaltendings shutouts"
},
"Started": {
"type": [
"integer",
"null"
],
"description": "Total games started"
},
"BenchPenaltyMinutes": {
"type": [
"number",
"null"
],
"description": "Total bench pentalty minutes"
},
"GoaltendingOvertimeLosses": {
"type": [
"number",
"null"
],
"description": "Total goaltending overtime losses"
},
"FantasyPointsFantasyDraft": {
"type": [
"number",
"null"
],
"description": "Total FantasyDraft daily fantasy points scored"
}
}
},
"Play": {
"properties": {
"PlayID": {
"type": "integer",
"description": "The unique ID of the play"
},
"PeriodID": {
"type": "integer",
"description": "The unique ID of the period during which this play occurred"
},
"PeriodName": {
"type": [
"string",
"null"
],
"description": "The name of the period that this play occurred in"
},
"Sequence": {
"type": "integer",
"description": "The order in which this play happened over the course of the game"
},
"ClockMinutes": {
"type": [
"integer",
"null"
],
"description": "The number of minutes passed in the period when this play completed"
},
"ClockSeconds": {
"type": [
"integer",
"null"
],
"description": "The number of seconds passed in the period when this play completed"
},
"AwayTeamScore": {
"type": [
"integer",
"null"
],
"description": "The score of the away team after the play ended"
},
"HomeTeamScore": {
"type": [
"integer",
"null"
],
"description": "The score of the home team after the play ended"
},
"TeamID": {
"type": [
"integer",
"null"
],
"description": "The unique ID of the team"
},
"Team": {
"type": [
"string",
"null"
],
"description": "The abbreviation [Key] of the team associated with this play"
},
"OpponentID": {
"type": [
"integer",
"null"
],
"description": "The unique ID of the team's opponent associated with this play"
},
"Opponent": {
"type": [
"string",
"null"
],
"description": "The abbreviation [Key] of the opponent team"
},
"Category": {
"type": [
"string",
"null"
],
"description": "The category of the play. Possible values: Block; Faceoff; Goal; Hit; Penalty; Period; Shootout; Shot; Stoppage; Turnover"
},
"Type": {
"type": [
"string",
"null"
],
"description": "The type of the play. Possible values: AwayTeamTimeout, Block, Boarding, Charging, CheckToTheHead, Clipping, ClosingHandOnThePuck, CrossChecking, DelayOfGame, Elbowing, Faceoff, Fighting, GameMisconduct, Giveaway, Goal, GoalieStopped, HandPass, HighSticking, HighStickOnPuck, Hit, Holding, HoldingTheStick, HomeTeamTimeout, Hooking, Icing, IllegalEquipment, Interference, Kneeing, MinorPenalty, Misconduct, NetOffPost, ObjectsOnIce, Offside, Period, PeriodEnd, PlayerEquipment, PlayerInjury, PowerPlayGoal, PuckFrozen, PuckInBench, PuckInCrowd, PuckInNetting, Referee, RinkRepair, Roughing, ShootoutGoal, ShootoutMiss, ShootoutSave, ShotMissed, ShotOnGoal, Slashing, Stoppage, Takeaway, TooManyMen, Tripping, TvTimeout, Unsportsmanlike, VideoReview"
},
"Description": {
"type": [
"string",
"null"
],
"description": "The description of the play (example: Sidney Crosby won faceoff against Aaron Ekblad)"
},
"PlayerID": {
"type": [
"integer",
"null"
],
"description": "The player's unique PlayerID as assigned by SportsDataIO. Note: this ID will stay with the player throughout their entire career"
},
"Updated": {
"type": [
"string",
"null"
],
"description": "The timestamp of when the play was last updated (in US Eastern Time)"
},
"Created": {
"type": [
"string",
"null"
],
"description": "The database generated timestamp of when this play was first created; based on US Eatern Time (EST/EDT)"
},
"FirstAssistedByPlayerID": {
"type": [
"integer",
"null"
],
"description": "The PlayerID of the player who got the first assist on this play (if applicable)"
},
"SecondAssistedByPlayerID": {
"type": [
"integer",
"null"
],
"description": "The PlayerID of the player who got the second assist on this play (if applicable)"
},
"PowerPlayTeamID": {
"type": [
"integer",
"null"
],
"description": "The unique TeamID of the team on the power play this play (if any)"
},
"PowerPlayTeam": {
"type": [
"string",
"null"
],
"description": "The abbreviation [Key] of the team on the power play this play (if any)"
},
"OpposingPlayerID": {
"type": [
"integer",
"null"
],
"description": "The PlayerID of the player involved in the play on the opposing team"
}
}
},
"PlayerSeason": {
"properties": {
"StatID": {
"type": "integer",
"description": "The unique ID of the stat"
},
"TeamID": {
"type": [
"integer",
"null"
],
"description": "The unique ID of the team"
},
"PlayerID": {
"type": [
"integer",
"null"
],
"description": "The player's unique PlayerID as assigned by SportsDataIO. Note: this ID will stay with the player throughout their entire career"
},
"SeasonType": {
"type": [
"integer",
"null"
],
"description": "The type of season that this record corresponds to (1=Regular Season; 2=Preseason; 3=Postseason; 5=AllStar; 6=Exhibition)"
},
"Season": {
"type": [
"integer",
"null"
],
"description": "The NHL regular season for which these totals apply"
},
"Name": {
"type": [
"string",
"null"
],
"description": "The player's full name"
},
"Team": {
"type": [
"string",
"null"
],
"description": "The abbreviation [Key] of the team"
},
"Position": {
"type": [
"string",
"null"
],
"description": "The player's primary position. Possible values: C; RW; LW; D; or G"
},
"GlobalTeamID": {
"type": [
"integer",
"null"
],
"description": "A globally unique ID for this team. This value is guaranteed to be unique across all sports/leagues"
},
"Updated": {
"type": [
"string",
"null"
],
"description": "The timestamp of when the record was last updated (US Eastern Time)."
},
"Games": {
"type": [
"integer",
"null"
],
"description": "The number of games played."
},
"FantasyPoints": {
"type": [
"number",
"null"
],
"description": "Total fantasy points"
},
"FantasyPointsFanDuel": {
"type": [
"number",
"null"
],
"description": "Total FanDuel daily fantasy points scored"
},
"FantasyPointsDraftKings": {
"type": [
"number",
"null"
],
"description": "Total DraftKings daily fantasy points scored"
},
"FantasyPointsYahoo": {
"type": [
"number",
"null"
],
"description": "Total Yahoo daily fantasy points scored"
},
"Minutes": {
"type": [
"integer",
"null"
],
"description": "Total number of minutes played"
},
"Seconds": {
"type": [
"integer",
"null"
],
"description": "Total number of seconds played"
},
"Goals": {
"type": [
"number",
"null"
],
"description": "Total number of goals scored"
},
"Assists": {
"type": [
"number",
"null"
],
"description": "Total number of assists"
},
"ShotsOnGoal": {
"type": [
"number",
"null"
],
"description": "Total number of shots on goal"
},
"PowerPlayGoals": {
"type": [
"number",
"null"
],
"description": "Total number of power play goals"
},
"ShortHandedGoals": {
"type": [
"number",
"null"
],
"description": "Total number of short handed goals"
},
"EmptyNetGoals": {
"type": [
"number",
"null"
],
"description": "Total number of empty net goals"
},
"PowerPlayAssists": {
"type": [
"number",
"null"
],
"description": "Total number of power play assists"
},
"ShortHandedAssists": {
"type": [
"number",
"null"
],
"description": "Total number of short handed assists"
},
"HatTricks": {
"type": [
"number",
"null"
],
"description": "Total number of hat tricks"
},
"ShootoutGoals": {
"type": [
"number",
"null"
],
"description": "Total number of shootout goals"
},
"PlusMinus": {
"type": [
"number",
"null"
],
"description": "Total plus minus"
},
"PenaltyMinutes": {
"type": [
"number",
"null"
],
"description": "Total pentalty minutes"
},
"Blocks": {
"type": [
"number",
"null"
],
"description": "Total blocked shots"
},
"Hits": {
"type": [
"number",
"null"
],
"description": "Total hits"
},
"Takeaways": {
"type": [
"number",
"null"
],
"description": "Total takeaways"
},
"Giveaways": {
"type": [
"number",
"null"
],
"description": "Total giveaways"
},
"FaceoffsWon": {
"type": [
"number",
"null"
],
"description": "Total faceoffs won"
},
"FaceoffsLost": {
"type": [
"number",
"null"
],
"description": "Total faceoffs lost"
},
"Shifts": {
"type": [
"number",
"null"
],
"description": "Total shifts"
},
"GoaltendingMinutes": {
"type": [
"integer",
"null"
],
"description": "Total goaltending minutes"
},
"GoaltendingSeconds": {
"type": [
"integer",
"null"
],
"description": "Total goaltending seconds"
},
"GoaltendingShotsAgainst": {
"type": [
"number",
"null"
],
"description": "Total goaltending shots against"
},
"GoaltendingGoalsAgainst": {
"type": [
"number",
"null"
],
"description": "Total goaltending goals against"
},
"GoaltendingSaves": {
"type": [
"number",
"null"
],
"description": "Total goaltending saves"
},
"GoaltendingWins": {
"type": [
"number",
"null"
],
"description": "Total goaltending wins"
},
"GoaltendingLosses": {
"type": [
"number",
"null"
],
"description": "Total goaltendings losses"
},
"GoaltendingShutouts": {
"type": [
"number",
"null"
],
"description": "Total goaltendings shutouts"
},
"Started": {
"type": [
"integer",
"null"
],
"description": "Total games started"
},
"BenchPenaltyMinutes": {
"type": [
"number",
"null"
],
"description": "Total bench pentalty minutes"
},
"GoaltendingOvertimeLosses": {
"type": [
"number",
"null"
],
"description": "Total goaltending overtime losses"
},
"FantasyPointsFantasyDraft": {
"type": [
"number",
"null"
],
"description": "Total FantasyDraft daily fantasy points scored"
}
}
},
"TeamLine": {
"properties": {
"TeamID": {
"type": "integer",
"description": "The unique ID of the team"
},
"Key": {
"type": [
"string",
"null"
],
"description": "\"The abbreviation [Key] of the team associated with this market (Ex. BOS, EDM, LAK)\""
},
"FullName": {
"type": [
"string",
"null"
],
"description": "The team's full name (ex. Minnesota Wild; New York Islanders)"
},
"EvenStrengthLines": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PlayerLine"
},
"description": "The even strength lines for this team"
},
"PowerPlayLines": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PlayerLine"
},
"description": "The power play lines for a given team"
},
"ShortHandedLines": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PlayerLine"
},
"description": "The short-handed/penalty-kill lines for this team"
}
}
},
"PlayerLine": {
"properties": {
"LineNumber": {
"type": "integer",
"description": "The line the player is on (e.g. 1, 2, 3, or 4)"
},
"Position": {
"type": [
"string",
"null"
],
"description": "The player's primary position. Possible values: C; RW; LW; D; or G"
},
"PlayerID": {
"type": [
"integer",
"null"
],
"description": "The player's unique PlayerID as assigned by SportsDataIO. Note: this ID will stay with the player throughout their entire career"
},
"Name": {
"type": [
"string",
"null"
],
"description": "The full name of the player on the line"
},
"Shoots": {
"type": [
"string",
"null"
],
"description": "The hand the player shoots the puck with (right or left)"
},
"LineType": {
"type": [
"string",
"null"
],
"description": "The type of line the player is on (e.g. EvenStrength (EV); PowerPlay (PP); ShortHanded (SH))"
}
}
},
"FantasyGame": {
"properties": {
"GameID": {
"type": [
"integer",
"null"
],
"description": "The unique ID of this game"
},
"PlayerID": {
"type": [
"integer",
"null"
],
"description": "The player's unique PlayerID as assigned by SportsDataIO. Note: this ID will stay with the player throughout their entire career"
},
"SeasonType": {
"type": [
"integer",
"null"
],
"description": "The type of season that this record corresponds to (1=Regular Season; 2=Preseason; 3=Postseason; 5=AllStar; 6=Exhibition)."
},
"Season": {
"type": [
"integer",
"null"
],
"description": "The NHL season of the game"
},
"Day": {
"type": [
"string",
"null"
],
"description": "The day of the game"
},
"DateTime": {
"type": [
"string",
"null"
],
"description": "The date and time of the game in US Eastern Time"
},
"Team": {
"type": [
"string",
"null"
],
"description": "The abbreviation [Key] of the team this player is employed by"
},
"Opponent": {
"type": [
"string",
"null"
],
"description": "The abbreviation [Key] of the opponent team"
},
"HomeOrAway": {
"type": [
"string",
"null"
],
"description": "Indicates whether the team is home or away"
},
"Jersey": {
"type": [
"integer",
"null"
],
"description": "The player's jersey number"
},
"Name": {
"type": [
"string",
"null"
],
"description": "The player's full name"
},
"Position": {
"type": [
"string",
"null"
],
"description": "The player's primary position. Possible values: C; RW; LW; D; or G."
},
"Games": {
"type": [
"integer",
"null"
],
"description": "Total games played by the player in the game. NOTE: this will be 1 or 0 for single game feeds"
},
"Started": {
"type": [
"integer",
"null"
],
"description": "Indicates whether or not the player started the game Note: this will be one or zero for single game feeds"
},
"FantasyPoints": {
"type": [
"number",
"null"
],
"description": "Total fantasy points by the player in the game"
},
"IsGameOver": {
"type": "boolean",
"description": "Whether the game is over (returns true/false)"
},
"FantasyPointsFanDuel": {
"type": [
"number",
"null"
],
"description": "Total FanDuel daily fantasy points by the player in the game"
},
"FantasyPointsYahoo": {
"type": [
"number",
"null"
],
"description": "Total Yahoo daily fantasy points by the player in the game"
},
"FantasyPointsDraftKings": {
"type": [
"number",
"null"
],
"description": "Total DraftKings daily fantasy points by the player in the game"
},
"FanDuelPosition": {
"type": [
"string",
"null"
],
"description": "The player's eligible position in FanDuel's daily fantasy sports platform"
},
"DraftKingsPosition": {
"type": [
"string",
"null"
],
"description": "The player's eligible position in DraftKings' daily fantasy sports platform"
},
"YahooPosition": {
"type": [
"string",
"null"
],
"description": "The player's eligible position in Yahoo's daily fantasy sports platform."
},
"OpponentRank": {
"type": [
"integer",
"null"
],
"description": "The ranking of the player's opponent with regards to fantasy points allowed"
},
"OpponentPositionRank": {
"type": [
"integer",
"null"
],
"description": "The ranking of the player's opponent by position with regards to fantasy points allowed"
},
"GlobalGameID": {
"type": [
"integer",
"null"
],
"description": "A globally unique ID for this game. This value is guaranteed to be unique across all sports/leagues."
},
"Updated": {
"type": [
"string",
"null"
],
"description": "The timestamp of when the record was last updated (in US Eastern Time)"
}
}
},
"PlayByPlay": {
"properties": {
"Game": {
"$ref": "#/components/schemas/Game",
"description": "The details of the game associated with this play-by-play"
},
"Plays": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Play"
},
"description": "List of Plays in the game"
}
}
},
"Headshot": {
"properties": {
"PlayerID": {
"type": "integer",
"description": "The player's unique PlayerID as assigned by SportsDataIO. Note: this ID will stay with the player throughout their entire career"
},
"Name": {
"type": [
"string",
"null"
],
"description": "The player's full name"
},
"TeamID": {
"type": [
"integer",
"null"
],
"description": "The unique ID of the team"
},
"Team": {
"type": [
"string",
"null"
],
"description": "The abbreviation [Key] of the team the player belongs to"
},
"Position": {
"type": [
"string",
"null"
],
"description": "The player's primary position. Possible values: C; RW; LW; D; or G."
},
"PreferredHostedHeadshotUrl": {
"type": [
"string",
"null"
],
"description": "The player's preferred hosted headshot URL. This returns the headshot with transparent background, if available."
},
"PreferredHostedHeadshotUpdated": {
"type": [
"string",
"null"
],
"description": "The last updated date of the player's preferred hosted headshot."
},
"HostedHeadshotWithBackgroundUrl": {
"type": [
"string",
"null"
],
"description": "The player's hosted headshot URL"
},
"HostedHeadshotWithBackgroundUpdated": {
"type": [
"string",
"null"
],
"description": "The last updated date of the player's hosted headshot"
},
"HostedHeadshotNoBackgroundUrl": {
"type": [
"string",
"null"
],
"description": "The player's transparent background hosted headshot URL"
},
"HostedHeadshotNoBackgroundUpdated": {
"type": [
"string",
"null"
],
"description": "The last updated date of the player's transparent background hosted headshot"
}
}
}
},
"securitySchemes": {
"apiKeyHeader": {
"type": "apiKey",
"name": "Ocp-Apim-Subscription-Key",
"in": "header"
},
"apiKeyQuery": {
"type": "apiKey",
"name": "key",
"in": "query"
}
}
},
"security": [
{
"apiKeyHeader": []
},
{
"apiKeyQuery": []
}
]
}