3.0.0 • Published 5 years ago
@datafire/sportsdata_nba_v3_stats v3.0.0
@datafire/sportsdata_nba_v3_stats
Client library for NBA v3 Stats
Installation and Usage
npm install --save @datafire/sportsdata_nba_v3_statslet sportsdata_nba_v3_stats = require('@datafire/sportsdata_nba_v3_stats').create({
apiKeyHeader: "",
apiKeyQuery: ""
});
.then(data => {
console.log(data);
});Description
Actions
AllStars
All-Stars
sportsdata_nba_v3_stats.AllStars({
"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 PlayerInfo
TeamsAll
Teams (All)
sportsdata_nba_v3_stats.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_nba_v3_stats.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
BoxScore
Box Score
sportsdata_nba_v3_stats.BoxScore({
"format": "",
"gameid": ""
}, context)Input
- input
object- format required
string(values: XML, JSON): Desired response format. Valid entries are XML or JSON. - gameid required
string: The GameID of an NBA game. GameIDs can be found in the Games API. Valid entries are 14620, 16905, etc.
- format required
Output
- output BoxScore
BoxScoresByDate
Box Scores by Date
sportsdata_nba_v3_stats.BoxScoresByDate({
"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 BoxScore
BoxScoresByDateDelta
Box Scores by Date Delta
sportsdata_nba_v3_stats.BoxScoresByDateDelta({
"format": "",
"date": "",
"minutes": ""
}, 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). - minutes required
string: 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:
- format required
Output
- output
array- items BoxScore
CurrentSeason
Current Season
sportsdata_nba_v3_stats.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
DfsSlatesByDate
DFS Slates by Date
sportsdata_nba_v3_stats.DfsSlatesByDate({
"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 DfsSlate
PlayerDetailsByFreeAgent
Player Details by Free Agent
sportsdata_nba_v3_stats.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_nba_v3_stats.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_nba_v3_stats.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_nba_v3_stats.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_nba_v3_stats.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_nba_v3_stats.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_nba_v3_stats.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
PlayerGameStatsByDate
Player Game Stats by Date
sportsdata_nba_v3_stats.PlayerGameStatsByDate({
"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 PlayerGame
PlayerGameStatsByPlayer
Player Game Stats by Player
sportsdata_nba_v3_stats.PlayerGameStatsByPlayer({
"format": "",
"date": "",
"playerid": ""
}, 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). - playerid required
string: Unique FantasyData Player ID.
- format required
Output
- output PlayerGame
PlayerGameLogsBySeason
Player Game Logs By Season
sportsdata_nba_v3_stats.PlayerGameLogsBySeason({
"format": "",
"season": "",
"playerid": "",
"numberofgames": ""
}, context)Input
- input
object- format required
string(values: XML, JSON): Desired response format. Valid entries are XML or JSON. - season required
string: Season to get games from. Example 2019POST, 2020 - playerid required
string: Unique FantasyData Player ID. - numberofgames required
string: How many games to return. Example all, 10, 25
- format required
Output
- output
array- items PlayerGame
PlayerSeasonStats
Player Season Stats
sportsdata_nba_v3_stats.PlayerSeasonStats({
"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 PlayerSeason
PlayerSeasonStatsByPlayer
Player Season Stats By Player
sportsdata_nba_v3_stats.PlayerSeasonStatsByPlayer({
"format": "",
"season": "",
"playerid": ""
}, 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. - playerid required
string: Unique FantasyData Player ID.
- format required
Output
- output PlayerSeason
PlayerSeasonStatsByTeam
Player Season Stats by Team
sportsdata_nba_v3_stats.PlayerSeasonStatsByTeam({
"format": "",
"season": "",
"team": ""
}, 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. - team required
string: The abbreviation of the requested team.
- format required
Output
- output
array- items PlayerSeason
PlayerDetailsByActive
Player Details by Active
sportsdata_nba_v3_stats.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_nba_v3_stats.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_nba_v3_stats.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_nba_v3_stats.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_nba_v3_stats.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_nba_v3_stats.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
TeamStatsAllowedByPosition
Team Stats Allowed by Position
sportsdata_nba_v3_stats.TeamStatsAllowedByPosition({
"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_nba_v3_stats.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
BoxScore
- BoxScore
object- Game Game
- PlayerGames
array- items PlayerGame
- Quarters
array- items Quarter
- TeamGames
array- items TeamGame
DfsSlate
- DfsSlate
object- DfsSlateGames
array- items DfsSlateGame
- DfsSlatePlayers
array- items DfsSlatePlayer
- IsMultiDaySlate
boolean - NumberOfGames
integer - Operator
string - OperatorDay
string - OperatorGameType
string - OperatorName
string - OperatorSlateID
integer - OperatorStartTime
string - RemovedByOperator
boolean - SalaryCap
integer - SlateID
integer - SlateRosterSlots
array- items
string
- items
- DfsSlateGames
DfsSlateGame
- DfsSlateGame
object- Game Game
- GameID
integer - OperatorGameID
integer - RemovedByOperator
boolean - SlateGameID
integer - SlateID
integer
DfsSlatePlayer
- DfsSlatePlayer
object- OperatorPlayerID
string - OperatorPlayerName
string - OperatorPosition
string - OperatorRosterSlots
array- items
string
- items
- OperatorSalary
integer - OperatorSlatePlayerID
string - PlayerGameProjectionStatID
integer - PlayerID
integer - RemovedByOperator
boolean - SlateGameID
integer - SlateID
integer - SlatePlayerID
integer - Team
string - TeamID
integer
- OperatorPlayerID
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 - PointSpread
number - PointSpreadAwayTeamMoneyLine
integer - PointSpreadHomeTeamMoneyLine
integer - Quarter
string - Quarters
array- items Quarter
- Season
integer - SeasonType
integer - StadiumID
integer - Status
string - TimeRemainingMinutes
integer - TimeRemainingSeconds
integer - Updated
string
- Attendance
News
- News
object- Author
string - Categories
string - Content
string - NewsID
integer - OriginalSource
string - OriginalSourceUrl
string - PlayerID
integer - PlayerID2
integer - Source
string - Team
string - Team2
string - TeamID
integer - TeamID2
integer - TermsOfUse
string - TimeAgo
string - Title
string - Updated
string - Url
string
- Author
OpponentSeason
- OpponentSeason
object- Assists
number - AssistsPercentage
number - BlockedShots
number - BlocksPercentage
number - DefensiveRebounds
number - DefensiveReboundsPercentage
number - DoubleDoubles
number - EffectiveFieldGoalsPercentage
number - FantasyPoints
number - FantasyPointsDraftKings
number - FantasyPointsFanDuel
number - FantasyPointsFantasyDraft
number - FantasyPointsYahoo
number - FieldGoalsAttempted
number - FieldGoalsMade
number - FieldGoalsPercentage
number - FreeThrowsAttempted
number - FreeThrowsMade
number - FreeThrowsPercentage
number - Games
integer - GlobalTeamID
integer - IsClosed
boolean - LineupConfirmed
boolean - LineupStatus
string - Losses
integer - Minutes
integer - Name
string - OffensiveRebounds
number - OffensiveReboundsPercentage
number - OpponentPosition
string - OpponentStat OpponentSeason
- PersonalFouls
number - PlayerEfficiencyRating
number - PlusMinus
number - Points
number - Possessions
number - Rebounds
number - Season
integer - SeasonType
integer - Seconds
integer - StatID
integer - Steals
number - StealsPercentage
number - Team
string - TeamID
integer - ThreePointersAttempted
number - ThreePointersMade
number - ThreePointersPercentage
number - TotalReboundsPercentage
number - TripleDoubles
number - TrueShootingAttempts
number - TrueShootingPercentage
number - TurnOversPercentage
number - Turnovers
number - TwoPointersAttempted
number - TwoPointersMade
number - TwoPointersPercentage
number - Updated
string - UsageRatePercentage
number - Wins
integer
- Assists
Player
- Player
object- BirthCity
string - BirthCountry
string - BirthDate
string - BirthState
string - College
string - DepthChartOrder
integer - DepthChartPosition
string - DraftKingsName
string - DraftKingsPlayerID
integer - Experience
integer - FanDuelName
string - FanDuelPlayerID
integer - FantasyAlarmPlayerID
integer - FantasyDraftName
string - FantasyDraftPlayerID
integer - FirstName
string - GlobalTeamID
integer - Height
integer - HighSchool
string - InjuryBodyPart
string - InjuryNotes
string - InjuryStartDate
string - InjuryStatus
string - Jersey
integer - LastName
string - NbaDotComPlayerID
integer - PhotoUrl
string - PlayerID
integer - Position
string - PositionCategory
string - RotoWirePlayerID
integer - RotoworldPlayerID
integer - Salary
integer - SportRadarPlayerID
string - SportsDataID
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
PlayerGame
- PlayerGame
object- Assists
number - AssistsPercentage
number - BlockedShots
number - BlocksPercentage
number - DateTime
string - Day
string - DefensiveRebounds
number - DefensiveReboundsPercentage
number - DoubleDoubles
number - DraftKingsPosition
string - DraftKingsSalary
integer - EffectiveFieldGoalsPercentage
number - FanDuelPosition
string - FanDuelSalary
integer - FantasyDataSalary
integer - FantasyDraftPosition
string - FantasyDraftSalary
integer - FantasyPoints
number - FantasyPointsDraftKings
number - FantasyPointsFanDuel
number - FantasyPointsFantasyDraft
number - FantasyPointsYahoo
number - FieldGoalsAttempted
number - FieldGoalsMade
number - FieldGoalsPercentage
number - FreeThrowsAttempted
number - FreeThrowsMade
number - FreeThrowsPercentage
number - GameID
integer - Games
integer - GlobalGameID
integer - GlobalOpponentID
integer - GlobalTeamID
integer - HomeOrAway
string - InjuryBodyPart
string - InjuryNotes
string - InjuryStartDate
string - InjuryStatus
string - IsClosed
boolean - IsGameOver
boolean - LineupConfirmed
boolean - LineupStatus
string - Minutes
integer - Name
string - OffensiveRebounds
number - OffensiveReboundsPercentage
number - Opponent
string - OpponentID
integer - OpponentPositionRank
integer - OpponentRank
integer - PersonalFouls
number - PlayerEfficiencyRating
number - PlayerID
integer - PlusMinus
number - Points
number - Position
string - Rebounds
number - Season
integer - SeasonType
integer - Seconds
integer - Started
integer - StatID
integer - Steals
number - StealsPercentage
number - Team
string - TeamID
integer - ThreePointersAttempted
number - ThreePointersMade
number - ThreePointersPercentage
number - TotalReboundsPercentage
number - TripleDoubles
number - TrueShootingAttempts
number - TrueShootingPercentage
number - TurnOversPercentage
number - Turnovers
number - TwoPointersAttempted
number - TwoPointersMade
number - TwoPointersPercentage
number - Updated
string - UsageRatePercentage
number - YahooPosition
string - YahooSalary
integer
- Assists
PlayerInfo
- PlayerInfo
object- Name
string - PlayerID
integer - Position
string - Team
string - TeamID
integer
- Name
PlayerSeason
- PlayerSeason
object- Assists
number - AssistsPercentage
number - BlockedShots
number - BlocksPercentage
number - DefensiveRebounds
number - DefensiveReboundsPercentage
number - DoubleDoubles
number - EffectiveFieldGoalsPercentage
number - FantasyPoints
number - FantasyPointsDraftKings
number - FantasyPointsFanDuel
number - FantasyPointsFantasyDraft
number - FantasyPointsYahoo
number - FieldGoalsAttempted
number - FieldGoalsMade
number - FieldGoalsPercentage
number - FreeThrowsAttempted
number - FreeThrowsMade
number - FreeThrowsPercentage
number - Games
integer - GlobalTeamID
integer - IsClosed
boolean - LineupConfirmed
boolean - LineupStatus
string - Minutes
integer - Name
string - OffensiveRebounds
number - OffensiveReboundsPercentage
number - PersonalFouls
number - PlayerEfficiencyRating
number - PlayerID
integer - PlusMinus
number - Points
number - Position
string - Rebounds
number - Season
integer - SeasonType
integer - Seconds
integer - Started
integer - StatID
integer - Steals
number - StealsPercentage
number - Team
string - TeamID
integer - ThreePointersAttempted
number - ThreePointersMade
number - ThreePointersPercentage
number - TotalReboundsPercentage
number - TripleDoubles
number - TrueShootingAttempts
number - TrueShootingPercentage
number - TurnOversPercentage
number - Turnovers
number - TwoPointersAttempted
number - TwoPointersMade
number - TwoPointersPercentage
number - Updated
string - UsageRatePercentage
number
- Assists
Quarter
- Quarter
object- AwayScore
integer - GameID
integer - HomeScore
integer - Name
string - Number
integer - QuarterID
integer
- AwayScore
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- AwayLosses
integer - AwayWins
integer - City
string - Conference
string - ConferenceLosses
integer - ConferenceRank
integer - ConferenceWins
integer - Division
string - DivisionLosses
integer - DivisionRank
integer - DivisionWins
integer - GamesBack
number - GlobalTeamID
integer - HomeLosses
integer - HomeWins
integer - Key
string - LastTenLosses
integer - LastTenWins
integer - Losses
integer - Name
string - Percentage
number - PointsPerGameAgainst
number - PointsPerGameFor
number - Season
integer - SeasonType
integer - Streak
integer - StreakDescription
string - TeamID
integer - Wins
integer
- AwayLosses
Team
- Team
object- Active
boolean - City
string - Conference
string - Division
string - GlobalTeamID
integer - LeagueID
integer - Name
string - NbaDotComTeamID
integer - PrimaryColor
string - QuaternaryColor
string - SecondaryColor
string - StadiumID
integer - TeamID
integer - TertiaryColor
string - WikipediaLogoUrl
string - WikipediaWordMarkUrl
string - Key
string
- Active
TeamGame
- TeamGame
object- Assists
number - AssistsPercentage
number - BlockedShots
number - BlocksPercentage
number - DateTime
string - Day
string - DefensiveRebounds
number - DefensiveReboundsPercentage
number - DoubleDoubles
number - EffectiveFieldGoalsPercentage
number - FantasyPoints
number - FantasyPointsDraftKings
number - FantasyPointsFanDuel
number - FantasyPointsFantasyDraft
number - FantasyPointsYahoo
number - FieldGoalsAttempted
number - FieldGoalsMade
number - FieldGoalsPercentage
number - FreeThrowsAttempted
number - FreeThrowsMade
number - FreeThrowsPercentage
number - GameID
integer - Games
integer - GlobalGameID
integer - GlobalOpponentID
integer - GlobalTeamID
integer - HomeOrAway
string - IsClosed
boolean - IsGameOver
boolean - LineupConfirmed
boolean - LineupStatus
string - Losses
integer - Minutes
integer - Name
string - OffensiveRebounds
number - OffensiveReboundsPercentage
number - Opponent
string - OpponentID
integer - PersonalFouls
number - PlayerEfficiencyRating
number - PlusMinus
number - Points
number - Possessions
number - Rebounds
number - Season
integer - SeasonType
integer - Seconds
integer - StatID
integer - Steals
number - StealsPercentage
number - Team
string - TeamID
integer - ThreePointersAttempted
number - ThreePointersMade
number - ThreePointersPercentage
number - TotalReboundsPercentage
number - TripleDoubles
number - TrueShootingAttempts
number - TrueShootingPercentage
number - TurnOversPercentage
number - Turnovers
number - TwoPointersAttempted
number - TwoPointersMade
number - TwoPointersPercentage
number - Updated
string - UsageRatePercentage
number - Wins
integer
- Assists
TeamSeason
- TeamSeason
object- Assists
number - AssistsPercentage
number - BlockedShots
number - BlocksPercentage
number - DefensiveRebounds
number - DefensiveReboundsPercentage
number - DoubleDoubles
number - EffectiveFieldGoalsPercentage
number - FantasyPoints
number - FantasyPointsDraftKings
number - FantasyPointsFanDuel
number - FantasyPointsFantasyDraft
number - FantasyPointsYahoo
number - FieldGoalsAttempted
number - FieldGoalsMade
number - FieldGoalsPercentage
number - FreeThrowsAttempted
number - FreeThrowsMade
number - FreeThrowsPercentage
number - Games
integer - GlobalTeamID
integer - IsClosed
boolean - LineupConfirmed
boolean - LineupStatus
string - Losses
integer - Minutes
integer - Name
string - OffensiveRebounds
number - OffensiveReboundsPercentage
number - OpponentPosition
string - OpponentStat OpponentSeason
- PersonalFouls
number - PlayerEfficiencyRating
number - PlusMinus
number - Points
number - Possessions
number - Rebounds
number - Season
integer - SeasonType
integer - Seconds
integer - StatID
integer - Steals
number - StealsPercentage
number - Team
string - TeamID
integer - ThreePointersAttempted
number - ThreePointersMade
number - ThreePointersPercentage
number - TotalReboundsPercentage
number - TripleDoubles
number - TrueShootingAttempts
number - TrueShootingPercentage
number - TurnOversPercentage
number - Turnovers
number - TwoPointersAttempted
number - TwoPointersMade
number - TwoPointersPercentage
number - Updated
string - UsageRatePercentage
number - Wins
integer
- Assists
3.0.0
5 years ago