This page was generated with Wiki Builder. Do not change the format!


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.


Path Parameters

Name Schema Required Description
groupId integer:int64 Yes Group ID of the clan whose leaderboards you wish to fetch.

Query String Parameters

Name Schema Required Description
maxtop integer:int32 No Maximum number of top players to return. Use a large number to get entire leaderboard.
modes string No List of game modes for which to get leaderboards. See the documentation for DestinyActivityModeType for valid values, and pass in string representation, comma delimited.
statid string No ID of stat to return rather than returning all Leaderboard stats.





PlatformErrorCode: 200

    // Type: Dictionary<string,Dictionary<string,DestinyLeaderboard>>
    "Response": {
        "{string}": {
            "{string}": {
                // Type: string
                "statId": "",
                // Type: DestinyLeaderboardEntry[]
                "entries": [
                   // Type: DestinyLeaderboardEntry
                        // Type: integer:int32
                        "rank": 0,
                        // Type: DestinyPlayer
                        "player": {},
                        // Type: integer:int64
                        "characterId": 0,
                        // Type: DestinyHistoricalStatsValue
                        "value": {}
    // Type: PlatformErrorCodes:Enum
    "ErrorCode": 0,
    // Type: integer:int32
    "ThrottleSeconds": 0,
    // Type: string
    "ErrorStatus": "",
    // Type: string
    "Message": "",
    // Type: Dictionary<string,string>
    "MessageData": {
        "{string}": ""
    // Type: object