Skip to contents

Fetch totals from the pbpstats API

Source: R/pbpstats.R
get_totals.Rd

A thin wrapper around the pbpstats API’s “get-totals” endpoint.

Usage

get_totals(
  league = "nba",
  season,
  season_type = "Regular Season",
  type,
  from_date = NULL,
  to_date = NULL,
  team_id = NULL,
  group_by = NULL,
  leverage = NULL,
  starter_state = NULL,
  start_type = NULL
)

Arguments

league

Character. Which league to query; e.g., "nba" or "wnba"; defaults to "nba".

season

Character or integer. The season to query; e.g. "2024-25".

season_type

Character. One of:

  • "Regular Season"

  • "Playoffs"

  • "PlayIn"

  • "All"

; defaults to "Regular Season".

type

Character. One of:

  • "Player"

  • "Team"

  • "Opponent"

  • "Lineup"

  • "LineupOpponent"

.

from_date

Character or Date. Optional start date filter; defaults to NULL.

to_date

Character or Date. Optional end date filter; defaults to NULL.

team_id

Integer or character. Optional pbpstats team ID; defaults to NULL.

group_by

Character. Optional grouping variable; e.g., "Player" or "Team"; defaults to NULL.

leverage

Character. One or more leverage levels; one of:

  • "VeryLow"

  • "Low"

  • "Medium"

  • "High"

  • "VeryHigh"

; comma‐separated for multiple values; defaults to NULL.

starter_state

Character. One or more starter configurations; one of:

  • "5v5"

  • "4v5"

  • "3v5"

  • "2v5"

  • "1v5"

  • "0v5"

; comma‐separated for multiple values; defaults to NULL.

start_type

Character. One or more possession start types; one of:

  • "All"

  • "OffMissedFG"

  • "OffMissed2"

  • "OffMissed3"

  • "OffMadeFG"

  • "OffMade2"

  • "OffMade3"

  • "OffAtRimMake"

  • "OffAtRimMiss"

  • "OffAtRimBlock"

  • "OffShortMidRangeMake"

  • "OffShortMidRangeMiss"

  • "OffLongMidRangeMake"

  • "OffLongMidRangeMiss"

  • "OffArc3Make"

  • "OffArc3Miss"

  • "OffCorner3Make"

  • "OffCorner3Miss"

  • "OffFTMake"

  • "OffFTMiss"

  • "OffLiveBallTurnover"

  • "OffDeadball"

  • "OffTimeout"

; comma‐separated for multiple values; defaults to NULL.

Value

A tibble of total metrics as returned by the API.

References

Darryl Blackport (2020). PBPStats API, MIT License. https://api.pbpstats.com/docs

See also

https://api.pbpstats.com/docs