getStartingPositions: Return a dataframe that contains all starting positions for a...

getStartingPositionsR Documentation

Return a dataframe that contains all starting positions for a set of given match IDs

Description

Return a dataframe that contains all starting positions for a set of given match IDs

Usage

getStartingPositions(matches, token, host = "https://api.impect.com")

Arguments

matches

'IMPECT' match ID or a list of match IDs

token

bearer token

host

host environment

Value

a dataframe containing all starting positions for a set of given match IDs

Examples

# Toy example: this will error quickly (no API token)
try(starting_pos <- getStartingPositions(
  matches = c(0, 1),
  token = "invalid"
))

# Real usage: requires valid Bearer Token from `getAccessToken()`
## Not run: 
starting_pos <- getStartingPositions(
  matches = c(84248, 158150),
  token = "yourToken"
)

## End(Not run)

impectR documentation built on Dec. 17, 2025, 5:09 p.m.