nba-api-ts
Preparing search index...
stats
StatsClient
Class StatsClient
Index
Constructors
constructor
Methods
all
Time
Leaders
Grids
assist
Leaders
assist
Tracker
box
Score
Advanced
V2
box
Score
Advanced
V3
box
Score
Defensive
V2
box
Score
Four
Factors
V2
box
Score
Four
Factors
V3
box
Score
Hustle
V2
box
Score
Matchups
V3
box
Score
Misc
V2
box
Score
Misc
V3
box
Score
Player
Track
V3
box
Score
Scoring
V2
box
Score
Scoring
V3
box
Score
Summary
V2
box
Score
Summary
V3
box
Score
Traditional
V2
box
Score
Traditional
V3
box
Score
Usage
V2
box
Score
Usage
V3
common
All
Players
common
Player
Info
common
Playoff
Series
common
Team
Roster
common
Team
Years
cume
Stats
Player
cume
Stats
Player
Games
cume
Stats
Team
cume
Stats
Team
Games
defense
Hub
draft
Board
draft
Combine
Drill
Results
draft
Combine
Non
Stationary
Shooting
draft
Combine
Player
Anthro
draft
Combine
Spot
Shooting
draft
Combine
Stats
draft
History
dunk
Score
Leaders
fantasy
Widget
franchise
History
franchise
Leaders
franchise
Players
game
Rotation
g
L
Alum
Box
Score
Similarity
Score
home
Page
Leaders
home
Page
V2
hustle
Stats
Box
Score
infographic
Fan
Duel
Player
i
ST
Standings
leaders
Tiles
league
Dash
Lineups
league
Dash
Opp
Pt
Shot
league
Dash
Player
Bio
Stats
league
Dash
Player
Clutch
league
Dash
Player
Pt
Shot
league
Dash
Player
Shot
Locations
league
Dash
Player
Stats
league
Dash
Pt
Defend
league
Dash
Pt
Stats
league
Dash
Pt
Team
Defend
league
Dash
Team
Clutch
league
Dash
Team
Pt
Shot
league
Dash
Team
Shot
Locations
league
Dash
Team
Stats
league
Game
Finder
league
Game
Log
league
Hustle
Stats
Player
league
Hustle
Stats
Team
league
Leaders
league
Lineup
Viz
league
Player
On
Details
league
Season
Matchups
league
Standings
league
Standings
V3
matchups
Rollup
play
By
Play
play
By
Play
V2
play
By
Play
V3
player
Awards
player
Career
By
College
player
Career
By
College
Rollup
player
Career
Stats
player
Compare
player
Dashboard
By
Clutch
player
Dashboard
By
Game
Splits
player
Dashboard
By
General
Splits
player
Dashboard
By
Last
N
Games
player
Dashboard
By
Shooting
Splits
player
Dashboard
By
Team
Performance
player
Dashboard
By
Year
Over
Year
player
Dash
Pt
Pass
player
Dash
Pt
Reb
player
Dash
Pt
Shot
Defend
player
Dash
Pt
Shots
player
Estimated
Metrics
player
Fantasy
Profile
Bar
Graph
player
Game
Log
player
Game
Logs
player
Game
Streak
Finder
player
Index
player
Next
N
Games
player
Profile
V2
player
Vs
Player
playoff
Picture
schedule
League
V2
schedule
League
V2
Int
scoreboard
V2
scoreboard
V3
shot
Chart
Detail
shot
Chart
League
Wide
shot
Chart
Lineup
Detail
synergy
Play
Types
team
And
Players
Vs
Players
team
Dashboard
By
General
Splits
team
Dashboard
By
Shooting
Splits
team
Dash
Lineups
team
Dash
Pt
Pass
team
Dash
Pt
Reb
team
Dash
Pt
Shots
team
Details
team
Estimated
Metrics
team
Game
Log
team
Game
Logs
team
Game
Streak
Finder
team
Historical
Leaders
team
Info
Common
team
Player
Dashboard
team
Player
On
Off
Details
team
Player
On
Off
Summary
team
Vs
Player
team
Year
By
Year
Stats
video
Details
video
Details
Asset
video
Events
video
Events
Asset
video
Status
win
Probability
PBP
Constructors
constructor
new
StatsClient
(
client
:
FetchClient
)
:
StatsClient
Parameters
client
:
FetchClient
Returns
StatsClient
Methods
all
Time
Leaders
Grids
allTimeLeadersGrids
(
params
:
AllTimeLeadersGridsParams
,
)
:
Promise
<
AllTimeLeadersGridsResponse
>
Parameters
params
:
AllTimeLeadersGridsParams
Returns
Promise
<
AllTimeLeadersGridsResponse
>
assist
Leaders
assistLeaders
(
params
:
AssistLeadersParams
)
:
Promise
<
AssistLeadersResponse
>
Parameters
params
:
AssistLeadersParams
Returns
Promise
<
AssistLeadersResponse
>
assist
Tracker
assistTracker
(
params
:
AssistTrackerParams
)
:
Promise
<
AssistTrackerResponse
>
Parameters
params
:
AssistTrackerParams
Returns
Promise
<
AssistTrackerResponse
>
box
Score
Advanced
V2
boxScoreAdvancedV2
(
params
:
BoxScoreAdvancedV2Params
,
)
:
Promise
<
BoxScoreAdvancedV2Response
>
Parameters
params
:
BoxScoreAdvancedV2Params
Returns
Promise
<
BoxScoreAdvancedV2Response
>
box
Score
Advanced
V3
boxScoreAdvancedV3
(
params
:
BoxScoreAdvancedV3Params
,
)
:
Promise
<
BoxScoreAdvancedV3Response
>
Parameters
params
:
BoxScoreAdvancedV3Params
Returns
Promise
<
BoxScoreAdvancedV3Response
>
box
Score
Defensive
V2
boxScoreDefensiveV2
(
params
:
BoxScoreDefensiveV2Params
,
)
:
Promise
<
BoxScoreDefensiveV2Response
>
Parameters
params
:
BoxScoreDefensiveV2Params
Returns
Promise
<
BoxScoreDefensiveV2Response
>
box
Score
Four
Factors
V2
boxScoreFourFactorsV2
(
params
:
BoxScoreFourFactorsV2Params
,
)
:
Promise
<
BoxScoreFourFactorsV2Response
>
Parameters
params
:
BoxScoreFourFactorsV2Params
Returns
Promise
<
BoxScoreFourFactorsV2Response
>
box
Score
Four
Factors
V3
boxScoreFourFactorsV3
(
params
:
BoxScoreFourFactorsV3Params
,
)
:
Promise
<
BoxScoreFourFactorsV3Response
>
Parameters
params
:
BoxScoreFourFactorsV3Params
Returns
Promise
<
BoxScoreFourFactorsV3Response
>
box
Score
Hustle
V2
boxScoreHustleV2
(
params
:
BoxScoreHustleV2Params
,
)
:
Promise
<
BoxScoreHustleV2Response
>
Parameters
params
:
BoxScoreHustleV2Params
Returns
Promise
<
BoxScoreHustleV2Response
>
box
Score
Matchups
V3
boxScoreMatchupsV3
(
params
:
BoxScoreMatchupsV3Params
,
)
:
Promise
<
BoxScoreMatchupsV3Response
>
Parameters
params
:
BoxScoreMatchupsV3Params
Returns
Promise
<
BoxScoreMatchupsV3Response
>
box
Score
Misc
V2
boxScoreMiscV2
(
params
:
BoxScoreMiscV2Params
)
:
Promise
<
BoxScoreMiscV2Response
>
Parameters
params
:
BoxScoreMiscV2Params
Returns
Promise
<
BoxScoreMiscV2Response
>
box
Score
Misc
V3
boxScoreMiscV3
(
params
:
BoxScoreMiscV3Params
)
:
Promise
<
BoxScoreMiscV3Response
>
Parameters
params
:
BoxScoreMiscV3Params
Returns
Promise
<
BoxScoreMiscV3Response
>
box
Score
Player
Track
V3
boxScorePlayerTrackV3
(
params
:
BoxScorePlayerTrackV3Params
,
)
:
Promise
<
BoxScorePlayerTrackV3Response
>
Parameters
params
:
BoxScorePlayerTrackV3Params
Returns
Promise
<
BoxScorePlayerTrackV3Response
>
box
Score
Scoring
V2
boxScoreScoringV2
(
params
:
BoxScoreScoringV2Params
,
)
:
Promise
<
BoxScoreScoringV2Response
>
Parameters
params
:
BoxScoreScoringV2Params
Returns
Promise
<
BoxScoreScoringV2Response
>
box
Score
Scoring
V3
boxScoreScoringV3
(
params
:
BoxScoreScoringV3Params
,
)
:
Promise
<
BoxScoreScoringV3Response
>
Parameters
params
:
BoxScoreScoringV3Params
Returns
Promise
<
BoxScoreScoringV3Response
>
box
Score
Summary
V2
boxScoreSummaryV2
(
params
:
BoxScoreSummaryV2Params
,
)
:
Promise
<
BoxScoreSummaryV2Response
>
Parameters
params
:
BoxScoreSummaryV2Params
Returns
Promise
<
BoxScoreSummaryV2Response
>
box
Score
Summary
V3
boxScoreSummaryV3
(
params
:
BoxScoreSummaryV3Params
,
)
:
Promise
<
BoxScoreSummaryV3Response
>
Parameters
params
:
BoxScoreSummaryV3Params
Returns
Promise
<
BoxScoreSummaryV3Response
>
box
Score
Traditional
V2
boxScoreTraditionalV2
(
params
:
BoxScoreTraditionalV2Params
,
)
:
Promise
<
BoxScoreTraditionalV2Response
>
Parameters
params
:
BoxScoreTraditionalV2Params
Returns
Promise
<
BoxScoreTraditionalV2Response
>
box
Score
Traditional
V3
boxScoreTraditionalV3
(
params
:
BoxScoreTraditionalV3Params
,
)
:
Promise
<
BoxScoreTraditionalV3Response
>
Parameters
params
:
BoxScoreTraditionalV3Params
Returns
Promise
<
BoxScoreTraditionalV3Response
>
box
Score
Usage
V2
boxScoreUsageV2
(
params
:
BoxScoreUsageV2Params
)
:
Promise
<
BoxScoreUsageV2Response
>
Parameters
params
:
BoxScoreUsageV2Params
Returns
Promise
<
BoxScoreUsageV2Response
>
box
Score
Usage
V3
boxScoreUsageV3
(
params
:
BoxScoreUsageV3Params
)
:
Promise
<
BoxScoreUsageV3Response
>
Parameters
params
:
BoxScoreUsageV3Params
Returns
Promise
<
BoxScoreUsageV3Response
>
common
All
Players
commonAllPlayers
(
params
:
CommonAllPlayersParams
,
)
:
Promise
<
CommonAllPlayersResponse
>
Parameters
params
:
CommonAllPlayersParams
Returns
Promise
<
CommonAllPlayersResponse
>
common
Player
Info
commonPlayerInfo
(
params
:
CommonPlayerInfoParams
,
)
:
Promise
<
CommonPlayerInfoResponse
>
Parameters
params
:
CommonPlayerInfoParams
Returns
Promise
<
CommonPlayerInfoResponse
>
common
Playoff
Series
commonPlayoffSeries
(
params
:
CommonPlayoffSeriesParams
,
)
:
Promise
<
CommonPlayoffSeriesResponse
>
Parameters
params
:
CommonPlayoffSeriesParams
Returns
Promise
<
CommonPlayoffSeriesResponse
>
common
Team
Roster
commonTeamRoster
(
params
:
CommonTeamRosterParams
,
)
:
Promise
<
CommonTeamRosterResponse
>
Parameters
params
:
CommonTeamRosterParams
Returns
Promise
<
CommonTeamRosterResponse
>
common
Team
Years
commonTeamYears
(
params
:
CommonTeamYearsParams
)
:
Promise
<
CommonTeamYearsResponse
>
Parameters
params
:
CommonTeamYearsParams
Returns
Promise
<
CommonTeamYearsResponse
>
cume
Stats
Player
cumeStatsPlayer
(
params
:
CumeStatsPlayerParams
)
:
Promise
<
CumeStatsPlayerResponse
>
Parameters
params
:
CumeStatsPlayerParams
Returns
Promise
<
CumeStatsPlayerResponse
>
cume
Stats
Player
Games
cumeStatsPlayerGames
(
params
:
CumeStatsPlayerGamesParams
,
)
:
Promise
<
CumeStatsPlayerGamesResponse
>
Parameters
params
:
CumeStatsPlayerGamesParams
Returns
Promise
<
CumeStatsPlayerGamesResponse
>
cume
Stats
Team
cumeStatsTeam
(
params
:
CumeStatsTeamParams
)
:
Promise
<
CumeStatsTeamResponse
>
Parameters
params
:
CumeStatsTeamParams
Returns
Promise
<
CumeStatsTeamResponse
>
cume
Stats
Team
Games
cumeStatsTeamGames
(
params
:
CumeStatsTeamGamesParams
,
)
:
Promise
<
CumeStatsTeamGamesResponse
>
Parameters
params
:
CumeStatsTeamGamesParams
Returns
Promise
<
CumeStatsTeamGamesResponse
>
defense
Hub
defenseHub
(
params
:
DefenseHubParams
)
:
Promise
<
DefenseHubResponse
>
Parameters
params
:
DefenseHubParams
Returns
Promise
<
DefenseHubResponse
>
draft
Board
draftBoard
(
params
:
DraftBoardParams
)
:
Promise
<
DraftBoardResponse
>
Parameters
params
:
DraftBoardParams
Returns
Promise
<
DraftBoardResponse
>
draft
Combine
Drill
Results
draftCombineDrillResults
(
params
:
DraftCombineDrillResultsParams
,
)
:
Promise
<
DraftCombineDrillResultsResponse
>
Parameters
params
:
DraftCombineDrillResultsParams
Returns
Promise
<
DraftCombineDrillResultsResponse
>
draft
Combine
Non
Stationary
Shooting
draftCombineNonStationaryShooting
(
params
:
DraftCombineNonStationaryShootingParams
,
)
:
Promise
<
DraftCombineNonStationaryShootingResponse
>
Parameters
params
:
DraftCombineNonStationaryShootingParams
Returns
Promise
<
DraftCombineNonStationaryShootingResponse
>
draft
Combine
Player
Anthro
draftCombinePlayerAnthro
(
params
:
DraftCombinePlayerAnthroParams
,
)
:
Promise
<
DraftCombinePlayerAnthroResponse
>
Parameters
params
:
DraftCombinePlayerAnthroParams
Returns
Promise
<
DraftCombinePlayerAnthroResponse
>
draft
Combine
Spot
Shooting
draftCombineSpotShooting
(
params
:
DraftCombineSpotShootingParams
,
)
:
Promise
<
DraftCombineSpotShootingResponse
>
Parameters
params
:
DraftCombineSpotShootingParams
Returns
Promise
<
DraftCombineSpotShootingResponse
>
draft
Combine
Stats
draftCombineStats
(
params
:
DraftCombineStatsParams
,
)
:
Promise
<
DraftCombineStatsResponse
>
Parameters
params
:
DraftCombineStatsParams
Returns
Promise
<
DraftCombineStatsResponse
>
draft
History
draftHistory
(
params
:
DraftHistoryParams
)
:
Promise
<
DraftHistoryResponse
>
Parameters
params
:
DraftHistoryParams
Returns
Promise
<
DraftHistoryResponse
>
dunk
Score
Leaders
dunkScoreLeaders
(
params
:
DunkScoreLeadersParams
,
)
:
Promise
<
DunkScoreLeadersResponse
>
Parameters
params
:
DunkScoreLeadersParams
Returns
Promise
<
DunkScoreLeadersResponse
>
fantasy
Widget
fantasyWidget
(
params
:
FantasyWidgetParams
)
:
Promise
<
FantasyWidgetResponse
>
Parameters
params
:
FantasyWidgetParams
Returns
Promise
<
FantasyWidgetResponse
>
franchise
History
franchiseHistory
(
params
:
FranchiseHistoryParams
,
)
:
Promise
<
FranchiseHistoryResponse
>
Parameters
params
:
FranchiseHistoryParams
Returns
Promise
<
FranchiseHistoryResponse
>
franchise
Leaders
franchiseLeaders
(
params
:
FranchiseLeadersParams
,
)
:
Promise
<
FranchiseLeadersResponse
>
Parameters
params
:
FranchiseLeadersParams
Returns
Promise
<
FranchiseLeadersResponse
>
franchise
Players
franchisePlayers
(
params
:
FranchisePlayersParams
,
)
:
Promise
<
FranchisePlayersResponse
>
Parameters
params
:
FranchisePlayersParams
Returns
Promise
<
FranchisePlayersResponse
>
game
Rotation
gameRotation
(
params
:
GameRotationParams
)
:
Promise
<
GameRotationResponse
>
Parameters
params
:
GameRotationParams
Returns
Promise
<
GameRotationResponse
>
g
L
Alum
Box
Score
Similarity
Score
gLAlumBoxScoreSimilarityScore
(
params
:
GLAlumBoxScoreSimilarityScoreParams
,
)
:
Promise
<
GLAlumBoxScoreSimilarityScoreResponse
>
Parameters
params
:
GLAlumBoxScoreSimilarityScoreParams
Returns
Promise
<
GLAlumBoxScoreSimilarityScoreResponse
>
home
Page
Leaders
homePageLeaders
(
params
:
HomePageLeadersParams
)
:
Promise
<
HomePageLeadersResponse
>
Parameters
params
:
HomePageLeadersParams
Returns
Promise
<
HomePageLeadersResponse
>
home
Page
V2
homePageV2
(
params
:
HomePageV2Params
)
:
Promise
<
HomePageV2Response
>
Parameters
params
:
HomePageV2Params
Returns
Promise
<
HomePageV2Response
>
hustle
Stats
Box
Score
hustleStatsBoxScore
(
params
:
HustleStatsBoxScoreParams
,
)
:
Promise
<
HustleStatsBoxScoreResponse
>
Parameters
params
:
HustleStatsBoxScoreParams
Returns
Promise
<
HustleStatsBoxScoreResponse
>
infographic
Fan
Duel
Player
infographicFanDuelPlayer
(
params
:
InfographicFanDuelPlayerParams
,
)
:
Promise
<
InfographicFanDuelPlayerResponse
>
Parameters
params
:
InfographicFanDuelPlayerParams
Returns
Promise
<
InfographicFanDuelPlayerResponse
>
i
ST
Standings
iSTStandings
(
params
:
ISTStandingsParams
)
:
Promise
<
ISTStandingsResponse
>
Parameters
params
:
ISTStandingsParams
Returns
Promise
<
ISTStandingsResponse
>
leaders
Tiles
leadersTiles
(
params
:
LeadersTilesParams
)
:
Promise
<
LeadersTilesResponse
>
Parameters
params
:
LeadersTilesParams
Returns
Promise
<
LeadersTilesResponse
>
league
Dash
Lineups
leagueDashLineups
(
params
:
LeagueDashLineupsParams
,
)
:
Promise
<
LeagueDashLineupsResponse
>
Parameters
params
:
LeagueDashLineupsParams
Returns
Promise
<
LeagueDashLineupsResponse
>
league
Dash
Opp
Pt
Shot
leagueDashOppPtShot
(
params
:
LeagueDashOppPtShotParams
,
)
:
Promise
<
LeagueDashOppPtShotResponse
>
Parameters
params
:
LeagueDashOppPtShotParams
Returns
Promise
<
LeagueDashOppPtShotResponse
>
league
Dash
Player
Bio
Stats
leagueDashPlayerBioStats
(
params
:
LeagueDashPlayerBioStatsParams
,
)
:
Promise
<
LeagueDashPlayerBioStatsResponse
>
Parameters
params
:
LeagueDashPlayerBioStatsParams
Returns
Promise
<
LeagueDashPlayerBioStatsResponse
>
league
Dash
Player
Clutch
leagueDashPlayerClutch
(
params
:
LeagueDashPlayerClutchParams
,
)
:
Promise
<
LeagueDashPlayerClutchResponse
>
Parameters
params
:
LeagueDashPlayerClutchParams
Returns
Promise
<
LeagueDashPlayerClutchResponse
>
league
Dash
Player
Pt
Shot
leagueDashPlayerPtShot
(
params
:
LeagueDashPlayerPtShotParams
,
)
:
Promise
<
LeagueDashPlayerPtShotResponse
>
Parameters
params
:
LeagueDashPlayerPtShotParams
Returns
Promise
<
LeagueDashPlayerPtShotResponse
>
league
Dash
Player
Shot
Locations
leagueDashPlayerShotLocations
(
params
:
LeagueDashPlayerShotLocationsParams
,
)
:
Promise
<
LeagueDashPlayerShotLocationsResponse
>
Parameters
params
:
LeagueDashPlayerShotLocationsParams
Returns
Promise
<
LeagueDashPlayerShotLocationsResponse
>
league
Dash
Player
Stats
leagueDashPlayerStats
(
params
:
LeagueDashPlayerStatsParams
,
)
:
Promise
<
LeagueDashPlayerStatsResponse
>
Parameters
params
:
LeagueDashPlayerStatsParams
Returns
Promise
<
LeagueDashPlayerStatsResponse
>
league
Dash
Pt
Defend
leagueDashPtDefend
(
params
:
LeagueDashPtDefendParams
,
)
:
Promise
<
LeagueDashPtDefendResponse
>
Parameters
params
:
LeagueDashPtDefendParams
Returns
Promise
<
LeagueDashPtDefendResponse
>
league
Dash
Pt
Stats
leagueDashPtStats
(
params
:
LeagueDashPtStatsParams
,
)
:
Promise
<
LeagueDashPtStatsResponse
>
Parameters
params
:
LeagueDashPtStatsParams
Returns
Promise
<
LeagueDashPtStatsResponse
>
league
Dash
Pt
Team
Defend
leagueDashPtTeamDefend
(
params
:
LeagueDashPtTeamDefendParams
,
)
:
Promise
<
LeagueDashPtTeamDefendResponse
>
Parameters
params
:
LeagueDashPtTeamDefendParams
Returns
Promise
<
LeagueDashPtTeamDefendResponse
>
league
Dash
Team
Clutch
leagueDashTeamClutch
(
params
:
LeagueDashTeamClutchParams
,
)
:
Promise
<
LeagueDashTeamClutchResponse
>
Parameters
params
:
LeagueDashTeamClutchParams
Returns
Promise
<
LeagueDashTeamClutchResponse
>
league
Dash
Team
Pt
Shot
leagueDashTeamPtShot
(
params
:
LeagueDashTeamPtShotParams
,
)
:
Promise
<
LeagueDashTeamPtShotResponse
>
Parameters
params
:
LeagueDashTeamPtShotParams
Returns
Promise
<
LeagueDashTeamPtShotResponse
>
league
Dash
Team
Shot
Locations
leagueDashTeamShotLocations
(
params
:
LeagueDashTeamShotLocationsParams
,
)
:
Promise
<
LeagueDashTeamShotLocationsResponse
>
Parameters
params
:
LeagueDashTeamShotLocationsParams
Returns
Promise
<
LeagueDashTeamShotLocationsResponse
>
league
Dash
Team
Stats
leagueDashTeamStats
(
params
:
LeagueDashTeamStatsParams
,
)
:
Promise
<
LeagueDashTeamStatsResponse
>
Parameters
params
:
LeagueDashTeamStatsParams
Returns
Promise
<
LeagueDashTeamStatsResponse
>
league
Game
Finder
leagueGameFinder
(
params
:
LeagueGameFinderParams
,
)
:
Promise
<
LeagueGameFinderResponse
>
Parameters
params
:
LeagueGameFinderParams
Returns
Promise
<
LeagueGameFinderResponse
>
league
Game
Log
leagueGameLog
(
params
:
LeagueGameLogParams
)
:
Promise
<
LeagueGameLogResponse
>
Parameters
params
:
LeagueGameLogParams
Returns
Promise
<
LeagueGameLogResponse
>
league
Hustle
Stats
Player
leagueHustleStatsPlayer
(
params
:
LeagueHustleStatsPlayerParams
,
)
:
Promise
<
LeagueHustleStatsPlayerResponse
>
Parameters
params
:
LeagueHustleStatsPlayerParams
Returns
Promise
<
LeagueHustleStatsPlayerResponse
>
league
Hustle
Stats
Team
leagueHustleStatsTeam
(
params
:
LeagueHustleStatsTeamParams
,
)
:
Promise
<
LeagueHustleStatsTeamResponse
>
Parameters
params
:
LeagueHustleStatsTeamParams
Returns
Promise
<
LeagueHustleStatsTeamResponse
>
league
Leaders
leagueLeaders
(
params
:
LeagueLeadersParams
)
:
Promise
<
LeagueLeadersResponse
>
Parameters
params
:
LeagueLeadersParams
Returns
Promise
<
LeagueLeadersResponse
>
league
Lineup
Viz
leagueLineupViz
(
params
:
LeagueLineupVizParams
)
:
Promise
<
LeagueLineupVizResponse
>
Parameters
params
:
LeagueLineupVizParams
Returns
Promise
<
LeagueLineupVizResponse
>
league
Player
On
Details
leaguePlayerOnDetails
(
params
:
LeaguePlayerOnDetailsParams
,
)
:
Promise
<
LeaguePlayerOnDetailsResponse
>
Parameters
params
:
LeaguePlayerOnDetailsParams
Returns
Promise
<
LeaguePlayerOnDetailsResponse
>
league
Season
Matchups
leagueSeasonMatchups
(
params
:
LeagueSeasonMatchupsParams
,
)
:
Promise
<
LeagueSeasonMatchupsResponse
>
Parameters
params
:
LeagueSeasonMatchupsParams
Returns
Promise
<
LeagueSeasonMatchupsResponse
>
league
Standings
leagueStandings
(
params
:
LeagueStandingsParams
)
:
Promise
<
LeagueStandingsResponse
>
Parameters
params
:
LeagueStandingsParams
Returns
Promise
<
LeagueStandingsResponse
>
league
Standings
V3
leagueStandingsV3
(
params
:
LeagueStandingsV3Params
,
)
:
Promise
<
LeagueStandingsV3Response
>
Parameters
params
:
LeagueStandingsV3Params
Returns
Promise
<
LeagueStandingsV3Response
>
matchups
Rollup
matchupsRollup
(
params
:
MatchupsRollupParams
)
:
Promise
<
MatchupsRollupResponse
>
Parameters
params
:
MatchupsRollupParams
Returns
Promise
<
MatchupsRollupResponse
>
play
By
Play
playByPlay
(
params
:
PlayByPlayParams
)
:
Promise
<
PlayByPlayResponse
>
Parameters
params
:
PlayByPlayParams
Returns
Promise
<
PlayByPlayResponse
>
play
By
Play
V2
playByPlayV2
(
params
:
PlayByPlayV2Params
)
:
Promise
<
PlayByPlayV2Response
>
Parameters
params
:
PlayByPlayV2Params
Returns
Promise
<
PlayByPlayV2Response
>
play
By
Play
V3
playByPlayV3
(
params
:
PlayByPlayV3Params
)
:
Promise
<
PlayByPlayV3Response
>
Parameters
params
:
PlayByPlayV3Params
Returns
Promise
<
PlayByPlayV3Response
>
player
Awards
playerAwards
(
params
:
PlayerAwardsParams
)
:
Promise
<
PlayerAwardsResponse
>
Parameters
params
:
PlayerAwardsParams
Returns
Promise
<
PlayerAwardsResponse
>
player
Career
By
College
playerCareerByCollege
(
params
:
PlayerCareerByCollegeParams
,
)
:
Promise
<
PlayerCareerByCollegeResponse
>
Parameters
params
:
PlayerCareerByCollegeParams
Returns
Promise
<
PlayerCareerByCollegeResponse
>
player
Career
By
College
Rollup
playerCareerByCollegeRollup
(
params
:
PlayerCareerByCollegeRollupParams
,
)
:
Promise
<
PlayerCareerByCollegeRollupResponse
>
Parameters
params
:
PlayerCareerByCollegeRollupParams
Returns
Promise
<
PlayerCareerByCollegeRollupResponse
>
player
Career
Stats
playerCareerStats
(
params
:
PlayerCareerStatsParams
,
)
:
Promise
<
PlayerCareerStatsResponse
>
Parameters
params
:
PlayerCareerStatsParams
Returns
Promise
<
PlayerCareerStatsResponse
>
player
Compare
playerCompare
(
params
:
PlayerCompareParams
)
:
Promise
<
PlayerCompareResponse
>
Parameters
params
:
PlayerCompareParams
Returns
Promise
<
PlayerCompareResponse
>
player
Dashboard
By
Clutch
playerDashboardByClutch
(
params
:
PlayerDashboardByClutchParams
,
)
:
Promise
<
PlayerDashboardByClutchResponse
>
Parameters
params
:
PlayerDashboardByClutchParams
Returns
Promise
<
PlayerDashboardByClutchResponse
>
player
Dashboard
By
Game
Splits
playerDashboardByGameSplits
(
params
:
PlayerDashboardByGameSplitsParams
,
)
:
Promise
<
PlayerDashboardByGameSplitsResponse
>
Parameters
params
:
PlayerDashboardByGameSplitsParams
Returns
Promise
<
PlayerDashboardByGameSplitsResponse
>
player
Dashboard
By
General
Splits
playerDashboardByGeneralSplits
(
params
:
PlayerDashboardByGeneralSplitsParams
,
)
:
Promise
<
PlayerDashboardByGeneralSplitsResponse
>
Parameters
params
:
PlayerDashboardByGeneralSplitsParams
Returns
Promise
<
PlayerDashboardByGeneralSplitsResponse
>
player
Dashboard
By
Last
N
Games
playerDashboardByLastNGames
(
params
:
PlayerDashboardByLastNGamesParams
,
)
:
Promise
<
PlayerDashboardByLastNGamesResponse
>
Parameters
params
:
PlayerDashboardByLastNGamesParams
Returns
Promise
<
PlayerDashboardByLastNGamesResponse
>
player
Dashboard
By
Shooting
Splits
playerDashboardByShootingSplits
(
params
:
PlayerDashboardByShootingSplitsParams
,
)
:
Promise
<
PlayerDashboardByShootingSplitsResponse
>
Parameters
params
:
PlayerDashboardByShootingSplitsParams
Returns
Promise
<
PlayerDashboardByShootingSplitsResponse
>
player
Dashboard
By
Team
Performance
playerDashboardByTeamPerformance
(
params
:
PlayerDashboardByTeamPerformanceParams
,
)
:
Promise
<
PlayerDashboardByTeamPerformanceResponse
>
Parameters
params
:
PlayerDashboardByTeamPerformanceParams
Returns
Promise
<
PlayerDashboardByTeamPerformanceResponse
>
player
Dashboard
By
Year
Over
Year
playerDashboardByYearOverYear
(
params
:
PlayerDashboardByYearOverYearParams
,
)
:
Promise
<
PlayerDashboardByYearOverYearResponse
>
Parameters
params
:
PlayerDashboardByYearOverYearParams
Returns
Promise
<
PlayerDashboardByYearOverYearResponse
>
player
Dash
Pt
Pass
playerDashPtPass
(
params
:
PlayerDashPtPassParams
,
)
:
Promise
<
PlayerDashPtPassResponse
>
Parameters
params
:
PlayerDashPtPassParams
Returns
Promise
<
PlayerDashPtPassResponse
>
player
Dash
Pt
Reb
playerDashPtReb
(
params
:
PlayerDashPtRebParams
)
:
Promise
<
PlayerDashPtRebResponse
>
Parameters
params
:
PlayerDashPtRebParams
Returns
Promise
<
PlayerDashPtRebResponse
>
player
Dash
Pt
Shot
Defend
playerDashPtShotDefend
(
params
:
PlayerDashPtShotDefendParams
,
)
:
Promise
<
PlayerDashPtShotDefendResponse
>
Parameters
params
:
PlayerDashPtShotDefendParams
Returns
Promise
<
PlayerDashPtShotDefendResponse
>
player
Dash
Pt
Shots
playerDashPtShots
(
params
:
PlayerDashPtShotsParams
,
)
:
Promise
<
PlayerDashPtShotsResponse
>
Parameters
params
:
PlayerDashPtShotsParams
Returns
Promise
<
PlayerDashPtShotsResponse
>
player
Estimated
Metrics
playerEstimatedMetrics
(
params
:
PlayerEstimatedMetricsParams
,
)
:
Promise
<
PlayerEstimatedMetricsResponse
>
Parameters
params
:
PlayerEstimatedMetricsParams
Returns
Promise
<
PlayerEstimatedMetricsResponse
>
player
Fantasy
Profile
Bar
Graph
playerFantasyProfileBarGraph
(
params
:
PlayerFantasyProfileBarGraphParams
,
)
:
Promise
<
PlayerFantasyProfileBarGraphResponse
>
Parameters
params
:
PlayerFantasyProfileBarGraphParams
Returns
Promise
<
PlayerFantasyProfileBarGraphResponse
>
player
Game
Log
playerGameLog
(
params
:
PlayerGameLogParams
)
:
Promise
<
PlayerGameLogResponse
>
Parameters
params
:
PlayerGameLogParams
Returns
Promise
<
PlayerGameLogResponse
>
player
Game
Logs
playerGameLogs
(
params
:
PlayerGameLogsParams
)
:
Promise
<
PlayerGameLogsResponse
>
Parameters
params
:
PlayerGameLogsParams
Returns
Promise
<
PlayerGameLogsResponse
>
player
Game
Streak
Finder
playerGameStreakFinder
(
params
:
PlayerGameStreakFinderParams
,
)
:
Promise
<
PlayerGameStreakFinderResponse
>
Parameters
params
:
PlayerGameStreakFinderParams
Returns
Promise
<
PlayerGameStreakFinderResponse
>
player
Index
playerIndex
(
params
:
PlayerIndexParams
)
:
Promise
<
PlayerIndexResponse
>
Parameters
params
:
PlayerIndexParams
Returns
Promise
<
PlayerIndexResponse
>
player
Next
N
Games
playerNextNGames
(
params
:
PlayerNextNGamesParams
,
)
:
Promise
<
PlayerNextNGamesResponse
>
Parameters
params
:
PlayerNextNGamesParams
Returns
Promise
<
PlayerNextNGamesResponse
>
player
Profile
V2
playerProfileV2
(
params
:
PlayerProfileV2Params
)
:
Promise
<
PlayerProfileV2Response
>
Parameters
params
:
PlayerProfileV2Params
Returns
Promise
<
PlayerProfileV2Response
>
player
Vs
Player
playerVsPlayer
(
params
:
PlayerVsPlayerParams
)
:
Promise
<
PlayerVsPlayerResponse
>
Parameters
params
:
PlayerVsPlayerParams
Returns
Promise
<
PlayerVsPlayerResponse
>
playoff
Picture
playoffPicture
(
params
:
PlayoffPictureParams
)
:
Promise
<
PlayoffPictureResponse
>
Parameters
params
:
PlayoffPictureParams
Returns
Promise
<
PlayoffPictureResponse
>
schedule
League
V2
scheduleLeagueV2
(
params
:
ScheduleLeagueV2Params
,
)
:
Promise
<
ScheduleLeagueV2Response
>
Parameters
params
:
ScheduleLeagueV2Params
Returns
Promise
<
ScheduleLeagueV2Response
>
schedule
League
V2
Int
scheduleLeagueV2Int
(
params
:
ScheduleLeagueV2IntParams
,
)
:
Promise
<
ScheduleLeagueV2IntResponse
>
Parameters
params
:
ScheduleLeagueV2IntParams
Returns
Promise
<
ScheduleLeagueV2IntResponse
>
scoreboard
V2
scoreboardV2
(
params
:
ScoreboardV2Params
)
:
Promise
<
ScoreboardV2Response
>
Parameters
params
:
ScoreboardV2Params
Returns
Promise
<
ScoreboardV2Response
>
scoreboard
V3
scoreboardV3
(
params
:
ScoreboardV3Params
)
:
Promise
<
ScoreboardV3Response
>
Parameters
params
:
ScoreboardV3Params
Returns
Promise
<
ScoreboardV3Response
>
shot
Chart
Detail
shotChartDetail
(
params
:
ShotChartDetailParams
)
:
Promise
<
ShotChartDetailResponse
>
Parameters
params
:
ShotChartDetailParams
Returns
Promise
<
ShotChartDetailResponse
>
shot
Chart
League
Wide
shotChartLeagueWide
(
params
:
ShotChartLeagueWideParams
,
)
:
Promise
<
ShotChartLeagueWideResponse
>
Parameters
params
:
ShotChartLeagueWideParams
Returns
Promise
<
ShotChartLeagueWideResponse
>
shot
Chart
Lineup
Detail
shotChartLineupDetail
(
params
:
ShotChartLineupDetailParams
,
)
:
Promise
<
ShotChartLineupDetailResponse
>
Parameters
params
:
ShotChartLineupDetailParams
Returns
Promise
<
ShotChartLineupDetailResponse
>
synergy
Play
Types
synergyPlayTypes
(
params
:
SynergyPlayTypesParams
,
)
:
Promise
<
SynergyPlayTypesResponse
>
Parameters
params
:
SynergyPlayTypesParams
Returns
Promise
<
SynergyPlayTypesResponse
>
team
And
Players
Vs
Players
teamAndPlayersVsPlayers
(
params
:
TeamAndPlayersVsPlayersParams
,
)
:
Promise
<
TeamAndPlayersVsPlayersResponse
>
Parameters
params
:
TeamAndPlayersVsPlayersParams
Returns
Promise
<
TeamAndPlayersVsPlayersResponse
>
team
Dashboard
By
General
Splits
teamDashboardByGeneralSplits
(
params
:
TeamDashboardByGeneralSplitsParams
,
)
:
Promise
<
TeamDashboardByGeneralSplitsResponse
>
Parameters
params
:
TeamDashboardByGeneralSplitsParams
Returns
Promise
<
TeamDashboardByGeneralSplitsResponse
>
team
Dashboard
By
Shooting
Splits
teamDashboardByShootingSplits
(
params
:
TeamDashboardByShootingSplitsParams
,
)
:
Promise
<
TeamDashboardByShootingSplitsResponse
>
Parameters
params
:
TeamDashboardByShootingSplitsParams
Returns
Promise
<
TeamDashboardByShootingSplitsResponse
>
team
Dash
Lineups
teamDashLineups
(
params
:
TeamDashLineupsParams
)
:
Promise
<
TeamDashLineupsResponse
>
Parameters
params
:
TeamDashLineupsParams
Returns
Promise
<
TeamDashLineupsResponse
>
team
Dash
Pt
Pass
teamDashPtPass
(
params
:
TeamDashPtPassParams
)
:
Promise
<
TeamDashPtPassResponse
>
Parameters
params
:
TeamDashPtPassParams
Returns
Promise
<
TeamDashPtPassResponse
>
team
Dash
Pt
Reb
teamDashPtReb
(
params
:
TeamDashPtRebParams
)
:
Promise
<
TeamDashPtRebResponse
>
Parameters
params
:
TeamDashPtRebParams
Returns
Promise
<
TeamDashPtRebResponse
>
team
Dash
Pt
Shots
teamDashPtShots
(
params
:
TeamDashPtShotsParams
)
:
Promise
<
TeamDashPtShotsResponse
>
Parameters
params
:
TeamDashPtShotsParams
Returns
Promise
<
TeamDashPtShotsResponse
>
team
Details
teamDetails
(
params
:
TeamDetailsParams
)
:
Promise
<
TeamDetailsResponse
>
Parameters
params
:
TeamDetailsParams
Returns
Promise
<
TeamDetailsResponse
>
team
Estimated
Metrics
teamEstimatedMetrics
(
params
:
TeamEstimatedMetricsParams
,
)
:
Promise
<
TeamEstimatedMetricsResponse
>
Parameters
params
:
TeamEstimatedMetricsParams
Returns
Promise
<
TeamEstimatedMetricsResponse
>
team
Game
Log
teamGameLog
(
params
:
TeamGameLogParams
)
:
Promise
<
TeamGameLogResponse
>
Parameters
params
:
TeamGameLogParams
Returns
Promise
<
TeamGameLogResponse
>
team
Game
Logs
teamGameLogs
(
params
:
TeamGameLogsParams
)
:
Promise
<
TeamGameLogsResponse
>
Parameters
params
:
TeamGameLogsParams
Returns
Promise
<
TeamGameLogsResponse
>
team
Game
Streak
Finder
teamGameStreakFinder
(
params
:
TeamGameStreakFinderParams
,
)
:
Promise
<
TeamGameStreakFinderResponse
>
Parameters
params
:
TeamGameStreakFinderParams
Returns
Promise
<
TeamGameStreakFinderResponse
>
team
Historical
Leaders
teamHistoricalLeaders
(
params
:
TeamHistoricalLeadersParams
,
)
:
Promise
<
TeamHistoricalLeadersResponse
>
Parameters
params
:
TeamHistoricalLeadersParams
Returns
Promise
<
TeamHistoricalLeadersResponse
>
team
Info
Common
teamInfoCommon
(
params
:
TeamInfoCommonParams
)
:
Promise
<
TeamInfoCommonResponse
>
Parameters
params
:
TeamInfoCommonParams
Returns
Promise
<
TeamInfoCommonResponse
>
team
Player
Dashboard
teamPlayerDashboard
(
params
:
TeamPlayerDashboardParams
,
)
:
Promise
<
TeamPlayerDashboardResponse
>
Parameters
params
:
TeamPlayerDashboardParams
Returns
Promise
<
TeamPlayerDashboardResponse
>
team
Player
On
Off
Details
teamPlayerOnOffDetails
(
params
:
TeamPlayerOnOffDetailsParams
,
)
:
Promise
<
TeamPlayerOnOffDetailsResponse
>
Parameters
params
:
TeamPlayerOnOffDetailsParams
Returns
Promise
<
TeamPlayerOnOffDetailsResponse
>
team
Player
On
Off
Summary
teamPlayerOnOffSummary
(
params
:
TeamPlayerOnOffSummaryParams
,
)
:
Promise
<
TeamPlayerOnOffSummaryResponse
>
Parameters
params
:
TeamPlayerOnOffSummaryParams
Returns
Promise
<
TeamPlayerOnOffSummaryResponse
>
team
Vs
Player
teamVsPlayer
(
params
:
TeamVsPlayerParams
)
:
Promise
<
TeamVsPlayerResponse
>
Parameters
params
:
TeamVsPlayerParams
Returns
Promise
<
TeamVsPlayerResponse
>
team
Year
By
Year
Stats
teamYearByYearStats
(
params
:
TeamYearByYearStatsParams
,
)
:
Promise
<
TeamYearByYearStatsResponse
>
Parameters
params
:
TeamYearByYearStatsParams
Returns
Promise
<
TeamYearByYearStatsResponse
>
video
Details
videoDetails
(
params
:
VideoDetailsParams
)
:
Promise
<
VideoDetailsResponse
>
Parameters
params
:
VideoDetailsParams
Returns
Promise
<
VideoDetailsResponse
>
video
Details
Asset
videoDetailsAsset
(
params
:
VideoDetailsAssetParams
,
)
:
Promise
<
VideoDetailsAssetResponse
>
Parameters
params
:
VideoDetailsAssetParams
Returns
Promise
<
VideoDetailsAssetResponse
>
video
Events
videoEvents
(
params
:
VideoEventsParams
)
:
Promise
<
VideoEventsResponse
>
Parameters
params
:
VideoEventsParams
Returns
Promise
<
VideoEventsResponse
>
video
Events
Asset
videoEventsAsset
(
params
:
VideoEventsAssetParams
,
)
:
Promise
<
VideoEventsAssetResponse
>
Parameters
params
:
VideoEventsAssetParams
Returns
Promise
<
VideoEventsAssetResponse
>
video
Status
videoStatus
(
params
:
VideoStatusParams
)
:
Promise
<
VideoStatusResponse
>
Parameters
params
:
VideoStatusParams
Returns
Promise
<
VideoStatusResponse
>
win
Probability
PBP
winProbabilityPBP
(
params
:
WinProbabilityPBPParams
,
)
:
Promise
<
WinProbabilityPBPResponse
>
Parameters
params
:
WinProbabilityPBPParams
Returns
Promise
<
WinProbabilityPBPResponse
>
Settings
Member Visibility
Protected
Inherited
External
Theme
OS
Light
Dark
On This Page
Constructors
constructor
Methods
all
Time
Leaders
Grids
assist
Leaders
assist
Tracker
box
Score
Advanced
V2
box
Score
Advanced
V3
box
Score
Defensive
V2
box
Score
Four
Factors
V2
box
Score
Four
Factors
V3
box
Score
Hustle
V2
box
Score
Matchups
V3
box
Score
Misc
V2
box
Score
Misc
V3
box
Score
Player
Track
V3
box
Score
Scoring
V2
box
Score
Scoring
V3
box
Score
Summary
V2
box
Score
Summary
V3
box
Score
Traditional
V2
box
Score
Traditional
V3
box
Score
Usage
V2
box
Score
Usage
V3
common
All
Players
common
Player
Info
common
Playoff
Series
common
Team
Roster
common
Team
Years
cume
Stats
Player
cume
Stats
Player
Games
cume
Stats
Team
cume
Stats
Team
Games
defense
Hub
draft
Board
draft
Combine
Drill
Results
draft
Combine
Non
Stationary
Shooting
draft
Combine
Player
Anthro
draft
Combine
Spot
Shooting
draft
Combine
Stats
draft
History
dunk
Score
Leaders
fantasy
Widget
franchise
History
franchise
Leaders
franchise
Players
game
Rotation
g
L
Alum
Box
Score
Similarity
Score
home
Page
Leaders
home
Page
V2
hustle
Stats
Box
Score
infographic
Fan
Duel
Player
i
ST
Standings
leaders
Tiles
league
Dash
Lineups
league
Dash
Opp
Pt
Shot
league
Dash
Player
Bio
Stats
league
Dash
Player
Clutch
league
Dash
Player
Pt
Shot
league
Dash
Player
Shot
Locations
league
Dash
Player
Stats
league
Dash
Pt
Defend
league
Dash
Pt
Stats
league
Dash
Pt
Team
Defend
league
Dash
Team
Clutch
league
Dash
Team
Pt
Shot
league
Dash
Team
Shot
Locations
league
Dash
Team
Stats
league
Game
Finder
league
Game
Log
league
Hustle
Stats
Player
league
Hustle
Stats
Team
league
Leaders
league
Lineup
Viz
league
Player
On
Details
league
Season
Matchups
league
Standings
league
Standings
V3
matchups
Rollup
play
By
Play
play
By
Play
V2
play
By
Play
V3
player
Awards
player
Career
By
College
player
Career
By
College
Rollup
player
Career
Stats
player
Compare
player
Dashboard
By
Clutch
player
Dashboard
By
Game
Splits
player
Dashboard
By
General
Splits
player
Dashboard
By
Last
N
Games
player
Dashboard
By
Shooting
Splits
player
Dashboard
By
Team
Performance
player
Dashboard
By
Year
Over
Year
player
Dash
Pt
Pass
player
Dash
Pt
Reb
player
Dash
Pt
Shot
Defend
player
Dash
Pt
Shots
player
Estimated
Metrics
player
Fantasy
Profile
Bar
Graph
player
Game
Log
player
Game
Logs
player
Game
Streak
Finder
player
Index
player
Next
N
Games
player
Profile
V2
player
Vs
Player
playoff
Picture
schedule
League
V2
schedule
League
V2
Int
scoreboard
V2
scoreboard
V3
shot
Chart
Detail
shot
Chart
League
Wide
shot
Chart
Lineup
Detail
synergy
Play
Types
team
And
Players
Vs
Players
team
Dashboard
By
General
Splits
team
Dashboard
By
Shooting
Splits
team
Dash
Lineups
team
Dash
Pt
Pass
team
Dash
Pt
Reb
team
Dash
Pt
Shots
team
Details
team
Estimated
Metrics
team
Game
Log
team
Game
Logs
team
Game
Streak
Finder
team
Historical
Leaders
team
Info
Common
team
Player
Dashboard
team
Player
On
Off
Details
team
Player
On
Off
Summary
team
Vs
Player
team
Year
By
Year
Stats
video
Details
video
Details
Asset
video
Events
video
Events
Asset
video
Status
win
Probability
PBP
nba-api-ts
Loading...