3.0.0 • Published 5 years ago
@datafire/sportsdata_nhl_v3_scores v3.0.0
@datafire/sportsdata_nhl_v3_scores
Client library for NHL v3 Scores
Installation and Usage
npm install --save @datafire/sportsdata_nhl_v3_scoreslet sportsdata_nhl_v3_scores = require('@datafire/sportsdata_nhl_v3_scores').create({
apiKeyHeader: "",
apiKeyQuery: ""
});
.then(data => {
console.log(data);
});Description
Actions
TeamsAll
Teams (All)
sportsdata_nhl_v3_scores.TeamsAll({
"format": ""
}, context)Input
- input
object- format required
string(values: XML, JSON): Desired response format. Valid entries are XML or JSON.
- format required
Output
- output
array- items Team
AreGamesInProgress
Returns true if there is at least one game being played at the time of the request or false if there are none.
sportsdata_nhl_v3_scores.AreGamesInProgress({
"format": ""
}, context)Input
- input
object- format required
string(values: XML, JSON): Desired response format. Valid entries are XML or JSON.
- format required
Output
- output
boolean
CurrentSeason
Current Season
sportsdata_nhl_v3_scores.CurrentSeason({
"format": ""
}, context)Input
- input
object- format required
string(values: XML, JSON): Desired response format. Valid entries are XML or JSON.
- format required
Output
- output Season
PlayerDetailsByFreeAgent
Player Details by Free Agent
sportsdata_nhl_v3_scores.PlayerDetailsByFreeAgent({
"format": ""
}, context)Input
- input
object- format required
string(values: XML, JSON): Desired response format. Valid entries are XML or JSON.
- format required
Output
- output
array- items Player
Schedules
Schedules
sportsdata_nhl_v3_scores.Schedules({
"format": "",
"season": ""
}, context)Input
- input
object- format required
string(values: XML, JSON): Desired response format. Valid entries are XML or JSON. - season required
string: Year of the season (with optional season type).Examples: 2018, 2018PRE, 2018POST, 2018STAR, 2019, etc.
- format required
Output
- output
array- items Game
GamesByDate
Games by Date
sportsdata_nhl_v3_scores.GamesByDate({
"format": "",
"date": ""
}, context)Input
- input
object- format required
string(values: XML, JSON): Desired response format. Valid entries are XML or JSON. - date required
string: The date of the game(s).
- format required
Output
- output
array- items Game
News
News
sportsdata_nhl_v3_scores.News({
"format": ""
}, context)Input
- input
object- format required
string(values: XML, JSON): Desired response format. Valid entries are XML or JSON.
- format required
Output
- output
array- items News
NewsByDate
News by Date
sportsdata_nhl_v3_scores.NewsByDate({
"format": "",
"date": ""
}, context)Input
- input
object- format required
string(values: XML, JSON): Desired response format. Valid entries are XML or JSON. - date required
string: The date of the news.
- format required
Output
- output
array- items News
NewsByPlayer
News by Player
sportsdata_nhl_v3_scores.NewsByPlayer({
"format": "",
"playerid": ""
}, context)Input
- input
object- format required
string(values: XML, JSON): Desired response format. Valid entries are XML or JSON. - playerid required
string: Unique FantasyData Player ID.
- format required
Output
- output
array- items News
PlayerDetailsByPlayer
Player Details by Player
sportsdata_nhl_v3_scores.PlayerDetailsByPlayer({
"format": "",
"playerid": ""
}, context)Input
- input
object- format required
string(values: XML, JSON): Desired response format. Valid entries are XML or JSON. - playerid required
string: Unique FantasyData Player ID.
- format required
Output
- output Player
PlayerDetailsByActive
Player Details by Active
sportsdata_nhl_v3_scores.PlayerDetailsByActive({
"format": ""
}, context)Input
- input
object- format required
string(values: XML, JSON): Desired response format. Valid entries are XML or JSON.
- format required
Output
- output
array- items Player
PlayersByTeam
Players by Team
sportsdata_nhl_v3_scores.PlayersByTeam({
"format": "",
"team": ""
}, context)Input
- input
object- format required
string(values: XML, JSON): Desired response format. Valid entries are XML or JSON. - team required
string: The abbreviation of the requested team.
- format required
Output
- output
array- items Player
Stadiums
Stadiums
sportsdata_nhl_v3_scores.Stadiums({
"format": ""
}, context)Input
- input
object- format required
string(values: xml, json): Desired response format. Valid entries are XML or JSON.
- format required
Output
- output
array- items Stadium
Standings
Standings
sportsdata_nhl_v3_scores.Standings({
"format": "",
"season": ""
}, context)Input
- input
object- format required
string(values: XML, JSON): Desired response format. Valid entries are XML or JSON. - season required
string: Year of the season.
- format required
Output
- output
array- items Standing
TeamGameStatsByDate
Team Game Stats by Date
sportsdata_nhl_v3_scores.TeamGameStatsByDate({
"format": "",
"date": ""
}, context)Input
- input
object- format required
string(values: XML, JSON): Desired response format. Valid entries are XML or JSON. - date required
string: The date of the game(s).
- format required
Output
- output
array- items TeamGame
TeamSeasonStats
Team Season Stats
sportsdata_nhl_v3_scores.TeamSeasonStats({
"format": "",
"season": ""
}, context)Input
- input
object- format required
string(values: XML, JSON): Desired response format. Valid entries are XML or JSON. - season required
string: Year of the season.
- format required
Output
- output
array- items TeamSeason
TeamsActive
Teams (Active)
sportsdata_nhl_v3_scores.TeamsActive({
"format": ""
}, context)Input
- input
object- format required
string(values: XML, JSON): Desired response format. Valid entries are XML or JSON.
- format required
Output
- output
array- items Team
Definitions
Game
- Game
object- Attendance
integer - AwayRotationNumber
integer - AwayTeam
string - AwayTeamID
integer - AwayTeamMoneyLine
integer - AwayTeamScore
integer - Channel
string - DateTime
string - Day
string - GameEndDateTime
string - GameID
integer - GlobalAwayTeamID
integer - GlobalGameID
integer - GlobalHomeTeamID
integer - HomeRotationNumber
integer - HomeTeam
string - HomeTeamID
integer - HomeTeamMoneyLine
integer - HomeTeamScore
integer - IsClosed
boolean - LastPlay
string - NeutralVenue
boolean - OverUnder
number - Period
string - Periods
array- items Period
- PointSpread
number - PointSpreadAwayTeamMoneyLine
integer - PointSpreadHomeTeamMoneyLine
integer - Season
integer - SeasonType
integer - StadiumID
integer - Status
string - TimeRemainingMinutes
integer - TimeRemainingSeconds
integer - Updated
string
- Attendance
News
- News
object- Content
string - NewsID
integer - PlayerID
integer - Source
string - Team
string - TeamID
integer - TermsOfUse
string - Title
string - Updated
string - Url
string
- Content
OpponentSeason
- OpponentSeason
object- Assists
number - BenchPenaltyMinutes
number - Blocks
number - EmptyNetGoals
number - FaceoffsLost
number - FaceoffsWon
number - FantasyPoints
number - FantasyPointsDraftKings
number - FantasyPointsFanDuel
number - FantasyPointsFantasyDraft
number - FantasyPointsYahoo
number - Games
integer - Giveaways
number - GlobalTeamID
integer - Goals
number - GoaltendingGoalsAgainst
number - GoaltendingLosses
number - GoaltendingMinutes
integer - GoaltendingOvertimeLosses
number - GoaltendingSaves
number - GoaltendingSeconds
integer - GoaltendingShotsAgainst
number - GoaltendingShutouts
number - GoaltendingWins
number - HatTricks
number - Hits
number - Losses
integer - Minutes
integer - Name
string - OpponentPosition
string - OpponentStat OpponentSeason
- OvertimeLosses
integer - PenaltyMinutes
number - PlusMinus
number - PowerPlayAssists
number - PowerPlayGoals
number - Season
integer - SeasonType
integer - Seconds
integer - Shifts
number - ShootoutGoals
number - ShortHandedAssists
number - ShortHandedGoals
number - ShotsOnGoal
number - Started
integer - StatID
integer - Takeaways
number - Team
string - TeamID
integer - Updated
string - Wins
integer
- Assists
Penalty
- Penalty
object- BenchPenaltyServedByPlayerID
integer - Description
string - DrawnByPlayerID
integer - DrawnByTeamID
integer - IsBenchPenalty
boolean - PenalizedPlayerID
integer - PenalizedTeamID
integer - PenaltyID
integer - PenaltyMinutes
integer - PeriodID
integer - Sequence
integer - TimeRemainingMinutes
integer - TimeRemainingSeconds
integer
- BenchPenaltyServedByPlayerID
Period
- Period
object- AwayScore
integer - GameID
integer - HomeScore
integer - Name
string - Penalties
array- items Penalty
- PeriodID
integer - ScoringPlays
array- items ScoringPlay
- AwayScore
Player
- Player
object- BirthCity
string - BirthDate
string - BirthState
string - Catches
string - DepthChartOrder
integer - DepthChartPosition
string - DraftKingsName
string - DraftKingsPlayerID
integer - FanDuelName
string - FanDuelPlayerID
integer - FantasyAlarmPlayerID
integer - FantasyDraftName
string - FantasyDraftPlayerID
integer - FirstName
string - GlobalTeamID
integer - Height
integer - InjuryBodyPart
string - InjuryNotes
string - InjuryStartDate
string - InjuryStatus
string - Jersey
integer - LastName
string - PhotoUrl
string - PlayerID
integer - Position
string - RotoWirePlayerID
integer - RotoworldPlayerID
integer - Shoots
string - SportRadarPlayerID
string - SportsDirectPlayerID
integer - StatsPlayerID
integer - Status
string - Team
string - TeamID
integer - UsaTodayHeadshotNoBackgroundUpdated
string - UsaTodayHeadshotNoBackgroundUrl
string - UsaTodayHeadshotUpdated
string - UsaTodayHeadshotUrl
string - UsaTodayPlayerID
integer - Weight
integer - XmlTeamPlayerID
integer - YahooName
string - YahooPlayerID
integer
- BirthCity
ScoringPlay
- ScoringPlay
object- AllowedByTeamID
integer - AssistedByPlayerID1
integer - AssistedByPlayerID2
integer - AwayTeamScore
integer - EmptyNet
boolean - HomeTeamScore
integer - PeriodID
integer - PowerPlay
boolean - ScoredByPlayerID
integer - ScoredByTeamID
integer - ScoringPlayID
integer - Sequence
integer - ShortHanded
boolean - TimeRemainingMinutes
integer - TimeRemainingSeconds
integer
- AllowedByTeamID
Season
- Season
object- ApiSeason
string - Description
string - EndYear
integer - PostSeasonStartDate
string - RegularSeasonStartDate
string - Season
integer - SeasonType
string - StartYear
integer
- ApiSeason
Stadium
- Stadium
object- Active
boolean - Address
string - Capacity
integer - City
string - Country
string - GeoLat
number - GeoLong
number - Name
string - StadiumID
integer - State
string - Zip
string
- Active
Standing
- Standing
object- City
string - Conference
string - ConferenceLosses
integer - ConferenceRank
integer - ConferenceWins
integer - Division
string - DivisionLosses
integer - DivisionRank
integer - DivisionWins
integer - GlobalTeamID
integer - Key
string - Losses
integer - Name
string - OvertimeLosses
integer - Percentage
number - Season
integer - SeasonType
integer - ShutoutWins
integer - TeamID
integer - Wins
integer
- City
Team
- Team
object- Active
boolean - City
string - Conference
string - Division
string - GlobalTeamID
integer - Name
string - PrimaryColor
string - QuaternaryColor
string - SecondaryColor
string - StadiumID
integer - TeamID
integer - TertiaryColor
string - WikipediaLogoUrl
string - WikipediaWordMarkUrl
string - Key
string
- Active
TeamGame
- TeamGame
object- Assists
number - BenchPenaltyMinutes
number - Blocks
number - DateTime
string - Day
string - EmptyNetGoals
number - FaceoffsLost
number - FaceoffsWon
number - FantasyPoints
number - FantasyPointsDraftKings
number - FantasyPointsFanDuel
number - FantasyPointsFantasyDraft
number - FantasyPointsYahoo
number - GameID
integer - Games
integer - Giveaways
number - GlobalGameID
integer - GlobalOpponentID
integer - GlobalTeamID
integer - Goals
number - GoaltendingGoalsAgainst
number - GoaltendingLosses
number - GoaltendingMinutes
integer - GoaltendingOvertimeLosses
number - GoaltendingSaves
number - GoaltendingSeconds
integer - GoaltendingShotsAgainst
number - GoaltendingShutouts
number - GoaltendingWins
number - HatTricks
number - Hits
number - HomeOrAway
string - IsGameOver
boolean - Losses
integer - Minutes
integer - Name
string - Opponent
string - OpponentID
integer - OvertimeLosses
integer - PenaltyMinutes
number - PlusMinus
number - PowerPlayAssists
number - PowerPlayGoals
number - Season
integer - SeasonType
integer - Seconds
integer - Shifts
number - ShootoutGoals
number - ShortHandedAssists
number - ShortHandedGoals
number - ShotsOnGoal
number - Started
integer - StatID
integer - Takeaways
number - Team
string - TeamID
integer - Updated
string - Wins
integer
- Assists
TeamSeason
- TeamSeason
object- Assists
number - BenchPenaltyMinutes
number - Blocks
number - EmptyNetGoals
number - FaceoffsLost
number - FaceoffsWon
number - FantasyPoints
number - FantasyPointsDraftKings
number - FantasyPointsFanDuel
number - FantasyPointsFantasyDraft
number - FantasyPointsYahoo
number - Games
integer - Giveaways
number - GlobalTeamID
integer - Goals
number - GoaltendingGoalsAgainst
number - GoaltendingLosses
number - GoaltendingMinutes
integer - GoaltendingOvertimeLosses
number - GoaltendingSaves
number - GoaltendingSeconds
integer - GoaltendingShotsAgainst
number - GoaltendingShutouts
number - GoaltendingWins
number - HatTricks
number - Hits
number - Losses
integer - Minutes
integer - Name
string - OpponentPosition
string - OpponentStat OpponentSeason
- OvertimeLosses
integer - PenaltyMinutes
number - PlusMinus
number - PowerPlayAssists
number - PowerPlayGoals
number - Season
integer - SeasonType
integer - Seconds
integer - Shifts
number - ShootoutGoals
number - ShortHandedAssists
number - ShortHandedGoals
number - ShotsOnGoal
number - Started
integer - StatID
integer - Takeaways
number - Team
string - TeamID
integer - Updated
string - Wins
integer
- Assists
3.0.0
5 years ago