Skip to contents

Fetch score margin breakdown from the pbpstats API

Source: R/pbpstats.R
get_score_margin_breakdown.Rd

A thin wrapper around the pbpstats API’s “get-score-margin-breakdown” endpoint.

Usage

get_score_margin_breakdown(
  league = "nba",
  season,
  season_type = "Regular Season",
  team_id,
  period
)

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".

team_id

Integer or character. The pbpstats ID of the team.

period

Character. One of:

  • "All"

  • "1"

  • "2"

  • "3"

  • "4"

  • "SecondHalf"

.

Value

A tibble of score margin breakdown 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