This article explains how to use the API to retrieve data from All-Star Rec Manager.
The following steps need to be taken to access the API.
Obtain an authorization token
Use a cUrl request to obtain the data you want from Disciple Launcher
To obtain an authorization token, go to the Preferences page and open the Account Preferences section. Click the Generate Token button adjacent to the API Authorization Token field.
Note: If you click Generate Token again, it will replace the existing token with a new token. You will likely only need to regenerate another token if your existing token is compromised.
This article assumes you are familiar with making a cUrl request.
Include the following information in your cUrl request.
URL: https://api.allstarrecmanager.com/{endpoint}?key1=value1&key2=value2
Header: "Authorization: Bearer {your_api_token}
Function: retrieves custom fields from the Preferences page
Endpoint: getCustomFields
Method: GET
Required keys:
field: specifies the custom field. Below is a list of available options
galleries
Function: retrieves your league’s divisions
Endpoint: getDivisions
Method: GET
Optional keys:
league_id: specifies a league. Defaults to all leagues.
season_id: specifies a season. Defaults to all seasons.
division_id: specifies a division. Defaults to all divisions.
Function: retrieves your organization's events
Endpoint: getEvents
Method: GET
Optional keys:
location_id: specifies a location. Defaults to all locations.
start: specifies a start date. Defaults to the current date month minus one month
end: specifies an end date. Defaults to the current date plus one month
Function: retrieves your league’s franchises
Endpoint: getFranchises
Method: GET
Required keys:
league_id: specifies a league.
Optional keys:
franchise_id: specifies a franchise. Defaults to all franchises.
Function: retrieves your organization's league events
Endpoint: getGames
Method: GET
Optional keys:
game_id: specifies a league event. Defaults to all league events.
league_id: specifies a league. Defaults to all leagues.
season_id: specifies a season. Defaults to all seasons.
division_id: specifies a division. Defaults to all divisions.
team_id: specifies a team. Defaults to all teams.
franchise_id: specifies a franchise. Defaults to all franchises.
game_type_id: specifies a game type. Defaults to all game types.
location_id: specifies a location. Defaults to all locations.
tournament_id: specifies a tournament. Defaults to all tournaments.
person_id: specifies a participant. Defaults to all participants.
start: specifies a start date. Defaults to no start date.
end: specifies an end date. Defaults to no end date.
Function: retrieves your league’s goaltending stats
Endpoint: getGoaltending
Method: GET
Optional keys:
league_id: specifies a league. Defaults to all leagues.
season_id: specifies a season. Defaults to all seasons.
division_id: specifies a division. Defaults to all divisions.
team_id: specifies a team. Defaults to all teams.
game_type_id: specifies a game type. Defaults to all game types.
tournament_id: specifies a tournament. Defaults to all tournaments.
person_id: specifies a participant. Defaults to all participants.
sort: specifies how the leaders are sorted. Defaults to save_percentage.
date
goals_against
goals_against_average
games_played
losses
name
save_percentage
saves
total_losses
total_wins
wins
limit: specifies the maximum number of records to pull. Defaults to all records.
Function: retrieves your organization's incident reports
Endpoint: getIncidentReports
Method: GET
Optional keys:
league_id: specifies a league. Defaults to all leagues.
season_id: specifies a season. Defaults to all seasons.
division_id: specifies a division. Defaults to all divisions.
team_id: specifies a team. Defaults to all teams.
game_type_id: specifies a game type. Defaults to all game types.
person_id: specifies a participant. Defaults to all participants.
publish: specifies whether the reports are published. Defaults to all.
Function: retrieves your organization's locations
Endpoint: getLocations
Method: GET
Function: retrieves your organization's posts
Endpoint: getPosts
Method: GET
Optional keys:
league_id: specifies a league. Defaults to all leagues.
location_id: specifies a location. Defaults to all locations.
category_id: specifies a category. Defaults to all categories.
post_id: specifies a post. Defaults to all posts.
dates: "past" or "future". Defaults to all dates.
limit: specifies the maximum number of records to pull. Defaults to all records.
Function: retrieves your league’s rosters
Endpoint: getRosters
Method: GET
Required keys:
league_id: specifies a league.
Optional keys:
season_id: specifies a season. Defaults to all seasons.
division_id: specifies a division. Defaults to all divisions.
team_id: specifies a team. Defaults to all teams.
person_id: specifies a participant. Defaults to all participants.
position_id: specifies a position. Defaults to all positions.
limit: specifies the maximum number of records to pull. Defaults to all records.
Function: retrieves your league’s roster transactions
Endpoint: getRosterTransactions
Method: GET
Required keys:
league_id: specifies a league.
Optional keys:
season_id: specifies a season. Defaults to all seasons.
division_id: specifies a division. Defaults to all divisions.
team_id: specifies a team. Defaults to all teams.
person_id: specifies a participant. Defaults to all participants.
start: specifies a start date. Defaults to no start date.
end: specifies an end date. Defaults to no end date.
limit: specifies the maximum number of records to pull. Defaults to all records.
Function: retrieves your league’s scoring leaders
Endpoint: getScoring
Method: GET
Optional keys:
league_id: specifies a league. Defaults to all leagues.
season_id: specifies a season. Defaults to all seasons.
division_id: specifies a division. Defaults to all divisions.
team_id: specifies a team. Defaults to all teams.
game_type_id: specifies a game type. Defaults to all game types.
tournament_id: specifies a tournament. Defaults to all tournaments.
person_id: specifies a participant. Defaults to all participants.
position_id: specifies a position. Defaults to all positions.
sort: specifies how the leaders are sorted. Defaults to points.
assists
date
games_played
goals
name
penalties
penalty_minutes
points
limit: specifies the maximum number of records to pull. Defaults to all records.
Function: retrieves your league’s seasons
Endpoint: getSeasons
Method: GET
Optional keys:
league_id: specifies a league. Defaults to all leagues.
season_id: specifies a season. Defaults to all seasons.
Function: retrieves your organization’s sponsors
Endpoint: getSponsors
Method: GET
Optional keys:
league_id: specifies a league. Defaults to all leagues.
Function: retrieves your league’s standings
Endpoint: getStandings
Method: GET
Optional keys:
league_id: specifies a league. Defaults to all leagues.
season_id: specifies a season. Defaults to all seasons.
division_id: specifies a division. Defaults to all divisions.
team_id: specifies a team. Defaults to all teams.
game_type_id: specifies a game type. Defaults to all game types.
tournament_id: specifies a tournament. Defaults to all tournaments.
person_id: specifies a participant. Defaults to all participants.
location_id: specifies a location. Defaults to all locations.
start: specifies a start date. Defaults to no start date.
end: specifies an end date. Defaults to no end date.
Function: retrieves your league’s sub requests
Endpoint: getSubRequests
Method: GET
Optional keys:
league_id: specifies a league. Defaults to all leagues.
season_id: specifies a season. Defaults to all seasons.
division_id: specifies a division. Defaults to all divisions.
team_id: specifies a team. Defaults to all teams.
start: specifies a start date. Defaults to no start date.
end: specifies an end date. Defaults to no end date.
dates: specifies relative timeframe. Defaults to all.
future
past
Function: retrieves your league’s suspensions
Endpoint: getSuspensions
Method: GET
Optional keys:
league_id: specifies a league. Defaults to all leagues.
season_id: specifies a season. Defaults to all seasons.
division_id: specifies a division. Defaults to all divisions.
team_id: specifies a team. Defaults to all teams.
person_id: specifies a participant. Defaults to all participants.
start: specifies a start date. Defaults to no start date.
end: specifies an end date. Defaults to no end date.
limit: specifies the maximum number of records to pull. Defaults to all records.
Function: retrieves your league’s teams
Endpoint: getTeams
Method: GET
Optional keys:
league_id: specifies a league. Defaults to all leagues.
season_id: specifies a season. Defaults to all seasons.
division_id: specifies a division. Defaults to all divisions.
team_id: specifies a team. Defaults to all teams.
display: specifies whether the team is marked to display. Defaults to all.