Ice Hockey API Tech Docs

Question & Answers

Ice Hockey API Tournament Info

Provides the information about tournaments. Names, Season, Stage(s).

Ice Hockey Tournament Info Request URL

GET

References / Dependencies

Tournament ID The id of the tournament. You can find list of tournament from Tournament List endpoint

Call Rate / Interval

Recommended API Call Interval: 1 Request / Day Daily Max API Call: 4 Request

Request Headers

Data	Type	O / R	Example	Description
languageId	INT	R	{languageId}	The id of the language that you select.
Ocp-Apim-Subscription-Key	STR	R	{yourOcp-Apim-Subscription-Key}	Your account key.
Accept	STR	O	application/xml	Selection of data presentation type as XML/JSON.

^*O= Optional, R= Required

Request Parameters

Data	Type	O / R	Example	Description
tournamentId	INT	R	{tournamentId}	The id of the tournament.

Response Output

{ "season": { "name": "2018/2019", "shortName": "18/19", "id": 184 }, "country": { "name": "U.S.A", "shortName": "USA", "id": 18 }, "participantType": { "name": "Club", "id": 1 }, "stages": [ { "rounds": [ { "name": "Single Game", "shortName": "SG", "active": true, "id": 209 } ], "name": "NHL Preseason", "shortName": "NHL PS", "id": 1431 }, { "rounds": [ { "name": "Round 1", "shortName": "W1", "id": 1 }, { "name": "Round 2", "shortName": "W2", "id": 2 }, { "name": "Round 26", "shortName": "W26", "id": 26 }, { "name": "Round 27", "shortName": "W27", "active": true, "id": 27 } ], "name": "Regular Season", "shortName": "RS", "roundless": true, "id": 1432 }, { "stages": [ { "rounds": [ { "name": "Game 1", "shortName": "M1", "id": 199 }, { "name": "Game 7", "shortName": "M7", "active": true, "id": 205 } ], "name": "Quarter Final", "shortName": "QF", "id": 1434 }, { "rounds": [ { "name": "Game 1", "shortName": "M1", "id": 199 }, { "name": "Game 6", "shortName": "M6", "active": true, "id": 204 } ], "name": "Semi Final", "shortName": "SF", "id": 1435 }, { "rounds": [ { "name": "Game 4", "shortName": "M4", "id": 202 } ], "name": "Final", "shortName": "F", "active": true, "id": 1436 } ], "name": "The Eastern Conference Play-offs", "shortName": "ECPO", "id": 1433 }, { "stages": [ { "rounds": [ { "name": "Game 1", "shortName": "M1", "id": 199 }, { "name": "Game 7", "shortName": "M7", "active": true, "id": 205 } ], "name": "Quarter Final", "shortName": "QF", "id": 1438 }, { "rounds": [ { "name": "Game 1", "shortName": "M1", "id": 199 }, { "name": "Game 7", "shortName": "M7", "active": true, "id": 205 } ], "name": "Semi Final", "shortName": "SF", "id": 1439 }, { "rounds": [ { "name": "Game 1", "shortName": "M1", "id": 199 }, { "name": "Game 4", "shortName": "M4", "id": 202 } ], "name": "Final", "shortName": "F", "id": 1440 } ], "name": "The Western Conference Play-offs", "shortName": "WCPO", "id": 1437 }, { "stages": [ { "name": "Final", "shortName": "F", "id": 1442 } ], "name": "Stanley Cup", "shortName": "SC", "id": 1441 } ], "name": "NHL", "shortName": "NHL", "mediumName": "", "globalName": "", "localName": "", "isOfficial": true, "isNational": true, "id": 2 }

sample - 1: NHL

Response Output Definitions

tournament

Data

Type

Example

Description

name

STR

NHL

The name of the tournament.

shortName

STR

NHL

The short name of the tournament.

globalName

STR

The global name of the tournament.

localName

STR

The local name of the tournament.

isOfficial

BLN

true

Determines that the tournament is official or unofficial.

isNational

BLN

true

Determines that the tournament is organized national or international.

INT

The id of the tournament.

season

Data	Type	Example	Description
name	STR	2018/2019	The name of the season
shortName	STR	18/19	The short name of the season
id	INT	184	The id of the season

country

Data	Type	Example	Description
name	STR	U.S.A	The name of the country
shortName	STR	USA	The short name of the country
id	INT	18	The id of the country

participantType

Data	Type	Example	Description
name	STR	Club	The participant type of the tournament. Determines that the club or national teams can participate
id	INT	1	The id of the participant type. 1 = Club, 2 = National

stages

stage

Data

Type

Example

Description

name

STR

The Western Conference Play-offs

The name of the stage

shortName

STR

WCPO

The short name of the stage

active

STR

true

Determines the stage is active or not

roundless

BLN

true

Determines the stage is roundless or not

INT

1437

The id of the stage

rounds

round

Data	Type	Example	Description
name	STR	Game 4	The name of the round
shortName	STR	M4	The short name of the round
active	STR	true	Determines the round is active or not
id	INT	202	The id of the round

Ice Hockey API Tech Docs

Tech Docs Index

Documentation

Widgets

Lookups

Global API

Soccer API

Basketball API

Football API

Baseball API

Ice Hockey API

Volleyball API

Handball API

Table Tennis API

Tennis API

Ice Hockey API Tournament Info

Ice Hockey Tournament Info Request URL

References / Dependencies

Call Rate / Interval

Request Headers

Request Parameters

Response Output

Response Output Definitions

tournament

season

country

participantType

stages

stage

rounds

round