Statistical Leaders

Request: GET

Returns a list of statistics leaders for a competition.

HTTP Request

GET /v1/{sport}/competitions/{competitionId}/leaders/{statisticCode}

Parameters

Parameter Name Value Description
Required Parameters
sport string The sport for which you are making the request
competitionId integer Unique identifier for the competition.
statisticCode text Unique identifier for the statistic.
The codes depend upon the sport:
Optional Parameters
teamId integer Unique identifier for the team.
personId integer Unique identifier for the person.
periodNumber integer Display leaders for only this period.
periodType string The type of period.
  • REGULAR
  • OVERTIME
homeAway string Is this value for when the team is playing at home/away or either. If not provided, then 'ALL' is assumed.
  • HOME
  • AWAY
  • ALL
winLoss string Is this value for when the team has won or loss or either. If not provided, then 'ALL' is assumed.
  • WIN
  • LOSS
  • ALL
inConference string Is this value for when the team is in or out of it's own conference or either. If not provided, then 'ALL' is assumed.
  • IN
  • OUT
  • ALL
matchType string Is this value for what type of matches the team was in. If not provided, then 'ALL' is assumed.
  • PRESEASON
  • REGULAR
  • FINALS
  • ALL
useExternalForLeague integer If this value is set to the leagueId, then the URL parameters personId, competitionId and teamId will instead refer to the externalId fields of their respective entities in that league.

Request Body

Do not supply a request body with this method.

Response

If successful this method returns an array of Leaders resources. This call returns all statistics for each person in the Leaders resource.

Request: GET

Returns a summary of statistics leaders for a competition for multiple statistics.

The summary is method is different from the list method above, in that it returns the leaders for a number of statistics in the one call. This call also only returns the one statistic for each leaders resource, whereas the list call returns all possible statistics.

HTTP Request

GET /v1/{sport}/competitions/{competitionId}/leaders/summary

Parameters

Parameter Name Value Description
Required Parameters
sport string The sport for which you are making the request
competitionId integer Unique identifier for the competition.
statisticCodes text A comma separated list of statistic codes for which leaders will be returned.
e.g. sAssists,sBlocks
The codes depend upon the sport:
Optional Parameters
teamId integer Unique identifier for the team.
personId integer Unique identifier for the person.
periodNumber integer Display leaders for only this period.
periodType string The type of period.
  • REGULAR
  • OVERTIME
homeAway string Is this value for when the team is playing at home/away or either. If not provided, then 'ALL' is assumed.
  • HOME
  • AWAY
  • ALL
winLoss string Is this value for when the team has won or loss or either. If not provided, then 'ALL' is assumed.
  • WIN
  • LOSS
  • ALL
inConference string Is this value for when the team is in or out of it's own conference or either. If not provided, then 'ALL' is assumed.
  • IN
  • OUT
  • ALL
matchType string Is this value for what type of matches the team was in. If not provided, then 'ALL' is assumed.
  • PRESEASON
  • REGULAR
  • FINALS
  • ALL

Request Body

Do not supply a request body with this method.

Response

If successful this method returns an array of the following structure.

Parameter Name Value Description
statisticCode text The code for the statistic
leaders array An array of Leaders resources.