GET /Destiny2/Stats/Leaderboards/Clans/{groupId}/

Gets leaderboards with the signed in user's friends and the supplied destinyMembershipId as the focus. PREVIEW: This endpoint is still in beta, and may experience rough edges. The schema is in final form, but there may be bugs that prevent desirable operation.

Request

Base URL
https://www.bungie.net/Platform
Auth
none declared

Path parameters

groupIdinteger required

Group ID of the clan whose leaderboards you wish to fetch.

Query parameters

maxtopinteger

Maximum number of top players to return. Use a large number to get entire leaderboard.

modesstring

List of game modes for which to get leaderboards. See the documentation for DestinyActivityModeType for valid values, and pass in string representation, comma delimited.

statidstring

ID of stat to return rather than returning all Leaderboard stats.

Response

Look at the Response property for more information about the nature of this response

Responseobject

ErrorCodeinteger

ThrottleSecondsinteger

ErrorStatusstring

Messagestring

MessageDataobject

DetailedErrorTracestring

Changes

No recorded changes to this operation across all 54 revisions of this API.