API v2 Documentation

Endpoints Code Lookup

← All endpoints

lineups

game NBA,WNBA,GL,MBB,MB2,MB3,WB2,WB3,MBIA,WBIA,MBJC,WBJC,WBB

A query to this endpoint without a qualifying query parameter will return an error. Results must be filtered by one or more of the following: team or season. Passing an id parameter will return a single PBP entry (with no additional metadata).

Please note that this endpoint can be used synonymously as lineup.

Lineups for Oregon Ducks WBB 2020
https://api.natstat.com/v1/lineups/WBB/?key=XXXX-XXXXXX&team=1156&format=xml Download sample

Parameters

Path

NameRequiredTypeDescription
level required string The competition level to retrieve information for. A full glossary can be found in the Path Parameters section

Query

NameRequiredTypeDescription
key required string A valid API key in XXXX-XXXXXX format
season required number A valid season ID code, formatted as the year that a season completes, in YYYY format. A list of available seasons can be retrieved from the seasons endpoint
team required number A valid team ID code. A list of teams can be retrieved from the teams endpoint
format optional string The preferred data format: xml, json or php (presented as a SimpleXML object). The default is json
max optional number The number of results per page to return. The default value is 100, and the maximum allowed parameter value is 1000. This value is echoed back as Max_Results in the meta block
page optional number The pagination page number. This value is echoed back as Page in the meta block. The meta block also contains the Total_Results of the query. If there are further results, a fully-formed Next_Page URI containing a pre-filled &page=X value will be returned
id optional number A valid season ID code, which returns details for that season (A list of available seasons can be retrieved from this endpoint by not passing an ID code.)

Response

NameRequiredTypeDescription
ID number The unique identifier for the record
LineupPlayers string A readout of the five players on the court in first initial and last name format, interpunct separated
TOV_M number Turnovers, margin
REB_D number Rebounds, defense
TOV_D number Turnovers, defense
TOV number Turnovers
STL_M number Steals, margin
STL_D number Steals, defense
STL number Steals
BLK_M number Blocks, margin
BLK_D number Blocks, defense
BLK number Blocks
AST_M number Assists, margin
AST_D number Assists, defense
AST number Assists
REB_M number Rebounds, margin
PTSpaint_M number Points in the paint, margin (NCAA only)
PF number Fouls
PF_D number Fouls, defense
PF_M number Fouls, margin
PTS2ch number Second chance points (NCAA only)
PTS2ch_D number Second chance points, defense (NCAA only)
PTS2ch_M number Second chance points, margin (NCAA only)
PTSbrk number Fastbreak points (NCAA only)
PTSbrk_D number Fastbreak points, defense (NCAA only)
PTSbrk_M number Fastbreak points, margin (NCAA only)
PTSoffto number Points off turnovers (NCAA only)
PTSoffto_D number Points off turnovers, defense (NCAA only)
PTSoffto_M number Points off turnovers, margin (NCAA only)
PTSpaint number Points in the paint (NCAA only)
PTSpaint_D number Points in the paint, defense (NCAA only)
FGA_D number Field goal attempts, defense
Possessions number The number of possessions used by this lineup during the season
OPPP number Offensive points per possession
DPPP number Defensive points per possession allowed
EffMargin number OPPP minus DPPP
Points number Points scored
Points_D number Points allowed
PlusMinus number Points margin
FGM number Field goals made
FGM_D number Field goals made, defense
FGM_M number Field goals made, margin
FGA number Field goal attempts
REB number Rebounds
FGA_M number Field goal attempts, margin
ThreeFM number Three-point field goals made
ThreeFM_D number Three-point field goals made, defense
ThreeFM_M number Three-point field goals made, margin
ThreeFA number Three-point field goals attempted
ThreeFA_D number Three-point field goals attempted, defense
ThreeFA_M number Three-point field goals attempted, margin
FTM number Free throws made
FTM_D number Free throws made, defense
FTM_M number Free throws made, margin
FTA number Free throws attempted
FTA_D number Free throws attempted, defense
FTA_M number Free throws attempted, margin